Added EnvironmentReader to control automatic test rewrite from the environment

kbilsted · kbilsted · commit 93bc4c0117bb · 2015-04-23T21:56:24.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,12 +4,20 @@
 
 Full documentation on usage and motivating examples at https://github.com/kbilsted/StatePrinter/tree/master/doc
 
+## v2.1.207-rc
+
+Added
+
+  * Functionality for controlling automatic test rewrite using an environment variable.
+
+  
 ## v2.1.198-rc
 
 Added
 
   * Functionality for including or excluding fields and properties based on one or more type descriptions. See IncludeByType() and ExcludeByType()
 
+  
 ## v2.1.186 
 
 Fixed
diff --git a/DeployToNuget.cmd b/DeployToNuget.cmd
@@ -2,8 +2,8 @@ REM ON FIRST RUN, RUN THIS (change the key to whatever is found on your profile
 REM .nuget\NuGet.exe setapikey e39ea-get-the-full-key-on-nuget.org
 
 call CreateNuget.cmd
-.nuget\NuGet.exe push nuget_packages\StatePrinter.2.0.*.nupkg
-.nuget\NuGet.exe push nuget_packages\StatePrinter.2.0.*.symbols.nupkg
+.nuget\NuGet.exe push nuget_packages\StatePrinter.2.*.*.symbols.nupkg
+.nuget\NuGet.exe push nuget_packages\StatePrinter.2.*.*.nupkg
 
 cd nuget_packages
 del /q *
diff --git a/StatePrinter.Tests/StatePrinter.Tests.csproj b/StatePrinter.Tests/StatePrinter.Tests.csproj
@@ -57,6 +57,7 @@
     <Compile Include="FieldHarvesters\ToStringAwareHarvesterTest.cs" />
     <Compile Include="Introspection\ReferenceTest.cs" />
     <Compile Include="Mocks\Mocks.cs" />
+    <Compile Include="TestingAssistance\EnvironmentReaderTest.cs" />
     <Compile Include="TestingAssistance\ParserTest.cs" />
     <Compile Include="IntegrationTests\PublicPropertiesTest.cs" />
     <Compile Include="IntegrationTests\PropertiesTest.cs" />
diff --git a/StatePrinter.Tests/TestHelper.cs b/StatePrinter.Tests/TestHelper.cs
@@ -53,8 +53,7 @@ public static Configuration CreateTestConfiguration()
                 .SetNewlineDefinition(" ")
                 .SetCulture(CultureInfo.CreateSpecificCulture("da-DK"))
                 .Test.SetAreEqualsMethod(NUnit.Framework.Assert.AreEqual)
-                //.Test.SetAutomaticTestRewrite(x => true);
-                .Test.SetAutomaticTestRewrite(x => false);
+                .Test.SetAutomaticTestRewrite(x => new EnvironmentReader().UseTestAutoRewrite());
 
             return cfg;
         }
diff --git a/StatePrinter.Tests/TestingAssistance/EnvironmentReaderTest.cs b/StatePrinter.Tests/TestingAssistance/EnvironmentReaderTest.cs
@@ -0,0 +1,49 @@
+// Copyright 2014-2015 Kasper B. Graversen
+// 
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+// 
+//   http://www.apache.org/licenses/LICENSE-2.0
+// 
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+using System;
+
+using NUnit.Framework;
+
+using StatePrinter.TestAssistance;
+
+namespace StatePrinter.Tests.TestingAssistance
+{
+    [TestFixture]
+    class EnvironmentReaderTest
+    {
+        [Test]
+        public void TestReadUseAutoReWrite()
+        {
+            var org = Environment.GetEnvironmentVariable(EnvironmentReader.Usetestautorewrite, EnvironmentVariableTarget.User);
+            try
+            {
+                var reader = new EnvironmentReader();
+                Assert.AreEqual(false, reader.UseTestAutoRewrite());
+
+                Environment.SetEnvironmentVariable(EnvironmentReader.Usetestautorewrite, "true", EnvironmentVariableTarget.User);
+                Assert.AreEqual(true, reader.UseTestAutoRewrite());
+            }
+            finally
+            {
+                Environment.SetEnvironmentVariable(EnvironmentReader.Usetestautorewrite, org, EnvironmentVariableTarget.User);
+            }
+        }
+    }
+}
diff --git a/StatePrinter.nuspec b/StatePrinter.nuspec
@@ -2,7 +2,7 @@
 <package>
   <metadata>
     <id>StatePrinter</id>
-    <version>2.0.198-rc</version>
+    <version>2.1.207-rc</version>
     <description>
       An open source utility to turn object graphs into strings. Automate your ToString and unit tests asserts.
     </description>
@@ -12,7 +12,8 @@ Fixed
   * [#22 Make error message configurable upon assertion failure](https://github.com/kbilsted/StatePrinter/issues/22)
 
 Added
-  * Functionality for including or excluding fields and properties based on one or more type descriptions. See IncludeByType() and ExcludeByType()
+  * Functionality for controlling automatic test rewrite using an environment variable.
+  * Functionality for including or excluding fields and properties based on one or more type descriptions. See IncludeByType() and ExcludeByType().
   * Added `AreAlike`, replacing `IsSame`.
   * Made error message tell about `AreAlike` when two strings are alike but not equals.
   * Prepared for future expansion of functionality, by placing unit testing configuration in a sub-configuration class.
diff --git a/StatePrinter/Configurations/Configuration.cs b/StatePrinter/Configurations/Configuration.cs
@@ -111,7 +111,6 @@ public Configuration(
         public IOutputFormatter OutputFormatter;
 
         
-        
         public Configuration SetOutputFormatter(IOutputFormatter formatter)
         {
             if (formatter == null)
diff --git a/StatePrinter/Properties/AssemblyInfo.cs b/StatePrinter/Properties/AssemblyInfo.cs
@@ -53,5 +53,5 @@
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
 [assembly: AssemblyVersion("2.1.0.0")]     // Change this upon breaking changes
-[assembly: AssemblyFileVersion("2.1.198.0")] // Bump this at every release
-[assembly: AssemblyInformationalVersion("2.0.198-rc")] // Customer public info (setting a version across multiple products each possibly with their own versioning)
+[assembly: AssemblyFileVersion("2.1.207.0")] // Bump this at every release
+[assembly: AssemblyInformationalVersion("2.0.207-rc")] // Customer public info (setting a version across multiple products each possibly with their own versioning)
diff --git a/StatePrinter/StatePrinter.csproj b/StatePrinter/StatePrinter.csproj
@@ -84,6 +84,7 @@
     <Compile Include="OutputFormatters\OutputFormatterHelpers.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="StatePrinter.cs" />
+    <Compile Include="TestAssistance\EnvironmentReader.cs" />
     <Compile Include="TestAssistance\Asserter.cs" />
     <Compile Include="TestAssistance\DefaultAssertMessage.cs" />
     <Compile Include="TestAssistance\FileRepository.cs" />
diff --git a/StatePrinter/TestAssistance/Asserter.cs b/StatePrinter/TestAssistance/Asserter.cs
@@ -142,7 +142,8 @@ void CallUnderlyingAssert(
           UnitTestLocationInfo info)
         {
             var escapedActual = stringUtils.Escape(actual);
-            bool rewriteTest = info != null && printer.Configuration.Test.AutomaticTestRewrite(info);
+            bool rewriteTest = info != null 
+                && printer.Configuration.Test.AutomaticTestRewrite(info);
 
             var message = printer.Configuration.Test.AssertMessageCreator(
                 expected,
diff --git a/StatePrinter/TestAssistance/EnvironmentReader.cs b/StatePrinter/TestAssistance/EnvironmentReader.cs
@@ -0,0 +1,37 @@
+﻿// Copyright 2014-2015 Kasper B. Graversen
+// 
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+// 
+//   http://www.apache.org/licenses/LICENSE-2.0
+// 
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+using System;
+
+namespace StatePrinter.TestAssistance
+{
+    public class EnvironmentReader
+    {
+        public const string Usetestautorewrite = "StatePrinter_UseTestAutoRewrite";
+
+        public bool UseTestAutoRewrite()
+        {
+            string result = Environment.GetEnvironmentVariable(
+                Usetestautorewrite, 
+                EnvironmentVariableTarget.User);
+            return "true".Equals(result);
+        }
+    }
+}
+

Original file line number	Diff line number	Diff line change
`@@ -53,8 +53,7 @@ public static Configuration CreateTestConfiguration()`
`53`	`53`	`.SetNewlineDefinition(" ")`
`54`	`54`	`.SetCulture(CultureInfo.CreateSpecificCulture("da-DK"))`
`55`	`55`	`.Test.SetAreEqualsMethod(NUnit.Framework.Assert.AreEqual)`
`56`		`- //.Test.SetAutomaticTestRewrite(x => true);`
`57`		`- .Test.SetAutomaticTestRewrite(x => false);`
	`56`	`+ .Test.SetAutomaticTestRewrite(x => new EnvironmentReader().UseTestAutoRewrite());`
`58`	`57`
`59`	`58`	`return cfg;`
`60`	`59`	`}`
Original file line number	Diff line number	Diff line change
`@@ -111,7 +111,6 @@ public Configuration(`
`111`	`111`	`public IOutputFormatter OutputFormatter;`
`112`	`112`
`113`	`113`
`114`		`-`
`115`	`114`	`public Configuration SetOutputFormatter(IOutputFormatter formatter)`
`116`	`115`	`{`
`117`	`116`	`if (formatter == null)`
Original file line number	Diff line number	Diff line change
`@@ -142,7 +142,8 @@ void CallUnderlyingAssert(`
`142`	`142`	`UnitTestLocationInfo info)`
`143`	`143`	`{`
`144`	`144`	`var escapedActual = stringUtils.Escape(actual);`
`145`		`- bool rewriteTest = info != null && printer.Configuration.Test.AutomaticTestRewrite(info);`
	`145`	`+ bool rewriteTest = info != null`
	`146`	`+ && printer.Configuration.Test.AutomaticTestRewrite(info);`
`146`	`147`
`147`	`148`	`var message = printer.Configuration.Test.AssertMessageCreator(`
`148`	`149`	`expected,`