fix(cts): make the testName optional APIC-226 (#37)

Author: millotp

doc/CTS.md

@@ -23,7 +23,7 @@ The test generation script requires a JSON file name from the `operationId` (e.g
 ```json
 [
   {
-    "testName": "the name of the test (e.g. test('search endpoint'))",
+    "testName": "the name of the test (e.g. test('search endpoint')) (default: 'method')",
     "method": "the method to call (e.g. search)",
     "parameters": [
       "indexName",

tests/CTS/clients/search/clearAllSynonyms.json

@@ -1,6 +1,5 @@
 [
   {
-    "testName": "clearAllSynonyms",
     "method": "clearAllSynonyms",
     "parameters": [
       "indexName"

tests/CTS/clients/search/deleteSynonym.json

@@ -1,6 +1,5 @@
 [
   {
-    "testName": "deleteSynonym",
     "method": "deleteSynonym",
     "parameters": [
       "indexName",

tests/CTS/clients/search/getSynonym.json

@@ -1,6 +1,5 @@
 [
   {
-    "testName": "getSynonym",
     "method": "getSynonym",
     "parameters": [
       "indexName",

tests/CTS/clients/search/saveSynonym.json

@@ -1,24 +1,31 @@
 [
   {
-    "testName": "saveSynonym",
     "method": "saveSynonym",
     "parameters": [
       "indexName",
       "id1",
       {
-        "objectID" : "id1",
+        "objectID": "id1",
         "type": "synonym",
-        "synonyms": ["car", "vehicule", "auto"]
+        "synonyms": [
+          "car",
+          "vehicule",
+          "auto"
+        ]
       },
       true
     ],
     "request": {
       "path": "/1/indexes/indexName/synonyms/id1",
       "method": "PUT",
       "data": {
-        "objectID" : "id1",
+        "objectID": "id1",
         "type": "synonym",
-        "synonyms": ["car", "vehicule", "auto"]
+        "synonyms": [
+          "car",
+          "vehicule",
+          "auto"
+        ]
       }
     }
   }

tests/CTS/clients/search/saveSynonyms.json

@@ -1,20 +1,27 @@
 [
   {
-    "testName": "saveSynonyms",
     "method": "saveSynonyms",
     "parameters": [
       "indexName",
       [
         {
-          "objectID" : "id1",
+          "objectID": "id1",
           "type": "synonym",
-          "synonyms": ["car", "vehicule", "auto"]
+          "synonyms": [
+            "car",
+            "vehicule",
+            "auto"
+          ]
         },
         {
-          "objectID" : "id2",
+          "objectID": "id2",
           "type": "onewaysynonym",
           "input": "iphone",
-          "synonyms": ["ephone", "aphone", "yphone"]
+          "synonyms": [
+            "ephone",
+            "aphone",
+            "yphone"
+          ]
         }
       ],
       true,
@@ -25,15 +32,23 @@
       "method": "POST",
       "data": [
         {
-          "objectID" : "id1",
+          "objectID": "id1",
           "type": "synonym",
-          "synonyms": ["car", "vehicule", "auto"]
+          "synonyms": [
+            "car",
+            "vehicule",
+            "auto"
+          ]
         },
         {
-          "objectID" : "id2",
+          "objectID": "id2",
           "type": "onewaysynonym",
           "input": "iphone",
-          "synonyms": ["ephone", "aphone", "yphone"]
+          "synonyms": [
+            "ephone",
+            "aphone",
+            "yphone"
+          ]
         }
       ]
     }

tests/CTS/clients/search/search.json

@@ -1,6 +1,5 @@
 [
   {
-    "testName": "search",
     "method": "search",
     "parameters": [
       "indexName",

tests/CTS/clients/search/searchSynonyms.json

@@ -1,6 +1,5 @@
 [
   {
-    "testName": "searchSynonyms",
     "method": "searchSynonyms",
     "parameters": [
       "indexName",

tests/CTS/templates/javascript.mustache

@@ -10,7 +10,7 @@ describe('Common Test Suite', () => {
     expect(req).toMatchObject({
       path: '{{{request.path}}}',
       method: '{{{request.method}}}',
-      {{#request.data}}data: {{{request.data}}},{{/request.data}}
+      {{#request.data}}data: {{{.}}},{{/request.data}}
     })
   });
 

tests/generateCTS.ts

@@ -12,13 +12,13 @@ const availableLanguages = ['javascript'] as const;
 type Language = typeof availableLanguages[number];
 
 type CTSBlock = {
-  name: string;
+  testName?: string;
   method: string;
   parameters: any[];
   request: {
     path: string;
     method: string;
-    data: string;
+    data?: string;
   };
 };
 
@@ -90,8 +90,12 @@ async function loadCTSForClient(client: string): Promise<CTSBlock[]> {
       );
     }
 
-    // for now we stringify all params for mustache to render them properly
     for (const test of tests) {
+      if (test.testName === undefined) {
+        test.testName = test.method;
+      }
+
+      // for now we stringify all params for mustache to render them properly
       for (let i = 0; i < test.parameters.length; i++) {
         // delete the object name for now, but it could be use for `new $objectName(params)`
         delete test.parameters[i].$objectName;

tests/output/javascript/search.test.ts

@@ -42,23 +42,19 @@ describe('Common Test Suite', () => {
     expect(req).toMatchObject({
       path: '/1/indexes/indexName/synonyms/batch',
       method: 'POST',
-      data: {
-        synonymHit: [
-          {
-            objectID: 'id1',
-            type: 'synonym',
-            synonyms: ['car', 'vehicule', 'auto'],
-          },
-          {
-            objectID: 'id2',
-            type: 'onewaysynonym',
-            input: 'iphone',
-            synonyms: ['ephone', 'aphone', 'yphone'],
-          },
-        ],
-        ForwardToReplicas: true,
-        ReplaceExistingSynonyms: false,
-      },
+      data: [
+        {
+          objectID: 'id1',
+          type: 'synonym',
+          synonyms: ['car', 'vehicule', 'auto'],
+        },
+        {
+          objectID: 'id2',
+          type: 'onewaysynonym',
+          input: 'iphone',
+          synonyms: ['ephone', 'aphone', 'yphone'],
+        },
+      ],
     });
   });
 
@@ -110,12 +106,9 @@ describe('Common Test Suite', () => {
       path: '/1/indexes/indexName/synonyms/id1',
       method: 'PUT',
       data: {
-        synonymHit: {
-          objectID: 'id1',
-          type: 'synonym',
-          synonyms: ['car', 'vehicule', 'auto'],
-        },
-        ForwardToReplicas: true,
+        objectID: 'id1',
+        type: 'synonym',
+        synonyms: ['car', 'vehicule', 'auto'],
       },
     });
   });