Updating my fork

.travis.yml

@@ -1,34 +1,37 @@
 language: node_js
 node_js:
-  - "8"
+  - '8'
 services:
   - docker
 env:
   matrix:
-  - MODE=syntax
-  - MODE=python
-  # - MODE=node
-  - MODE=ruby
-  - MODE=semantic PR_ONLY=true
-  # - MODE=linter PR_ONLY=false Disabling to save travis-ci resource for now
-  - MODE=semantic PR_ONLY=false
-  - MODE=model PR_ONLY=false
-  - MODE=linter PR_ONLY=true
-  - MODE=model PR_ONLY=true
-  - MODE=BreakingChange PR_ONLY=true
-  - MODE=azurebot PR_ONLY=true
-  global:
-    secure: n7Ptb5x7Zdq/7na2L68JlrRPbl/xWtiFQncO7fsrSVuVGI4Mhjj1LD2k07qWAdFPM1PaZYvCRWc3YwbXr1NTOOn485r6qcLUjpN9TICP0ErGcEA9SzctipfbFP1IV4aCh23WSaopMueBki52KfskaGcZ2ox9pvI2LCysCp7q4WwF/0vArLYf48FeZuscWHVaLsU4z8ZMFPT9yHg+RQoqPeBnaR/ZGtG96NZolT+VAlP445geb0qn8wWAuSl4bR1JQV2eA3MwdWu/iVkepBeKTN7d81l3yjWzTvFtP/JRJClWBNQbOMjAed3/2Tr2lGgyRUM6Uwp4KvfRmbX3Xrlggen1AO/YAb2mJDs+HARPnhZXIOtDjgft/ethVeLTTBUsbNFGUN2lcrJMw9dkFi+ai3XefatENJbULqWx8Xb+wMD1b0TrI6sZZpdC8vYHnM/DoqiEh5+h3okkSmQcjPF4K9js294G790PKf4u2CQdur41qh4Ze4IzbvulVsGMON+O93vA6ZRK1sTHC5VUTs2iMhCnf6LtMN59kBq1T2MJ8ndXRpGlFEn2wDTjJSpSr0k0sjoG5i+bIFhbqVF8xegBb/PH4H9/i1ifIypNNp0FGdz4o2cFsYrcUKFsx1C/kFJ6rC809r0odDt32hGSOkOCziTwFHusbR5Nwf0RjOWSgvc=
+    - MODE=syntax
+    - MODE=python
+    - MODE=node
+    - MODE=ruby
+    - MODE=java
+    - MODE=go
+    - MODE=semantic PR_ONLY=true
+    - MODE=semantic PR_ONLY=false
+    - MODE=model PR_ONLY=false
+    - MODE=linter PR_ONLY=true
+    - MODE=model PR_ONLY=true
+    - MODE=BreakingChange PR_ONLY=true
+    - MODE=azurebot PR_ONLY=true
+    - MODE=liveValidation PR_ONLY=true
 matrix:
   fast_finish: true
   allow_failures:
-    - env: MODE=linter PR_ONLY=false
     - env: MODE=semantic PR_ONLY=false
     - env: MODE=model PR_ONLY=false
     - env: MODE=linter PR_ONLY=true
     - env: MODE=model PR_ONLY=true
     - env: MODE=BreakingChange PR_ONLY=true
     - env: MODE=azurebot PR_ONLY=true
+    - env: MODE=liveValidation PR_ONLY=true
+    - env: MODE=java
+    - env: MODE=go
+    - env: MODE=node
 before_install:
   - docker pull lmazuel/swagger-to-sdk
   - python -c "import os; print('\n'.join(v for v in os.environ.keys() if v.startswith('TRAVIS')))" > /tmp/env_file
@@ -43,12 +46,51 @@ install:
   - npm install
 script:
   - DOCKER_CMD="docker run --rm --env-file /tmp/env_file -e GH_TOKEN -v $PWD:/git-restapi/ lmazuel/swagger-to-sdk"
-  - if [[ $MODE == 'python' ]]; then $DOCKER_CMD AutorestCI/azure-sdk-for-python --pr-repo-id Azure/azure-sdk-for-python -o master -v; fi
-  - if [[ $MODE == 'node' ]]; then $DOCKER_CMD AutorestCI/azure-sdk-for-node --pr-repo-id Azure/azure-sdk-for-node -o master -v; fi
-  - if [[ $MODE == 'ruby' ]]; then $DOCKER_CMD AutorestCI/azure-sdk-for-ruby --pr-repo-id Azure/azure-sdk-for-ruby -o master -v; fi
-  - if [[ $MODE == 'syntax' ]]; then npm test -- test/syntax.js; fi
-  - if [[ $MODE == 'linter' ]]; then npm test -- test/linter.js; fi
-  - if [[ $MODE == 'semantic' ]]; then npm test -- test/semantic.js; fi
-  - if [[ $MODE == 'model' ]]; then npm test -- test/model.js; fi
-  - if [[ $MODE == 'BreakingChange' ]]; then node -- scripts/breaking-change.js; fi
-  - if [[ $MODE == 'azurebot' ]]; then node scripts/momentOfTruth.js; fi
+  - >-
+    if [[ $MODE == 'python' ]]; then
+      $DOCKER_CMD Azure/azure-sdk-for-python -v
+    fi
+  - >-
+    if [[ $MODE == 'node' ]]; then
+      $DOCKER_CMD Azure/azure-sdk-for-node -v
+    fi
+  - >-
+    if [[ $MODE == 'ruby' ]]; then
+      $DOCKER_CMD Azure/azure-sdk-for-ruby -v
+    fi
+  - >-
+    if [[ $MODE == 'go' ]]; then
+      $DOCKER_CMD Azure/azure-sdk-for-go -o latest -v
+    fi
+  - >-
+    if [[ $MODE == 'java' ]]; then
+      $DOCKER_CMD Azure/azure-libraries-for-java -v
+    fi
+  - >-
+    if [[ $MODE == 'syntax' ]]; then
+      npm test -- test/syntax.js
+    fi
+  - >-
+    if [[ $MODE == 'linter' ]]; then
+      npm test -- test/linter.js
+    fi
+  - >-
+    if [[ $MODE == 'semantic' ]]; then
+      npm test -- test/semantic.js
+    fi
+  - >-
+    if [[ $MODE == 'model' ]]; then
+      npm test -- test/model.js
+    fi
+  - >-
+    if [[ $MODE == 'BreakingChange' ]]; then
+      node -- scripts/breaking-change.js
+    fi
+  - >-
+    if [[ $MODE == 'azurebot' ]]; then
+      node scripts/momentOfTruth.js
+    fi
+  - >-
+    if [[ $MODE == 'liveValidation' ]]; then
+      node -- scripts/liveValidation.js;
+    fi

README.md

@@ -33,18 +33,18 @@ The structure of the directory should strictly follow these rules:
 
 1. **Profile**: The profile holder contains the profiles' definition MD files. these files will contain information and references to the snapshots of the RPs' Resource types or Dataplane API versions that represent a specific profile.
 
-2. **Specification**: This folder the is root folder for all Specs (Management and Dataplane) related docs. 
+2. **Specification**: This folder the is root folder for all Specs (Management and Dataplane) related docs.
 
-3. **<RP-Name>** Folders - each RP will have a seperate folder
+3. **<RP-Name>** Folders - each RP will have a separate folder
 
-4. **'resource-manager' and 'data-plane' Folders**: the RPs can put specs in one of two categories: `resource-manager` (for ARM resources) and `data-plane` (for everything else) . The autorest configuration file (`readme.md`) for the RP should be inside this folder 
+4. **'resource-manager' and 'data-plane' Folders**: the RPs can put specs in one of two categories: `resource-manager` (for ARM resources) and `data-plane` (for everything else) . The autorest configuration file (`readme.md`) for the RP should be inside this folder
 
-4. **API versions**: this folder will be the direct child of the category folder. there will be one such folder per resource type or dataplane service version. This folder will contain the OpenAPI validation Specs (Swaggers previously) and the examples folder. 
+4. **API versions**: this folder will be the direct child of the category folder. there will be one such folder per resource type or dataplane service version. This folder will contain the OpenAPI validation Specs (Swaggers previously) and the examples folder.
 
-6. **Examples**: the example folder will contain the x-ms-examples files. it will reside under the APIs or Resources' version folders as different APIs or Resource types version can have different examples. 
+6. **Examples**: the example folder will contain the x-ms-examples files. it will reside under the APIs or Resources' version folders as different APIs or Resource types version can have different examples.
 
-7. **Notes**: 
-    - folder names should be singular (ie, 'profile' not 'profiles' ) -- this removes ambiguity for some non-english speakers. 
+7. **Notes**:
+    - folder names should be singular (ie, 'profile' not 'profiles' ) -- this removes ambiguity for some non-english speakers.
     - generic folder names should be lower-case
     - proper-name/product name/namespace folders can be PascalCased (ie, "KeyVault")
     - files are whatever case you think is good for your soul.

documentation/creating-swagger.md

@@ -414,6 +414,35 @@ Please note, that the use of "x-ms-paths" should be minimized to the above scena
 The request body and response definitions become simple model types in the generated code. The models include 
 basic validation methods, but are generally stateless serialization definitions.
 
+### Understanding the importance of "type" keyword while definining model types.
+"Type-specific" keywords such as properties, items, minLength, etc. do not enforce a type on the schema. It works the other way around – when an instance is validated against a schema, these keywords only apply when the instance is of the corresponding type, otherwise they are ignored. Here's the relevant part of the [JSON Schema Validation](https://tools.ietf.org/html/draft-fge-json-schema-validation-00#section-4.1) spec:
+
+> 4.1. Keywords and instance primitive types
+Some validation keywords only apply to one or more primitive types. When the primitive type of the instance cannot be validated by a given keyword, validation for this keyword and instance SHOULD succeed.
+
+For example, consider this schema:
+
+```yaml
+definitions:
+  Something:
+    properties:
+      id:
+        type: integer
+    required: [id]
+    minLength: 8
+```
+It's a valid schema, even though it combines object-specific keywords properties and required and string-specific keyword minLength. This schema means:
+- If the instance is an object, it must have an integer property named id. For example, `{"id": 4}` and `{"id": -1, "foo": "bar"}` are valid, but `{}` and `{"id": "ACB123"}` are not.
+- If the instance is a string, it must contain at least 8 characters. `"Hello, world!"` is valid, but `""` and `abc` are not.
+- Any instances of other types are valid - `true`, `false`, `-1.234`, `[]`, `[1, 2, 3]`, `[1, "foo", true]`, etc.
+(Except `null` - OpenAPI 2.0 does not have the `null` type and does not support `null` except in extension properties. OpenAPI 3.0 supports the `null` value for schemas with nullable: true.)
+
+If there are tools that infer the `type` from other keywords (for example, handle schemas with no `type` but with `properties` as always objects), then these tools are not exactly following the OpenAPI Specification and JSON Schema.
+
+> Bottom line: If a schema must always be an object, add `"type": "object"` explicitly. Otherwise you might get unexpected results.
+
+**Credits** - Stack Overflow [link](https://stackoverflow.com/questions/47374980/schema-object-without-a-type-attribute-in-swagger-2-0).
+
 ### Model Inheritance<a name="ModelInheritance"></a>
 Swagger schema allows for specifying that one type is `allOf` other types, meaning that the entire specification of 
 the referenced schema applies is included in the new schema. By convention, if a schema has an 'allOf' that references 

package.json

@@ -10,19 +10,19 @@
   "description": "Tests for Azure REST API Specifications",
   "license": "MIT",
   "devDependencies": {
+    "@microsoft.azure/async-io": "^1.0.21",
+    "@microsoft.azure/literate": "^1.0.21",
+    "@microsoft.azure/polyfill": "^1.0.17",
     "fs-extra": "^3.0.1",
-    "mocha": "*",
     "glob": "^5.0.14",
+    "js-yaml": "^3.8.2",
     "json-schema-ref-parser": "^3.1.2",
-    "request": "^2.61.0",
-    "z-schema": "^3.16.1",
+    "mocha": "*",
+    "oad": "^0.1.9",
     "oav": "^0.4.1",
-    "js-yaml": "^3.8.2",
-    "azure-storage": "^2.1.0",
-    "@microsoft.azure/literate": "^1.0.21",
-    "@microsoft.azure/async-io": "^1.0.21",
-    "@microsoft.azure/polyfill": "^1.0.17",
-    "oad": "^0.1.9"
+    "request": "^2.61.0",
+    "request-promise-native": "^1.0.5",
+    "z-schema": "^3.16.1"
   },
   "homepage": "https://github.com/azure/azure-rest-api-specs",
   "repository": {

scripts/breaking-change.js

@@ -10,7 +10,7 @@ var utils = require('../test/util/utils'),
   execSync = require('child_process').execSync,
   oad = require('oad');
 
-  // This map is used to store the mapping between files resolved and stored location
+// This map is used to store the mapping between files resolved and stored location
 var resolvedMapForNewSpecs = {};
 let outputFolder = path.join(os.tmpdir(), "resolved");
 // Used to enable running script outside TravisCI for debugging
@@ -46,6 +46,7 @@ function runOad(oldSpec, newSpec) {
     return Promise.resolve();
   }).catch(err => {
     console.log(err);
+    process.exitCode = 1;
   });
 }
 
@@ -71,7 +72,7 @@ function processViaAutoRest(swaggerPath) {
     let result = execSync(`${autoRestCmd}`, { encoding: 'utf8', maxBuffer: 1024 * 1024 * 64 });
     resolvedMapForNewSpecs[outputFileNameWithExt] = path.join(outputFolder, outputFileNameWithExt);
   } catch (err) {
-    // Do not update map in case of errors
+    // Do not update map in case of errors.
   }
 
   return Promise.resolve();

scripts/liveValidation.js

@@ -0,0 +1,157 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See License in the project root for license information.
+
+'use strict';
+
+const utils = require('../test/util/utils'),
+    request = require('request-promise-native'),
+    zlib = require('zlib');
+
+const repoUrl = utils.getSourceRepoUrl(),
+    validationService = "https://app.azure-devex-tools.com/api/validations",
+    branch = utils.getSourceBranch(),
+    processingDelay = 20,
+    isRunningInTravisCI = process.env.MODE === 'liveValidation' && process.env.PR_ONLY === 'true',
+    specsPaths = utils.getFilesChangedInPR(),
+    regex = /resource-manager[\\|\/](.*?)[\\|\/].*?[\\|\/](.*?)[\\|\/]/,
+    successThreshold = 90,
+    validationModels = new Map();
+
+let durationInSeconds = parseInt(process.env.LIVE_VALIDATION_DURATION_IN_MINUTES) * 60;
+if (isNaN(durationInSeconds)) {
+    durationInSeconds = 180;
+}
+
+async function runScript() {
+    // See whether script is in Travis CI context
+    console.log(`isRunningInTraviSCI: ${isRunningInTravisCI}`);
+    for (const specPath of specsPaths) {
+        let matchResult = specPath.match(regex);
+
+        if (matchResult === null) {
+            continue;
+        }
+
+        let resourceProvider = matchResult[1];
+        let apiVersion = matchResult[2];
+
+        if (!validationModels.has(resourceProvider)) {
+            validationModels.set(resourceProvider, new Set());
+        }
+
+        validationModels.get(resourceProvider).add(apiVersion);
+    }
+
+    if (validationModels.size === 0) {
+        console.log("Change didn't affect any swagger specs. No validation to be done.");
+        return;
+    } else if (validationModels.size > 1) {
+        console.log("WARNING: Multiple resource provider have changes, only the first one will be validated.");
+    }
+
+    let resourceProvider = validationModels.keys().next().value;
+
+    if (validationModels.get(resourceProvider).size > 1) {
+        console.log("WARNING: Multiple api versions have changes, only the first one will be validated.");
+    }
+
+    let apiVersion = validationModels.get(resourceProvider).values().next().value;
+
+    console.log(`Changes detected in a swagger spec.`);
+    console.log(`RP is: ${resourceProvider}`);
+    console.log(`ApiVersion is: ${apiVersion}`);
+    console.log(`Source repo is: ${repoUrl}`);
+    console.log(`Branch is: ${branch}`);
+
+    console.log(`Making the request to the validation service...`);
+
+    let response = await request.post(validationService).form({
+        repoUrl: repoUrl,
+        branch: branch,
+        resourceProvider: resourceProvider,
+        apiVersion: apiVersion,
+        duration: durationInSeconds
+    });
+    let validationId = JSON.parse(response).validationId;
+
+    let validationResultUrl = `${validationService}/${validationId}`;
+    console.log(`Request done, results will be available in ${durationInSeconds} seconds...`);
+
+    await timeout((durationInSeconds + processingDelay) * 1000);
+    let validationResult = JSON.parse(await request(validationResultUrl));
+
+    console.log(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>");
+    console.log(`Results of validation ${validationId}:`);
+
+    let analyticsUrl = await createAnalyticsLink(validationId);
+
+    let failingOperations = [];
+    let noTrafficOperations = [];
+    for (const [operationId, operationResult] of Object.entries(validationResult.operationResults)) {
+
+        if (operationResult.operationCount === 0) {
+            noTrafficOperations.push(operationResult.operationId)
+        } else if (operationResult.successRate < successThreshold) {
+            failingOperations.push(operationResult.operationId);
+        }
+
+        console.log(JSON.stringify(operationResult));
+    }
+
+    console.log(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>");
+    if (validationResult.totalOperationCount === 0) {
+        console.log(`There was no traffic detected for the provided RP and API version:${resourceProvider}-${apiVersion}. Please make sure there is traffic so the changes can be validated.`);
+        process.exitCode = 1;
+    } else if (failingOperations.length > 0 || noTrafficOperations.length > 0) {
+        console.log(`The changes in the specs introduced by this PR potentially do not reflect the Service API.`);
+
+        console.log(`Active traffic and success rate > ${successThreshold}% FOR EACH OPERATION is required. Please review the following operations before moving forward.`);
+        console.log(`SUCCESS RATE < ${successThreshold}%:
+        ${JSON.stringify(failingOperations)}`);
+
+        if (noTrafficOperations.length > 0) {
+            console.log(`NO TRAFFIC:
+         ${JSON.stringify(noTrafficOperations)}
+         `);
+        }
+        console.log(`To inspect the individual failures go to the url (add '| where customDimensions.operationId == "<OPERATION_ID>"' to filter for individual operations.):
+        ${analyticsUrl}
+        `);
+        process.exitCode = 1;
+    } else {
+        console.log(`SUCCESS RATE: ${validationResult.successRate} > ${successThreshold}. You can move forward.`);
+    }
+}
+
+function timeout(ms) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+}
+
+function createAnalyticsLink(validationId) {
+    return new Promise(resolve => {
+        const query = `
+traces
+| where customDimensions.validationId == "${validationId}"
+| where customDimensions.logType == "data"
+| where customDimensions.isSuccess == "false"
+| project timestamp, message, customDimensions
+`;
+
+        zlib.deflate(query, (err, buffer) => {
+            if (!err) {
+                let queryParams = buffer.toString('base64');
+                let analyticsLink = `https://analytics.applicationinsights.io/subscriptions/6b085460-5f21-477e-ba44-1035046e9101/resourcegroups/openapi-platform-logs/components/openapiAI?q=${queryParams}&apptype=Node.JS&timespan=P1D`;
+                resolve(analyticsLink);
+            }
+        });
+    });
+}
+
+runScript().then(success => {
+    console.log(">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>");
+    console.log(`Thanks for using live validation.`);
+    console.log(`If you encounter any issue(s), please open issue(s) at https://github.com/Azure/openapi-platform/issues .`);
+}).catch(err => {
+    console.log(err);
+    process.exitCode = 1;
+});