refactor: Add unit tests and in-code documentation to improve maintan…

…ability

jest.config.cjs

@@ -1,3 +1,6 @@
+const dotenv = require('dotenv');
+dotenv.config({ path: './.test.env' });
+
 /**
  * For a detailed explanation regarding each configuration property, visit:
  * https://jestjs.io/docs/configuration
@@ -18,19 +21,18 @@ const config = {
     clearMocks: true,
 
     // Indicates whether the coverage information should be collected while executing the test
-    // collectCoverage: true,
-    collectCoverage: false,
+    collectCoverage: true,
+    // collectCoverage: false,
 
     // An array of glob patterns indicating a set of files for which coverage information should be collected
     // collectCoverageFrom: undefined,
+    // collectCoverageFrom: ['./src/**/*.{js,jsx}'],
 
     // The directory where Jest should output its coverage files
     coverageDirectory: 'coverage',
 
     // An array of regexp pattern strings used to skip coverage collection
-    // coveragePathIgnorePatterns: [
-    //   "/node_modules/"
-    // ],
+    coveragePathIgnorePatterns: ['/node_modules/', '/build/', '/dist/'],
 
     // Indicates which provider should be used to instrument code for coverage
     coverageProvider: 'v8',
@@ -45,6 +47,14 @@ const config = {
 
     // An object that configures minimum threshold enforcement for coverage results
     // coverageThreshold: undefined,
+    // coverageThreshold: {
+    //     global: {
+    //         branches: 90,
+    //         functions: 90,
+    //         lines: 90,
+    //         statements: 90,
+    //     },
+    // },
 
     // A path to a custom dependency extractor
     // dependencyExtractor: undefined,

package.json

@@ -60,6 +60,7 @@
         "@babel/plugin-syntax-import-assertions": "^7.26.0",
         "@eslint/js": "^9.15.0",
         "@jest/globals": "^29.7.0",
+        "dotenv": "^16.4.7",
         "eslint-config-prettier": "^9.1.0",
         "eslint-plugin-prettier": "^5.2.1",
         "jest": "^29.7.0",

src/__tests__/activity_custom_property_create_cert.test.js → src/__tests__/cmd/activity_custom_property_create_cert.test.js

@@ -1,6 +1,6 @@
 import { jest, test, expect, describe } from '@jest/globals';
 
-import { createUserActivityBucketsCustomProperty } from '../lib/cmd/qseow/createuseractivitycp.js';
+import { createUserActivityBucketsCustomProperty } from '../../lib/cmd/qseow/createuseractivitycp.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/app_cert.test.js → src/__tests__/cmd/app_cert.test.js

@@ -1,7 +1,7 @@
 /* eslint-disable no-console */
 import { jest, test, expect, describe } from '@jest/globals';
 
-import { getApps, getAppById } from '../lib/util/qseow/app.js';
+import { getApps, getAppById } from '../../lib/util/qseow/app.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/app_export_cert.test.js → src/__tests__/cmd/app_export_cert.test.js

@@ -3,7 +3,7 @@ import { jest, test, expect, describe } from '@jest/globals';
 
 import fs from 'node:fs';
 import path from 'node:path';
-import { exportAppToFile } from '../lib/cmd/qseow/exportapp.js';
+import { exportAppToFile } from '../../lib/cmd/qseow/exportapp.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/app_export_jwt.test.js → src/__tests__/cmd/app_export_jwt.test.js

@@ -3,7 +3,7 @@ import { jest, test, expect, describe } from '@jest/globals';
 
 import fs from 'node:fs';
 import path from 'node:path';
-import { exportAppToFile } from '../lib/cmd/qseow/exportapp.js';
+import { exportAppToFile } from '../../lib/cmd/qseow/exportapp.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/app_import_cert.test.js → src/__tests__/cmd/app_import_cert.test.js

@@ -1,8 +1,8 @@
 /* eslint-disable no-console */
 import { jest, test, expect, describe } from '@jest/globals';
 
-import { importAppFromFile } from '../lib/cmd/qseow/importapp.js';
-import { appExistById, deleteAppById } from '../lib/util/qseow/app.js';
+import { importAppFromFile } from '../../lib/cmd/qseow/importapp.js';
+import { appExistById, deleteAppById } from '../../lib/util/qseow/app.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/app_import_jwt.test.js → src/__tests__/cmd/app_import_jwt.test.js

@@ -1,8 +1,8 @@
 /* eslint-disable no-console */
 import { jest, test, expect, describe } from '@jest/globals';
 
-import { importAppFromFile } from '../lib/cmd/qseow/importapp.js';
-import { appExistById, deleteAppById } from '../lib/util/qseow/app.js';
+import { importAppFromFile } from '../../lib/cmd/qseow/importapp.js';
+import { appExistById, deleteAppById } from '../../lib/util/qseow/app.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/app_jwt.test.js → src/__tests__/cmd/app_jwt.test.js

@@ -1,9 +1,9 @@
 /* eslint-disable no-console */
 import { jest, test, expect, describe } from '@jest/globals';
 
-import { getApps, getAppById, appExistById, deleteAppById } from '../lib/util/qseow/app.js';
-import { importAppFromFile } from '../lib/cmd/qseow/importapp.js';
-import { sleep } from '../globals.js';
+import { getApps, getAppById, appExistById, deleteAppById } from '../../lib/util/qseow/app.js';
+import { importAppFromFile } from '../../lib/cmd/qseow/importapp.js';
+import { sleep } from '../../globals.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/app_scramble_cert.test.js → src/__tests__/cmd/app_scramble_cert.test.js

@@ -1,7 +1,7 @@
 import { jest, test, expect, describe } from '@jest/globals';
 import { validate as uuidValidate } from 'uuid';
 
-import { scrambleField } from '../lib/cmd/qseow/scramblefield.js';
+import { scrambleField } from '../../lib/cmd/qseow/scramblefield.js';
 
 let options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/bookmark_get_cert.test.js → src/__tests__/cmd/bookmark_get_cert.test.js

@@ -1,7 +1,7 @@
 /* eslint-disable no-console */
 import { jest, test, expect, describe } from '@jest/globals';
 
-import { getBookmark } from '../lib/cmd/qseow/getbookmark.js';
+import { getBookmark } from '../../lib/cmd/qseow/getbookmark.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/bookmark_get_jwt.test.js → src/__tests__/cmd/bookmark_get_jwt.test.js

@@ -1,6 +1,6 @@
 import { jest, test, expect, describe } from '@jest/globals';
 
-import { getBookmark } from '../lib/cmd/qseow/getbookmark.js';
+import { getBookmark } from '../../lib/cmd/qseow/getbookmark.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/connection_test_cert.test.js → src/__tests__/cmd/connection_test_cert.test.js

@@ -1,6 +1,6 @@
 import { jest, test, expect, describe } from '@jest/globals';
 
-import { testConnection } from '../lib/cmd/qseow/testconnection.js';
+import { testConnection } from '../../lib/cmd/qseow/testconnection.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/connection_test_jwt.test.js → src/__tests__/cmd/connection_test_jwt.test.js

@@ -1,6 +1,6 @@
 import { jest, test, expect, describe } from '@jest/globals';
 
-import { testConnection } from '../lib/cmd/qseow/testconnection.js';
+import { testConnection } from '../../lib/cmd/qseow/testconnection.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/script_get_cert.test.js → src/__tests__/cmd/script_get_cert.test.js

@@ -1,6 +1,6 @@
 import { jest, test, expect, describe } from '@jest/globals';
 
-import { getScript } from '../lib/cmd/qseow/getscript.js';
+import { getScript } from '../../lib/cmd/qseow/getscript.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/script_get_jwt.test.js → src/__tests__/cmd/script_get_jwt.test.js

@@ -1,6 +1,6 @@
 import { jest, test, expect, describe } from '@jest/globals';
 
-import { getScript } from '../lib/cmd/qseow/getscript.js';
+import { getScript } from '../../lib/cmd/qseow/getscript.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/task_cert.test.js → src/__tests__/cmd/task_cert.test.js

@@ -1,6 +1,6 @@
 import { jest, test, expect, describe } from '@jest/globals';
 
-import { taskExistById, getTaskByName, getTaskById } from '../lib/util/qseow/task.js';
+import { taskExistById, getTaskByName, getTaskById } from '../../lib/util/qseow/task.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/task_custom_property_set_cert.test.js → src/__tests__/cmd/task_custom_property_set_cert.test.js

@@ -1,7 +1,7 @@
 import { jest, test, expect, describe } from '@jest/globals';
 
-import { setTaskCustomProperty } from '../lib/cmd/qseow/settaskcp.js';
-import { getTaskById } from '../lib/util/qseow/task.js';
+import { setTaskCustomProperty } from '../../lib/cmd/qseow/settaskcp.js';
+import { getTaskById } from '../../lib/util/qseow/task.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/task_custom_property_set_jwt.test.js → src/__tests__/cmd/task_custom_property_set_jwt.test.js

@@ -1,7 +1,7 @@
 import { jest, test, expect, describe } from '@jest/globals';
 
-import { setTaskCustomProperty } from '../lib/cmd/qseow/settaskcp.js';
-import { getTaskById } from '../lib/util/qseow/task.js';
+import { setTaskCustomProperty } from '../../lib/cmd/qseow/settaskcp.js';
+import { getTaskById } from '../../lib/util/qseow/task.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/task_get_cert.test.js → src/__tests__/cmd/task_get_cert.test.js

@@ -2,7 +2,7 @@ import { jest, test, expect, describe } from '@jest/globals';
 
 import fs from 'node:fs';
 import path from 'node:path';
-import { getTask } from '../lib/cmd/qseow/gettask.js';
+import { getTask } from '../../lib/cmd/qseow/gettask.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/task_get_jwt.test.js → src/__tests__/cmd/task_get_jwt.test.js

@@ -2,7 +2,7 @@ import { jest, test, expect, describe } from '@jest/globals';
 
 import fs from 'node:fs';
 import path from 'node:path';
-import { getTask } from '../lib/cmd/qseow/gettask.js';
+import { getTask } from '../../lib/cmd/qseow/gettask.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/task_import_cert.test.js → src/__tests__/cmd/task_import_cert.test.js

@@ -1,8 +1,8 @@
 import { jest, test, expect, describe } from '@jest/globals';
 
-import { importTaskFromFile } from '../lib/cmd/qseow/importtask.js';
-import { getTaskById, deleteExternalProgramTaskById, deleteReloadTaskById } from '../lib/util/qseow/task.js';
-import { mapTaskType } from '../lib/util/qseow/lookups.js';
+import { importTaskFromFile } from '../../lib/cmd/qseow/importtask.js';
+import { getTaskById, deleteExternalProgramTaskById, deleteReloadTaskById } from '../../lib/util/qseow/task.js';
+import { mapTaskType } from '../../lib/util/qseow/lookups.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/task_import_jwt.test.js → src/__tests__/cmd/task_import_jwt.test.js

@@ -1,8 +1,8 @@
 import { jest, test, expect, describe } from '@jest/globals';
 
-import { importTaskFromFile } from '../lib/cmd/qseow/importtask.js';
-import { getTaskById, deleteExternalProgramTaskById, deleteReloadTaskById } from '../lib/util/qseow/task.js';
-import { mapTaskType } from '../lib/util/qseow/lookups.js';
+import { importTaskFromFile } from '../../lib/cmd/qseow/importtask.js';
+import { getTaskById, deleteExternalProgramTaskById, deleteReloadTaskById } from '../../lib/util/qseow/task.js';
+import { mapTaskType } from '../../lib/util/qseow/lookups.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/task_jwt.test.js → src/__tests__/cmd/task_jwt.test.js

@@ -1,6 +1,6 @@
 import { jest, test, expect, describe } from '@jest/globals';
 
-import { taskExistById, getTaskByName, getTaskById } from '../lib/util/qseow/task.js';
+import { taskExistById, getTaskByName, getTaskById } from '../../lib/util/qseow/task.js';
 
 const options = {
     logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',

src/__tests__/testdata/test-file-1.txt

@@ -0,0 +1 @@
+Hello, world!

src/__tests__/testdata/unreadable-file-1.txt

@@ -0,0 +1 @@
+Foo