Initial ModelsRepositoryClient

[cartertinney]

Initial ModelsRepositoryClient

Unittests + some integration tests will be added after API review signoff

[check-enforcer]

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 python - [service] - ci

[digimaun]

Can we append at least you and me from the IoT D&D team as code owners for this project?

[digimaun]

Normally we'd want to run recordings in the pipeline. The live tests happen locally and test recordings would be checked-in.

[cartertinney]

Recordings have not yet been generated due to a what appears to be a bug in the testing infrastructure. This will be changed once recordings can be generated.

[digimaun]

Would be good to add a test case for basic windows UNC path...as an example getting the model uri for "dtmi:com:example:Thermostat;1" in the repository location of "\\server\repository" should net the uri of "file://server/repository/dtmi/com/example/thermostat-1.json"

[cartertinney]

The function .get_model_uri() has been scoped to require the base path to already be provided in URI format (as opposed to the ModelsRepositoryClient itself, which does support non-URI filepaths). If you wish to expand it's functionality to support absolute paths (including UNC path format) being converted to file URI, this would be an additional feature that can be added at a later date.

[scbedd]

@cartertinney The failure for verifyChangeLog is just because there is no changelog. I recommend adding a bare one with content of:

# Release History

## 1.0.0b1 (Unreleased)

To unblock the check.

Prior to your actual release, you'll need to update the date, something like.

## 1.0.0b1 (2021-05-01)

* Initial Release
* Feature X/Y/Z supported

Or the like.

[digimaun]

We have a number of follow up topics but I think we are at a solid baseline to build on.

[scbedd]

/check-enforcer override

[scbedd]

Overriding check enforcer, this is the initial cut at the new SDK, and no build definition yet exists. @cartertinney will submit PRs to deal with any failures AFTER the build definition exists.