build: Add unit tests for task-custom-property-set command

First version of unit tests
ptarmiganlabs · Dec 21, 2023 · cacdbf4 · cacdbf4
1 parent 5cfb204
commit cacdbf4
Show file tree

Hide file tree

Showing 2 changed files with 190 additions and 0 deletions.
diff --git a/src/__tests__/task_custom_property_set_cert.test.js b/src/__tests__/task_custom_property_set_cert.test.js
@@ -0,0 +1,97 @@
+/* eslint-disable no-console */
+const { test, expect, describe } = require('@jest/globals');
+
+const { setTaskCustomProperty } = require('../lib/cmd/settaskcp');
+const { getTaskById } = require('../lib/util/task');
+
+const options = {
+    logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',
+    authType: process.env.CTRL_Q_AUTH_TYPE || 'cert',
+    authCertFile: process.env.CTRL_Q_AUTH_CERT_FILE || './cert/client.pem',
+    authCertKeyFile: process.env.CTRL_Q_AUTH_CERT_KEY_FILE || './cert/client_key.pem',
+    host: process.env.CTRL_Q_HOST || '',
+    port: process.env.CTRL_Q_PORT || '4242',
+    schemaVersion: process.env.CTRL_Q_SCHEMA_VERSION || '12.612.0',
+    virtualProxy: process.env.CTRL_Q_VIRTUAL_PROXY || '',
+    secure: process.env.CTRL_Q_SECURE || true,
+    authUserDir: process.env.CTRL_Q_AUTH_USER_DIR || '',
+    authUserId: process.env.CTRL_Q_AUTH_USER_ID || '',
+
+    taskType: process.env.CTRL_Q_TASK_TYPE || ['reload', 'ext-program'],
+};
+
+const defaultTestTimeout = process.env.CTRL_Q_TEST_TIMEOUT || 600000; // 10 minute default timeout
+jest.setTimeout(defaultTestTimeout);
+
+options.fileType = 'excel';
+options.fileName = `./testdata/tasks.xlsx`;
+options.sheetName = 'App import';
+options.port = '4242';
+
+// Define eixsting tasks
+const existingTaskId = 'e9100e69-4e8e-414b-bf88-10a1110c43a9';
+
+test('set custom properties (verify parameters)', async () => {
+    expect(options.authCertFile).not.toHaveLength(0);
+    expect(options.authCertKeyFile).not.toHaveLength(0);
+    expect(options.host).not.toHaveLength(0);
+    expect(options.authUserDir).not.toHaveLength(0);
+    expect(options.authUserId).not.toHaveLength(0);
+});
+
+// Test suite for app export
+describe('set custom property on reload task (cert auth)', () => {
+    /**
+     * One task ID, replace any existing CPs with 2 new ones
+     *
+     * ----task-id <id>
+     * --update-mode replace
+     * --overwrite
+     */
+    test('replace task cp', async () => {
+        options.updateMode = 'replace';
+        options.overwrite = true;
+        options.taskId = [existingTaskId];
+        options.customPropertyName = 'ctrl_q_unit_test_1';
+        options.customPropertyValue = ['Value 1', 'Value 2'];
+
+        const result = await setTaskCustomProperty(options);
+
+        // Result should be true
+        expect(result).toBe(true);
+
+        // Get task and verify that CPs have been set
+        const task = await getTaskById(existingTaskId, options);
+        expect(task.customProperties.length).toBe(2);
+
+        // Verify that CP has the correct values
+        expect(task.customProperties[0].value).toBe('Value 1');
+        expect(task.customProperties[1].value).toBe('Value 2');
+    });
+
+    /**
+     * One task ID, append any existing CPs with 1 new one
+     *
+     * ----task-id <id>
+     * --update-mode append
+     */
+    test('append task cp', async () => {
+        options.updateMode = 'append';
+        options.overwrite = true;
+        options.taskId = [existingTaskId];
+        options.customPropertyName = 'ctrl_q_unit_test_1';
+        options.customPropertyValue = ['Value 3'];
+
+        const result = await setTaskCustomProperty(options);
+
+        // Result should be true
+        expect(result).toBe(true);
+
+        // Get task and verify that CPs have been set
+        const task = await getTaskById(existingTaskId, options);
+        expect(task.customProperties.length).toBe(3);
+
+        // Verify that CP has the correct values
+        expect(task.customProperties[2].value).toBe('Value 3');
+    });
+});
diff --git a/src/__tests__/task_custom_property_set_jwt.test.js b/src/__tests__/task_custom_property_set_jwt.test.js
@@ -0,0 +1,93 @@
+/* eslint-disable no-console */
+const { test, expect, describe } = require('@jest/globals');
+
+const { setTaskCustomProperty } = require('../lib/cmd/settaskcp');
+const { getTaskById } = require('../lib/util/task');
+
+const options = {
+    logLevel: process.env.CTRL_Q_LOG_LEVEL || 'info',
+    authType: process.env.CTRL_Q_AUTH_TYPE || 'jwt',
+    authCertFile: process.env.CTRL_Q_AUTH_CERT_FILE || './cert/client.pem',
+    authCertKeyFile: process.env.CTRL_Q_AUTH_CERT_KEY_FILE || './cert/client_key.pem',
+    host: process.env.CTRL_Q_HOST || '',
+    port: process.env.CTRL_Q_PORT || '443',
+    schemaVersion: process.env.CTRL_Q_SCHEMA_VERSION || '12.612.0',
+    virtualProxy: process.env.CTRL_Q_VIRTUAL_PROXY || 'jwt',
+    secure: process.env.CTRL_Q_SECURE || true,
+    authUserDir: process.env.CTRL_Q_AUTH_USER_DIR || '',
+    authUserId: process.env.CTRL_Q_AUTH_USER_ID || '',
+
+    taskType: process.env.CTRL_Q_TASK_TYPE || ['reload', 'ext-program'],
+    authJwt: process.env.CTRL_Q_AUTH_JWT || '',
+};
+
+const defaultTestTimeout = process.env.CTRL_Q_TEST_TIMEOUT || 600000; // 10 minute default timeout
+jest.setTimeout(defaultTestTimeout);
+
+// Define eixsting tasks
+const existingTaskId = 'e9100e69-4e8e-414b-bf88-10a1110c43a9';
+
+test('set custom properties (verify parameters)', async () => {
+    expect(options.authCertFile).not.toHaveLength(0);
+    expect(options.authCertKeyFile).not.toHaveLength(0);
+    expect(options.host).not.toHaveLength(0);
+    expect(options.authUserDir).not.toHaveLength(0);
+    expect(options.authUserId).not.toHaveLength(0);
+});
+
+// Test suite for app export
+describe('set custom property on reload task (jwt auth)', () => {
+    /**
+     * One task ID, replace any existing CPs with 2 new ones
+     *
+     * ----task-id <id>
+     * --update-mode replace
+     * --overwrite
+     */
+    test('replace task cp', async () => {
+        options.updateMode = 'replace';
+        options.overwrite = true;
+        options.taskId = [existingTaskId];
+        options.customPropertyName = 'ctrl_q_unit_test_1';
+        options.customPropertyValue = ['Value 1', 'Value 2'];
+
+        const result = await setTaskCustomProperty(options);
+
+        // Result should be true
+        expect(result).toBe(true);
+
+        // Get task and verify that CPs have been set
+        const task = await getTaskById(existingTaskId, options);
+        expect(task.customProperties.length).toBe(2);
+
+        // Verify that CP has the correct values
+        expect(task.customProperties[0].value).toBe('Value 1');
+        expect(task.customProperties[1].value).toBe('Value 2');
+    });
+
+    /**
+     * One task ID, append any existing CPs with 1 new one
+     *
+     * ----task-id <id>
+     * --update-mode append
+     */
+    test('append task cp', async () => {
+        options.updateMode = 'append';
+        options.overwrite = true;
+        options.taskId = [existingTaskId];
+        options.customPropertyName = 'ctrl_q_unit_test_1';
+        options.customPropertyValue = ['Value 3'];
+
+        const result = await setTaskCustomProperty(options);
+
+        // Result should be true
+        expect(result).toBe(true);
+
+        // Get task and verify that CPs have been set
+        const task = await getTaskById(existingTaskId, options);
+        expect(task.customProperties.length).toBe(3);
+
+        // Verify that CP has the correct values
+        expect(task.customProperties[2].value).toBe('Value 3');
+    });
+});