Change Environment.Version to return product version (#22664)
authorJan Kotas <jkotas@microsoft.com>
Sat, 23 Feb 2019 01:56:02 +0000 (17:56 -0800)
committerGitHub <noreply@github.com>
Sat, 23 Feb 2019 01:56:02 +0000 (17:56 -0800)
* Change Environment.Version to return product version

- Contributes to https://github.com/dotnet/corefx/issues/31099
- Use AssemblyInformationalVersion attribute as fallback

* Add sanity test for Environment.Version

* Disable CodeDom tests

* Fix test assembly name

src/System.Private.CoreLib/System.Private.CoreLib.csproj
src/System.Private.CoreLib/shared/System/Environment.cs
tests/CoreFX/CoreFX.issues.json
tests/src/CoreMangLib/system/environment/environment_version.cs [new file with mode: 0644]
tests/src/CoreMangLib/system/environment/environment_version.csproj [new file with mode: 0644]

index 5e98274..6bfc44c 100644 (file)
     <SkipCommonResourcesIncludes>true</SkipCommonResourcesIncludes>
     <DocumentationFile>$(OutputPath)$(MSBuildProjectName).xml</DocumentationFile>
   </PropertyGroup>
+
+  <!-- Approximate Arcade version string https://github.com/dotnet/arcade/blob/master/Documentation/CorePackages/Versioning.md -->
+  <!-- This workaround should be removed once CoreCLR repo is updated to use Arcade -->
+  <PropertyGroup>
+    <InformationalVersion>$(VersionPrefix)</InformationalVersion>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(PreReleaseLabel)' != ''">
+    <InformationalVersion>$(InformationalVersion)-$(PreReleaseLabel).$(BuildNumberMajor).$(BuildNumberMinor)</InformationalVersion>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(LatestCommit)' != ''">
+    <InformationalVersion>$(InformationalVersion)+$(LatestCommit)</InformationalVersion>
+  </PropertyGroup>
+
   <!-- Add Serviceable attribute to the project's metadata -->
   <ItemGroup>
     <AssemblyMetadata Include="Serviceable">
index bb99dc8..ade5091 100644 (file)
@@ -129,10 +129,30 @@ namespace System
 
         public static bool UserInteractive => true;
 
-        // Previously this represented the File version of mscorlib.dll.  Many other libraries in the framework and outside took dependencies on the first three parts of this version 
-        // remaining constant throughout 4.x.  From 4.0 to 4.5.2 this was fine since the file version only incremented the last part. Starting with 4.6 we switched to a file versioning
-        // scheme that matched the product version.  In order to preserve compatibility with existing libraries, this needs to be hard-coded.
-        public static Version Version => new Version(4, 0, 30319, 42000);
+        public static Version Version
+        {
+            get
+            {
+                // FX_PRODUCT_VERSION is expected to be set by the host
+                string versionString = (string)AppContext.GetData("FX_PRODUCT_VERSION");
+
+                if (versionString == null)
+                {
+                    // Use AssemblyInformationalVersionAttribute as fallback if the exact product version is not specified by the host
+                    versionString = typeof(object).Assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>()?.InformationalVersion;
+                }
+
+                ReadOnlySpan<char> versionSpan = versionString.AsSpan();
+
+                // Strip optional suffixes
+                int separatorIndex = versionSpan.IndexOfAny("-+ ");
+                if (separatorIndex != -1)
+                    versionSpan = versionSpan.Slice(0, separatorIndex);
+
+                // Return zeros rather then failing if the version string fails to parse
+                return Version.TryParse(versionSpan, out Version version) ? version : new Version();
+            }
+        }
 
         public static long WorkingSet
         {
index d16c88b..9a1f067 100644 (file)
                     "name": "System.Tests.MathFTests.Min",
                     "reason": "https://github.com/dotnet/coreclr/pull/20912"
                 },
+                {
+                    "name": "System.Tests.EnvironmentTests.Version_MatchesFixedVersion",
+                    "reason": "outdated"
+                },
             ]
         }
     },
             ]
         }
     },
+    {
+        "name": "System.CodeDom.Tests",
+        "enabled": true,
+        "exclusions": {
+            "namespaces": null,
+            "classes": null,
+            "methods": [
+                {
+                    "name": "System.CodeDom.Compiler.Tests.CSharpCodeGenerationTests.ProviderSupports",
+                    "reason": "outdated"
+                },
+                {
+                    "name": "System.CodeDom.Compiler.Tests.CSharpCodeGenerationTests.MetadataAttributes",
+                    "reason": "outdated"
+                },
+                {
+                    "name": "System.CodeDom.Compiler.Tests.CSharpCodeGenerationTests.RegionsSnippetsAndLinePragmas",
+                    "reason": "outdated"
+                },
+                {
+                    "name": "System.CodeDom.Compiler.Tests.VBCodeGenerationTests.RegionsSnippetsAndLinePragmas",
+                    "reason": "outdated"
+                },
+                {
+                    "name": "System.CodeDom.Compiler.Tests.VBCodeGenerationTests.MetadataAttributes",
+                    "reason": "outdated"
+                },
+                {
+                    "name": "System.CodeDom.Compiler.Tests.VBCodeGenerationTests.ProviderSupports",
+                    "reason": "outdated"
+                }
+            ]
+        }
+    }
 ]
diff --git a/tests/src/CoreMangLib/system/environment/environment_version.cs b/tests/src/CoreMangLib/system/environment/environment_version.cs
new file mode 100644 (file)
index 0000000..8fbe5e4
--- /dev/null
@@ -0,0 +1,38 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System;
+
+class enviroment_version
+{
+    static int Main()
+    {
+        Version ver = Environment.Version;
+        Console.WriteLine($"Environment.Version = {ver}");
+
+        if (ver < new Version("3.0"))
+        {
+            Console.WriteLine("ERROR: Version less than 3.0.");
+            return -1;
+        }
+
+        // Verify that we are not returning hardcoded version from .NET Framework.
+        if (ver == new Version("4.0.30319.42000"))
+        {
+            Console.WriteLine("ERROR: Version is hardcoded .NET Framework version.");
+            return -1;
+        }
+
+        // .NET Core assemblies use 4.6+ as file version. Verify that we have not used
+        // the file version as product version by accident.
+        if (ver.Major == 4 && (ver.Minor >= 6))
+        {
+            Console.WriteLine("ERROR: Version is 4.6+.");
+            return -1;
+        }
+
+        Console.WriteLine("PASSED");
+        return 100;
+    }
+}
diff --git a/tests/src/CoreMangLib/system/environment/environment_version.csproj b/tests/src/CoreMangLib/system/environment/environment_version.csproj
new file mode 100644 (file)
index 0000000..b23455b
--- /dev/null
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="12.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory), dir.props))\dir.props" />
+  <PropertyGroup>
+    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
+    <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
+    <SchemaVersion>2.0</SchemaVersion>
+    <ProjectGuid>{95DFC527-4DC1-495E-97D7-E94EE1F7140D}</ProjectGuid>
+    <OutputType>Exe</OutputType>
+    <ProjectTypeGuids>{786C830F-07A1-408B-BD7F-6EE04809D6DB};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}</ProjectTypeGuids>
+    <SolutionDir Condition="$(SolutionDir) == '' Or $(SolutionDir) == '*Undefined*'">..\..\</SolutionDir>
+    <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+    <CLRTestKind>BuildAndRun</CLRTestKind>
+    <CLRTestPriority>0</CLRTestPriority>
+  </PropertyGroup>
+  <!-- Default configurations to help VS understand the configurations -->
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
+  </PropertyGroup>
+  <ItemGroup>
+    <CodeAnalysisDependentAssemblyPaths Condition=" '$(VS100COMNTOOLS)' != '' " Include="$(VS100COMNTOOLS)..\IDE\PrivateAssemblies">
+      <Visible>False</Visible>
+    </CodeAnalysisDependentAssemblyPaths>
+  </ItemGroup>
+  <ItemGroup>
+    <!-- Add Compile Object Here -->
+    <Compile Include="environment_version.cs" />
+  </ItemGroup>
+  <ItemGroup>
+    <Service Include="{82A7F48D-3B50-4B1E-B82E-3ADA8210C358}" />
+  </ItemGroup>
+  <Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory), dir.targets))\dir.targets" />
+  <PropertyGroup Condition=" '$(MsBuildProjectDirOverride)' != '' ">
+  </PropertyGroup>
+</Project>