Remove vendored EnvironmentVariablesConfigurationProvider

stevejgordon · stevejgordon · commit 34d71f764665 · 2026-04-23T14:28:58.000+01:00
- Update dependencies to use Microsoft.Extensions.Configuration.EnvironmentVariables.
- Add basic E2E test to validate existing ENV VAR behaviour continues to function.
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -12,25 +12,29 @@
   -->
   <ItemGroup>
     <!-- Default to latest versions for all TFMs -->
+    <PackageVersion Include="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="[10.0.0,)" />
     <PackageVersion Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="[10.0.0,)" />
     <PackageVersion Include="Microsoft.Extensions.Diagnostics.Abstractions" Version="[10.0.0,)" />
     <PackageVersion Include="Microsoft.Extensions.Hosting.Abstractions" Version="[10.0.0,)" />
     <PackageVersion Include="Microsoft.Extensions.Logging.Configuration" Version="[10.0.0,)" />
   </ItemGroup>
   <!-- Version overrides for specific netX.0 TFMs -->
   <ItemGroup Condition="'$(TargetFramework)' == 'net8.0'">
+    <PackageVersion Update="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="[8.0.0,)" />
     <PackageVersion Update="Microsoft.Extensions.DependencyInjection.Abstractions" Version="[8.0.0,)" />
     <PackageVersion Update="Microsoft.Extensions.Diagnostics.Abstractions" Version="[8.0.0,)" />
     <PackageVersion Update="Microsoft.Extensions.Hosting.Abstractions" Version="[8.0.0,)" />
     <PackageVersion Update="Microsoft.Extensions.Logging.Configuration" Version="[8.0.0,)" />
   </ItemGroup>
   <ItemGroup Condition="'$(TargetFramework)' == 'net9.0'">
+    <PackageVersion Update="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="[9.0.0,)" />
     <PackageVersion Update="Microsoft.Extensions.DependencyInjection.Abstractions" Version="[9.0.0,)" />
     <PackageVersion Update="Microsoft.Extensions.Diagnostics.Abstractions" Version="[9.0.0,)" />
     <PackageVersion Update="Microsoft.Extensions.Hosting.Abstractions" Version="[9.0.0,)" />
     <PackageVersion Update="Microsoft.Extensions.Logging.Configuration" Version="[9.0.0,)" />
   </ItemGroup>
   <ItemGroup Condition="'$(TargetFramework)' == 'net10.0'">
+    <PackageVersion Update="Microsoft.Extensions.Configuration.EnvironmentVariables" Version="[10.0.0,)" />
     <PackageVersion Update="Microsoft.Extensions.DependencyInjection.Abstractions" Version="[10.0.0,)" />
     <PackageVersion Update="Microsoft.Extensions.Diagnostics.Abstractions" Version="[10.0.0,)" />
     <PackageVersion Update="Microsoft.Extensions.Hosting.Abstractions" Version="[10.0.0,)" />
diff --git a/OpenTelemetry.slnx b/OpenTelemetry.slnx
@@ -161,11 +161,6 @@
     <File Path="src/Shared/Configuration/IConfigurationExtensionsLogger.cs" />
     <File Path="src/Shared/Configuration/OpenTelemetryConfigurationExtensions.cs" />
   </Folder>
-  <Folder Name="/Shared/EnvironmentVariables/">
-    <File Path="src/Shared/EnvironmentVariables/EnvironmentVariablesConfigurationProvider.cs" />
-    <File Path="src/Shared/EnvironmentVariables/EnvironmentVariablesConfigurationSource.cs" />
-    <File Path="src/Shared/EnvironmentVariables/EnvironmentVariablesExtensions.cs" />
-  </Folder>
   <Folder Name="/Shared/Metrics/">
     <File Path="src/Shared/Metrics/Base2ExponentialBucketHistogramHelper.cs" />
   </Folder>
diff --git a/src/OpenTelemetry.Exporter.Zipkin/CHANGELOG.md b/src/OpenTelemetry.Exporter.Zipkin/CHANGELOG.md
@@ -6,6 +6,12 @@ Notes](../../RELEASENOTES.md).
 
 ## Unreleased
 
+* Dropped the vendored `EnvironmentVariablesConfigurationProvider` copy; the
+  provider is now sourced transitively from the
+  `Microsoft.Extensions.Configuration.EnvironmentVariables` package referenced
+  by `OpenTelemetry`. No public API or behavioural change.
+  ([#7146](https://github.com/open-telemetry/opentelemetry-dotnet/pull/7146))
+
 ## 1.15.3
 
 Released 2026-Apr-21
diff --git a/src/OpenTelemetry.Exporter.Zipkin/OpenTelemetry.Exporter.Zipkin.csproj b/src/OpenTelemetry.Exporter.Zipkin/OpenTelemetry.Exporter.Zipkin.csproj
@@ -15,7 +15,6 @@
     <Compile Include="$(RepoRoot)\src\Shared\Guard.cs" Link="Includes\Guard.cs" />
     <Compile Include="$(RepoRoot)\src\Shared\ResourceSemanticConventions.cs" Link="Includes\ResourceSemanticConventions.cs" />
     <Compile Include="$(RepoRoot)\src\Shared\ActivityHelperExtensions.cs" Link="Includes\ActivityHelperExtensions.cs" />
-    <Compile Include="$(RepoRoot)\src\Shared\EnvironmentVariables\*.cs" Link="Includes\EnvironmentVariables\%(Filename).cs" />
     <Compile Include="$(RepoRoot)\src\Shared\ExceptionExtensions.cs" Link="Includes\ExceptionExtensions.cs" />
     <Compile Include="$(RepoRoot)\src\Shared\Shims\Lock.cs" Link="Includes\Shims\Lock.cs" />
     <Compile Include="$(RepoRoot)\src\Shared\Options\*.cs" Link="Includes\Options\%(Filename).cs" />
diff --git a/src/OpenTelemetry/CHANGELOG.md b/src/OpenTelemetry/CHANGELOG.md
@@ -6,6 +6,13 @@ Notes](../../RELEASENOTES.md).
 
 ## Unreleased
 
+* Replaced the vendored copy of
+  `EnvironmentVariablesConfigurationProvider` with a direct
+  `Microsoft.Extensions.Configuration.EnvironmentVariables` package dependency.
+  Consumers gain automatic pickup of upstream bug fixes and security patches;
+  no public API or behavioural change.
+  ([#7146](hhttps://github.com/open-telemetry/opentelemetry-dotnet/pull/7146))
+
 ## 1.15.3
 
 Released 2026-Apr-21
diff --git a/src/OpenTelemetry/OpenTelemetry.csproj b/src/OpenTelemetry/OpenTelemetry.csproj
@@ -8,6 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" />
     <PackageReference Include="Microsoft.Extensions.Diagnostics.Abstractions" />
     <PackageReference Include="Microsoft.Extensions.Logging.Configuration" />
   </ItemGroup>
@@ -19,7 +20,6 @@
   <ItemGroup>
     <Compile Include="$(RepoRoot)\src\Shared\AssemblyVersionExtensions.cs" Link="Includes\AssemblyVersionExtensions.cs" />
     <Compile Include="$(RepoRoot)\src\Shared\Configuration\*.cs" Link="Includes\Configuration\%(Filename).cs" />
-    <Compile Include="$(RepoRoot)\src\Shared\EnvironmentVariables\*.cs" Link="Includes\EnvironmentVariables\%(Filename).cs" />
     <Compile Include="$(RepoRoot)\src\Shared\MathHelper.cs" Link="Includes\MathHelper.cs" />
     <Compile Include="$(RepoRoot)\src\Shared\Options\*.cs" Link="Includes\Options\%(Filename).cs" />
     <Compile Include="$(RepoRoot)\src\Shared\ResourceSemanticConventions.cs" Link="Includes\ResourceSemanticConventions.cs" />
diff --git a/src/Shared/EnvironmentVariables/EnvironmentVariablesConfigurationProvider.cs b/src/Shared/EnvironmentVariables/EnvironmentVariablesConfigurationProvider.cs
diff --git a/src/Shared/EnvironmentVariables/EnvironmentVariablesConfigurationSource.cs b/src/Shared/EnvironmentVariables/EnvironmentVariablesConfigurationSource.cs
diff --git a/src/Shared/EnvironmentVariables/EnvironmentVariablesExtensions.cs b/src/Shared/EnvironmentVariables/EnvironmentVariablesExtensions.cs
diff --git a/test/OpenTelemetry.Tests/Resources/EnvironmentVariableResourceIntegrationTests.cs b/test/OpenTelemetry.Tests/Resources/EnvironmentVariableResourceIntegrationTests.cs
@@ -0,0 +1,33 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+using OpenTelemetry.Tests;
+using OpenTelemetry.Trace;
+using Xunit;
+
+namespace OpenTelemetry.Resources.Tests;
+
+[Collection(EnvVarsCollectionDefinition.Name)]
+public sealed class EnvironmentVariableResourceIntegrationTests
+{
+    [Fact]
+    public void TracerProvider_PopulatesResourceFromEnvironmentVariables()
+    {
+        // End-to-end smoke for the env-var > IConfiguration > Resource chain used by
+        // ResourceBuilderExtensions.AddEnvironmentVariableDetector. Drives real OTEL
+        // spec variables through ResourceBuilder.CreateDefault and reads the live
+        // Resource off the built TracerProvider. Catches any regression that breaks
+        // the pipeline between Environment and the SDK's exported resource.
+        using (new EnvironmentVariableScope("OTEL_SERVICE_NAME", "e2e-env-var-service"))
+        using (new EnvironmentVariableScope("OTEL_RESOURCE_ATTRIBUTES", "deployment.environment=test,region=eu-west"))
+        {
+            using var tracerProvider = Sdk.CreateTracerProviderBuilder().Build();
+
+            var attributes = tracerProvider.GetResource().Attributes;
+
+            Assert.Contains(new KeyValuePair<string, object>("service.name", "e2e-env-var-service"), attributes);
+            Assert.Contains(new KeyValuePair<string, object>("deployment.environment", "test"), attributes);
+            Assert.Contains(new KeyValuePair<string, object>("region", "eu-west"), attributes);
+        }
+    }
+}
diff --git a/test/OpenTelemetry.Tests/Resources/OtelEnvResourceDetectorTests.cs b/test/OpenTelemetry.Tests/Resources/OtelEnvResourceDetectorTests.cs
@@ -2,10 +2,12 @@
 // SPDX-License-Identifier: Apache-2.0
 
 using Microsoft.Extensions.Configuration;
+using OpenTelemetry.Tests;
 using Xunit;
 
 namespace OpenTelemetry.Resources.Tests;
 
+[Collection(EnvVarsCollectionDefinition.Name)]
 public sealed class OtelEnvResourceDetectorTests : IDisposable
 {
     public OtelEnvResourceDetectorTests()
diff --git a/test/OpenTelemetry.Tests/Resources/OtelServiceNameEnvVarDetectorTests.cs b/test/OpenTelemetry.Tests/Resources/OtelServiceNameEnvVarDetectorTests.cs
@@ -2,10 +2,12 @@
 // SPDX-License-Identifier: Apache-2.0
 
 using Microsoft.Extensions.Configuration;
+using OpenTelemetry.Tests;
 using Xunit;
 
 namespace OpenTelemetry.Resources.Tests;
 
+[Collection(EnvVarsCollectionDefinition.Name)]
 public sealed class OtelServiceNameEnvVarDetectorTests : IDisposable
 {
     public OtelServiceNameEnvVarDetectorTests()
diff --git a/test/OpenTelemetry.Tests/Shared/EnvVarsCollectionDefinition.cs b/test/OpenTelemetry.Tests/Shared/EnvVarsCollectionDefinition.cs
@@ -0,0 +1,21 @@
+// Copyright The OpenTelemetry Authors
+// SPDX-License-Identifier: Apache-2.0
+
+using Xunit;
+
+namespace OpenTelemetry.Tests;
+
+/// <summary>
+/// Serialization anchor for tests that mutate process-global environment
+/// variables. Tests that set or clear env vars should carry
+/// <c>[Collection(EnvVarsCollectionDefinition.Name)]</c> so they run
+/// sequentially with each other, avoiding cross-class races on shared env
+/// var state.
+/// </summary>
+[CollectionDefinition(Name, DisableParallelization = true)]
+#pragma warning disable CA1515 // xUnit1027 requires [CollectionDefinition] classes to be public.
+public sealed class EnvVarsCollectionDefinition
+#pragma warning restore CA1515
+{
+    public const string Name = "EnvVars";
+}
