Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove ResolverException in favor of RequestFailedException #18874

Merged
merged 2 commits into from
Feb 19, 2021

Conversation

digimaun
Copy link
Member

And adds more docstrings.

@check-enforcer
Copy link

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.

/// <summary>
/// <c>DtmiConventions</c> implements the core aspects of the IoT model repo conventions
/// which includes calculating a generic path from a DTMI.
/// </summary>
internal static class DtmiConventions
{
private static readonly Regex s_validDtmiRegex = new Regex(@"^dtmi:[A-Za-z](?:[A-Za-z0-9_]*[A-Za-z0-9])?(?::[A-Za-z](?:[A-Za-z0-9_]*[A-Za-z0-9])?)*;[1-9][0-9]{0,8}$");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Independent of this PR, can we get a comment on this Regex that describes how it works. The universal truth about regex is that the author knows what it does, but it can appear undecipherable to others. :'-)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will do.

Copy link
Contributor

@drwill-ms drwill-ms left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments. I'll keep the page up and occasionally refresh, but feel free to ping me when you have responses or have pushed changes.

@digimaun digimaun requested a review from drwill-ms February 19, 2021 19:32
throw new ResolverException(dtmi, invalidArgMsg, new ArgumentException(invalidArgMsg));

string invalidArgMsg =
$"{string.Format(CultureInfo.CurrentCulture, ServiceStrings.GenericResolverError, dtmi)} " +
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think at this point, you might as well not use string interpolation. We're already concatenating the second string for line break reasons. The only thing we're adding in is the space. May as well just concat all 3.

@digimaun digimaun merged commit 40896b9 into Azure:feature/modelsRepo Feb 19, 2021
azabbasi added a commit that referenced this pull request Feb 25, 2021
* Initial Commit - Bring ModelRepository Project to the mono repo (#18706)
* Use resx file and update formattings.
* Add client diagnostics - Add sync APIs to RemoteFetcher and LocalFetcher (#18807)
* Add async methods to the ResolverClient (#18814)
* Add support for recorded tests. (#18836)
* Add support for recorded tests.
* Make strings constants
* Update file names to include plural models
* Refactor RepositoryHandler and ResolverClient (#18857)
* Refactor ModelQuery (#18843)
* Refactor ModelQuery.
* Combine constant files.
* Rename Client to ModelsRepoClient (#18862)
* Remove ResolverException in favor of RequestFailedException (#18874)
* Remove ResolverException in favor of RequestFailedException. Adds more docstrings.
* Rename Repo to Repository and minor changes / Import samples project (#18986)
* Format changes/Remove resx file.
* Add first draft of readme. Add comment for dtmi validation. (#18987)
* Add comment for dtmi validation.
* Fix links.
* Add diagnostic event info.
* Source link specifically pointing to 'src' folder.
* Use fluent assertion
* Use playback as default
* fix Links and root service directory casing
Co-authored-by: Paymaun <Paymaunh@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants