Merge pull request #539 from AmadeusITGroup/bugfix/cherry-pick-from-s…

…dk-create-yarn

fix(ama-sdk/create): enable create feature for yarn pnp

packages/@ama-sdk/create/README.md

@@ -25,5 +25,6 @@ yarn create @ama-sdk typescript <project-name> [...options]
 
 - `--spec-path`: Path to the swagger/open-api specification used to generate the SDK
 - `--package-manager`: Node package manager to be used (`npm` and `yarn` are available).
+- `--debug`: Enable schematics debug mode (including dry run).
 
 > **Note**: if the `--spec-path` is specified, the SDK will be generated based on this specification at the creation time.

packages/@ama-sdk/create/project.json

@@ -54,8 +54,7 @@
       "executor": "@nx/jest:jest",
       "options": {
         "jestConfig": "packages/@ama-sdk/create/testing/jest.config.it.js",
-        "silent": false,
-        "passWithNoTests": true
+        "silent": false
       }
     },
     "publish": {

packages/@ama-sdk/create/src/index.it.spec.ts

@@ -39,7 +39,7 @@ const sdkPackagePath = path.join(execAppOptions.cwd!.toString(), sdkPackageName.
  * Publish all the packages of the Otter monorepo on it.
  * Can be accessed during the tests with url http://localhost:4873
  */
-function setupLocalRegistry() {
+function setupLocalRegistryRules() {
   let shouldHandleVerdaccio = false;
 
   beforeAll(async () => {
@@ -79,6 +79,7 @@ function setupYarn(yarnVersion: string) {
 
     execSync('yarn config set enableStrictSsl false', execAppOptions);
     execSync(`yarn set version ${yarnVersion}`, execAppOptions);
+    execSync(`yarn config set cacheFolder ${cacheFolderPath}`, execAppOptions);
     execSync(`yarn config set npmScopes.ama-sdk.npmRegistryServer ${registry}`, execAppOptions);
     execSync(`yarn config set npmScopes.o3r.npmRegistryServer ${registry}`, execAppOptions);
     execSync('yarn config set unsafeHttpWhitelist localhost', execAppOptions);
@@ -89,10 +90,19 @@ function setupYarn(yarnVersion: string) {
     // copy npmrc config to generated SDK
     mkdirSync(sdkPackagePath, { recursive: true });
     cpSync(path.join(execAppOptions.cwd.toString(), '.yarnrc.yml'), path.join(sdkPackagePath, '.yarnrc.yml'));
+    cpSync(path.join(execAppOptions.cwd.toString(), '.yarn'), path.join(sdkPackagePath, '.yarn'), {recursive: true});
   });
 }
 
-function setupCache() {
+function setupPackageManagerRules() {
+  if (packageManager.startsWith('yarn')) {
+    setupYarn(o3rPackageJson?.packageManager?.split('@')?.[1] || '3.5.0');
+  } else {
+    setupNpm();
+  }
+}
+
+function setupCacheRules() {
   beforeEach(() => {
     try {
       rmSync(sdkFolderPath, { recursive: true, force: true });
@@ -117,24 +127,24 @@ function setupCache() {
   });
 }
 
-describe('new Otter sdk', () => {
-  setupLocalRegistry();
-  setupCache();
-  setupNpm();
-  if (packageManager.startsWith('yarn')) {
-    setupYarn(o3rPackageJson?.packageManager?.split('@')?.[1] || '3.5.0');
-  }
+describe('Create new sdk command', () => {
+  setupLocalRegistryRules();
+  setupCacheRules();
+  setupPackageManagerRules();
 
-  test('should build from full generation', () => {
+  beforeEach(() => {
     cpSync(path.join(__dirname, '..', 'testing', 'mocks', 'MOCK_swagger_updated.yaml'), path.join(sdkFolderPath, 'swagger-spec.yml'));
-    expect(() => execSync(`npm create @ama-sdk typescript ${sdkPackageName} -- --package-manager ${packageManager} --spec-path ./swagger-spec.yml`, execAppOptions)).not.toThrow();
+  });
+
+  test('should generate a full SDK when the specification is provided', () => {
+    // eslint-disable-next-line max-len
+    expect(() => execSync(`${packageManager} create @ama-sdk typescript ${sdkPackageName}${packageManager.startsWith('npm') ? ' --' : ''} --package-manager ${packageManager} --spec-path ./swagger-spec.yml`, execAppOptions)).not.toThrow();
     // TODO: uncomment when the generation is fixed for NPM
     // expect(() => execSync(`${packageManager} run build`, { ...execAppOptions, cwd: sdkPackagePath })).not.toThrow();
   });
 
-  test('should build after new generation', () => {
-    cpSync(path.join(__dirname, '..', 'testing', 'mocks', 'MOCK_swagger_updated.yaml'), path.join(sdkFolderPath, 'swagger-spec.yml'));
-    expect(() => execSync(`npm create @ama-sdk typescript ${sdkPackageName}`, execAppOptions)).not.toThrow();
+  test('should generate an empty SDK ready to be used', () => {
+    expect(() => execSync(`${packageManager} create @ama-sdk typescript ${sdkPackageName}`, execAppOptions)).not.toThrow();
     expect(() =>
       execSync(
         `${packageManager} exec schematics @ama-sdk/schematics:typescript-core --spec-path ${path.join(path.relative(sdkPackagePath, execAppOptions.cwd.toString()), 'swagger-spec.yml')}`,

packages/@ama-sdk/create/src/index.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 import { spawnSync } from 'node:child_process';
-import { join, resolve } from 'node:path';
+import { dirname, join, resolve } from 'node:path';
 import * as minimist from 'minimist';
 
 const defaultScope = 'sdk';
@@ -12,6 +12,7 @@ const argv = minimist(args);
 if (argv._.length < 2) {
   // eslint-disable-next-line no-console
   console.error('The SDK type and project name are mandatory');
+  console.info('usage: create typescript <@scope/package>');
   process.exit(-1);
 }
 
@@ -31,9 +32,10 @@ if (!pck) {
 }
 
 const targetDirectory = join('.', name, pck);
+const schematicsPackage = dirname(require.resolve('@ama-sdk/schematics/package.json'));
 const schematicsToRun = [
-  '@ama-sdk/schematics:typescript-shell',
-  ...(argv['spec-path'] ? ['@ama-sdk/schematics:typescript-core'] : [])
+  `${schematicsPackage}:typescript-shell`,
+  ...(argv['spec-path'] ? [`${schematicsPackage}:typescript-core`] : [])
 ];
 
 const packageManagerEnv = process.env.npm_config_user_agent?.split('/')[0];
@@ -46,9 +48,14 @@ const packageManager = argv['package-manager'] || defaultPackageManager;
 
 const run = () => {
   const schematicArgs = [
-    '--name', name, '--package', pck, '--package-manager', packageManager, '--directory', targetDirectory,
+    argv.debug !== undefined ? `--debug=${argv.debug as string}` : '--debug=false', // schematics enable debug mode per default when using schematics with relative path
+    '--name', name,
+    '--package', pck,
+    '--package-manager', packageManager,
+    '--directory', targetDirectory,
     ...(argv['spec-path'] ? ['--spec-path', argv['spec-path']] : [])
   ];
+
   const errors = schematicsToRun
     .map((schematic) => spawnSync(process.execPath, [binPath, schematic, ...schematicArgs], { stdio: 'inherit', cwd: process.cwd()}))
     .map(({error}) => error)

packages/@ama-sdk/schematics/project.json

@@ -73,7 +73,8 @@
       "executor": "@nx/jest:jest",
       "options": {
         "jestConfig": "packages/@ama-sdk/schematics/testing/jest.config.it.js",
-        "silent": false
+        "silent": false,
+        "passWithNoTests": true
       }
     },
     "prepare-publish": {