Output generateOutput.json

Author: leniatgh

.vscode/launch.json

@@ -46,7 +46,7 @@
       "cwd": "${workspaceFolder}/generator",
       "args": [
         "${workspaceFolder}/generator/cmd/generateall.ts",
-        "{\"localPath\":\"/home/me/workspace/azure-rest-api-specs\",\"readmeFiles\":[\"specification/signalr/resource-manager/readme.md\",\"specification/appplatform/resource-manager/readme.md\"]}"
+        "{\"localPath\":\"/home/me/workspace/azure-rest-api-specs\",\"readmeFiles\":[\"specification/signalr/resource-manager/readme.md\",\"specification/appplatform/resource-manager/readme.md\"],\"outputPath\":\"../generateOutput.json\"}"
       ]
     }
   ],

generator/cmd/generateall.ts

@@ -1,16 +1,18 @@
 import * as constants from '../constants';
-import { cloneAndGenerateBasePaths, resolveLocalPath, validateAndReturnReadmePath } from '../specs';
+import { cloneAndGenerateBasePaths, getPackageString, resolveAbsolutePath, validateAndReturnReadmePath } from '../specs';
 import { SchemaConfiguration, generateSchemas, clearAutogeneratedSchemaRefs, saveAutogeneratedSchemaRefs } from '../generate';
 import { getAutogenlist } from '../autogenlist';
 import chalk from 'chalk';
 import { flatten } from 'lodash';
-import { executeSynchronous, chunker } from '../utils';
+import { executeSynchronous, chunker, writeJsonFile } from '../utils';
+import { Package } from '../models';
 
 interface GenerateAllParams {
     batchCount?: number,
     batchIndex?: number,
     localPath?: string,
     readmeFiles?: string[],
+    outputPath?: string,
 }
 
 function parseParams(): GenerateAllParams {
@@ -34,36 +36,55 @@ executeSynchronous(async () => {
         localPath = constants.specsRepoPath;
         await cloneAndGenerateBasePaths(localPath, constants.specsRepoUri, constants.specsRepoCommitHash);
     } else {
-        localPath = await resolveLocalPath(localPath);
+        localPath = await resolveAbsolutePath(localPath);
     }
 
     if (!!params.readmeFiles) {
-        filteredAutogenlist = filteredAutogenlist.filter(c =>
-            !!(params.readmeFiles?.find(f => f.startsWith('specification/' + c.basePath)))
+        filteredAutogenlist = filteredAutogenlist.filter(c => {
+            let r = params.readmeFiles?.find(f => f.startsWith('specification/' + c.basePath));
+            if (!!r) {
+                c.readmeFile = r;
+                return true;
+            }
+            return false;
+        }
         );
     }
 
     await clearAutogeneratedSchemaRefs(filteredAutogenlist);
 
     const schemaConfigs: SchemaConfiguration[] = [];
     const errors = [];
+    const packages: Package[] = [];
     for (const autogenlistConfig of filteredAutogenlist) {
+        let pkg = {} as Package;
         try {
-            const readme = await validateAndReturnReadmePath(localPath, autogenlistConfig.basePath);
+            const readme = await validateAndReturnReadmePath(localPath, autogenlistConfig.readmeFile || autogenlistConfig.basePath);
+            pkg.packageName = getPackageString(readme);
 
             const newConfigs = await generateSchemas(readme, autogenlistConfig);
             schemaConfigs.push(...newConfigs);
+            pkg.result = 'succeeded';
         } catch(error) {
+            pkg.packageName = autogenlistConfig.basePath;
+            pkg.result = 'failed';
             console.log(chalk.red(`Caught exception processing autogenlist entry ${autogenlistConfig.basePath}.`));
             console.log(chalk.red(error));
 
             errors.push(error);
         }
+        packages.push(pkg);
     }
 
     await saveAutogeneratedSchemaRefs(flatten(schemaConfigs));
 
-    if (errors.length > 0) {
-        throw new Error(`Autogeneration failed with ${errors.length} errors. See logs for detailed information.`);
+    if (!!params.outputPath) {
+        const outputPath = await resolveAbsolutePath(params.outputPath);
+        await writeJsonFile(outputPath, { packages });
+    } else {
+        if (errors.length > 0) {
+            throw new Error(`Autogeneration failed with ${errors.length} errors. See logs for detailed information.`);
+        }
     }
+
 });

generator/cmd/generatesingle.ts

@@ -1,5 +1,5 @@
 import * as constants from '../constants';
-import { cloneAndGenerateBasePaths, resolveLocalPath, validateAndReturnReadmePath } from '../specs';
+import { cloneAndGenerateBasePaths, resolveAbsolutePath, validateAndReturnReadmePath, getPackageString } from '../specs';
 import { generateSchemas, saveAutogeneratedSchemaRefs } from '../generate';
 import process from 'process';
 import { findAutogenEntries } from '../autogenlist';
@@ -13,7 +13,7 @@ executeSynchronous(async () => {
         localPath = constants.specsRepoPath;
         await cloneAndGenerateBasePaths(localPath, constants.specsRepoUri, constants.specsRepoCommitHash);
     } else {
-        localPath = await resolveLocalPath(localPath);
+        localPath = await resolveAbsolutePath(localPath);
     }
 
     let readme = '';

generator/models.ts

@@ -11,6 +11,7 @@ export enum ScopeType {
 export interface AutogenlistConfig {
   basePath: string,
   namespace: string,
+  readmeFile?: string,
   suffix?: string,
   resourceConfig?: AutogenlistResourceConfig[],
   postProcessor?: SchemaPostProcessor,
@@ -23,4 +24,9 @@ export interface AutogenlistResourceConfig {
 
 export interface SchemaPostProcessor {
   (namespace: string, apiVersion: string, schema: any): void,
+}
+
+export interface Package {
+  packageName?: string,
+  result: 'succeeded' | 'failed' | 'warning'
 }

generator/specs.ts

@@ -7,21 +7,20 @@ import * as constants from './constants'
 
 const exists = promisify(fs.exists);
 
-export async function resolveLocalPath(localPath: string) {
+export async function resolveAbsolutePath(localPath: string) {
     if (path.isAbsolute(localPath)) {
         return path.resolve(localPath);
     }
     return path.resolve(constants.generatorRoot, localPath);
 }
 
-export async function resolveReadmePath(localPath: string, basePath: string) {
-    const readmePath = path.join(localPath, 'specification', basePath, 'readme.md');
-
-    return path.resolve(readmePath);
-}
-
 export async function validateAndReturnReadmePath(localPath: string, basePath: string) {
-    const readme = await resolveReadmePath(localPath, basePath);
+    let readme = '';
+    if (basePath.toLowerCase().endsWith('readme.md')) {
+        readme = path.resolve(localPath, basePath);
+    } else {
+        readme = path.resolve(localPath, 'specification', basePath, 'readme.md')
+    }
 
     if (!await exists(readme)) {
         throw new Error(`Unable to find readme '${readme}' in specs repo`);
@@ -58,6 +57,12 @@ export function getBasePathString(localPath: string, basePath: string) {
         .join('/');
 }
 
+export function getPackageString(readme: string) {
+    return readme
+        .split(path.sep)
+        .find((_, index, obj) => index > 0 && obj[index - 1] === 'specification');
+}
+
 function isBlocklisted(basePath: string) {
     return constants.blocklist.includes(basePath);
 }

swagger_to_sdk_config.json

@@ -12,6 +12,9 @@
       "path": ".sdkauto/generateScript.sh"
     }
   },
+  "packageOptions": {
+    "packageFolderFromFileSearch": false
+  },
   "advancedOptions": {
     "closeIntegrationPR": false,
     "draftIntegrationPR": false,