Release of Device Update for IoT Hub SDK for .NET. #19116

dpokluda · 2021-03-02T01:39:02Z

All SDK Contribution checklist:

This checklist is used to make sure that common guidelines for a pull request are followed.

Please open PR in Draft mode if it is:
- Work in progress or not intended to be merged.
- Encountering multiple pipeline failures and working on fixes.
If an SDK is being regenerated based on a new swagger spec, a link to the pull request containing these swagger spec changes has been included above.
I have read the contribution guidelines.
The pull request does not introduce breaking changes.

General Guidelines and Best Practices

Title of the pull request is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

Pull request includes test coverage for the included changes.

SDK Generation Guidelines

The generate.cmd file for the SDK has been updated with the version of AutoRest, as well as the commitid of your swagger spec or link to the swagger spec, used to generate the code. (Track 2 only)
The *.csproj and AssemblyInfo.cs files have been updated with the new version of the SDK. Please double check nuget.org current release version.

Additional management plane SDK specific contribution checklist:

Note: Only applies to Microsoft.Azure.Management.[RP] or Azure.ResourceManager.[RP]

Include updated management metadata.
Update AzureRP.props to add/remove version info to maintain up to date API versions.

Management plane SDK Troubleshooting

If this is very first SDK for a services and you are adding new service folders directly under /SDK, please add new service label and/or contact assigned reviewer.
If the check fails at the Verify Code Generation step, please ensure:
- Do not modify any code in generated folders.
- Do not selectively include/remove generated files in the PR.
- Do use generate.ps1/cmd to generate this PR instead of calling autorest directly.
  Please pay attention to the @microsoft.csharp version output after running generate.ps1. If it is lower than current released version (2.3.82), please run it again as it should pull down the latest version,

Old outstanding PR cleanup

Please note:
If PRs (including draft) has been out for more than 60 days and there are no responses from our query or followups, they will be closed to maintain a concise list for our reviewers.

check-enforcer · 2021-03-02T01:44: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, please perform following steps:

For data-plane/track 2 SDKs 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 net - [service] - ci

For track 1 management-plane SDKs

Please open a separate PR and to your service SDK path in this file. Once that PR has been merged, you can re-run the pipeline to trigger the verification.

pakrym · 2021-03-02T18:01:10Z

/azp run prepare-pipelines

azure-pipelines · 2021-03-02T18:01:21Z

Azure Pipelines successfully started running 1 pipeline(s).

pakrym · 2021-03-02T18:06:22Z

/azp run net - deviceupdate - ci

azure-pipelines · 2021-03-02T18:06:33Z

Azure Pipelines failed to run 1 pipeline(s).

pakrym · 2021-03-02T18:09:38Z

/azp run net - deviceupdate - ci

azure-pipelines · 2021-03-02T18:09:52Z

Azure Pipelines successfully started running 1 pipeline(s).

sdk/deviceupdate/Azure.Iot.DeviceUpdate/README.md

pakrym · 2021-03-02T18:29:56Z

sdk/deviceupdate/Azure.Iot.DeviceUpdate/README.md

+
+For example, if you use the `GetUpdateAsync` operation and the model you are looking for doesn't exist, you can catch that specific [HttpStatusCode](https://docs.microsoft.com/dotnet/api/system.net.httpstatuscode?view=netcore-3.1) to decide the operation that follows in that case.
+
+```csharp


Please use snippets https://github.com/Azure/azure-sdk-for-net/blob/master/CONTRIBUTING.md#updating-sample-snippets

pakrym · 2021-03-02T20:35:03Z

...ate/Azure.Iot.DeviceUpdate/src/Generated/Models/PageableListOfDeviceClasses.Serialization.cs

+
+namespace Azure.Iot.DeviceUpdate.Models
+{
+    public partial class PageableListOfDeviceClasses


These classes shouldn't be generated but it's a code-gen bug. Azure/autorest.csharp#1066

Got it, what should I do about that?

The fix has landed in master, rebase and re-generate.

pakrym · 2021-03-02T20:35:26Z

sdk/deviceupdate/Azure.Iot.DeviceUpdate/tests/ServiceClientTestEnvironment.cs

+        /// <summary>
+        /// ADU account identifier
+        /// </summary>
+        public string AccountEndpoint => GetRecordedVariable("DEVICEUPDATE_ACCOUNT_ENDPOINT");


I haven't noticed this resource being created in test-resources.json

Same for other variables. To be able to run live tests all resources required need to be created after deploying test-resources.json

That's right. The tests are written in such a way, that I need to set certain env. variables, run sample and it will populate things. After that I can run the test suite and it will collect test sessions.

You should be able to replay test sessions since the test sessions will capture environment variables.

It's fine for the initial PR but won't work with nightly CI runs, you won't be able to set additional variables there. Is there a way to create all resources via the test-resource.json without requiring manual steps?

pakrym · 2021-03-02T20:47:43Z

sdk/deviceupdate/Azure.Iot.DeviceUpdate/src/UpdatesClient.cs

+    /// <summary>
+    /// Update management service client.
+    /// </summary>
+    public partial class UpdatesClient


You typically need only one ClientOptions per library.

Yeah; this could be updated. Correct.

Release of Device Update for IoT Hub SDK for .NET.

52ae28f

dpokluda requested review from AlexGhiondea, KrzysztofCwalina, mitchdenny and tg-msft as code owners March 2, 2021 01:39

deviceupdate/ci.yml

2f14f70

pakrym added 2 commits March 2, 2021 10:27

Some README and csproj fixes to get things building

5d186fa

changelog

c1469a6

pakrym reviewed Mar 2, 2021

View reviewed changes

sdk/deviceupdate/Azure.Iot.DeviceUpdate/README.md Outdated Show resolved Hide resolved

pakrym reviewed Mar 2, 2021

View reviewed changes

David Pokluda added 2 commits March 2, 2021 12:22

Update ContentFactory.cs

9f8c5a3

Updating test and samples.

abcf1c4

pakrym reviewed Mar 2, 2021

View reviewed changes

David Pokluda added 5 commits March 2, 2021 14:07

Updating doc links

08d462e

Fixing one more link

7332ced

Fixing broken links.

cdce459

Fixing/removing extra client option classes.

6b1e58c

Update README.md

0e60c41

dpokluda requested review from abhipsaMisra, aim-for-better and allenjzhang as code owners March 3, 2021 19:12

dpokluda added 2 commits March 3, 2021 11:59

Merge remote-tracking branch 'upstream/master' into HEAD

9b85195

Regenerating all the files with new autorest

7090ad2

pakrym approved these changes Mar 3, 2021

View reviewed changes

pakrym merged commit 7cfd84f into Azure:master Mar 3, 2021


		For example, if you use the `GetUpdateAsync` operation and the model you are looking for doesn't exist, you can catch that specific [HttpStatusCode](https://docs.microsoft.com/dotnet/api/system.net.httpstatuscode?view=netcore-3.1) to decide the operation that follows in that case.

		```csharp

Release of Device Update for IoT Hub SDK for .NET. #19116

Release of Device Update for IoT Hub SDK for .NET. #19116

Uh oh!

Conversation

dpokluda commented Mar 2, 2021

All SDK Contribution checklist:

Additional management plane SDK specific contribution checklist:

Management plane SDK Troubleshooting

Old outstanding PR cleanup

Uh oh!

check-enforcer bot commented Mar 2, 2021

What is Check Enforcer?

Why am I getting this message?

What should I do now?

What if I am onboarding a new service?

For data-plane/track 2 SDKs Issue the following command as a pull request comment:

For track 1 management-plane SDKs

Uh oh!

pakrym commented Mar 2, 2021

Uh oh!

azure-pipelines bot commented Mar 2, 2021

Uh oh!

pakrym commented Mar 2, 2021

Uh oh!

azure-pipelines bot commented Mar 2, 2021

Uh oh!

pakrym commented Mar 2, 2021

Uh oh!

azure-pipelines bot commented Mar 2, 2021

Uh oh!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants