(modelsRepo): Initial commit: Azure.Iot.ModelsRepository (#18998)

* 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>
Azure · Feb 25, 2021 · 733e79a · 733e79a
1 parent 36b4daa
commit 733e79a
Show file tree

Hide file tree

Showing 94 changed files with 6,044 additions and 0 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -261,6 +261,10 @@
 # ServiceLabel: %Digital Twins %Service Attention
 /sdk/digitaltwins/                              @drwill-ms @timtay-microsoft @abhipsaMisra @vinagesh @azabbasi @bikamani @barustum @jamdavi
 
+# PRLabel: %IoT Models Repository
+# ServiceLabel: %IoT Models Repository %Service Attention
+/sdk/modelsrepository/                              @drwill-ms @timtay-microsoft @abhipsaMisra @vinagesh @azabbasi @bikamani @barustum @jamdavi @digimaun
+
 # PRLabel: %TimeSeriesInsights
 # ServiceLabel: %TimeSeriesInsights %Service Attention
 /sdk/timeseriesinsights/                        @drwill-ms @timtay-microsoft @abhipsaMisra @vinagesh @azabbasi @bikamani @barustum @jamdavi @yeskarthik @rasidhan @dmdenmsft

diff --git a/sdk/modelsrepository/Azure.Iot.ModelsRepository/.gitignore b/sdk/modelsrepository/Azure.Iot.ModelsRepository/.gitignore
@@ -0,0 +1 @@
+launchSettings.json
diff --git a/sdk/modelsrepository/Azure.Iot.ModelsRepository/Azure.Iot.ModelsRepository.sln b/sdk/modelsrepository/Azure.Iot.ModelsRepository/Azure.Iot.ModelsRepository.sln
@@ -0,0 +1,43 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 16
+VisualStudioVersion = 16.0.30717.126
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Iot.ModelsRepository", "src\Azure.Iot.ModelsRepository.csproj", "{5E11A377-0D20-49F8-952B-50390196EF4B}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Iot.ModelsRepository.Tests", "tests\Azure.Iot.ModelsRepository.Tests.csproj", "{092E6CE2-9998-428C-A801-2BAB4E14A577}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Core.TestFramework", "..\..\core\Azure.Core.TestFramework\src\Azure.Core.TestFramework.csproj", "{1FC8A3EA-3C0D-4DDF-B710-A7091F2CEBB1}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ModelsRepositoryClientSamples", "samples\ModelsRepositoryClientSamples\ModelsRepositoryClientSamples.csproj", "{51E4AB9E-46F3-450C-B52A-C4C6378E8BA3}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{5E11A377-0D20-49F8-952B-50390196EF4B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{5E11A377-0D20-49F8-952B-50390196EF4B}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{5E11A377-0D20-49F8-952B-50390196EF4B}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{5E11A377-0D20-49F8-952B-50390196EF4B}.Release|Any CPU.Build.0 = Release|Any CPU
+		{092E6CE2-9998-428C-A801-2BAB4E14A577}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{092E6CE2-9998-428C-A801-2BAB4E14A577}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{092E6CE2-9998-428C-A801-2BAB4E14A577}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{092E6CE2-9998-428C-A801-2BAB4E14A577}.Release|Any CPU.Build.0 = Release|Any CPU
+		{1FC8A3EA-3C0D-4DDF-B710-A7091F2CEBB1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{1FC8A3EA-3C0D-4DDF-B710-A7091F2CEBB1}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{1FC8A3EA-3C0D-4DDF-B710-A7091F2CEBB1}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{1FC8A3EA-3C0D-4DDF-B710-A7091F2CEBB1}.Release|Any CPU.Build.0 = Release|Any CPU
+		{51E4AB9E-46F3-450C-B52A-C4C6378E8BA3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{51E4AB9E-46F3-450C-B52A-C4C6378E8BA3}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{51E4AB9E-46F3-450C-B52A-C4C6378E8BA3}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{51E4AB9E-46F3-450C-B52A-C4C6378E8BA3}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {671D1EFB-2BB9-4846-91EF-A3FB1FF9DDA6}
+	EndGlobalSection
+EndGlobal
diff --git a/sdk/modelsrepository/Azure.Iot.ModelsRepository/CHANGELOG.md b/sdk/modelsrepository/Azure.Iot.ModelsRepository/CHANGELOG.md
@@ -0,0 +1,19 @@
+# Release History
+
+## 1.0.0-preview.1 (Unreleased)
+
+### New features
+
+- Initial preview of Azure.Iot.ModelsRepository SDK
+
+### Breaking changes
+
+- N/A
+
+### Added
+
+- N/A
+
+### Fixes and improvements
+
+- N/A
diff --git a/sdk/modelsrepository/Azure.Iot.ModelsRepository/CodeMaid.config b/sdk/modelsrepository/Azure.Iot.ModelsRepository/CodeMaid.config
@@ -0,0 +1,41 @@
+<?xml version="1.0" encoding="utf-8"?>
+<configuration>
+  <configSections>
+    <sectionGroup name="userSettings" type="System.Configuration.UserSettingsGroup, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089">
+      <section name="SteveCadwallader.CodeMaid.Properties.Settings" type="System.Configuration.ClientSettingsSection, System, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" />
+    </sectionGroup>
+  </configSections>
+  <userSettings>
+    <SteveCadwallader.CodeMaid.Properties.Settings>
+      <setting name="Cleaning_AutoCleanupOnFileSave" serializeAs="String">
+        <value>True</value>
+      </setting>
+      <setting name="Formatting_CommentXmlSpaceSingleTags" serializeAs="String">
+        <value>True</value>
+      </setting>
+      <setting name="Cleaning_InsertEndOfFileTrailingNewLine" serializeAs="String">
+        <value>True</value>
+      </setting>
+      <setting name="Formatting_CommentWrapColumn" serializeAs="String">
+        <value>120</value>
+      </setting>
+      <setting name="Formatting_CommentRunDuringCleanup" serializeAs="String">
+        <value>False</value>
+      </setting>
+      <setting name="Cleaning_UpdateFileHeaderCSharp" serializeAs="String">
+        <value>// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+</value>
+      </setting>
+      <setting name="Reorganizing_PrimaryOrderByAccessLevel" serializeAs="String">
+        <value>True</value>
+      </setting>
+      <setting name="Cleaning_PerformPartialCleanupOnExternal" serializeAs="String">
+        <value>1</value>
+      </setting>
+      <setting name="Progressing_ShowBuildProgressOnBuildStart" serializeAs="String">
+        <value>False</value>
+      </setting>
+    </SteveCadwallader.CodeMaid.Properties.Settings>
+  </userSettings>
+</configuration>
diff --git a/sdk/modelsrepository/Azure.Iot.ModelsRepository/Directory.Build.props b/sdk/modelsrepository/Azure.Iot.ModelsRepository/Directory.Build.props
@@ -0,0 +1,6 @@
+<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <!--
+    Add any shared properties you want for the projects under this package directory that need to be set before the auto imported Directory.Build.props
+  -->
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., Directory.Build.props))\Directory.Build.props" />
+</Project>
diff --git a/sdk/modelsrepository/Azure.Iot.ModelsRepository/README.md b/sdk/modelsrepository/Azure.Iot.ModelsRepository/README.md
@@ -0,0 +1,94 @@
+# Azure IoT Models Repository client library for .NET
+
+This library provides functionality for interacting with the [Azure IoT Models Repository][modelsrepository_iot_endpoint]. It also aims to provide a consistent experience working with digital twin model repositories following Azure IoT conventions.
+
+[Source code][source] | Package (nuget)
+
+## Getting started
+
+The complete Microsoft Azure SDK can be downloaded from the [Microsoft Azure downloads][microsoft_sdk_download] page, and it ships with support for building deployment packages, integrating with tooling, rich command-line tooling, and more.
+
+For the best development experience, developers should use the official Microsoft NuGet packages for libraries. NuGet packages are regularly updated with new functionality and bug fixes.
+
+### Install the package
+
+Install the Azure IoT Models Repository client library for .NET with [NuGet][nuget]:
+
+```PowerShell
+Install-Package Azure.Iot.ModelsRepository
+```
+
+View the package details at nuget.org.
+
+### Prerequisites
+
+- A models repository following [Azure IoT conventions][modelsrepository_conventions]
+  - The models repository can be located on the local filesystem or hosted on a webserver.
+  - Azure IoT hosts the global [Azure IoT Models Repository][modelsrepository_iot_endpoint] which the client will point to by default if no URI is provided.
+
+### Authenticate the client
+
+Currently no authentication mechanisms are supported in the client. The global endpoint is not tied to an Azure subscription and does not support auth. All models published are meant for anonymous public consumption.
+
+## Key concepts
+
+The Azure IoT Models Repository enables builders to manage and share digital twin models. The models are [JSON-LD][json_ld_reference] documents defined using the Digital Twins Definition Language ([DTDL][dtdlv2_reference]).
+
+The repository defines a pattern to store DTDL interfaces in a directory structure based on the Digital Twin Model Identifier (DTMI). You can locate an interface in the repository by converting the DTMI to a relative path. For example, the DTMI "`dtmi:com:example:Thermostat;1`" translates to `/dtmi/com/example/thermostat-1.json`.
+
+### Thread safety
+
+We guarantee that all client instance methods are thread-safe and independent of each other. See thread safety [guideline][thread_safety_guideline]. This ensures that the recommendation of reusing client instances is always safe, even across threads.
+
+### Additional concepts
+
+<!-- CLIENT COMMON BAR -->
+[Client options](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) |
+[Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) |
+[Long-running operations](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#consuming-long-running-operations-using-operationt) |
+[Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) |
+[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Diagnostics.md) |
+[Mocking](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#mocking) |
+[Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/)
+<!-- CLIENT COMMON BAR -->
+
+## Examples
+
+You can familiarize yourself with the client using [samples for IoT Models Repository][modelsrepository_samples].
+
+## Troubleshooting
+
+All service operations will throw RequestFailedException on failure, with helpful error codes and other information. The client also produces diagnostic events and logging which can be listened to with an [EventListener][eventsourcelistener_reference].
+
+## Next steps
+
+See implementation examples with our [code samples][modelsrepository_samples].
+
+## Contributing
+
+This project welcomes contributions and suggestions.
+Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution.
+For details, visit <https://cla.microsoft.com>
+
+When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment).
+Simply follow the instructions provided by the bot.
+You will only need to do this once across all repos using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct].
+For more information see the [Code of Conduct FAQ][code_of_conduct_faq] or contact opencode@microsoft.com with any additional questions or comments.
+
+<!-- LINKS -->
+[microsoft_sdk_download]: https://azure.microsoft.com/downloads/?sdk=net
+[azure_sdk_target_frameworks]: https://github.com/azure/azure-sdk-for-net#target-frameworks
+[source]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/modelsrepository/Azure.Iot.ModelsRepository/src
+[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
+[code_of_conduct_faq]: https://opensource.microsoft.com/codeofconduct/faq/
+[nuget]: https://www.nuget.org/
+[azure_core_library]: https://github.com/Azure/azure-sdk-for-net/tree/master/sdk/core/Azure.Core
+[modelsrepository_conventions]: https://github.com/Azure/iot-plugandplay-models-tools/wiki
+[modelsrepository_iot_endpoint]: https://devicemodels.azure.com/
+[modelsrepository_samples]: https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/modelsrepository/Azure.Iot.ModelsRepository/samples
+[thread_safety_guideline]: https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-service-methods-thread-safety
+[json_ld_reference]: https://json-ld.org
+[dtdlv2_reference]: https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md
+[eventsourcelistener_reference]: https://docs.microsoft.com/dotnet/api/azure.core.diagnostics.azureeventsourcelistener?view=azure-dotnet
diff --git a/...delsRepository/samples/ModelsRepositoryClientSamples/ModelsRepositoryClientSamples.csproj b/...delsRepository/samples/ModelsRepositoryClientSamples/ModelsRepositoryClientSamples.csproj
@@ -0,0 +1,15 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net5.0</TargetFramework>
+    <RootNamespace>Azure.Iot.ModelsRepository.Samples</RootNamespace>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <AdditionalFiles Include="..\readme.md" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\Azure.Iot.ModelsRepository.csproj" />
+  </ItemGroup>
+</Project>
diff --git a/...elsrepository/Azure.Iot.ModelsRepository/samples/ModelsRepositoryClientSamples/Program.cs b/...elsrepository/Azure.Iot.ModelsRepository/samples/ModelsRepositoryClientSamples/Program.cs
@@ -0,0 +1,53 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+using Azure.Core.Diagnostics;
+using System;
+using System.Collections.Generic;
+using System.Diagnostics.Tracing;
+using System.Net;
+using System.Threading.Tasks;
+
+namespace Azure.Iot.ModelsRepository.Samples
+{
+    public class Program
+    {
+        public static async Task Main(string[] args)
+        {
+            // Forward all the events written to the console output with a specific format.
+            using AzureEventSourceListener listener = new AzureEventSourceListener(
+                (e, message) =>
+                    Console.WriteLine("[{0:HH:mm:ss:fff}][{1}] {2}", DateTimeOffset.Now, e.Level, message),
+                level: EventLevel.Verbose);
+
+            await ResolveExistingAsync();
+            await TryResolveButNotFoundAsync();
+        }
+
+        private static async Task ResolveExistingAsync()
+        {
+            var dtmi = "dtmi:com:example:TemperatureController;1";
+            var client = new ModelsRepositoryClient();
+
+            IDictionary<string, string> models = await client.ResolveAsync(dtmi).ConfigureAwait(false);
+
+            Console.WriteLine($"{dtmi} resolved in {models.Count} interfaces.");
+        }
+
+        private static async Task TryResolveButNotFoundAsync()
+        {
+            var dtmi = "dtmi:com:example:NotFound;1";
+            var client = new ModelsRepositoryClient();
+
+            try
+            {
+                IDictionary<string, string> models = await client.ResolveAsync(dtmi).ConfigureAwait(false);
+                Console.WriteLine($"{dtmi} resolved in {models.Count} interfaces.");
+            }
+            catch (RequestFailedException ex) when (ex.Status == (int)HttpStatusCode.NotFound)
+            {
+                Console.WriteLine($"{dtmi} was not found in the default public models repository: {ex.Message}");
+            }
+        }
+    }
+}
diff --git a/sdk/modelsrepository/Azure.Iot.ModelsRepository/samples/readme.md b/sdk/modelsrepository/Azure.Iot.ModelsRepository/samples/readme.md
diff --git a/sdk/modelsrepository/Azure.Iot.ModelsRepository/src/Azure.Iot.ModelsRepository.csproj b/sdk/modelsrepository/Azure.Iot.ModelsRepository/src/Azure.Iot.ModelsRepository.csproj
@@ -0,0 +1,57 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <AssemblyTitle>Azure IoT Models Repository SDK</AssemblyTitle>
+    <TargetFrameworks>$(RequiredTargetFrameworks)</TargetFrameworks>
+
+    <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+  </PropertyGroup>
+
+  <!-- Nuget properties -->
+  <PropertyGroup>
+    <PackageTags>IoT;ModelsRepository;Pnp;DigitalTwins$(PackageCommonTags)</PackageTags>
+    <Description>SDK for the Azure IoT Models Repository</Description>
+    <Version>1.0.0-preview.1</Version>
+  </PropertyGroup>
+
+
+  <ItemGroup>
+    <PackageReference Include="System.Text.Json" />
+  </ItemGroup>
+
+  <!-- Common source from Azure.Core -->
+  <ItemGroup>
+    <Compile Include="$(AzureCoreSharedSources)ArrayBufferWriter.cs">
+      <LinkBase>Shared\Azure.Core</LinkBase>
+    </Compile>
+    <Compile Include="$(AzureCoreSharedSources)ClientDiagnostics.cs">
+      <LinkBase>Shared\Azure.Core</LinkBase>
+    </Compile>
+    <Compile Include="$(AzureCoreSharedSources)ContentTypeUtilities.cs">
+      <LinkBase>Shared\Azure.Core</LinkBase>
+    </Compile>
+    <Compile Include="$(AzureCoreSharedSources)DiagnosticScope.cs">
+      <LinkBase>Shared\Azure.Core</LinkBase>
+    </Compile>
+    <Compile Include="$(AzureCoreSharedSources)DiagnosticScopeFactory.cs">
+      <LinkBase>Shared\Azure.Core</LinkBase>
+    </Compile>
+    <Compile Include="$(AzureCoreSharedSources)HttpMessageSanitizer.cs">
+      <LinkBase>Shared\Azure.Core</LinkBase>
+    </Compile>
+    <Compile Include="$(AzureCoreSharedSources)TaskExtensions.cs">
+      <LinkBase>Shared\Azure.Core</LinkBase>
+    </Compile>
+    <Compile Include="$(AzureCoreSharedSources)OperationHelpers.cs">
+      <LinkBase>Shared\Azure.Core</LinkBase>
+    </Compile>
+    <Compile Include="$(AzureCoreSharedSources)Argument.cs">
+      <LinkBase>Shared\Azure.Core</LinkBase>
+    </Compile>
+    <Compile Include="$(AzureCoreSharedSources)AzureResourceProviderNamespaceAttribute.cs">
+      <LinkBase>Shared\Azure.Core</LinkBase>
+    </Compile>
+  </ItemGroup>
+
+  <Import Project="$(RepoRoot)\sdk\core\Azure.Core\src\Azure.Core.props" />
+</Project>
diff --git a/sdk/modelsrepository/Azure.Iot.ModelsRepository/src/DependencyResolutionOption.cs b/sdk/modelsrepository/Azure.Iot.ModelsRepository/src/DependencyResolutionOption.cs
@@ -0,0 +1,26 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+namespace Azure.Iot.ModelsRepository
+{
+    /// <summary>
+    /// The dependency processing options.
+    /// </summary>
+    public enum DependencyResolutionOption
+    {
+        /// <summary>
+        /// Do not process external dependencies.
+        /// </summary>
+        Disabled,
+
+        /// <summary>
+        /// Enable external dependencies.
+        /// </summary>
+        Enabled,
+
+        /// <summary>
+        /// Try to get external dependencies using .expanded.json.
+        /// </summary>
+        TryFromExpanded
+    }
+}