From 15d896763fdf647a583bbc77c34d8210f73381c7 Mon Sep 17 00:00:00 2001
From: mary-georgiou-sonarsource <mary.georgiou@sonarsource.com>
Date: Mon, 13 Mar 2023 15:03:07 +0100
Subject: [PATCH] rename method that read sonarlintxml

---
 .../AnalysisContext/SonarAnalysisContextBase.cs  |  2 +-
 .../Rules/Utilities/UtilityAnalyzerBase.cs       |  2 +-
 .../SonarAnalysisContextBaseTest.cs              | 16 ++++++++--------
 3 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/analyzers/src/SonarAnalyzer.Common/AnalysisContext/SonarAnalysisContextBase.cs b/analyzers/src/SonarAnalyzer.Common/AnalysisContext/SonarAnalysisContextBase.cs
index 431e96c8643..1294566e09a 100644
--- a/analyzers/src/SonarAnalyzer.Common/AnalysisContext/SonarAnalysisContextBase.cs
+++ b/analyzers/src/SonarAnalyzer.Common/AnalysisContext/SonarAnalysisContextBase.cs
@@ -83,7 +83,7 @@ public ProjectConfigReader ProjectConfiguration()
     /// <summary>
     /// Reads the properties from the SonarLint.xml file and caches the result for the scope of this analysis.
     /// </summary>
-    public SonarLintXmlReader SonarLintFile()
+    public SonarLintXmlReader ReadSonarLintXml()
     {
         if (Options.SonarLintXml() is { } sonarLintXml)
         {
diff --git a/analyzers/src/SonarAnalyzer.Common/Rules/Utilities/UtilityAnalyzerBase.cs b/analyzers/src/SonarAnalyzer.Common/Rules/Utilities/UtilityAnalyzerBase.cs
index 6df9b93a53e..aaed58232f0 100644
--- a/analyzers/src/SonarAnalyzer.Common/Rules/Utilities/UtilityAnalyzerBase.cs
+++ b/analyzers/src/SonarAnalyzer.Common/Rules/Utilities/UtilityAnalyzerBase.cs
@@ -60,7 +60,7 @@ protected void ReadParameters(SonarCompilationStartAnalysisContext context)
             }
             if (context.Options.SonarLintXml() != null && !string.IsNullOrEmpty(outPath))
             {
-                var sonarLintXml = context.SonarLintFile();
+                var sonarLintXml = context.ReadSonarLintXml();
                 IgnoreHeaderComments = sonarLintXml.IgnoreHeaderComments;
                 AnalyzeGeneratedCode = sonarLintXml.AnalyzeGeneratedCode;
                 OutPath = Path.Combine(outPath, context.Compilation.Language == LanguageNames.CSharp ? "output-cs" : "output-vbnet");
diff --git a/analyzers/tests/SonarAnalyzer.UnitTest/AnalysisContext/SonarAnalysisContextBaseTest.cs b/analyzers/tests/SonarAnalyzer.UnitTest/AnalysisContext/SonarAnalysisContextBaseTest.cs
index e0c98dd49aa..37c160341b3 100644
--- a/analyzers/tests/SonarAnalyzer.UnitTest/AnalysisContext/SonarAnalysisContextBaseTest.cs
+++ b/analyzers/tests/SonarAnalyzer.UnitTest/AnalysisContext/SonarAnalysisContextBaseTest.cs
@@ -179,7 +179,7 @@ public void SonarLintFile_LoadsExpectedValues(string language)
         var analyzerLanguage = language == "cs" ? AnalyzerLanguage.CSharp : AnalyzerLanguage.VisualBasic;
         var (compilation, _) = CreateDummyCompilation(analyzerLanguage, "ExtraEmptyFile");
         var options = AnalysisScaffolding.CreateOptions($"ResourceTests\\SonarLintXml\\All_properties_{language}\\SonarLint.xml");
-        var sut = CreateSut(compilation, options).SonarLintFile();
+        var sut = CreateSut(compilation, options).ReadSonarLintXml();
 
         sut.IgnoreHeaderComments.Should().BeTrue();
         sut.AnalyzeGeneratedCode.Should().BeFalse();
@@ -204,8 +204,8 @@ public void SonarLintFile_UsesCachedValue()
         var options = AnalysisScaffolding.CreateOptions("ResourceTests\\SonarLintXml\\All_properties_cs\\SonarLint.xml");
         var firstSut = CreateSut(options);
         var secondSut = CreateSut(options);
-        var firstFile = firstSut.SonarLintFile();
-        var secondFile = secondSut.SonarLintFile();
+        var firstFile = firstSut.ReadSonarLintXml();
+        var secondFile = secondSut.ReadSonarLintXml();
 
         secondFile.Should().BeSameAs(firstFile);
     }
@@ -215,8 +215,8 @@ public void SonarLintFile_WhenFileChanges_RebuildsCache()
     {
         var firstOptions = AnalysisScaffolding.CreateOptions("ResourceTests\\SonarLintXml\\All_properties_cs\\SonarLint.xml");
         var secondOptions = AnalysisScaffolding.CreateOptions("ResourceTests\\SonarLintXml\\All_properties_vbnet\\SonarLint.xml");
-        var firstFile = CreateSut(firstOptions).SonarLintFile();
-        var secondFile = CreateSut(secondOptions).SonarLintFile();
+        var firstFile = CreateSut(firstOptions).ReadSonarLintXml();
+        var secondFile = CreateSut(secondOptions).ReadSonarLintXml();
 
         secondFile.Should().NotBeSameAs(firstFile);
     }
@@ -229,14 +229,14 @@ public void SonarLintFile_WhenFileChanges_RebuildsCache()
     [DataRow("path//SonarLint.xmla")] // different extension
     public void SonarLintFile_WhenAdditionalFileNotPresent_ReturnsDefaultValues(string folder)
     {
-        var sut = CreateSut(AnalysisScaffolding.CreateOptions(folder)).SonarLintFile();
+        var sut = CreateSut(AnalysisScaffolding.CreateOptions(folder)).ReadSonarLintXml();
         CheckSonarLintXmlDefaultValues(sut);
     }
 
     [TestMethod]
     public void SonarLintFile_WhenInvalidXml_ReturnsDefaultValues()
     {
-        var sut = CreateSut(AnalysisScaffolding.CreateOptions("ResourceTests\\SonarLintXml\\Invalid_Xml\\SonarLint.xml")).SonarLintFile();
+        var sut = CreateSut(AnalysisScaffolding.CreateOptions("ResourceTests\\SonarLintXml\\Invalid_Xml\\SonarLint.xml")).ReadSonarLintXml();
         CheckSonarLintXmlDefaultValues(sut);
     }
 
@@ -245,7 +245,7 @@ public void SonarLintFile_WhenFileIsMissing_ThrowException()
     {
         var sut = CreateSut(AnalysisScaffolding.CreateOptions("ThisPathDoesNotExist\\SonarLint.xml"));
 
-        sut.Invoking(x => x.SonarLintFile())
+        sut.Invoking(x => x.ReadSonarLintXml())
            .Should()
            .Throw<InvalidOperationException>()
            .WithMessage("File 'SonarLint.xml' has been added as an AdditionalFile but could not be read and parsed.");