[Automation] Generate Fluent Lite from deviceprovisioningservices# by azure-sdk · Pull Request #21149 · Azure/azure-sdk-for-java

azure-sdk · 2021-05-04T18:43:09Z

[Automation] Generate Fluent Lite from deviceprovisioningservices#

check-enforcer · 2021-05-04T18:48:31Z

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run java - [service] - ci

timtay-microsoft · 2021-05-04T18:51:42Z

For additional context here, the Device Provisioning Service control plane swagger has been GA for some time now, but we've never published any Java control plane SDK (track 1 or track 2), so this would be the first.

This work comes on the heels of the same work for .NET which can be seen here

weidongxu-microsoft · 2021-05-06T02:15:10Z

/azp run prepare-pipelines

azure-pipelines · 2021-05-06T02:15:20Z

Azure Pipelines successfully started running 1 pipeline(s).

weidongxu-microsoft · 2021-05-06T02:16:04Z

Currently Java is in core release stage, therefore the code need to be merged a few days later (and with some changes to the pom file, as e.g. azure-core/azure-core-test/azure-identity version will be updated).

weidongxu-microsoft · 2021-05-06T04:11:05Z

/azp run java - deviceprovisioningservices - ci

azure-pipelines · 2021-05-06T04:11:21Z

Azure Pipelines successfully started running 1 pipeline(s).

weidongxu-microsoft · 2021-05-06T04:37:47Z

+              <source>9</source>
+              <target>9</target>


SDK is for Java8.

weidongxu-microsoft · 2021-05-06T04:38:03Z

+
+    @Test
+    @DoNotRecord(skipInPlayback = true)
+    public void CreateAndDelete() {


Follow Java convention, else build will fail.

timtay-microsoft · 2021-05-10T20:55:19Z

@weidongxu-microsoft The generated code is running into some "Path too long" issues around a few classes:

sdk/deviceprovisioningservices/azure-resourcemanager-deviceprovisioningservices/src/main/java/com/azure/resourcemanager/deviceprovisioningservices/implementation/SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionImpl.java
sdk/deviceprovisioningservices/azure-resourcemanager-deviceprovisioningservices/src/main/java/com/azure/resourcemanager/deviceprovisioningservices/fluent/models/SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionInner.java

Is there some way to shorten these class names when generating this managed library?

timtay-microsoft · 2021-05-10T21:38:04Z

/azp run java - deviceprovisioningservices

azure-pipelines · 2021-05-10T21:38:20Z

Azure Pipelines successfully started running 1 pipeline(s).

weidongxu-microsoft · 2021-05-11T01:37:06Z

@timtay-microsoft

Yes, we can, via directive in swagger (for java only) or some optional parameter in codegen.

But is this name correct in the first place? SharedAccessSignatureAuthorizationRule[AccessRightsDescription] (it is the first time I saw [ ] in model name)?
https://github.com/Azure/azure-rest-api-specs/blob/master/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/iotdps.json#L2132-L2169

Could you verify the name is correct? Any suggestion for shorter name? I can add it to directive.

weidongxu-microsoft · 2021-05-11T03:06:46Z

+      <dependency>
+        <groupId>com.azure.resourcemanager</groupId>
+        <artifactId>azure-resourcemanager-test</artifactId>
+        <version>2.0.0-beta.1</version> <!-- {x-version-update;com.azure.resourcemanager:azure-resourcemanager-test;current} -->


It would be better not to include this.

If you really really need this, you need to put it in a profile, as this azure-resourcemanager-test is not released to maven.

<profile> <id>azure-mgmt-sdk-test-jar</id> <activation> <property> <name>!maven.test.skip</name> </property> </activation> <dependencies> <dependency> <groupId>com.azure.resourcemanager</groupId> <artifactId>azure-resourcemanager-test</artifactId> <version>2.0.0-beta.1</version>  <scope>test</scope> </dependency> </dependencies> </profile>

weidongxu-microsoft · 2021-05-11T03:07:36Z

+import java.time.temporal.ChronoUnit;
+import java.util.List;
+
+public class DeviceProvisioningResourceManagementTestBase extends ResourceManagerTestBase


Again, I don't think you need this.

Gotcha. I had been modeling my test code on the Key Vault Resource Management SDK, but is there a more recent control plane SDK that I should model my test code on?

I've added a few recently
https://github.com/Azure/azure-sdk-for-java/tree/master/sdk/resourcegraph/azure-resourcemanager-resourcegraph/src/test/java/com/azure/resourcemanager/resourcegraph
https://github.com/Azure/azure-sdk-for-java/tree/master/sdk/datafactory/azure-resourcemanager-datafactory/src/test/java/com/azure/resourcemanager/datafactory

Though I think your digitaltwins is nearest in your case.
https://github.com/Azure/azure-sdk-for-java/tree/master/sdk/digitaltwins/azure-resourcemanager-digitaltwins/src/test/java/com/azure/resourcemanager/digitaltwins

timtay-microsoft · 2021-05-12T00:08:18Z

@timtay-microsoft

Yes, we can, via directive in swagger (for java only) or some optional parameter in codegen.

But is this name correct in the first place? SharedAccessSignatureAuthorizationRule[AccessRightsDescription] (it is the first time I saw [ ] in model name)?
https://github.com/Azure/azure-rest-api-specs/blob/master/specification/deviceprovisioningservices/resource-manager/Microsoft.Devices/stable/2020-03-01/iotdps.json#L2132-L2169

Could you verify the name is correct? Any suggestion for shorter name? I can add it to directive.

I hadn't noticed that before, but the model names do seem a bit odd. I'll follow up with the service team to see if we can fix these names. If so, then we won't need any special directives here.

timtay-microsoft · 2021-05-17T18:08:58Z

@weidongxu-microsoft the service team that owns the control plane swagger here asserts that the strange naming of that autorest model came from autorest itself since their swagger is not hand-written. That means we can either push for autorest swagger generation to not do this strange naming, or just override the name locally for this SDK via directives. I'm guessing that the latter would be easier, but the former would prevent other language SDKs from hitting this same issue in the future. Considering the swagger was generated, do you still see this as an swagger bug? Or would you be fine leaving the swagger as is and use directives here to fix the naming?

weidongxu-microsoft · 2021-05-18T02:30:02Z

@timtay-microsoft

I don't think there is any "official" tool for service to auto-generate the control-plane swagger. However if the tool really is maintained by Microsoft (maybe ADL? that one is in preview or even before preview), we could at least notify them.

timtay-microsoft · 2021-05-27T00:54:21Z

@weidongxu-microsoft I'd like to wrap this up, so is it possible for you to just use directives to simplify the name to "SharedAccessSignatureAuthorizationRule"? I've also implemented all the tests for this SDK now based on the tests in the digital twins resource manager like you suggested.

timtay-microsoft · 2021-05-27T01:10:46Z

/azp run java - deviceprovisioningservices

azure-pipelines · 2021-05-27T01:11:04Z

Azure Pipelines successfully started running 1 pipeline(s).

weidongxu-microsoft · 2021-05-27T02:23:43Z

@timtay-microsoft Swagger PR here Azure/azure-rest-api-specs#14565

timtay-microsoft · 2021-05-28T21:22:37Z

Closing this PR in favor of #21938 which captures the new generated layer with the slight renaming discussed above

azure-sdk added 2 commits May 4, 2021 18:43

[Automation] External Change

3d7a599

[Automation] Generate Fluent Lite from deviceprovisioningservices#

5888f20

azure-sdk requested review from ChenTanyi, JimSuplizio, alzimmermsft, anuchandy, conniey, danieljurek, g2vinay, hemanttanwar, jianghaolu, joshfree, mitchdenny, samvaity, srnagar, weidongxu-microsoft and yungezz as code owners May 4, 2021 18:43

azure-sdk added the Mgmt - Track 2 label May 4, 2021

Testing out a simple test

5fac79f

weidongxu-microsoft approved these changes May 6, 2021

View reviewed changes

fixup

d1467b1

Azure deleted a comment from azure-pipelines Bot May 10, 2021

fixup

b494f45

fixup

2cc0455

weidongxu-microsoft reviewed May 11, 2021

View reviewed changes

timtay-microsoft added 2 commits May 26, 2021 17:37

Add tests for device provisioning resource manager

82c868e

Merge branch 'master' into fluent-lite-generation-875089

fe22e34

Azure deleted a comment from azure-pipelines Bot May 27, 2021

timtay-microsoft closed this May 28, 2021

azure-sdk deleted the fluent-lite-generation-875089 branch October 19, 2023 00:20

Uh oh!

Conversation

azure-sdk commented May 4, 2021

Uh oh!

check-enforcer Bot commented May 4, 2021

What is Check Enforcer?

Why am I getting this message?

What should I do now?

What if I am onboarding a new service?

Uh oh!

timtay-microsoft commented May 4, 2021

Uh oh!

weidongxu-microsoft commented May 6, 2021

Uh oh!

azure-pipelines Bot commented May 6, 2021

Uh oh!

weidongxu-microsoft commented May 6, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

weidongxu-microsoft commented May 6, 2021

Uh oh!

azure-pipelines Bot commented May 6, 2021

Uh oh!

weidongxu-microsoft May 6, 2021

Choose a reason for hiding this comment

Uh oh!

weidongxu-microsoft May 6, 2021

Choose a reason for hiding this comment

Uh oh!

timtay-microsoft commented May 10, 2021

Uh oh!

timtay-microsoft commented May 10, 2021

Uh oh!

azure-pipelines Bot commented May 10, 2021

Uh oh!

weidongxu-microsoft commented May 11, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

weidongxu-microsoft May 11, 2021 • 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!

weidongxu-microsoft May 11, 2021

Choose a reason for hiding this comment

Uh oh!

timtay-microsoft May 12, 2021

Choose a reason for hiding this comment

Uh oh!

weidongxu-microsoft May 12, 2021

Choose a reason for hiding this comment

Uh oh!

timtay-microsoft commented May 12, 2021

Uh oh!

timtay-microsoft commented May 17, 2021

Uh oh!

weidongxu-microsoft commented May 18, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

timtay-microsoft commented May 27, 2021

Uh oh!

timtay-microsoft commented May 27, 2021

Uh oh!

azure-pipelines Bot commented May 27, 2021

Uh oh!

weidongxu-microsoft commented May 27, 2021

Uh oh!

timtay-microsoft commented May 28, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

weidongxu-microsoft commented May 6, 2021 •

edited

Loading

weidongxu-microsoft commented May 11, 2021 •

edited

Loading

weidongxu-microsoft May 11, 2021 •

edited

Loading

weidongxu-microsoft commented May 18, 2021 •

edited

Loading