Merge pull request #3064 from Azure/ant/restore_resource

Bring back resources.json

Author: anthony-c-martin

.github/workflows/generate-schemas.yml

@@ -114,6 +114,11 @@ jobs:
             --batch-count ${{ env.BATCH_COUNT }}
         working-directory: generator
 
+      - name: Update resources.json
+        run: |
+          npm run list-resources
+        working-directory: generator
+
       - name: Push to autogenerate-batch branch
         uses: stefanzweifel/git-auto-commit-action@v5
         with:

.github/workflows/generate-single.yml

@@ -59,6 +59,11 @@ jobs:
             --base-path '${{ github.event.inputs.single_path }}'
         working-directory: generator
 
+      - name: Update resources.json
+        run: |
+          npm run list-resources
+        working-directory: generator
+
       - name: Push to git branch
         uses: stefanzweifel/git-auto-commit-action@v5
         with:

generator/cmd/listresources.ts

@@ -0,0 +1,113 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+import path from 'path';
+import { writeFile } from 'fs/promises';
+import { resourcesJsonPath, schemasBasePath, schemasBaseUri, } from '../constants';
+import { lowerCaseCompare, executeSynchronous, readJsonFile, lowerCaseStartsWith } from '../utils';
+
+const rootSchemaPaths = [
+  'https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json',
+  'https://schema.management.azure.com/schemas/common/definitions.json',
+  'https://schema.management.azure.com/schemas/common/autogeneratedResources.json',
+  'https://schema.management.azure.com/schemas/common/manuallyAddedResources.json',
+  'https://schema.management.azure.com/schemas/2018-05-01/subscriptionDeploymentTemplate.json',
+  'https://schema.management.azure.com/schemas/2019-08-01/tenantDeploymentTemplate.json',
+  'https://schema.management.azure.com/schemas/2019-08-01/managementGroupDeploymentTemplate.json',
+];
+
+async function readSchema(schemaUri: string) {
+  if (!lowerCaseStartsWith(schemaUri, `${schemasBaseUri}/`)) {
+    throw new Error(`Invalid schema Uri ${schemaUri}`);
+  }
+
+  const filePath = path.join(schemasBasePath, schemaUri.substring(schemasBaseUri.length + 1));
+  return await readJsonFile(filePath);
+}
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function findAllReferences(input: any) {
+  let refs: string[] = [];
+
+  for (const key of Object.keys(input)) {
+    if (Array.isArray(input[key])) {
+      for (const value of input[key]) {
+        const foundRefs = findAllReferences(value);
+        refs = refs.concat(foundRefs);
+      }
+    } else if (typeof input[key] === 'object') {
+      const foundRefs = findAllReferences(input[key]);
+      refs = refs.concat(foundRefs);
+    } else if (key === '$ref' && typeof input[key] === 'string') {
+      refs.push(input[key]);
+    }
+  }
+
+  return refs;
+}
+
+async function getResourceInfo(schemaRef: string) {
+  const schemaUri = schemaRef.split('#')[0];
+  const relativeRef = schemaRef.split('#')[1].substring(1);
+
+  let schema = await readSchema(schemaUri);
+
+  for (const pathElement of relativeRef.split('/')) {
+    schema = schema[pathElement];
+  }
+
+  if (!schema?.properties?.type?.enum || !schema?.properties?.apiVersion?.enum) {
+    throw new Error(`Unable to find expected properties for ${schemaRef}`)
+  }
+
+  const resourceTypes: string[] = schema['properties']['type']['enum'];
+  const apiVersions: string[] = schema['properties']['apiVersion']['enum'];
+
+  return resourceTypes.map(type => apiVersions.map(apiVersion => ({
+    apiVersion,
+    type,
+  }))).reduce((a, b) => a.concat(b), []);
+}
+
+async function findAllResourceReferences() {
+  let allRefs: string[] = [];
+  for (const rootSchemaPath of rootSchemaPaths) {
+    const rootSchema = await readSchema(rootSchemaPath);
+    const schemaRefs = findAllReferences(rootSchema)
+      .filter(schema => schema.toLowerCase().startsWith(schemasBaseUri.toLowerCase() + '/'));
+
+    allRefs = allRefs.concat(schemaRefs);
+  }
+
+  for (const rootSchemaPath of rootSchemaPaths) {
+    allRefs = allRefs.filter(ref => lowerCaseCompare(ref.split('#')[0], rootSchemaPath) !== 0);
+  }
+
+  return [...new Set(allRefs)];
+}
+
+executeSynchronous(async () => {
+  const rootSchemaRefs = await findAllResourceReferences();
+
+  const allResources: { [type: string]: string[] } = {};
+  for (const ref of rootSchemaRefs) {
+    const resources = await getResourceInfo(ref);
+
+    for (const resource of resources) {
+      // Casing can vary, so do a case-insensitive lookup
+      let resourceKey = Object.keys(allResources).find(key => lowerCaseCompare(key, resource.type) === 0);
+      if (resourceKey === undefined) {
+        resourceKey = resource.type;
+        allResources[resourceKey] = [];
+      }
+
+      allResources[resourceKey].push(resource.apiVersion);
+    }
+  }
+
+  for (const resourceType of Object.keys(allResources)) {
+    allResources[resourceType].sort();
+  }
+
+  const sortedJsonOutput = JSON.stringify(allResources, Object.keys(allResources).sort(), 2);
+  await writeFile(resourcesJsonPath, sortedJsonOutput, { encoding: 'utf8' });
+});

generator/constants.ts

@@ -2,12 +2,13 @@
 // Licensed under the MIT License.
 import path from 'path';
 
-export const generatorRoot = path.resolve(__dirname, '../');
+export const repoRoot = path.resolve(__dirname, '../');
 
 export const autoRestVerboseOutput = false;
 
 export const schemasBaseUri = 'https://schema.management.azure.com/schemas';
-export const schemasBasePath = path.join(generatorRoot, 'schemas');
+export const schemasBasePath = path.join(repoRoot, 'schemas');
+export const resourcesJsonPath = path.join(repoRoot, 'generator/resources.json');
 export const resourceGroupRootSchema = {
     file: path.join(schemasBasePath, 'common/autogeneratedResources.json'),
     jsonPath: 'allOf[1].oneOf'

generator/package.json

@@ -10,6 +10,7 @@
   "scripts": {
     "build": "tsc -p .",
     "list-basepaths": "ts-node cmd/listbasepaths",
+    "list-resources": "ts-node cmd/listresources",
     "generate-all": "ts-node cmd/generateall",
     "find-basepath": "ts-node cmd/findbasepath",
     "generate-single": "ts-node cmd/generatesingle",