Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add logging when environment variable parsing fails #1251

Merged
merged 10 commits into from
Jun 15, 2022
Merged

Add logging when environment variable parsing fails #1251

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
5f08c0f
Pass the logger param
andrei-epure-sonarsource Jun 8, 2022
60e948a
Propagate logger interface changes to TFS code
andrei-epure-sonarsource Jun 8, 2022
0f8848b
Improve error reporting
andrei-epure-sonarsource Jun 8, 2022
cd6ead4
Add IT
andrei-epure-sonarsource Jun 8, 2022
edd6865
treat 2 code smells
andrei-epure-sonarsource Jun 9, 2022
a5f5eb7
Add TestInitialize
andrei-epure-sonarsource Jun 9, 2022
e9733cc
Improve readability
andrei-epure-sonarsource Jun 9, 2022
3eedf6d
Only log warning
andrei-epure-sonarsource Jun 13, 2022
9e61c6c
Revert "Only log warning"
andrei-epure-sonarsource Jun 14, 2022
643e370
Revert "treat 2 code smells"
andrei-epure-sonarsource Jun 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions src/SonarScanner.MSBuild.Common/AnalysisProperties/EnvScannerPropertiesProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,7 @@

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;

namespace SonarScanner.MSBuild.Common
Expand All @@ -48,7 +46,7 @@ public static bool TryCreateProvider(ILogger logger, out IAnalysisPropertyProvid
provider = new EnvScannerPropertiesProvider(Environment.GetEnvironmentVariable(ENV_VAR_KEY));
return true;
}
catch (Exception ex) when (ex is JsonException || ex is IOException)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JsonException is in Newtonsoft 12 :|

hence failures on .NET Core 2.1

🤦

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it make sense to leave a comment here, so it will be fixed once NET 2.1 version is removed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll do a separate PR to avoid postponing merging this one.

I think there's multiple things:

  • filtering down the exception
  • general cleanup after removing .NET 2.1

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#1258

catch (Exception ex)
{
logger.LogError(Resources.ERROR_FailedParsePropertiesEnvVar, ENV_VAR_KEY, ex.Message);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this will fail the build, which is ok in this case (otherwise, users will be confused)

}
Expand Down
2 changes: 1 addition & 1 deletion src/SonarScanner.MSBuild.TFS/SummaryReportBuilder.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public class SummaryReportData
public int SkippedProjects { get; set; }
public int ExcludedProjects { get; set; }
public bool Succeeded { get; set; }
public string DashboardUrl { get; set; } // should be Uri https://github.com/SonarSource/sonar-scanner-msbuild/issues/1252
public string DashboardUrl { get; set; }
public string ProjectDescription { get; set; }
}

Expand Down