[repo+ci] Use SDK dotnet format in CI (#1339)

open-telemetry · Sep 7, 2023 · a5a584e · a5a584e
1 parent ebc40a0
commit a5a584e
Show file tree

Hide file tree

Showing 30 changed files with 160 additions and 200 deletions.
diff --git a/.github/workflows/dotnet-format.yml b/.github/workflows/dotnet-format.yml
@@ -23,8 +23,12 @@ jobs:
     - name: Setup dotnet
       uses: actions/setup-dotnet@v3
 
-    - name: Install format tool
-      run: dotnet tool install -g dotnet-format
+    - name: Install dependencies
+      run: dotnet restore
+
+    - name: Protobuf compile
+      run: dotnet build -t:Protobuf_Compile --no-restore
+      continue-on-error: true # Note: Projects without Grpc.Tools won't have the Protobuf_Compile target which generates an error
 
     - name: dotnet format
-      run: dotnet-format --folder --check
+      run: dotnet format opentelemetry-dotnet-contrib.sln --no-restore --verify-no-changes
diff --git a/build/Common.prod.props b/build/Common.prod.props
@@ -13,7 +13,6 @@
     <CodeAnalysisRuleSet>$(MSBuildThisFileDirectory)/OpenTelemetryContrib.prod.ruleset</CodeAnalysisRuleSet>
     <NoWarn>$(NoWarn),1573,1712</NoWarn>
     <PackageOutputPath Condition="$(Build_ArtifactStagingDirectory) != ''">$(Build_ArtifactStagingDirectory)</PackageOutputPath>
-    <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <!--<MinVerVerbosity>detailed</MinVerVerbosity>-->
     <PackageTags>Observability;OpenTelemetry;Monitoring;Telemetry</PackageTags>
   </PropertyGroup>

diff --git a/build/Common.props b/build/Common.props
@@ -1,6 +1,6 @@
 <Project>
   <PropertyGroup>
-    <LangVersion>11.0</LangVersion>
+    <LangVersion>latest</LangVersion>
     <SignAssembly>true</SignAssembly>
     <RepoRoot>$([System.IO.Directory]::GetParent($(MSBuildThisFileDirectory)).Parent.FullName)</RepoRoot>
     <AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)debug.snk</AssemblyOriginatorKeyFile>
@@ -10,7 +10,7 @@
     <NetMinimumSupportedVersion>net6.0</NetMinimumSupportedVersion>
     <NetStandardMinimumSupportedVersion>netstandard2.0</NetStandardMinimumSupportedVersion>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
-    <AnalysisLevel>latest-All</AnalysisLevel>
+    <AnalysisLevel>latest-all</AnalysisLevel>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(Configuration)'=='Debug'">

diff --git a/build/Common.targets b/build/Common.targets
@@ -1,7 +1,3 @@
 <Project>
 
-  <PropertyGroup Condition="'$(EnableAnalysis)'=='true' and '$(SkipAnalysis)'!='true'">
-    <AnalysisLevel>latest-all</AnalysisLevel>
-  </PropertyGroup>
-
 </Project>
diff --git a/examples/AspNet/App_Start/RouteConfig.cs b/examples/AspNet/App_Start/RouteConfig.cs
@@ -17,20 +17,19 @@
 using System.Web.Mvc;
 using System.Web.Routing;
 
-namespace Examples.AspNet
+namespace Examples.AspNet;
+
+public class RouteConfig
 {
-    public class RouteConfig
+    public static void RegisterRoutes(RouteCollection routes)
     {
-        public static void RegisterRoutes(RouteCollection routes)
-        {
-            routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
+        routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
 
-            routes.MapMvcAttributeRoutes();
+        routes.MapMvcAttributeRoutes();
 
-            routes.MapRoute(
-                name: "Default",
-                url: "{controller}/{action}/{id}",
-                defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional });
-        }
+        routes.MapRoute(
+            name: "Default",
+            url: "{controller}/{action}/{id}",
+            defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional });
     }
 }
diff --git a/examples/AspNet/Controllers/HomeController.cs b/examples/AspNet/Controllers/HomeController.cs
@@ -21,11 +21,13 @@ namespace Examples.AspNet.Controllers;
 public class HomeController : Controller
 {
     // For testing traditional routing. Ex: https://localhost:XXXX/
+    [HttpGet]
     public ActionResult Index()
     {
         return this.View();
     }
 
+    [HttpGet]
     [Route("about_attr_route/{customerId}")] // For testing attribute routing. Ex: https://localhost:XXXX/about_attr_route
     public ActionResult About(int? customerId)
     {

diff --git a/examples/AspNet/Controllers/WeatherForecastController.cs b/examples/AspNet/Controllers/WeatherForecastController.cs
@@ -57,7 +57,7 @@ public async Task<IEnumerable<WeatherForecast>> Get(int customerId)
     {
         if (customerId < 0)
         {
-            throw new ArgumentException();
+            throw new ArgumentOutOfRangeException(nameof(customerId), "CustomerId should be 0 or greater.");
         }
 
         // Making http calls here to serve as an example of
@@ -141,31 +141,31 @@ private static async Task RequestGoogleHomPageViaHttpClient()
     {
         using var request = new HttpClient();
 
-        using var response = await request.GetAsync("http://www.google.com").ConfigureAwait(false);
+        using var response = await request.GetAsync(new Uri("http://www.google.com")).ConfigureAwait(false);
 
         response.EnsureSuccessStatusCode();
     }
 
     // Test dependency collection via legacy HttpWebRequest sync.
     private static void RequestGoogleHomPageViaHttpWebRequestLegacySync()
     {
-        var request = WebRequest.Create("http://www.google.com/?sync");
+        var request = WebRequest.Create(new Uri("http://www.google.com/?sync"));
 
         using var response = request.GetResponse();
     }
 
     // Test dependency collection via legacy HttpWebRequest async.
     private static async Task RequestGoogleHomPageViaHttpWebRequestLegacyAsync()
     {
-        var request = (HttpWebRequest)WebRequest.Create($"http://www.google.com/?async");
+        var request = (HttpWebRequest)WebRequest.Create(new Uri("http://www.google.com/?async"));
 
         using var response = await request.GetResponseAsync().ConfigureAwait(false);
     }
 
     // Test dependency collection via legacy HttpWebRequest IAsyncResult.
     private static void RequestGoogleHomPageViaHttpWebRequestLegacyAsyncResult()
     {
-        var request = (HttpWebRequest)WebRequest.Create($"http://www.google.com/?async");
+        var request = (HttpWebRequest)WebRequest.Create(new Uri("http://www.google.com/?async"));
 
         var asyncResult = request.BeginGetResponse(null, null);
 
@@ -181,7 +181,9 @@ private async Task RequestInvalidViaHttpClient()
 
             // This request is not available over SSL and will throw a handshake exception.
 
-            using var response = await request.GetAsync(this.Url.Content("~/subroute/10").Replace("http", "https")).ConfigureAwait(false);
+            var requestUri = this.GenerateContentRequestUri("~/subroute/10", uri => uri.Replace("http", "https"));
+
+            using var response = await request.GetAsync(requestUri).ConfigureAwait(false);
 
             Debug.Fail("Unreachable");
         }
@@ -197,7 +199,8 @@ private async Task RequestValidThatReturnsFailedViaHttpClient()
 
         // This request will return a 500 error because customerId should be >= 0;
 
-        using var response = await request.GetAsync(this.Url.Content("~/subroute/-1")).ConfigureAwait(false);
+        using var response = await request.GetAsync(
+            this.GenerateContentRequestUri("~/subroute/-1")).ConfigureAwait(false);
 
         Debug.Assert(response.StatusCode == HttpStatusCode.InternalServerError, "response.StatusCode is InternalServerError");
     }
@@ -209,8 +212,21 @@ private async Task RequestValidThatSpawnsSubSpansViaHttpClient()
 
         // This request will return successfully and cause a bunch of sub-spans;
 
-        using var response = await request.GetAsync(this.Url.Content("~/subroute/10")).ConfigureAwait(false);
+        using var response = await request.GetAsync(
+            this.GenerateContentRequestUri("~/subroute/10")).ConfigureAwait(false);
 
         response.EnsureSuccessStatusCode();
     }
+
+    private Uri GenerateContentRequestUri(string path, Func<string, string> transform = null)
+    {
+        var rawUri = this.Url.Content(path);
+
+        if (transform != null)
+        {
+            rawUri = transform(rawUri);
+        }
+
+        return new(rawUri);
+    }
 }
diff --git a/examples/AspNet/Examples.AspNet.csproj b/examples/AspNet/Examples.AspNet.csproj
@@ -1,46 +1,19 @@
-<Project ToolsVersion="15.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
-  <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
+<Project>
+  <Import Project="Sdk.props" Sdk="Microsoft.NET.Sdk" />
   <PropertyGroup>
-    <RestoreProjectStyle>PackageReference</RestoreProjectStyle>
-    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
-    <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
-    <ProductVersion>
-    </ProductVersion>
-    <SchemaVersion>2.0</SchemaVersion>
-    <ProjectGuid>{9A4E3A68-904B-4835-A3C8-F664B73098DB}</ProjectGuid>
-    <ProjectTypeGuids>{349c5851-65df-11da-9384-00065b846f21};{fae04ec0-301f-11d3-bf4b-00c04f79efbc}</ProjectTypeGuids>
+    <TargetFramework>net48</TargetFramework>
     <OutputType>Library</OutputType>
-    <AppDesignerFolder>Properties</AppDesignerFolder>
-    <RootNamespace>OpenTelemetry.Exporter.AspNet</RootNamespace>
-    <AssemblyName>OpenTelemetry.Exporter.AspNet</AssemblyName>
-    <TargetFrameworkVersion>v4.8</TargetFrameworkVersion>
-    <UseIISExpress>true</UseIISExpress>
-    <Use64BitIISExpress />
-    <IISExpressSSLPort>
-    </IISExpressSSLPort>
-    <IISExpressAnonymousAuthentication />
-    <IISExpressWindowsAuthentication />
-    <IISExpressUseClassicPipelineMode />
-    <UseGlobalApplicationHostFile />
-  </PropertyGroup>
-  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
-    <DebugSymbols>true</DebugSymbols>
-    <DebugType>full</DebugType>
-    <Optimize>false</Optimize>
-    <OutputPath>bin\</OutputPath>
-    <DefineConstants>DEBUG;TRACE</DefineConstants>
-    <ErrorReport>prompt</ErrorReport>
-    <WarningLevel>4</WarningLevel>
-  </PropertyGroup>
-  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
-    <DebugSymbols>true</DebugSymbols>
-    <DebugType>pdbonly</DebugType>
-    <Optimize>true</Optimize>
     <OutputPath>bin\</OutputPath>
-    <DefineConstants>TRACE</DefineConstants>
-    <ErrorReport>prompt</ErrorReport>
-    <WarningLevel>4</WarningLevel>
+    <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
+    <AppendRuntimeIdentifierToOutputPath>false</AppendRuntimeIdentifierToOutputPath>
+    <AppConfig>web.config</AppConfig>
+    <EnableDefaultCompileItems>false</EnableDefaultCompileItems>
   </PropertyGroup>
+  <ItemGroup>
+    <ProjectCapability Include="DotNetCoreWeb" />
+    <ProjectCapability Include="SupportsSystemWeb" />
+    <ProjectCapability Include="LegacyRazorEditor" />
+  </ItemGroup>
   <ItemGroup>
     <Reference Include="Microsoft.CSharp" />
     <Reference Include="System.Configuration" />
@@ -87,16 +60,13 @@
     <PackageReference Include="OpenTelemetry.Exporter.Prometheus.HttpListener" Version="1.5.0-rc.1" />
   </ItemGroup>
   <ItemGroup>
-    <ProjectReference Include="$(RepoRoot)\src\OpenTelemetry.Instrumentation.AspNet\OpenTelemetry.Instrumentation.AspNet.csproj">
-      <Project>{582b70b5-0067-4d9a-abf2-623f502be9a9}</Project>
-      <Name>OpenTelemetry.Instrumentation.AspNet</Name>
-    </ProjectReference>
+    <ProjectReference Include="$(RepoRoot)\src\OpenTelemetry.Instrumentation.AspNet\OpenTelemetry.Instrumentation.AspNet.csproj" />
   </ItemGroup>
   <PropertyGroup>
     <VisualStudioVersion Condition="'$(VisualStudioVersion)' == ''">10.0</VisualStudioVersion>
     <VSToolsPath Condition="'$(VSToolsPath)' == ''">$(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion)</VSToolsPath>
   </PropertyGroup>
-  <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
+  <Import Project="Sdk.targets" Sdk="Microsoft.NET.Sdk" />
   <Import Project="$(VSToolsPath)\WebApplications\Microsoft.WebApplication.targets" Condition="Exists('$(VSToolsPath)\WebApplications\Microsoft.WebApplication.targets')" />
   <Target Name="MvcBuildViews" AfterTargets="AfterBuild" Condition="'$(MvcBuildViews)'=='true'">
     <AspNetCompiler VirtualPath="temp" PhysicalPath="$(WebProjectOutputDir)" />
@@ -109,22 +79,4 @@
     <BuildDependsOnOriginalValue>$(BuildDependsOn)</BuildDependsOnOriginalValue>
     <BuildDependsOn>SkipBuildWithoutVisualStudio</BuildDependsOn>
   </PropertyGroup>
-  <ProjectExtensions>
-    <VisualStudio>
-      <FlavorProperties GUID="{349c5851-65df-11da-9384-00065b846f21}">
-        <WebProjectProperties>
-          <UseIIS>True</UseIIS>
-          <AutoAssignPort>True</AutoAssignPort>
-          <DevelopmentServerPort>0</DevelopmentServerPort>
-          <DevelopmentServerVPath>/</DevelopmentServerVPath>
-          <IISUrl>http://localhost:56171/</IISUrl>
-          <NTLMAuthentication>False</NTLMAuthentication>
-          <UseCustomServer>False</UseCustomServer>
-          <CustomServerUrl>
-          </CustomServerUrl>
-          <SaveServerSettingsInUserFile>False</SaveServerSettingsInUserFile>
-        </WebProjectProperties>
-      </FlavorProperties>
-    </VisualStudio>
-  </ProjectExtensions>
 </Project>
diff --git a/examples/AspNet/Global.asax.cs b/examples/AspNet/Global.asax.cs
@@ -40,15 +40,15 @@ protected void Application_Start()
              .AddAspNetInstrumentation()
              .AddHttpClientInstrumentation();
 
-        switch (ConfigurationManager.AppSettings["UseExporter"].ToLowerInvariant())
+        switch (ConfigurationManager.AppSettings["UseExporter"].ToUpperInvariant())
         {
-            case "zipkin":
+            case "ZIPKIN":
                 builder.AddZipkinExporter(zipkinOptions =>
                 {
                     zipkinOptions.Endpoint = new Uri(ConfigurationManager.AppSettings["ZipkinEndpoint"]);
                 });
                 break;
-            case "otlp":
+            case "OTLP":
                 builder.AddOtlpExporter(otlpOptions =>
                     {
                         otlpOptions.Endpoint = new Uri(ConfigurationManager.AppSettings["OtlpEndpoint"]);
@@ -68,15 +68,15 @@ protected void Application_Start()
         var meterBuilder = Sdk.CreateMeterProviderBuilder()
              .AddAspNetInstrumentation();
 
-        switch (ConfigurationManager.AppSettings["UseMetricsExporter"].ToLowerInvariant())
+        switch (ConfigurationManager.AppSettings["UseMetricsExporter"].ToUpperInvariant())
         {
-            case "otlp":
+            case "OTLP":
                 meterBuilder.AddOtlpExporter(otlpOptions =>
                 {
                     otlpOptions.Endpoint = new Uri(ConfigurationManager.AppSettings["OtlpEndpoint"]);
                 });
                 break;
-            case "prometheus":
+            case "PROMETHEUS":
                 meterBuilder.AddPrometheusHttpListener();
                 break;
             default:

diff --git a/examples/AspNet/Properties/AssemblyInfo.cs b/examples/AspNet/Properties/AssemblyInfo.cs
@@ -14,37 +14,9 @@
 // limitations under the License.
 // </copyright>
 
-using System.Reflection;
 using System.Runtime.InteropServices;
 
-// General Information about an assembly is controlled through the following
-// set of attributes. Change these attribute values to modify the information
-// associated with an assembly.
-[assembly: AssemblyTitle("Examples.AspNet")]
-[assembly: AssemblyDescription("")]
-[assembly: AssemblyConfiguration("")]
-[assembly: AssemblyCompany("")]
-[assembly: AssemblyProduct("Examples.AspNet")]
-[assembly: AssemblyCopyright("Copyright @ 2020")]
-[assembly: AssemblyTrademark("")]
-[assembly: AssemblyCulture("")]
-
 // Setting ComVisible to false makes the types in this assembly not visible
 // to COM components.  If you need to access a type in this assembly from
 // COM, set the ComVisible attribute to true on that type.
 [assembly: ComVisible(false)]
-
-// The following GUID is for the ID of the typelib if this project is exposed to COM
-[assembly: Guid("9a4e3a68-904b-4835-a3c8-f664b73098db")]
-
-// Version information for an assembly consists of the following four values:
-//
-//      Major Version
-//      Minor Version
-//      Build Number
-//      Revision
-//
-// You can specify all the values or you can default the Revision and Build Numbers
-// by using the '*' as shown below:
-[assembly: AssemblyVersion("1.0.0.0")]
-[assembly: AssemblyFileVersion("1.0.0.0")]
diff --git a/examples/AspNet/Properties/launchSettings.json b/examples/AspNet/Properties/launchSettings.json
@@ -0,0 +1,18 @@
+{
+  "iisSettings": {
+    "windowsAuthentication": false,
+    "anonymousAuthentication": true,
+    "iisExpress": {
+      "applicationUrl": "http://localhost:23307"
+    }
+  },
+  "profiles": {
+    "IIS Express": {
+      "commandName": "IISExpress",
+      "launchBrowser": true,
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}