Merge branch 'master' into mitryakh/08-01

Author: MikhailTryakhov

.github/workflows/autogenerateBatch0.yml

@@ -0,0 +1,68 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Autogenerate (Batch 0)
+
+on:
+  push:
+    branches: [ autogenerate ]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+        
+      - name: Configure Git
+        run: |
+          git config user.name "Autogenerator Pipeline"
+          git config user.email "azure-resource-manager-schemas@noreply.github.com"
+
+      - name: Integrate main branch
+        run: |
+          git checkout autogenerate
+          git pull
+          git merge --no-commit --no-ff --strategy-option=theirs origin/master --allow-unrelated-histories
+          if ! git diff-index --quiet HEAD --; then
+            git commit -m "Merge remote-tracking branch 'origin/master' into autogenerate"
+            git push origin autogenerate
+          fi
+          
+      - name: Setup Node.js
+        uses: actions/setup-node@v2.1.2
+        with:
+          node-version: 10.x
+          
+      - name: Install packages
+        run: npm install
+        working-directory: ./generator
+              
+      - name: Generate Schemas
+        run: |
+          npm run generate-all '{"batchCount": 4, "batchIndex": 0}'
+        working-directory: ./generator
+        
+      - name: Commit autogenerated schemas
+        run: |
+          git add --all schemas
+          if ! git diff-index --quiet HEAD --; then
+            git commit -m "Autogenerate schemas"
+            git push origin autogenerate
+          fi
+      
+      - name: List resources
+        run: |
+          npm run list-resources resources.json
+      
+      - name: Commit resource list
+        run: |
+          git add generator/resources.json
+          if ! git diff-index --quiet HEAD --; then
+            git commit -m "Update resource list"
+            git push origin autogenerate
+          fi

.github/workflows/main.yml

@@ -0,0 +1,64 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [ master ]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2.1.2
+        with:
+          node-version: 10.x
+      
+      - name: GitHub context (actor and head ref)
+        run: |          
+          echo ${{ github.actor }}
+          echo ${{ github.head_ref }}
+
+      - name: Install NPM modules
+        run: npm ci
+        working-directory: ./tools
+
+      - name: Run CI tests
+        run: npm test
+        working-directory: ./tools
+
+  automerge:
+    runs-on: ubuntu-latest
+    needs: build
+    env:
+      PR_PREFIX: sdkAuto/
+    if: ${{ github.event.pull_request.user.login == 'openapi-sdkautomation[bot]' }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2.1.2
+        with:
+          node-version: 10.x
+
+      - name: Install NPM modules
+        run: npm ci
+        working-directory: ./generator
+
+      - name: Check RP in Autogenlist
+        run: |
+          check_result='';
+          exec=$(npm run find-basepath ${{ github.head_ref }} $PR_PREFIX); 
+          while read line; 
+          do
+            # overriding check_result until the last line is read, last line contains
+            # the result to whether or not the basepath was found in autogenlist.
+            check_result=$line; 
+            echo $check_result;
+          done <<< "$exec";
+          
+          if [ $check_result == 'false' ] ; then
+            exit 1
+          fi
+        working-directory: ./generator

.gitignore

@@ -1,4 +1,7 @@
 .vs
-.vscode
 js-coverage
-node_modules
+npm-debug.log
+node_modules
+.DS_Store
+test-results.xml
+schemas/code-model-v1

.vscode/launch.json

@@ -0,0 +1,48 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "List basepaths",
+      "runtimeArgs": ["-r", "ts-node/register"],
+      "cwd": "${workspaceFolder}/generator",
+      "args": ["${workspaceFolder}/generator/cmd/listbasepaths.ts"]
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "List resources",
+      "runtimeArgs": ["-r", "ts-node/register"],
+      "cwd": "${workspaceFolder}/generator",
+      "args": ["${workspaceFolder}/generator/cmd/listresources.ts"]
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Generate single",
+      "runtimeArgs": ["-r", "ts-node/register"],
+      "cwd": "${workspaceFolder}/generator",
+      "args": [
+        "${workspaceFolder}/generator/cmd/generatesingle.ts",
+        "${input:resourceProvider}/resource-manager"
+      ]
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Generate all",
+      "runtimeArgs": ["-r", "ts-node/register"],
+      "cwd": "${workspaceFolder}/generator",
+      "args": ["${workspaceFolder}/generator/cmd/generateall.ts"]
+    }
+  ],
+  "inputs": [
+    {
+      "id": "resourceProvider",
+      "type": "promptString",
+      "default": "alertsmanagement",
+      "description": "The ResourceProvider name, e.g., compute, network"
+    }
+  ]
+}

CredScanSuppressions.json

@@ -0,0 +1,33 @@
+{
+  "tool": "Credential Scanner",
+  "suppressions": [
+    {
+      "hash": "/d5snlRGcdND41zmqGMEShzulA381IT1cTRpPVIzMi0=",
+      "_justification": "Secret used as a sample in test library"
+    },
+    {
+      "hash": "Dbm7cwbNwfW2wfoczuNvILGE4JN6/Qyd7R0PC0LFY0Q=",
+      "_justification": "Secret used as a sample in test library"
+    },
+    {
+      "hash": "DqnzqSuPoql8CRa0NwVQjvMWVEdB/1JVZhMLf5a7caw=",
+      "_justification": "Secret used as a sample in test library"
+    },
+    {
+      "hash": "JiUVlQAt6apvitt6Uy0wYdalRKzj85fDWT8qFpFgpoY=",
+      "_justification": "Secret used as a sample in test library"
+    },
+    {
+      "hash": "LJ2GmegghFcVzhg0rCOmNVxBzYbBxEsP1MrhtJ6hiT8=",
+      "_justification": "Secret used as a sample in test library"
+    },
+    {
+      "hash": "aFrn+1gsLqL40HnUNj5Rl+ZYnxDXify72bGdAf3Xexk=",
+      "_justification": "Secret used as a sample in test library"
+    },
+    {
+      "hash": "nmsaWxY/4tYovFLEYR36oWY7xh6lInTNbrh+YvIWT+g=",
+      "_justification": "Secret used as a sample in test library"
+    }
+  ]
+}

README.md

@@ -1,27 +1,81 @@
 # azure-resource-manager-schemas 
 
-This is the repo for template deployment schemas hosted at https://schema.management.azure.com/.
-
-Welcome to contribute to template deployment schemas, please send pull request to improve the schemas. We will review the pull request and publish the latest schemas to https://schema.management.azure.com/schemas
-
-## Hints:
-* When you add a new resource type in schema, please add it into [schemas\2014-04-01-preview\deploymentTemplate.json](schemas/2014-04-01-preview/deploymentTemplate.json), [schemas\2015-01-01\deploymentTemplate.json](schemas/2015-01-01/deploymentTemplate.json) and [schemas\2019-04-01\deploymentTemplate.json](schemas/2019-04-01/deploymentTemplate.json).
-* Please add or update [tests](tests/) for your change.
-* Please test your change with following two node.js scripts:
-  1. [tools\validateJSON.js](tools/validateJSON.js) and [ResourceMetaSchema.json](tools/ResourceMetaSchema.json):  
-The script uses the ResourceMetaSchema.json to do some basic checks against the new/updated schema file.  
-**Usage:**   
-Node validateJSON.js \<schema file path\> ResourceMetaSchema.json \<schema folder path\>  
-**Sample:**  
-Node validateJSON.js ..\schemas\2015-08-01\Microsoft.Compute.json ResourceMetaSchema.json ..\schemas\
-  2. [tools\runSchemaTests.js](tools/runSchemaTests.js)  
-The script uses all test JSON files under [tests](tests/) folder to test against the schema files.  
-**Usage:**   
-Node runSchemaTests.js [--dir _folder_] [--AssertSubErrors]  
-&nbsp;&nbsp;&nbsp;&nbsp;***To run tests in single folder:***  
-&nbsp;&nbsp;&nbsp;&nbsp;Node runSchemaTests.js --dir ..\tests\2018-08-01  
-&nbsp;&nbsp;&nbsp;&nbsp;***To run tests in single folder and assert subErrors:***  
-&nbsp;&nbsp;&nbsp;&nbsp;Node runSchemaTests.js --dir ..\tests\2018-08-01 --AssertSubErrors  
+This is the repo for template deployment schemas hosted under `https://schema.management.azure.com/schemas`. Please see below for information on contributing and publishing updated schemas.
+
+## Updating Schemas
+There are two processes for updating schemas:
+1. **Daily autogeneration**: Schemas are automatically generated from definitions in the [azure-rest-api-specs](https://github.com/Azure/azure-rest-api-specs) repo. This requires [onboarding](/generator/README.md#onboarding-teams-to-autogeneration-pipeline) on a per-provider basis.
+2. **Manually**: Schemas are manually authored and committed via PR.
+
+### Has my team been onboarded for daily autogeneration?
+Please see [generator/autogenlist.ts](/generator/autogenlist.ts) for the list of teams which have been onboarded. `basePath` refers to the path in the [azure-rest-api-specs](https://github.com/Azure/azure-rest-api-specs) repo, and `namespace` is the Resource Provider namespace.
+
+**If your team has been onboarded, we do not require any manual contributions to this repo and your schemas will automatically be kept up to date by the pipeline.**
+
+## Authoring Schemas and submitting a PR
+**Please ensure you have read [Updating Schemas](#updating-schemas) before continuing with this step, and only continue if this applies to your team.**
+
+### Authoring
+You can use the generator in this repo to automatically generate a schema from a swagger spec checked into the [azure-rest-api-specs](https://github.com/Azure/azure-rest-api-specs) repo.
+
+#### Generating locally
+1. Fork this repo, and clone it locally.
+2. Run the following commands (replace the base path accordingly - valid paths can be disovered with `npm run list-basepaths`):
+```bash
+cd generator
+npm install
+npm run generate-single myprovider/resource-manager
+```
+4. Review the generator logs to ensure no errors, and review the changes generated.
+5. Ensure that you have reviewed the guidelines under [Submitting a PR](#submitting-a-pr).
+6. Generate a commit and push it to your fork.
+7. Submit a pull request to this repo. Please include the full command output in a PR comment.
+
+Alternatively, you can hand-author your schema, but **please note** that this process is error-prone, and ARM will not be responsible for reviewing for accuracy when validating your PR.
+
+### Submitting a PR
+* Ensure that any $refs to resource types that you are adding has been added to the following top-level template schema: [schemas/2019-04-01/deploymentTemplate.json](/schemas/2019-04-01/deploymentTemplate.json)
+* If your schema has been manually generated, please ensure you include appropriate tests in [tests](/tests/)
+* If adding a new resource type, please add examples to the templates in [tools/templateTests](/tools/templateTests/)
+* Ensure that the test suite passes (see [Tests](#tests))
+
+> **NOTE**: We will no longer be taking any updates to the [2015-01-01](/schemas/2015-01-01/deploymentTemplate.json) or [2014-04-01-preview](/schemas/2014-04-01-preview/deploymentTemplate.json) root schemas. If you are authoring a template which references one of these schemas, please upgrade it to use the [2019-04-01](/schemas/2019-04-01/deploymentTemplate.json) root schema by setting the `$schema` property to `https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#"`.
+
+### Runing Unit Tests
+Use the following commands to execute the test suite locally:
+```bash
+cd tools
+npm install
+npm test
+```
+
+## Manual testing with a local schema server
+This repo contains a command to run a schema web server which will host files directly from your local repo. This can be useful if you want to validate schemas against a particular tool - for example if you want to verify VSCode autocompletion and syntax highlighting. By default this will listen on port 3000, but this can be modified by editing [tools/server.ts](/tools/server.ts).
+To start an instance you can use the following commands:
+```bash
+cd tools
+npm install
+npm run serve
+```
+
+Once this is running, you can create a basic template with the following structure (replacing the sections between `<` and `>` as appropriate for your scenario):
+```json
+{
+  "$schema": "http://<hostname>:<port>/schemas/2019-04-01/deploymentTemplate.json",
+  "resources": [
+    {
+      "type": "<providerNamespace>/<resourceType>",
+      "apiVersion": "<apiVersion>",
+      "properties": {
+      }
+    }
+  ]
+}
+```
+**NOTE** Many client tools will cache responses from schema servers, so you may need to clear this cache if you are testing modifications, or alternatively, change the port between retries.
+
+## RP Schemas Repo Issues Bot Notifications
+To get quickly notified on GitHub issues for your RP's schema, please update the [rp-label-to-contact.md](/rp-label-to-contact.md) by submitting a PR with the desired GitHub handle(s) and label for your RP.
 
 ---
-This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.