Implement ability for project properties to suppress and elevate warnings #1928

jeffkl · 2017-03-30T16:14:55Z

Introduce MSBuildTreatWarningsAsErrors property that when set to true will treat all warnings as errors when building a project.
Introduce MSBuildWarningsAsErrors property which is a semicolon delmited list of warning codes to treat as errors when building a project.
Introduce MSBuildWarningsAsMessages property which is a semicolon delimited list of warning codes to treat as low importance messages.

This allows users to control warnings at the project level via standard MSBuild properties. They can be set in a project, an import, or from the command-line.

The limitation here is that the warnings can only include ones that occur during a build. This is because the properties are not read until after parsing so warnings generated during parse/evaluation happen too soon. For these warnings, users will only be able to treat them as errors/messages with the /WarnAsError and /WarnAsMessage command-line arguments.

Closes #1886

jeffkl · 2017-03-30T16:17:27Z

FYI @jaredpar

jaredpar · 2017-03-30T16:19:45Z

Nice!

cdmihai · 2017-03-31T22:40:44Z

src/Build/BackEnd/Components/RequestBuilder/RequestBuilder.cs

@@ -1079,6 +1080,10 @@ private void SetProjectCurrentDirectory()

            _projectLoggingContext = _nodeLoggingContext.LogProjectStarted(_requestEntry);

+            // Now that the project has started, parse a few known properties which indicate warning codes to treat as errors or messages
+            //
+            ConfigureWarningsAsErrorsAndMessages();


Hopefully this is the only place where MSBuild evaluates a project file during build. :)

Do you foresee any performance degradation by adding this call? I assumed it was safe since the project has "started" building...

It runs once for each project evaluation, so it should scale linearly with number of evaluations (Project nr x (msbuild tasks per project)). I think ~5000 projects is considered "outlier big".

Offline discussion: My bad, this actually happens only once per node.

cdmihai · 2017-03-31T22:52:33Z

src/Build/BackEnd/Components/RequestBuilder/RequestBuilder.cs

+
+            // Ensure everything that is required is available at this time
+            //
+            if (project != null && buildEventContext != null && loggingService != null && buildEventContext.ProjectInstanceId != BuildEventContext.InvalidProjectInstanceId)


Check this works on a p2p node as well. Nodes initially assign a temp project ID (maybe the invalid one?) and I don't remember whether they get the global ID before or after they evaluate the project.

cdmihai · 2017-03-31T22:56:51Z

src/Build/BackEnd/Components/RequestBuilder/RequestBuilder.cs

+                }
+                else
+                {
+                    ISet<string> warningsAsErrors = ParseWarningCodes(project.GetPropertyValue(MSBuildConstants.WarningsAsErrors));


What if the user defines TreatWarningsAsErrors=True and also WarningsAsErrors="a;b;c;d"? I'd expect msbuild to treat only the specified warnings as errors, as opposed to ignoring the warning list.

At the moment, MSBuildTreatWarningsAsErrors will override any list. This is the same way that argument works for the compilers.

Cool, didn't know. Go with the same behaviour as the compilers then. Except for the warning list separator :)

cdmihai · 2017-03-31T23:19:50Z

src/Build/BackEnd/Components/RequestBuilder/RequestBuilder.cs

+            }
+
+            return new HashSet<string>(
+                warnings.Split(new[] { ',', ';' }, StringSplitOptions.RemoveEmptyEntries)


I'd only keep semicolons, as they are the msbuild approved way of separating things. And then maybe use ExpressionShredder.SplitSemiColonSeparatedList

cdmihai · 2017-03-31T23:24:11Z

src/Build/BackEnd/Components/Logging/LoggingService.cs

+
+        public void AddWarningsAsMessages(int projectInstanceId, ISet<string> codes)
+        {
+            lock (_lockObject)


If you are using a concurrent dictionary, rather than locking, you can use a thread safe Lazy to initialize it, and then not use the external lock when using it.

I tried this out but hit a snag. I'm using the state of null as an indicator if any warnings should be treated as an error/message. If I use a Lazy<T>, then I would have to expose it as such so that the caller can determine if HasValue is true. Leaving it the way it is, the property remains of type IDictionary and a simple null check is done. If its okay to have IBuildEventSink have a property that is of type Lazy<T>, then I'll do it.

cdmihai · 2017-03-31T23:29:40Z

src/Build/BackEnd/Components/RequestBuilder/RequestBuilder.cs

+                    }
+                }
+
+                ISet<string> warningsAsMessages = ParseWarningCodes(project.GetPropertyValue(MSBuildConstants.WarningsAsMessages));


What if the user has the same warning code as both a message and an error? I'd expect error to win, on the grounds that errors are more serious than messages. Or maybe emit a warning saying that both were specified and the intent is ambiguous. The user can then treat that new warning as a message (but hopefully not as an error as well) :)

Suppressing a warning overrides elevating one. This is so you can treat all warnings as errors but still turn a few of them off.

cdmihai · 2017-03-31T23:35:48Z

src/Build/BackEnd/Components/Logging/EventSourceSink.cs

+        {
+            // This only applies if the user specified /warnaserror from the command-line or added an empty set through the object model
+            //
+            if (WarningsAsErrors != null)


I'd rename WarningsAsErrors/Messages to something like GlobalWarningsAsErrors/Messages

The name is technically part of our public API already as a property to BuildParameters. I could rename the internal property on EventSourceSink if you feel strongly about it.

It was more of a nit. Thought it's worth making it clear in the ILoggingService that WarningsAsErrors is the global, master switch and not the local per project one.

…ings. Introduce MSBuildTreatWarningsAsErrors property that when set to true will treat all warnings as errors when building a project. Introduce MSBuildWarningsAsErrors property which is a semicolon delmited list of warning codes to treat as errors when building a project. Introduce MSBuildWarningsAsMessages property which is a semicolon delimited list of warning codes to treat as low importance messages. This allows users to control warnings at the project level via standard MSBuild properties. They can be set in a project, an import, or from the command-line. The limitation here is that the warnings can only include ones that occur during a build. This is because the properties are not read until after parsing so warnings generated during parse/evaluation happen too soon. For these warnings, users will only be able to treat them as errors/messages with the /WarnAsError and /WarnAsMessage command-line arguments. Closes dotnet#1886

Should reduce memory use when building large project trees

…ate warnings (#1928)" This reverts commit 01f9915.

dnfclas added the cla-already-signed label Mar 30, 2017

cdmihai reviewed Mar 31, 2017

View reviewed changes

jeffkl added 2 commits April 3, 2017 07:14

Use ExpressionShredder to split only by semicolon

a6af98a

jeffkl force-pushed the warnaserrorprop branch from 81b0bf8 to a6af98a Compare April 3, 2017 14:32

cdmihai approved these changes Apr 3, 2017

View reviewed changes

AndyGerlicher approved these changes Apr 4, 2017

View reviewed changes

Remove projects from the dictionary after they've finished.

a76a10c

Should reduce memory use when building large project trees

jeffkl merged commit 01f9915 into dotnet:master Apr 4, 2017

jeffkl deleted the warnaserrorprop branch April 4, 2017 22:37

cdmihai added a commit that referenced this pull request Apr 6, 2017

Revert "Implement ability for project properties to suppress and elev…

3e74cc7

…ate warnings (#1928)" This reverts commit 01f9915.

jeffkl mentioned this pull request Nov 9, 2017

Add a "treat warnings as errors" option #68

Closed

nguerrera mentioned this pull request Jun 8, 2018

[WIP] Add warning for ref to netstandard >= 1.5 from netfx without built-in support dotnet/sdk#2316

Closed

7 tasks

rainersigwald mentioned this pull request Jul 26, 2018

Adding warning for P2P reference with ATF in GetReferenceNearestTargetFrameworkTask NuGet/NuGet.Client#2366

Merged

mishra14 mentioned this pull request Jul 26, 2018

msbuild should pass warning properties to GetReferenceNearestTargetFrameworkTask #3548

Open

weshaggard mentioned this pull request Jul 27, 2018

Move warnaserror from build scripts to common props dotnet/arcade#389

Closed

rainersigwald mentioned this pull request May 21, 2019

Treat specific warnings as errors #4388

Closed

llongley mentioned this pull request Jun 27, 2019

Fixing CalendarDatePicker's template microsoft/microsoft-ui-xaml#881

Merged

amis92 mentioned this pull request Dec 10, 2019

Use McMaster.NETCore.Plugins for assembly loading AArnott/CodeGeneration.Roslyn#156

Merged

1 task

rainersigwald mentioned this pull request Jan 17, 2020

TreatWarningsAsErrors doesn't work for MSB3277 #5053

Closed

sbomer mentioned this pull request Mar 31, 2020

Output illink messages without --verbose dotnet/linker#1030

Closed

bddckr mentioned this pull request May 21, 2020

TreatWarningsAsErrors ignored when severity set in EditorConfig dotnet/roslyn#43051

Closed

This was referenced Jan 12, 2021

HasLoggedError Respects MSBuildWarningsAsErrors #5957

Closed

Tasks Log.HasLoggedError now respects MSBuildWarningsAsErrors #6040

Closed

benvillalobos mentioned this pull request Feb 10, 2021

NuGet pack raises a warning, which is turned into an error, but the build still passes #4842

Closed

benvillalobos mentioned this pull request Feb 18, 2021

Tasks Log.HasLoggedError now respects MSBuildWarningsAsErrors #6174

Merged

2 tasks

ghogen mentioned this pull request Apr 27, 2022

MSBuildTreatWarningsAsErrors doesn't work in Visual Studio builds #7579

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement ability for project properties to suppress and elevate warnings #1928

Implement ability for project properties to suppress and elevate warnings #1928

jeffkl commented Mar 30, 2017

jeffkl commented Mar 30, 2017

jaredpar commented Mar 30, 2017

cdmihai Mar 31, 2017

jeffkl Apr 3, 2017

cdmihai Apr 3, 2017 •

edited

Loading

cdmihai Apr 3, 2017 •

edited

Loading

cdmihai Mar 31, 2017 •

edited

Loading

cdmihai Mar 31, 2017

jeffkl Apr 3, 2017

cdmihai Apr 3, 2017

cdmihai Mar 31, 2017

jeffkl Apr 3, 2017

cdmihai Mar 31, 2017 •

edited

Loading

jeffkl Apr 3, 2017

cdmihai Mar 31, 2017 •

edited

Loading

jeffkl Apr 3, 2017

cdmihai Mar 31, 2017

jeffkl Apr 3, 2017

cdmihai Apr 3, 2017

Implement ability for project properties to suppress and elevate warnings #1928

Implement ability for project properties to suppress and elevate warnings #1928

Conversation

jeffkl commented Mar 30, 2017

jeffkl commented Mar 30, 2017

jaredpar commented Mar 30, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cdmihai Apr 3, 2017 • edited Loading

Choose a reason for hiding this comment

cdmihai Apr 3, 2017 • edited Loading

Choose a reason for hiding this comment

cdmihai Mar 31, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cdmihai Mar 31, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cdmihai Mar 31, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cdmihai Apr 3, 2017 •

edited

Loading

cdmihai Apr 3, 2017 •

edited

Loading

cdmihai Mar 31, 2017 •

edited

Loading

cdmihai Mar 31, 2017 •

edited

Loading

cdmihai Mar 31, 2017 •

edited

Loading