lots of thing

Author: millotp

package.json

@@ -11,7 +11,7 @@
     "build:specs": "./scripts/builds/specs.sh ${0:-all} ${1:-yaml}",
     "build": "yarn build:specs && yarn build:clients",
     "clean": "rm -rf **/dist **/build **/node_modules",
-    "cts:generate": "yarn workspace tests start",
+    "cts:generate": "yarn workspace tests build && ./scripts/multiplexer.sh yarn workspace tests generate ${0:-all} ${1:-all} && yarn workspace tests lint:fix",
     "cts:test": "yarn workspace tests test",
     "docker:build": "./scripts/docker/build.sh",
     "docker:clean": "docker stop dev; docker rm -f dev; docker image rm -f api-clients-automation",
@@ -36,13 +36,13 @@
     "eslint-plugin-algolia": "2.0.0",
     "eslint-plugin-eslint-comments": "3.2.0",
     "eslint-plugin-import": "2.25.4",
-    "eslint-plugin-jsdoc": "37.5.1",
+    "eslint-plugin-jsdoc": "37.6.1",
     "eslint-plugin-prettier": "4.0.0",
     "eslint-plugin-unused-imports": "2.0.0",
     "eslint-plugin-yml": "0.12.0",
     "json": "11.0.0",
     "prettier": "2.5.1",
-    "prettier-plugin-java": "1.6.0",
+    "prettier-plugin-java": "1.6.1",
     "swagger-cli": "4.0.4",
     "typescript": "4.5.4"
   },

playground/javascript/package.json

@@ -23,7 +23,7 @@
     "@algolia/client-query-suggestions": "5.0.0",
     "@algolia/client-search": "5.0.0",
     "@algolia/recommend": "5.0.0",
-    "dotenv": "10.0.0",
+    "dotenv": "11.0.0",
     "typescript": "4.5.4"
   },
   "engines": {

scripts/multiplexer.sh

@@ -15,9 +15,9 @@ DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" >/dev/null && pwd)"
 # Move to the root (easier to locate other scripts)
 cd ${DIR}/..
 
-CMD=$1
-LANGUAGE=$2
-CLIENT=$3
+CMD=${@:1:$#-2}
+LANGUAGE=${@: -2:1}
+CLIENT=${@: -1}
 
 if [[ $CMD == "./scripts/playground.sh" ]] && ([[ $LANGUAGE == "all" ]] || [[ $CLIENT == "all" ]]); then
     echo "You cannot use 'all' when running the playground, please specify the language and client"

tests/CTS/clients/abtesting/addABTests.json renamed to tests/CTS/clients/abtesting/requests/addABTests.json

@@ -8,8 +8,6 @@ import type { OpenAPIV3 } from 'openapi-types';
 
 import openapitools from '../openapitools.json';
 
-const availableLanguages = ['javascript'] as const;
-type Language = typeof availableLanguages[number];
 type ParametersWithDataType = {
   key: string;
   value: string;
@@ -40,22 +38,22 @@ type CTSBlock = {
   tests: Tests[];
 };
 
-// Array of test per client
-type CTS = Record<string, CTSBlock[]>;
-
-const extensionForLanguage: Record<Language, string> = {
-  javascript: '.test.ts',
+type CTS = {
+  requests: CTSBlock[];
 };
 
-const cts: CTS = {};
+const extensionForLanguage: Record<string, string> = {
+  javascript: 'test.ts',
+  java: 'java',
+};
 
 // For each generator, we map the packageName with the language and client
-const packageNames: Record<string, Record<Language, string>> = Object.entries(
+const packageNames: Record<string, Record<string, string>> = Object.entries(
   openapitools['generator-cli'].generators
 ).reduce((prev, [clientName, clientConfig]) => {
   const obj = prev;
   const parts = clientName.split('-');
-  const lang = parts[0] as Language;
+  const lang = parts[0];
   const client = parts.slice(1).join('-');
 
   if (!(lang in prev)) {
@@ -67,8 +65,9 @@ const packageNames: Record<string, Record<Language, string>> = Object.entries(
   return obj;
 }, {} as Record<string, Record<string, string>>);
 
-async function createOutputDir(language: Language): Promise<void> {
+async function createOutputDir(language: string): Promise<void> {
   await fsp.mkdir(`output/${language}`, { recursive: true });
+  await fsp.mkdir(`output/${language}/tests`, { recursive: true });
 }
 
 async function* walk(
@@ -103,7 +102,7 @@ function removeObjectName(obj: Record<string, any>): void {
   }
 }
 
-async function loadCTSForClient(client: string): Promise<CTSBlock[]> {
+async function loadRequestsCTS(client: string): Promise<CTSBlock[]> {
   // load the list of operations from the spec
   const spec = await SwaggerParser.validate(`../specs/${client}/spec.yml`);
   if (!spec.paths) {
@@ -116,7 +115,7 @@ async function loadCTSForClient(client: string): Promise<CTSBlock[]> {
 
   const ctsClient: CTSBlock[] = [];
 
-  for await (const file of walk(`./CTS/clients/${client}`)) {
+  for await (const file of walk(`./CTS/clients/${client}/requests`)) {
     if (!file.name.endsWith('json')) {
       continue;
     }
@@ -181,10 +180,6 @@ async function loadCTSForClient(client: string): Promise<CTSBlock[]> {
         }
       );
 
-      if (fileName === 'getDictionarySettings') {
-        console.log(test.parameters, test.parametersWithDataType);
-      }
-
       test.parameters = JSON.stringify(test.parameters);
       test.hasParameters = true;
     }
@@ -200,45 +195,56 @@ async function loadCTSForClient(client: string): Promise<CTSBlock[]> {
   );
 }
 
-async function loadCTS(): Promise<void> {
-  for await (const { name: client } of await fsp.opendir('./CTS/clients/')) {
-    cts[client] = await loadCTSForClient(client);
-  }
+async function loadCTS(client: string): Promise<CTS> {
+  return {
+    requests: await loadRequestsCTS(client),
+  };
 }
 
-async function loadTemplate(language: Language): Promise<string> {
-  return (await fsp.readFile(`CTS/templates/${language}.mustache`)).toString();
+async function loadRequestsTemplate(language: string): Promise<string> {
+  return (
+    await fsp.readFile(`CTS/templates/${language}/requests.mustache`)
+  ).toString();
+}
+
+async function generateRequestsTests(
+  cts: CTSBlock[],
+  template: string,
+  language: string,
+  client: string
+): Promise<void> {
+  if (cts.length === 0) {
+    return;
+  }
+
+  const code = Mustache.render(template, {
+    import: packageNames[language][client],
+    client: createClientName(client),
+    blocks: cts,
+    hasRegionalHost: [
+      'personalization',
+      'analytics',
+      'abtesting',
+      'query-suggestions',
+    ].includes(client),
+  });
+  await fsp.writeFile(
+    `output/${language}/tests/${client}Requests.${extensionForLanguage[language]}`,
+    code
+  );
 }
 
-async function generateCode(language: Language): Promise<void> {
-  const template = await loadTemplate(language);
+async function generateTests(language: string, client: string): Promise<void> {
+  const template = await loadRequestsTemplate(language);
+  const cts = await loadCTS(client);
+
   await createOutputDir(language);
-  for (const client in cts) {
-    if (cts[client].length === 0) {
-      continue;
-    }
 
-    const code = Mustache.render(template, {
-      import: packageNames[language][client],
-      client: createClientName(client),
-      blocks: cts[client],
-      hasRegionalHost: [
-        'personalization',
-        'analytics',
-        'abtesting',
-        'query-suggestions',
-      ].includes(client),
-    });
-    await fsp.writeFile(
-      `output/${language}/${client}${extensionForLanguage[language]}`,
-      code
-    );
-  }
+  await generateRequestsTests(cts.requests, template, language, client);
 }
 
 function printUsage(): void {
-  console.log(`usage: generateCTS all | language1 language2...`);
-  console.log(`\tavailable languages: ${availableLanguages.join(',')}`);
+  console.log(`usage: generateCTS language client`);
   // eslint-disable-next-line no-process-exit
   process.exit(1);
 }
@@ -249,26 +255,24 @@ async function parseCLI(args: string[]): Promise<void> {
     printUsage();
   }
 
-  let toGenerate: Language[];
-  if (args.length === 3 && args[2] === 'all') {
-    toGenerate = [...availableLanguages];
-  } else {
-    const languages = args[2].split(' ') as Language[];
-    const unknownLanguages = languages.filter(
-      (lang) => !availableLanguages.includes(lang)
-    );
-    if (unknownLanguages.length > 0) {
-      console.log('unkown language(s): ', unknownLanguages.join(', '));
-      printUsage();
-    }
-    toGenerate = languages;
+  const lang = args[2];
+  const client = args[3];
+
+  if (!(lang in packageNames)) {
+    console.log('Unknown language', lang);
+    // eslint-disable-next-line no-process-exit
+    process.exit(1);
+  }
+  if (!(client in packageNames[lang])) {
+    console.log('Unknown client', client);
+    // eslint-disable-next-line no-process-exit
+    process.exit(1);
   }
 
+  console.log(`Generating CTS for ${lang} and ${client}`);
+
   try {
-    await loadCTS();
-    for (const lang of toGenerate) {
-      generateCode(lang);
-    }
+    await generateTests(args[2], args[3]);
   } catch (e) {
     if (e instanceof Error) {
       console.error(e);

tests/CTS/clients/abtesting/deleteABTest.json renamed to tests/CTS/clients/abtesting/requests/deleteABTest.json

@@ -0,0 +1,31 @@
+{
+  "name": "javascript-tests",
+  "version": "1.0.0",
+  "scripts": {
+    "lint:fix": "yarn eslint --ext=ts tests --fix",
+    "test": "jest"
+  },
+  "dependencies": {
+    "@algolia/client-abtesting": "5.0.0",
+    "@algolia/client-analytics": "5.0.0",
+    "@algolia/client-insights": "5.0.0",
+    "@algolia/client-personalization": "5.0.0",
+    "@algolia/client-query-suggestions": "5.0.0",
+    "@algolia/client-search": "5.0.0",
+    "@algolia/recommend": "5.0.0"
+  },
+  "devDependencies": {
+    "@apidevtools/swagger-parser": "10.0.3",
+    "@types/jest": "27.0.3",
+    "@types/mustache": "4.1.2",
+    "@types/node": "16.11.11",
+    "dotenv": "11.0.0",
+    "eslint": "8.6.0",
+    "jest": "27.4.7",
+    "mustache": "4.2.0",
+    "openapi-types": "10.0.0",
+    "prettier": "2.5.1",
+    "ts-jest": "27.1.2",
+    "typescript": "4.5.4"
+  }
+}

tests/CTS/clients/abtesting/getABTest.json renamed to tests/CTS/clients/abtesting/requests/getABTest.json

@@ -0,0 +1,35 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "noImplicitAny": false,
+    "suppressImplicitAnyIndexErrors": true,
+    "target": "ES6",
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "strict": true,
+    "moduleResolution": "node",
+    "removeComments": true,
+    "sourceMap": true,
+    "noLib": false,
+    "declaration": true,
+    "lib": [
+      "dom",
+      "es6",
+      "es5",
+      "dom.iterable",
+      "scripthost"
+    ],
+    "outDir": "dist",
+    "typeRoots": [
+      "../node_modules/@types"
+    ],
+    "types": [
+      "node",
+      "jest"
+    ],
+    "resolveJsonModule": true
+  },
+  "include": [
+    "tests"
+  ]
+}

tests/CTS/clients/abtesting/listABTests.json renamed to tests/CTS/clients/abtesting/requests/listABTests.json

@@ -1,33 +1,22 @@
 {
   "name": "tests",
   "version": "1.0.0",
+  "workspaces": [
+    "output/javascript"
+  ],
   "scripts": {
     "build": "tsc",
-    "lint:fix": "yarn eslint --ext=ts output --fix",
-    "test": "jest",
-    "start": "yarn build && node dist/tests/generateCTS.js ${0:-all} && yarn lint:fix"
-  },
-  "dependencies": {
-    "@algolia/client-abtesting": "5.0.0",
-    "@algolia/client-analytics": "5.0.0",
-    "@algolia/client-insights": "5.0.0",
-    "@algolia/client-personalization": "5.0.0",
-    "@algolia/client-query-suggestions": "5.0.0",
-    "@algolia/client-search": "5.0.0",
-    "@algolia/recommend": "5.0.0"
+    "lint:fix": "yarn workspace javascript-tests lint:fix",
+    "generate": "node dist/tests/generateCTS.js ${0:-javascript} ${1:-search}",
+    "start": "yarn build && yarn generate ${0:-javascript} ${1:-search} && yarn lint:fix"
   },
   "devDependencies": {
     "@apidevtools/swagger-parser": "10.0.3",
-    "@types/jest": "27.0.3",
     "@types/mustache": "4.1.2",
     "@types/node": "16.11.11",
-    "dotenv": "10.0.0",
     "eslint": "8.6.0",
-    "jest": "27.4.5",
     "mustache": "4.2.0",
     "openapi-types": "10.0.0",
-    "prettier": "2.5.1",
-    "ts-jest": "27.1.2",
     "typescript": "4.5.4"
   }
 }