Adding examples and fixing the DSC related lint issues #2415

vrdmr · 2018-02-03T05:38:16Z

This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.

PR information

The title of the PR is clear and informative.
There are a small number of commits, each of which has an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, see this page.
Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch.
If applicable, the PR references the bug/issue that it fixes.
Swagger files are correctly named (e.g. the api-version in the path should match the api-version in the spec).

Quality of Swagger

I have read the contribution guidelines.
My spec meets the review criteria:
- The spec conforms to the Swagger 2.0 specification.
- The spec follows the guidelines described in the Swagger checklist document.
- Validation tools were run on swagger spec(s) and have all been fixed in this PR.

AutorestCI · 2018-02-03T05:42:52Z

Did a commit to Azure/azure-sdk-for-go:
Azure/azure-sdk-for-go@d3f1eca

AutorestCI · 2018-02-05T04:37:54Z

This commit was treated and no generation was made for Azure/azure-sdk-for-go

AutorestCI · 2018-02-05T18:27:01Z

Did a commit to Azure/azure-sdk-for-go:
Azure/azure-sdk-for-go@f19be4f

fearthecowboy · 2018-02-05T22:31:17Z

Hey @vrdmr ,

I was about to start reviewing the PR, but it still has an awful lot of validation errors.

See: https://travis-ci.org/Azure/azure-rest-api-specs/jobs/337677030

Can you review those, and see what you can do to get it to pass?

vrdmr · 2018-02-06T05:50:57Z

Hi @fearthecowboy,

Thanks. I'll take a look.

I am trying to run the model-validator but I am hitting the following:

varads-mbp:resource-manager varadmeru$ autorest --model-validator readme.md 
AutoRest code generation utility [version: 2.0.4245; node: v9.4.0]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
   Loading AutoRest core      '/private/var/folders/sp/dpmjjqvj7gs3ylxw_08wpxk40000gn/T/.autorest/@[email protected]/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4245)
   Loading local AutoRest extension 'oav' (/usr/local/Cellar/node/9.4.0/lib/node_modules/oav)
FATAL: TypeError: Cannot read property 'ReadFile' of undefined
FATAL: swagger-document/model-validator - FAILED
FATAL: Error: Plugin model-validator reported failure.
Process() cancelled due to exception : Plugin model-validator reported failure.
  Error: Plugin model-validator reported failure.
varads-mbp:resource-manager varadmeru$

and when using the --validation and --oav options, I do not see any validation issues.

varads-mbp:resource-manager varadmeru$ autorest --validation --oav
AutoRest code generation utility [version: 2.0.4245; node: v9.4.0]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
   Loading AutoRest core      '/private/var/folders/sp/dpmjjqvj7gs3ylxw_08wpxk40000gn/T/.autorest/@[email protected]/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4245)
varads-mbp:resource-manager varadmeru$

varads-mbp:resource-manager varadmeru$ autorest --oav
AutoRest code generation utility [version: 2.0.4245; node: v9.4.0]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
   Loading AutoRest core      '/private/var/folders/sp/dpmjjqvj7gs3ylxw_08wpxk40000gn/T/.autorest/@[email protected]/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4245)
varads-mbp:resource-manager varadmeru$

Could you please help me with this.

Thanks,
Varad

fearthecowboy · 2018-02-06T17:06:54Z

Hey @vrdmr ,

I'm seeing the problem using --model-validator too. I'm looking into it.

In the mean time, you can use the model-validator outside of autorest on individual swagger files:

Example

# ensure the module globally
> npm install -g oav

# example: run it against a swagger file directly.
> oav validate-example Microsoft.Automation/stable/2015-10-31/dscCompilationJob.json

I'm looking into why using it as a plugin isn't working right now.

fearthecowboy · 2018-02-06T17:09:40Z

FYI @vrdmr

This was the correct syntax (even tho it fails)

  
autorest --model-validator readme.md

Using --oav and --validation don't do anything; the validators are activated with --model-validator and --azure-validator (you'll know which are correct, they will show you Loading autorest extension messages)

fearthecowboy · 2018-02-06T20:45:27Z

Hey @vrdmr,

I've asked the OAV author to fix the autorest extension, I think we've got a few glitches he has to take care of.

in the mean time, fall back to using oav manually on each of the files.

AutorestCI · 2018-02-07T19:57:44Z

Automation for azure-sdk-for-python

A PR has been created for you:
Azure/azure-sdk-for-python#1928

AutorestCI · 2018-02-07T19:59:52Z

Swagger to SDK encountered a Subprocess error: (Azure/azure-sdk-for-go)

Command: ['/usr/local/bin/autorest', '/tmp/tmpauiawjcr/rest/specification/automation/resource-manager/readme.md', '--go', '--go-sdk-folder=/tmp/tmpauiawjcr/sdk', '--multiapi', '--package-version=v12.2.1-beta', '[email protected]/autorest.go@preview', "--user-agent='Azure-SDK-For-Go/v12.2.1-beta services'", '--verbose']
Finished with return code 1
and output:

AutoRest code generation utility [version: 2.0.4244; node: v7.10.1]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest

There is a new version of AutoRest available (2.0.4245).
 > You can install the newer version with with npm install -g autorest@latest

   Loading AutoRest core      '/tmp/.autorest/@[email protected]/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4244)
   Loading AutoRest extension '@microsoft.azure/autorest.go' (preview->2.1.70)
   Loading AutoRest extension '@microsoft.azure/autorest.modeler' (2.3.38->2.3.38)
Processing batch task - {"tag":"package-2015-10"} .
ERROR: Schema violation: Data does not match any schemas from 'oneOf'
    - file:///tmp/tmpauiawjcr/rest/specification/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscConfiguration.json:256:10 ($.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName}/content"].get.responses["200"])
FATAL: swagger-document/individual/schema-validator - FAILED
FATAL: Error: [OperationAbortedException] Error occurred. Exiting.
Process() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting.
Failure during batch task - {"tag":"package-2015-10"} -- false.

AutorestCI · 2018-02-07T21:11:29Z

Did a commit to Azure/azure-sdk-for-go:
Azure/azure-sdk-for-go@78f84aa

vrdmr · 2018-02-07T21:17:39Z

Hi Garrett,

I have fixed most of the DSC related issues and am working with other teams to fix their resources specs. Could you please take a look at this PR now and merge it in when you get a chance?

Thanks,
Varad

@fearthecowboy

fearthecowboy · 2018-02-08T15:34:48Z

...fication/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/definitions.json

Ouch!
You're changing enum values here.

Did the service change, or was this an error in the spec before? If this is a service change, we're potentially breaking an API.

As it is, this means that current clients are incorrect. Is this so?

The Spec was incorrect here and I just changed it to reflect what we are sending from the service. And we are in the process of releasing new Automation SDKs based on Swagger and are still in preview mode.

Our last stable release of SDK was based on Hyak.

fearthecowboy · 2018-02-08T15:37:14Z

...fication/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/definitions.json

Why has this allOf been removed?

This resource is a ProxyResource and does not have all the requirements of the Resource (like Location, Tags etc.). Thus I removed the allOf - Resource and just added the tag.

To make it better, I can go and take this route as mentioned here - #2368 (comment). By creating a separate Proxy Resource.

fearthecowboy · 2018-02-08T15:37:23Z

...fication/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/definitions.json

And this one?

Explained above.

fearthecowboy · 2018-02-08T15:38:11Z

...on/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscCompilationJob.json

Is this adding a new API or documenting an existing one that wasn't listed before?

Documenting existing API which wasn't listed earlier.

fearthecowboy · 2018-02-08T15:39:08Z

...automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscNodeConfiguration.json

Why was this deleted? This may result in a breaking change in the generated clients.

It returns only 200 and not 201. As mentioned earlier, we don't have any swagger-based stable clients and are in the process of releasing them.

I'll confirm the response code with Fiddler.

fearthecowboy · 2018-02-08T15:45:10Z

...on/automation/resource-manager/Microsoft.Automation/stable/2015-10-31/dscCompilationJob.json

Validation Failure: https://travis-ci.org/Azure/azure-rest-api-specs/jobs/338705368#L755

Hey, I checked with the team and I resolved the issue. They had added new flags and it wasn't documented in the spec, which caused the validation failures in DSCCompilationJob. Fixed it.

fearthecowboy · 2018-02-08T15:56:21Z

Hey @vrdmr -- we're getting closer. Just a few things i need you to look at.

It's a bit tricky, since there are other validation failures and examples failing -- is it possible that whoever owns the examples that are failing could look at those and update this PR?

AutorestCI · 2018-02-12T21:56:55Z

Automation for azure-sdk-for-go

A PR has been created for you:
Azure/azure-sdk-for-go#1078

vrdmr · 2018-02-12T23:24:51Z

@fearthecowboy Hi Garrett, Could you please have a look at this PR. If you have any questions, we can have a quick sync. Thanks.

fearthecowboy · 2018-02-12T23:32:42Z

@vrdmr - I'll get back to it first thing in the morning.

fearthecowboy · 2018-02-13T17:30:24Z

@vrdmr -- You're still showing validator problems:
https://travis-ci.org/Azure/azure-rest-api-specs/jobs/340682526 -- invalid examples validation
https://travis-ci.org/Azure/azure-rest-api-specs/jobs/340682523 -- a lot of these are flagging because they are marked as azure resources but not showing the required fields.

azuresdkciprbot · 2018-02-13T21:44:28Z

Hi There,

I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result:

File: specification/automation/resource-manager/readme.md
Before the PR: Warning(s): 0 Error(s): 36
After the PR: Warning(s): 0 Error(s): 22

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

vrdmr · 2018-02-13T21:49:10Z

Hi @fearthecowboy, For the issues you specified in the build, related to linting issues, we have active work going on to get them down to 0. There are actively three PRs (#2360, #2466 and this one) from our team and I would be sending one more PR for DSC issues.

For the first set of issues related to x-ms-example, I will push in the changes.

azuresdkciprbot · 2018-02-13T23:32:38Z

Hi There,

I am the AutoRest Linter Azure bot. I am here to help. My task is to analyze the situation from the AutoRest linter perspective. Please review the below analysis result:

File: specification/automation/resource-manager/readme.md
Before the PR: Warning(s): 0 Error(s): 36
After the PR: Warning(s): 0 Error(s): 24

AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback

Thanks for your co-operation.

fearthecowboy · 2018-02-14T17:16:46Z

Merging this -- noting that other PRs (#2360, #2466) are intended to address some of the linter issues.

azuresdkci assigned fearthecowboy Feb 3, 2018

AutorestCI mentioned this pull request Feb 3, 2018

Automatic PR of restapi_auto_vrdmr_vameru-dsc-swagger-validation-issues into master Azure/azure-sdk-for-python#1900

Closed

AutorestCI mentioned this pull request Feb 3, 2018

Automatic PR of restapi_auto_vrdmr_vameru-dsc-swagger-validation-issues into dev Azure/azure-sdk-for-go#1046

Closed

fearthecowboy added Does-Not-Validate Changes Required labels Feb 5, 2018

AutorestCI mentioned this pull request Feb 7, 2018

[AutoPR automation/resource-manager] Adding examples and fixing the DSC related lint issues Azure/azure-sdk-for-python#1928

Closed

Azure deleted a comment from AutorestCI Feb 7, 2018

fearthecowboy reviewed Feb 8, 2018

View reviewed changes

fearthecowboy added the Requesting Clarification label Feb 8, 2018

AutorestCI mentioned this pull request Feb 12, 2018

[AutoPR automation/resource-manager] Adding examples and fixing the DSC related lint issues Azure/azure-sdk-for-go#1078

Merged

Adding Examples and fixing the DSC related lint issues

dc1da21

fearthecowboy approved these changes Feb 14, 2018

View reviewed changes

fearthecowboy added Conditionally-Merged and removed Changes Required Does-Not-Validate Requesting Clarification labels Feb 14, 2018

fearthecowboy merged commit b8c8d8b into Azure:master Feb 14, 2018

vrdmr deleted the vameru-dsc-swagger-validation-issues branch February 14, 2018 19:52

Adding examples and fixing the DSC related lint issues #2415

Adding examples and fixing the DSC related lint issues #2415

Uh oh!

Conversation

vrdmr commented Feb 3, 2018 • edited by azuresdkci Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR information

Quality of Swagger

Uh oh!

AutorestCI commented Feb 3, 2018

Uh oh!

AutorestCI commented Feb 5, 2018

Uh oh!

AutorestCI commented Feb 5, 2018

Uh oh!

fearthecowboy commented Feb 5, 2018

Uh oh!

vrdmr commented Feb 6, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fearthecowboy commented Feb 6, 2018

Uh oh!

fearthecowboy commented Feb 6, 2018

Uh oh!

fearthecowboy commented Feb 6, 2018

Uh oh!

AutorestCI commented Feb 7, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-python

Uh oh!

AutorestCI commented Feb 7, 2018

Uh oh!

AutorestCI commented Feb 7, 2018

Uh oh!

vrdmr commented Feb 7, 2018

Uh oh!

fearthecowboy Feb 8, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fearthecowboy commented Feb 8, 2018

Uh oh!

AutorestCI commented Feb 12, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-go

Uh oh!

vrdmr commented Feb 12, 2018

Uh oh!

fearthecowboy commented Feb 12, 2018

Uh oh!

fearthecowboy commented Feb 13, 2018

Uh oh!

azuresdkciprbot commented Feb 13, 2018

Uh oh!

vrdmr commented Feb 13, 2018

Uh oh!

azuresdkciprbot commented Feb 13, 2018

Uh oh!

vrdmr commented Feb 3, 2018 •

edited by azuresdkci

Loading

vrdmr commented Feb 6, 2018 •

edited

Loading

AutorestCI commented Feb 7, 2018 •

edited

Loading

fearthecowboy Feb 8, 2018 •

edited

Loading

AutorestCI commented Feb 12, 2018 •

edited

Loading