OSMT-64: API Endpoint Tests

docs/int/openapi.yaml

@@ -83,15 +83,12 @@ paths:
       tags:
         - Collections
       responses:
-        '200':
-          description: OK
+        '202':
+          description: Accepted
           content:
-            text/csv:
+            application/json:
               schema:
-                type: string
-                example: >-
-                  id,type,authors,skillName,skillStatement,alignments,keywords,categories,occupations
-                  https://osmt.example.com/skills/9cd84455-2086-4f41-bcac-6d518beeb6ac,RichSkillDescriptor,"https://osmt.example.com/organization","Document Saving","The learner copies and saves documents to their local machine.","https://skillsource.example.com/base-skills/simple-compuhacking","documents, file operations, computer basics","Productivity Software","13-0000, 13-2000, 13-2010, 13-2030, 13-2040, 13-2060, 13-2080"
+                $ref: '#/components/schemas/TaskResult'
 
   /api/collections/{uuid}/xlsx:
     parameters:
@@ -102,13 +99,12 @@ paths:
       tags:
         - Collections
       responses:
-        '200':
-          description: OK
+        '202':
+          description: Accepted
           content:
-            application/vnd.ms-excel:
+            application/json:
               schema:
-                type: string
-                format: binary
+                $ref: '#/components/schemas/TaskResult'
 
   /api/collections/{uuid}/log:
     parameters:

test/.gitignore

@@ -0,0 +1,2 @@
+# dependencies
+/node_modules

test/api-test/api/collections/get-pre-request.js

@@ -0,0 +1,22 @@
+let sizeId = pm.request.url.query.indexOf('size');
+if (sizeId < 0) {
+  pm.request.url.query.add("size=50");
+}
+else {
+  pm.request.url.query.idx(sizeId).value = "50";
+}
+
+let fromId = pm.request.url.query.indexOf('from');
+if (fromId < 0) {
+  pm.request.url.query.add("size=0");
+}
+else {
+    pm.request.url.query.idx(fromId).value = "0";
+}
+
+let statusId = pm.request.url.query.indexOf('status');
+if (statusId > 0) {
+  pm.request.url.removeQueryParams('status');
+}
+
+pm.request.url.query.add("status=Draft");

test/api-test/api/collections/get.js

@@ -0,0 +1,7 @@
+// let expectedData is injected from <response-type>.json
+
+pm.test("Check collections", function () {
+  let responseData = pm.response.json();
+
+  pm.expect(responseData).to.have.deep.equal(expectedData);
+});

test/api-test/api/collections/get.json

@@ -0,0 +1,25 @@
+[
+  {
+      "uuid": "ce1ccd5d-2ba8-496d-bdb6-87a278752a15",
+      "name": "Bailiffs, Correctional Officers, and Jailers",
+      "skillCount": 132,
+      "workspaceOwner": "",
+      "status": "draft"
+  },
+  {
+      "uuid": "60495ba4-c529-4327-8a04-9d282ec2c2c0",
+      "name": "Marketing",
+      "description": "Marketing stuff",
+      "skillCount": 224,
+      "workspaceOwner": "",
+      "status": "draft"
+  },
+  {
+      "uuid": "f4e45435-99ef-4432-ad4d-bd7494ca0c83",
+      "name": "Nursing RSDs",
+      "description": "A few skills for nursing",
+      "skillCount": 25,
+      "workspaceOwner": "",
+      "status": "draft"
+  }
+]

test/api-test/api/collections/post-pre-request.js

@@ -0,0 +1,27 @@
+let create = [
+  {
+    "name": "API Test Collection - System Admin",
+    "description": "Tests creation of collection",
+    "status": "Draft",
+    "author": "Newman",
+    "skills": {
+      "add": [
+        "9d075e9d-2bde-4956-bf8c-83e5616a7c45",
+        "80e70dd1-4827-45e0-8038-f745433b6d86",
+        "bf408208-7e16-4a96-a769-40a9ecc161ff"
+      ]
+    }
+  }
+];
+
+let body = {
+  mode: 'raw',
+  raw: JSON.stringify(create),
+  options: {
+    raw: {
+      language: 'json'
+    }
+  }
+};
+
+pm.request.body.update(body);

test/api-test/api/collections/post.js

@@ -0,0 +1,61 @@
+// let expectedData is injected from <response-type>.json
+
+let responseData = pm.response.json();
+
+console.log("Check collection creation");
+
+pm.test("Check collection count", function () {
+  pm.expect(responseData.length).to.equal(expectedData.length);
+});
+
+for (let collectionIndex = 0; collectionIndex < expectedData.length; collectionIndex++) {
+  let expectedCol = expectedData[0];
+  let colNum = collectionIndex + 1;
+
+  let responseCol = responseData[0];
+  pm.test(`Collection ${colNum} - Check object type`, function () {
+  pm.expect(responseCol.type).to.equal(expectedCol.type);
+  });
+  pm.test(`Collection ${colNum} - Check collection name`, function () {
+  pm.expect(responseCol.name).to.equal(expectedCol.name);
+  });
+  pm.test(`Collection ${colNum} - Check ID exists`, function () {
+  pm.expect(responseCol.id).exists;
+  });
+  pm.test(`Collection ${colNum} - Check description`, function () {
+  pm.expect(responseCol.description).to.equal(expectedCol.description);
+  });
+  pm.test(`Collection ${colNum} - Check status`, function () {
+  pm.expect(responseCol.status).to.equal(expectedCol.status);
+  });
+  pm.test(`Collection ${colNum} - Check skills`, function () {
+  pm.expect(responseCol.skills).to.have.deep.equal(expectedCol.skills);
+  });
+  pm.test(`Collection ${colNum} - Check author`, function () {
+  pm.expect(responseCol.author).to.equal(expectedCol.author);
+  });
+  pm.test(`Collection ${colNum} - Check UUID exists`, function () {
+  pm.expect(responseCol.uuid).exists;
+  });
+  pm.test(`Collection ${colNum} - Check archive date does not exist`, function () {
+  pm.expect(responseCol.archiveDate).not.exists;
+  });
+  pm.test(`Collection ${colNum} - Check publish date does not exist`, function () {
+  pm.expect(responseCol.publishDate).not.exists;
+  });
+  pm.test(`Collection ${colNum} - Check creation date exists`, function () {
+  pm.expect(responseCol.creationDate).exists;
+  });
+  pm.test(`Collection ${colNum} - Check update date exists`, function () {
+  pm.expect(responseCol.updateDate).exists;
+  });
+  pm.test(`Collection ${colNum} - Check creator exists`, function () {
+  pm.expect(responseCol.creator).exists;
+  });
+  pm.test(`Collection ${colNum} - Check skills keywords`, function () {
+  pm.expect(responseCol.skillKeywords).to.have.deep.equal(expectedCol.skillKeywords);
+  });
+  pm.test(`Collection ${colNum} - Check context`, function () {
+  pm.expect(responseCol["@context"]).to.equal(expectedCol["@context"]);
+  });
+}