Merge pull request #23 from Staffbase/more-optional-prepare-properties

✨ additionalInstructions support

.gitignore

@@ -3,3 +3,6 @@
 
 # node
 node_modules
+
+# Jest
+coverage

jest.config.js

@@ -18,7 +18,7 @@
 module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',
-  collectCoverage: false,
-  // coverageReporters: ["clover", "json", "lcov", "text", "html"],
+  collectCoverage: true,
+  coverageReporters: ["clover", "json", "lcov", "text", "html"],
   // testTimeout: 10 * 1000,
 };

package.json

@@ -1,4 +1,7 @@
 {
+  "scripts": {
+    "test": "jest"
+  },
   "devDependencies": {
     "@types/jest": "^29.5.2",
     "jest": "^29.6.1",

resources/exploratory_test_comment_prepare.json

@@ -10,5 +10,6 @@
     "user_stories": [
       "Add 1 or more user stories here which you want the tester to verify"
     ]
-  }
+  },
+  "additionalInstructions": "(optional, remove it if not needed)"
 }

resources/exploratory_test_comment_prepare_schema.json

@@ -45,6 +45,9 @@
         "howtofind",
         "user_stories"
       ]
+    },
+    "additionalInstructions": {
+      "type": "string"
     }
   },
   "required": [

src/Util.ts

@@ -19,7 +19,7 @@ import Ajv, {ValidateFunction} from "ajv";
 
 export class Util {
 
-    public static getJsonObjectFromComment(regex: RegExp, comment: string, expectedIndexOfObject: number): any {
+    private static getJsonObjectFromComment(regex: RegExp, comment: string, expectedIndexOfObject: number): any {
         const matches = regex.exec(comment);
         if (!matches) {
             throw new Error("Provided comment didn't match");
@@ -61,6 +61,7 @@ export class Util {
                         user_stories: prepareObject.feature.user_stories
                     }
                 ],
+                instructions: (prepareObject.additionalInstructions ? prepareObject.additionalInstructions : null),
                 duration: "2",
                 testing_type: "rapid"
             }

test/Util.test.ts

@@ -36,13 +36,13 @@ describe("TestIO Trigger-from-PR logic", () => {
     });
 
     it('should parse an object from the Github preparation comment', () => {
-        const parsedObject = Util.getJsonObjectFromComment( /```json\s(.+)\s```/sm, commentBody, 1);
+        const parsedObject = Util.retrievePrepareObjectFromComment(commentBody);
         expect(parsedObject).not.toBeNull();
     });
 
     it('should validate parsed object against schema', () => {
         const prepareTestSchemaFile = "resources/exploratory_test_comment_prepare_schema.json";
-        const parsedObject = Util.getJsonObjectFromComment( /```json\s(.+)\s```/sm, commentBody, 1);
+        const parsedObject = Util.retrievePrepareObjectFromComment(commentBody);
         const {valid, validation} = Util.validateObjectAgainstSchema(parsedObject, prepareTestSchemaFile);
         if (!valid) {
             if (validation.errors) {
@@ -61,7 +61,7 @@ describe("TestIO Trigger-from-PR logic", () => {
     });
 
     it('should convert prepare object into TestIO payload', () => {
-        const prepareObject = Util.getJsonObjectFromComment( /```json\s(.+)\s```/sm, commentBody, 1);
+        const prepareObject = Util.retrievePrepareObjectFromComment(commentBody);
         const repo = "testio-management";
         const owner = "Staffbase";
         const pr = 666;
@@ -77,6 +77,7 @@ describe("TestIO Trigger-from-PR logic", () => {
         expect(testioPayload.exploratory_test.features[0].description).toBe(prepareObject.feature.description);
         expect(testioPayload.exploratory_test.features[0].howtofind).toBe(prepareObject.feature.howtofind);
         expect(testioPayload.exploratory_test.features[0].user_stories).toBe(prepareObject.feature.user_stories);
+        expect(testioPayload.exploratory_test.instructions).toBe(prepareObject.additionalInstructions);
     });
 
     it('should truncate looooooong PR titles and add suffix', () => {