feat(cts): add custom request tests

.github/.cache_version

@@ -1 +1 @@
-7.2.0
+7.2.1.0.1

.github/workflows/check.yml

@@ -277,6 +277,7 @@ jobs:
             hashFiles(
               format('{0}/lib/Api/{1}.php', matrix.client.folder, matrix.client.api),
               format('{0}/lib/Configuration/{1}.php', matrix.client.folder, matrix.client.config),
+              format('{0}/lib/Model/{1}/**', matrix.client.folder, matrix.client.capitalizedName),
               format('specs/bundled/{0}.yml', matrix.client.name),
               'templates/php/**',
               'generators/src/**'

.yarnrc.yml

@@ -2,6 +2,6 @@ nodeLinker: node-modules
 
 plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
-    spec: "@yarnpkg/plugin-interactive-tools"
+    spec: '@yarnpkg/plugin-interactive-tools'
 
 yarnPath: .yarn/releases/yarn-3.1.1.cjs

generators/src/main/java/com/algolia/codegen/cts/AlgoliaCtsGenerator.java

@@ -170,6 +170,9 @@ public Map<String, Object> postProcessSupportingFileData(
         System.out.println(e.getMessage());
         System.exit(0);
       }
+
+      System.out.println(e.getMessage());
+      System.exit(1);
     } catch (Exception e) {
       e.printStackTrace();
       System.exit(1);
@@ -181,15 +184,28 @@ private Map<String, Request[]> loadCTS()
     throws JsonParseException, JsonMappingException, IOException, CTSException {
     TreeMap<String, Request[]> cts = new TreeMap<>();
     File dir = new File("tests/CTS/methods/requests/" + client);
+    File commonTestDir = new File("tests/CTS/methods/requests/common");
     if (!dir.exists()) {
       throw new CTSException("CTS not found at " + dir.getAbsolutePath(), true);
     }
+    if (!commonTestDir.exists()) {
+      throw new CTSException(
+        "CTS not found at " + commonTestDir.getAbsolutePath(),
+        true
+      );
+    }
     for (File f : dir.listFiles()) {
       cts.put(
         f.getName().replace(".json", ""),
         Json.mapper().readValue(f, Request[].class)
       );
     }
+    for (File f : commonTestDir.listFiles()) {
+      cts.put(
+        f.getName().replace(".json", ""),
+        Json.mapper().readValue(f, Request[].class)
+      );
+    }
     return cts;
   }
 

generators/src/main/java/com/algolia/codegen/cts/ParametersWithDataType.java

@@ -200,8 +200,13 @@ private void handleModel(
     String parent,
     int suffix
   ) throws CTSException {
-    assert (spec.getHasVars());
-    assert (spec.getItems() == null);
+    if (!spec.getHasVars()) {
+      throw new CTSException("Spec has no vars.");
+    }
+
+    if (spec.getItems() != null) {
+      throw new CTSException("Spec has items.");
+    }
 
     if (
       spec instanceof CodegenModel && ((CodegenModel) spec).oneOf.size() > 0
@@ -269,8 +274,13 @@ private void handleObject(
     IJsonSchemaValidationProperties spec,
     int suffix
   ) throws CTSException {
-    assert (!spec.getHasVars());
-    assert (spec.getItems() == null);
+    if (spec.getHasVars()) {
+      throw new CTSException("Spec has vars.");
+    }
+
+    if (spec.getItems() != null) {
+      throw new CTSException("Spec has items.");
+    }
 
     Map<String, Object> vars = (Map<String, Object>) param;
 
@@ -300,18 +310,37 @@ private void handleMap(
     IJsonSchemaValidationProperties spec,
     int suffix
   ) throws CTSException {
-    assert (!spec.getHasVars());
-    assert (spec.getItems() != null);
+    if (spec.getHasVars()) {
+      throw new CTSException("Spec has vars.");
+    }
 
     Map<String, Object> vars = (Map<String, Object>) param;
 
     List<Object> values = new ArrayList<>();
+
+    CodegenProperty items = spec.getItems();
+
     for (Entry<String, Object> entry : vars.entrySet()) {
+      IJsonSchemaValidationProperties itemType = items;
+
+      // The generator consider a free form object type as an `object`, which
+      // is wrong in our case, so we infer it.
+      if (
+        items == null ||
+        (items.openApiType.equals("object") && items.isFreeFormObject)
+      ) {
+        CodegenParameter maybeMatch = new CodegenParameter();
+        String paramType = inferDataType(entry.getValue(), maybeMatch, null);
+
+        maybeMatch.dataType = paramType;
+        itemType = maybeMatch;
+      }
+
       values.add(
         traverseParams(
           entry.getKey(),
           entry.getValue(),
-          spec.getItems(),
+          itemType,
           paramName,
           suffix + 1
         )

package.json

@@ -1,6 +1,7 @@
 {
   "name": "@algolia/api-client-automation",
   "version": "0.0.0",
+  "private": true,
   "workspaces": [
     "clients/algoliasearch-client-javascript/",
     "playground/javascript/node/",

scripts/cts/client/generate.ts

@@ -7,10 +7,10 @@ import { createSpinner } from '../../oraLog';
 import type { Generator } from '../../types';
 import {
   walk,
-  createClientName,
   createOutputDir,
   getOutputPath,
   loadTemplates,
+  createClientName,
 } from '../utils';
 
 import type { TestsBlock, Test, ModifiedStepForMustache } from './types';
@@ -98,7 +98,7 @@ export async function generateClientTests(
     template,
     {
       import: packageName,
-      client: createClientName(client, language),
+      client: `${createClientName(client, language)}Api`,
       blocks: modifyForMustache(testsBlocks),
       hasRegionalHost: hasRegionalHost ? true : undefined,
     },

scripts/cts/utils.test.ts

@@ -20,22 +20,20 @@ describe('utils', () => {
 
   describe('createClientName', () => {
     it('does not capitalize every part for JavaScript', () => {
-      expect(createClientName('search', 'javascript')).toEqual('searchApi');
+      expect(createClientName('search', 'javascript')).toEqual('search');
       expect(createClientName('search-client', 'javascript')).toEqual(
-        'searchClientApi'
+        'searchClient'
       );
       expect(createClientName('search-cli!nt-complex', 'javascript')).toEqual(
-        'searchCli!ntComplexApi'
+        'searchCli!ntComplex'
       );
     });
 
     it('capitalize every part for other languages', () => {
-      expect(createClientName('search', 'java')).toEqual('SearchApi');
-      expect(createClientName('search-client', 'java')).toEqual(
-        'SearchClientApi'
-      );
+      expect(createClientName('search', 'java')).toEqual('Search');
+      expect(createClientName('search-client', 'java')).toEqual('SearchClient');
       expect(createClientName('search-cli!nt-complex', 'java')).toEqual(
-        'SearchCli!ntComplexApi'
+        'SearchCli!ntComplex'
       );
     });
   });

scripts/cts/utils.ts

@@ -30,8 +30,9 @@ export function createClientName(client: string, language: string): string {
     })
     .join('');
 
-  return `${clientName}Api`;
+  return clientName;
 }
+
 export async function createOutputDir({
   language,
   testPath,

specs/common/paths/customRequest.yml

@@ -24,10 +24,4 @@ put:
 
 delete:
   operationId: del
-  requestBody:
-    description: The parameters to send with the custom request.
-    content:
-      application/json:
-        schema:
-          type: object
   $ref: '../schemas/CustomRequest.yml#/customRequest'

tests/CTS/methods/requests/common/del.json

@@ -0,0 +1,30 @@
+[
+  {
+    "method": "del",
+    "testName": "allow del method for a custom path with minimal parameters",
+    "parameters": {
+      "path": "/test/minimal"
+    },
+    "request": {
+      "path": "/1/test/minimal",
+      "method": "DELETE"
+    }
+  },
+  {
+    "method": "del",
+    "testName": "allow del method for a custom path with all parameters",
+    "parameters": {
+      "path": "/test/all",
+      "parameters": {
+        "query": "parameters"
+      }
+    },
+    "request": {
+      "path": "/1/test/all",
+      "method": "DELETE",
+      "searchParams": {
+        "query": "parameters"
+      }
+    }
+  }
+]

tests/CTS/methods/requests/common/get.json

@@ -0,0 +1,30 @@
+[
+  {
+    "method": "get",
+    "testName": "allow get method for a custom path with minimal parameters",
+    "parameters": {
+      "path": "/test/minimal"
+    },
+    "request": {
+      "path": "/1/test/minimal",
+      "method": "GET"
+    }
+  },
+  {
+    "method": "get",
+    "testName": "allow get method for a custom path with all parameters",
+    "parameters": {
+      "path": "/test/all",
+      "parameters": {
+        "query": "parameters"
+      }
+    },
+    "request": {
+      "path": "/1/test/all",
+      "method": "GET",
+      "searchParams": {
+        "query": "parameters"
+      }
+    }
+  }
+]

tests/CTS/methods/requests/common/post.json

@@ -0,0 +1,36 @@
+[
+  {
+    "method": "post",
+    "testName": "allow post method for a custom path with minimal parameters",
+    "parameters": {
+      "path": "/test/minimal"
+    },
+    "request": {
+      "path": "/1/test/minimal",
+      "method": "POST"
+    }
+  },
+  {
+    "method": "post",
+    "testName": "allow post method for a custom path with all parameters",
+    "parameters": {
+      "path": "/test/all",
+      "parameters": {
+        "query": "parameters"
+      },
+      "body": {
+        "body": "parameters"
+      }
+    },
+    "request": {
+      "path": "/1/test/all",
+      "method": "POST",
+      "data": {
+        "body": "parameters"
+      },
+      "searchParams": {
+        "query": "parameters"
+      }
+    }
+  }
+]

tests/CTS/methods/requests/common/put.json

@@ -0,0 +1,36 @@
+[
+  {
+    "method": "put",
+    "testName": "allow put method for a custom path with minimal parameters",
+    "parameters": {
+      "path": "/test/minimal"
+    },
+    "request": {
+      "path": "/1/test/minimal",
+      "method": "PUT"
+    }
+  },
+  {
+    "method": "put",
+    "testName": "allow put method for a custom path with all parameters",
+    "parameters": {
+      "path": "/test/all",
+      "parameters": {
+        "query": "parameters"
+      },
+      "body": {
+        "body": "parameters"
+      }
+    },
+    "request": {
+      "path": "/1/test/all",
+      "method": "PUT",
+      "data": {
+        "body": "parameters"
+      },
+      "searchParams": {
+        "query": "parameters"
+      }
+    }
+  }
+]

tests/CTS/methods/requests/templates/java/requests.mustache

@@ -50,8 +50,8 @@ class {{client}}Tests {
 
         {{#request.searchParams}}
         HashMap<String, String> expectedQuery = JSON.deserialize("{{#lambda.escapequotes}}{{{request.searchParams}}}{{/lambda.escapequotes}}", new TypeToken<HashMap<String, String>>() {}.getType());
-        List<Pair> acutalQuery = req.getQueryParams();
-        for (Pair p : acutalQuery) {
+        List<Pair> actualQuery = req.getQueryParams();
+        for (Pair p : actualQuery) {
             assertEquals(expectedQuery.get(p.getName()), p.getValue());
         }
         {{/request.searchParams}}