Supress CS0618 build warning for known obsolete members

gitfool · gitfool · commit 9beb51a8b52b · 2020-02-29T15:25:22.000+13:00
https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/cs0618
diff --git a/src/GitVersionCore.Tests/VariableProviderTests.cs b/src/GitVersionCore.Tests/VariableProviderTests.cs
@@ -43,7 +43,9 @@ public void ShouldLogWarningWhenUsingDefaultInformationalVersionInCustomFormat()
                 Patch = 3,
             };
 
+#pragma warning disable CS0618 // Type or member is obsolete
             var propertyName = nameof(SemanticVersionFormatValues.DefaultInformationalVersion);
+#pragma warning restore CS0618 // Type or member is obsolete
             var config = new TestEffectiveConfiguration(assemblyInformationalFormat: $"{{{propertyName}}}");
             variableProvider.GetVariablesFor(semVer, config, false);
             logMessages.ShouldContain(message => message.Trim().StartsWith("WARN") && message.Contains(propertyName), 1, $"Expected a warning to be logged when using the variable {propertyName} in a configuration format template");
diff --git a/src/GitVersionCore/OutputVariables/VariableProvider.cs b/src/GitVersionCore/OutputVariables/VariableProvider.cs
@@ -154,7 +154,9 @@ private string CheckAndFormatString<T>(string formatString, T source, IEnvironme
 
         private void WarnIfUsingObsoleteFormatValues(string formatString)
         {
+#pragma warning disable CS0618 // Type or member is obsolete
             var obsoletePropertyName = nameof(SemanticVersionFormatValues.DefaultInformationalVersion);
+#pragma warning restore CS0618 // Type or member is obsolete
             if (formatString.Contains($"{{{obsoletePropertyName}}}"))
             {
                 log.Write(LogLevel.Warn, $"Use format variable '{nameof(SemanticVersionFormatValues.InformationalVersion)}' instead of '{obsoletePropertyName}' which is obsolete and will be removed in a future release.");
diff --git a/src/GitVersionExe.Tests/ArgumentParserTests.cs b/src/GitVersionExe.Tests/ArgumentParserTests.cs
@@ -59,7 +59,9 @@ public void HMeansIsHelp()
         public void Exec()
         {
             var arguments = argumentParser.ParseArguments("-exec rake");
+#pragma warning disable CS0612 // Type or member is obsolete
             arguments.Exec.ShouldBe("rake");
+#pragma warning restore CS0612 // Type or member is obsolete
         }
 
         [Test]
@@ -72,15 +74,19 @@ public void ExecWithArgs()
                 "-execargs",
                 "clean build"
             });
+#pragma warning disable CS0612 // Type or member is obsolete
             arguments.Exec.ShouldBe("rake");
             arguments.ExecArgs.ShouldBe("clean build");
+#pragma warning restore CS0612 // Type or member is obsolete
         }
 
         [Test]
         public void Msbuild()
         {
             var arguments = argumentParser.ParseArguments("-proj msbuild.proj");
+#pragma warning disable CS0612 // Type or member is obsolete
             arguments.Proj.ShouldBe("msbuild.proj");
+#pragma warning restore CS0612 // Type or member is obsolete
         }
 
         [Test]
@@ -93,16 +99,20 @@ public void MsbuildWithArgs()
                 "-projargs",
                 "/p:Configuration=Debug /p:Platform=AnyCPU"
             });
+#pragma warning disable CS0612 // Type or member is obsolete
             arguments.Proj.ShouldBe("msbuild.proj");
             arguments.ProjArgs.ShouldBe("/p:Configuration=Debug /p:Platform=AnyCPU");
+#pragma warning restore CS0612 // Type or member is obsolete
         }
 
         [Test]
         public void ExecwithTargetdirectory()
         {
             var arguments = argumentParser.ParseArguments("targetDirectoryPath -exec rake");
             arguments.TargetPath.ShouldBe("targetDirectoryPath");
+#pragma warning disable CS0612 // Type or member is obsolete
             arguments.Exec.ShouldBe("rake");
+#pragma warning restore CS0612 // Type or member is obsolete
         }
 
         [Test]
@@ -374,23 +384,29 @@ public void OtherArgumentsCanBeParsedAfterNofetch()
         {
             var arguments = argumentParser.ParseArguments("-nofetch -proj foo.sln");
             arguments.NoFetch.ShouldBe(true);
+#pragma warning disable CS0612 // Type or member is obsolete
             arguments.Proj.ShouldBe("foo.sln");
+#pragma warning restore CS0612 // Type or member is obsolete
         }
 
         [Test]
         public void OtherArgumentsCanBeParsedAfterNonormalize()
         {
             var arguments = argumentParser.ParseArguments("-nonormalize -proj foo.sln");
             arguments.NoNormalize.ShouldBe(true);
+#pragma warning disable CS0612 // Type or member is obsolete
             arguments.Proj.ShouldBe("foo.sln");
+#pragma warning restore CS0612 // Type or member is obsolete
         }
 
         [Test]
         public void OtherArgumentsCanBeParsedAfterNocache()
         {
             var arguments = argumentParser.ParseArguments("-nocache -proj foo.sln");
             arguments.NoCache.ShouldBe(true);
+#pragma warning disable CS0612 // Type or member is obsolete
             arguments.Proj.ShouldBe("foo.sln");
+#pragma warning restore CS0612 // Type or member is obsolete
         }
 
         [TestCase("-nofetch -nonormalize -nocache")]
diff --git a/src/GitVersionExe/ArgumentParser.cs b/src/GitVersionExe/ArgumentParser.cs
@@ -149,29 +149,37 @@ public Arguments ParseArguments(string[] commandLineArguments)
                 if (name.IsSwitch("exec"))
                 {
                     EnsureArgumentValueCount(values);
+#pragma warning disable CS0612 // Type or member is obsolete
                     arguments.Exec = value;
+#pragma warning restore CS0612 // Type or member is obsolete
                     continue;
                 }
 
 
                 if (name.IsSwitch("execargs"))
                 {
                     EnsureArgumentValueCount(values);
+#pragma warning disable CS0612 // Type or member is obsolete
                     arguments.ExecArgs = value;
+#pragma warning restore CS0612 // Type or member is obsolete
                     continue;
                 }
 
                 if (name.IsSwitch("proj"))
                 {
                     EnsureArgumentValueCount(values);
+#pragma warning disable CS0612 // Type or member is obsolete
                     arguments.Proj = value;
+#pragma warning restore CS0612 // Type or member is obsolete
                     continue;
                 }
 
                 if (name.IsSwitch("projargs"))
                 {
                     EnsureArgumentValueCount(values);
+#pragma warning disable CS0612 // Type or member is obsolete
                     arguments.ProjArgs = value;
+#pragma warning restore CS0612 // Type or member is obsolete
                     continue;
                 }
 
diff --git a/src/GitVersionExe/ExecCommand.cs b/src/GitVersionExe/ExecCommand.cs
@@ -83,16 +83,19 @@ public void Execute()
 
         private static bool RunMsBuildIfNeeded(Arguments args, string workingDirectory, VersionVariables variables, ILog log)
         {
+#pragma warning disable CS0612 // Type or member is obsolete
             if (string.IsNullOrEmpty(args.Proj)) return false;
 
             args.Exec = "dotnet";
             args.ExecArgs = $"msbuild \"{args.Proj}\" {args.ProjArgs}";
+#pragma warning restore CS0612 // Type or member is obsolete
 
             return RunExecCommandIfNeeded(args, workingDirectory, variables, log);
         }
 
         private static bool RunExecCommandIfNeeded(Arguments args, string workingDirectory, VersionVariables variables, ILog log)
         {
+#pragma warning disable CS0612 // Type or member is obsolete
             if (string.IsNullOrEmpty(args.Exec)) return false;
 
             log.Info($"Launching {args.Exec} {args.ExecArgs}");
@@ -103,6 +106,7 @@ private static bool RunExecCommandIfNeeded(Arguments args, string workingDirecto
 
             if (results != 0)
                 throw new WarningException($"Execution of {args.Exec} failed, non-zero return code");
+#pragma warning restore CS0612 // Type or member is obsolete
 
             return true;
         }
diff --git a/src/GitVersionExe/GitVersionExecutor.cs b/src/GitVersionExe/GitVersionExecutor.cs
@@ -76,7 +76,9 @@ private int VerifyArgumentsAndRun(Arguments arguments)
                     arguments.Output.Add(OutputType.BuildServer);
                 }
 
+#pragma warning disable CS0612 // Type or member is obsolete
                 if (!string.IsNullOrEmpty(arguments.Proj) || !string.IsNullOrEmpty(arguments.Exec))
+#pragma warning restore CS0612 // Type or member is obsolete
                 {
                     arguments.Output.Add(OutputType.BuildServer);
                 }

Original file line number	Diff line number	Diff line change
`@@ -154,7 +154,9 @@ private string CheckAndFormatString<T>(string formatString, T source, IEnvironme`
`154`	`154`
`155`	`155`	`private void WarnIfUsingObsoleteFormatValues(string formatString)`
`156`	`156`	`{`
	`157`	`+#pragma warning disable CS0618 // Type or member is obsolete`
`157`	`158`	`var obsoletePropertyName = nameof(SemanticVersionFormatValues.DefaultInformationalVersion);`
	`159`	`+#pragma warning restore CS0618 // Type or member is obsolete`
`158`	`160`	`if (formatString.Contains($"{{{obsoletePropertyName}}}"))`
`159`	`161`	`{`
`160`	`162`	`log.Write(LogLevel.Warn, $"Use format variable '{nameof(SemanticVersionFormatValues.InformationalVersion)}' instead of '{obsoletePropertyName}' which is obsolete and will be removed in a future release.");`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,9 @@ public void HMeansIsHelp()`
`59`	`59`	`public void Exec()`
`60`	`60`	`{`
`61`	`61`	`var arguments = argumentParser.ParseArguments("-exec rake");`
	`62`	`+#pragma warning disable CS0612 // Type or member is obsolete`
`62`	`63`	`arguments.Exec.ShouldBe("rake");`
	`64`	`+#pragma warning restore CS0612 // Type or member is obsolete`
`63`	`65`	`}`
`64`	`66`
`65`	`67`	`[Test]`
`@@ -72,15 +74,19 @@ public void ExecWithArgs()`
`72`	`74`	`"-execargs",`
`73`	`75`	`"clean build"`
`74`	`76`	`});`
	`77`	`+#pragma warning disable CS0612 // Type or member is obsolete`
`75`	`78`	`arguments.Exec.ShouldBe("rake");`
`76`	`79`	`arguments.ExecArgs.ShouldBe("clean build");`
	`80`	`+#pragma warning restore CS0612 // Type or member is obsolete`
`77`	`81`	`}`
`78`	`82`
`79`	`83`	`[Test]`
`80`	`84`	`public void Msbuild()`
`81`	`85`	`{`
`82`	`86`	`var arguments = argumentParser.ParseArguments("-proj msbuild.proj");`
	`87`	`+#pragma warning disable CS0612 // Type or member is obsolete`
`83`	`88`	`arguments.Proj.ShouldBe("msbuild.proj");`
	`89`	`+#pragma warning restore CS0612 // Type or member is obsolete`
`84`	`90`	`}`
`85`	`91`
`86`	`92`	`[Test]`
`@@ -93,16 +99,20 @@ public void MsbuildWithArgs()`
`93`	`99`	`"-projargs",`
`94`	`100`	`"/p:Configuration=Debug /p:Platform=AnyCPU"`
`95`	`101`	`});`
	`102`	`+#pragma warning disable CS0612 // Type or member is obsolete`
`96`	`103`	`arguments.Proj.ShouldBe("msbuild.proj");`
`97`	`104`	`arguments.ProjArgs.ShouldBe("/p:Configuration=Debug /p:Platform=AnyCPU");`
	`105`	`+#pragma warning restore CS0612 // Type or member is obsolete`
`98`	`106`	`}`
`99`	`107`
`100`	`108`	`[Test]`
`101`	`109`	`public void ExecwithTargetdirectory()`
`102`	`110`	`{`
`103`	`111`	`var arguments = argumentParser.ParseArguments("targetDirectoryPath -exec rake");`
`104`	`112`	`arguments.TargetPath.ShouldBe("targetDirectoryPath");`
	`113`	`+#pragma warning disable CS0612 // Type or member is obsolete`
`105`	`114`	`arguments.Exec.ShouldBe("rake");`
	`115`	`+#pragma warning restore CS0612 // Type or member is obsolete`
`106`	`116`	`}`
`107`	`117`
`108`	`118`	`[Test]`
`@@ -374,23 +384,29 @@ public void OtherArgumentsCanBeParsedAfterNofetch()`
`374`	`384`	`{`
`375`	`385`	`var arguments = argumentParser.ParseArguments("-nofetch -proj foo.sln");`
`376`	`386`	`arguments.NoFetch.ShouldBe(true);`
	`387`	`+#pragma warning disable CS0612 // Type or member is obsolete`
`377`	`388`	`arguments.Proj.ShouldBe("foo.sln");`
	`389`	`+#pragma warning restore CS0612 // Type or member is obsolete`
`378`	`390`	`}`
`379`	`391`
`380`	`392`	`[Test]`
`381`	`393`	`public void OtherArgumentsCanBeParsedAfterNonormalize()`
`382`	`394`	`{`
`383`	`395`	`var arguments = argumentParser.ParseArguments("-nonormalize -proj foo.sln");`
`384`	`396`	`arguments.NoNormalize.ShouldBe(true);`
	`397`	`+#pragma warning disable CS0612 // Type or member is obsolete`
`385`	`398`	`arguments.Proj.ShouldBe("foo.sln");`
	`399`	`+#pragma warning restore CS0612 // Type or member is obsolete`
`386`	`400`	`}`
`387`	`401`
`388`	`402`	`[Test]`
`389`	`403`	`public void OtherArgumentsCanBeParsedAfterNocache()`
`390`	`404`	`{`
`391`	`405`	`var arguments = argumentParser.ParseArguments("-nocache -proj foo.sln");`
`392`	`406`	`arguments.NoCache.ShouldBe(true);`
	`407`	`+#pragma warning disable CS0612 // Type or member is obsolete`
`393`	`408`	`arguments.Proj.ShouldBe("foo.sln");`
	`409`	`+#pragma warning restore CS0612 // Type or member is obsolete`
`394`	`410`	`}`
`395`	`411`
`396`	`412`	`[TestCase("-nofetch -nonormalize -nocache")]`
Original file line number	Diff line number	Diff line change
`@@ -149,29 +149,37 @@ public Arguments ParseArguments(string[] commandLineArguments)`
`149`	`149`	`if (name.IsSwitch("exec"))`
`150`	`150`	`{`
`151`	`151`	`EnsureArgumentValueCount(values);`
	`152`	`+#pragma warning disable CS0612 // Type or member is obsolete`
`152`	`153`	`arguments.Exec = value;`
	`154`	`+#pragma warning restore CS0612 // Type or member is obsolete`
`153`	`155`	`continue;`
`154`	`156`	`}`
`155`	`157`
`156`	`158`
`157`	`159`	`if (name.IsSwitch("execargs"))`
`158`	`160`	`{`
`159`	`161`	`EnsureArgumentValueCount(values);`
	`162`	`+#pragma warning disable CS0612 // Type or member is obsolete`
`160`	`163`	`arguments.ExecArgs = value;`
	`164`	`+#pragma warning restore CS0612 // Type or member is obsolete`
`161`	`165`	`continue;`
`162`	`166`	`}`
`163`	`167`
`164`	`168`	`if (name.IsSwitch("proj"))`
`165`	`169`	`{`
`166`	`170`	`EnsureArgumentValueCount(values);`
	`171`	`+#pragma warning disable CS0612 // Type or member is obsolete`
`167`	`172`	`arguments.Proj = value;`
	`173`	`+#pragma warning restore CS0612 // Type or member is obsolete`
`168`	`174`	`continue;`
`169`	`175`	`}`
`170`	`176`
`171`	`177`	`if (name.IsSwitch("projargs"))`
`172`	`178`	`{`
`173`	`179`	`EnsureArgumentValueCount(values);`
	`180`	`+#pragma warning disable CS0612 // Type or member is obsolete`
`174`	`181`	`arguments.ProjArgs = value;`
	`182`	`+#pragma warning restore CS0612 // Type or member is obsolete`
`175`	`183`	`continue;`
`176`	`184`	`}`
`177`	`185`
Original file line number	Diff line number	Diff line change
`@@ -83,16 +83,19 @@ public void Execute()`
`83`	`83`
`84`	`84`	`private static bool RunMsBuildIfNeeded(Arguments args, string workingDirectory, VersionVariables variables, ILog log)`
`85`	`85`	`{`
	`86`	`+#pragma warning disable CS0612 // Type or member is obsolete`
`86`	`87`	`if (string.IsNullOrEmpty(args.Proj)) return false;`
`87`	`88`
`88`	`89`	`args.Exec = "dotnet";`
`89`	`90`	`args.ExecArgs = $"msbuild \"{args.Proj}\" {args.ProjArgs}";`
	`91`	`+#pragma warning restore CS0612 // Type or member is obsolete`
`90`	`92`
`91`	`93`	`return RunExecCommandIfNeeded(args, workingDirectory, variables, log);`
`92`	`94`	`}`
`93`	`95`
`94`	`96`	`private static bool RunExecCommandIfNeeded(Arguments args, string workingDirectory, VersionVariables variables, ILog log)`
`95`	`97`	`{`
	`98`	`+#pragma warning disable CS0612 // Type or member is obsolete`
`96`	`99`	`if (string.IsNullOrEmpty(args.Exec)) return false;`
`97`	`100`
`98`	`101`	`log.Info($"Launching {args.Exec} {args.ExecArgs}");`
`@@ -103,6 +106,7 @@ private static bool RunExecCommandIfNeeded(Arguments args, string workingDirecto`
`103`	`106`
`104`	`107`	`if (results != 0)`
`105`	`108`	`throw new WarningException($"Execution of {args.Exec} failed, non-zero return code");`
	`109`	`+#pragma warning restore CS0612 // Type or member is obsolete`
`106`	`110`
`107`	`111`	`return true;`
`108`	`112`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,7 +76,9 @@ private int VerifyArgumentsAndRun(Arguments arguments)`
`76`	`76`	`arguments.Output.Add(OutputType.BuildServer);`
`77`	`77`	`}`
`78`	`78`
	`79`	`+#pragma warning disable CS0612 // Type or member is obsolete`
`79`	`80`	`if (!string.IsNullOrEmpty(arguments.Proj) \|\| !string.IsNullOrEmpty(arguments.Exec))`
	`81`	`+#pragma warning restore CS0612 // Type or member is obsolete`
`80`	`82`	`{`
`81`	`83`	`arguments.Output.Add(OutputType.BuildServer);`
`82`	`84`	`}`