Sync with atata-repository-template and refactor sources accordingly

YevgeniyShunevych · YevgeniyShunevych · commit c1c296511e8c · 2022-10-04T13:50:38.000+02:00
diff --git a/.editorconfig b/.editorconfig
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,42 @@
+*              text=auto
+
+*.sln          text eol=crlf
+
+*.csproj       text eol=crlf
+
+*.cs           text eol=crlf
+*.csx          text eol=crlf
+
+*.props        text eol=crlf
+*.targets      text eol=crlf
+*.config       text eol=crlf
+*.nuspec       text eol=crlf
+*.resx         text eol=crlf
+*.vsixmanifest text eol=crlf
+*.vstemplate   text eol=crlf
+
+*.xml          text eol=crlf
+*.runsettings  text eol=crlf
+*.json         text eol=crlf
+*.yml          text eol=crlf
+*.yaml         text eol=crlf
+*.editorconfig text eol=crlf
+*.config       text eol=crlf
+*.manifest     text eol=crlf
+
+*.md           text eol=crlf
+
+*.ps1          text eol=crlf
+*.bat          text eol=crlf
+
+*.html         text eol=crlf
+*.cshtml       text eol=crlf
+*.aspx         text eol=crlf
+*.razor        text eol=crlf
+
+*.css          text eol=crlf
+*.scss         text eol=crlf
+*.less         text eol=crlf
+
+*.js           text eol=crlf
+*.ts           text eol=crlf
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -7,25 +7,27 @@ Any issues or questions can also be targeted to any communication channel define
 
 ## Code Contributing
 
+### Development Prerequisites
+
+- Visual Studio 2022 or JetBrains Raider.
+
 ### Setting Up For Development
 
 In order to set up this project for further contributing do the following:
 
 - Fork the repository.
 - Clone the forked repository locally.
 - Open `.sln` file located in the root of the repository.
-
-### Development Prerequisites
-
-- Visual Studio 2019 with .NET Core tools installed or JetBrains Raider.
+- Run tests through IDE or with `dotnet test` command.
 
 ### Development
 
 Please follow the rules during development:
+
 - Fix (or suppress in rare cases) all code analysis warnings.
 - Ensure that newly added public classes and members have XML documentation comments.
   This does not apply to classes in test projects. 
 - Run all tests in order to ensure the changes don't break anything.
 - Try to add/update tests respectively.
 - Follow [Semantic Versioning 2.0](https://semver.org/) during the source changes.
-- [Create pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork) when it is done.
+- [Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) when it is done.
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -5,15 +5,14 @@
     <Company>Yevgeniy Shunevych</Company>
     <Product>Atata Framework</Product>
     <Copyright>© Yevgeniy Shunevych 2022</Copyright>
-    <CodeAnalysisRuleSet>$(MSBuildThisFileDirectory)General.ruleset</CodeAnalysisRuleSet>
     <EnableNETAnalyzers>true</EnableNETAnalyzers>
     <AnalysisMode>AllEnabledByDefault</AnalysisMode>
     <AnalysisLevel>latest</AnalysisLevel>
   </PropertyGroup>
 
   <ItemGroup Label="Code analysis packages">
-    <PackageReference Include="SonarAnalyzer.CSharp" Version="8.35.0.42613" PrivateAssets="All" />
-    <PackageReference Include="StyleCop.Analyzers" Version="1.1.118" PrivateAssets="All" />
+    <PackageReference Include="SonarAnalyzer.CSharp" Version="8.44.0.52574" PrivateAssets="All" />
+    <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.435" PrivateAssets="All" />
   </ItemGroup>
 
 </Project>
diff --git a/src/Atata.HtmlValidation/Extensions/CheckExtensions.cs b/src/Atata.HtmlValidation/Extensions/CheckExtensions.cs
@@ -104,11 +104,9 @@ message is null
             ? new ArgumentNullException(argumentName)
             : new ArgumentNullException(argumentName, message);
 
-        private static string ConcatMessage(string primaryMessage, string secondaryMessage)
-        {
-            return string.IsNullOrEmpty(secondaryMessage)
+        private static string ConcatMessage(string primaryMessage, string secondaryMessage) =>
+            string.IsNullOrEmpty(secondaryMessage)
                 ? primaryMessage
                 : $"{primaryMessage} {secondaryMessage}";
-        }
     }
 }
diff --git a/src/Atata.HtmlValidation/GlobalSuppressions.cs b/src/Atata.HtmlValidation/GlobalSuppressions.cs
@@ -3,5 +3,6 @@
 #pragma warning disable S103 // Lines should not be too long
 
 [assembly: SuppressMessage("Critical Code Smell", "S2696:Instance members should not write to \"static\" fields", Justification = "<Pending>", Scope = "member", Target = "~M:Atata.HtmlValidation.HtmlValidator.EnsureCliIsInstalled")]
+[assembly: SuppressMessage("Style", "IDE0053:Use expression body for lambda expressions", Justification = "<Pending>", Scope = "member", Target = "~M:Atata.PageObjectHtmlValidateExtensions.ValidateHtml``1(``0,Atata.HtmlValidation.HtmlValidationOptions,System.Boolean)~``0")]
 
 #pragma warning restore S103 // Lines should not be too long
diff --git a/src/Atata.HtmlValidation/ValidateHtmlAttribute.cs b/src/Atata.HtmlValidation/ValidateHtmlAttribute.cs
@@ -19,9 +19,7 @@ public ValidateHtmlAttribute(TriggerEvents on = TriggerEvents.Init, TriggerPrior
         /// </summary>
         public bool AsWarning { get; set; }
 
-        protected override void Execute<TOwner>(TriggerContext<TOwner> context)
-        {
+        protected override void Execute<TOwner>(TriggerContext<TOwner> context) =>
             context.Component.Owner.ValidateHtml(asWarning: AsWarning);
-        }
     }
 }
diff --git a/src/icon.png b/src/icon.png
diff --git a/test/Atata.HtmlValidation.IntegrationTests/Atata.HtmlValidation.IntegrationTests.csproj b/test/Atata.HtmlValidation.IntegrationTests/Atata.HtmlValidation.IntegrationTests.csproj
@@ -2,8 +2,15 @@
 
   <PropertyGroup>
     <TargetFramework>net6.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
   </PropertyGroup>
 
+  <ItemGroup>
+    <Using Include="NUnit.Framework" />
+    <Using Include="NUnit.Framework.Internal" />
+    <Using Include="System.Collections" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Atata.WebDriverSetup" Version="2.4.0" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.2" />
diff --git a/test/Atata.HtmlValidation.IntegrationTests/PageObjectHtmlValidateExtensionsTests.cs b/test/Atata.HtmlValidation.IntegrationTests/PageObjectHtmlValidateExtensionsTests.cs
@@ -1,59 +1,52 @@
-﻿using System;
-using System.IO;
-using Atata.Cli.HtmlValidate;
-using NUnit.Framework;
-using NUnit.Framework.Internal;
+﻿using Atata.Cli.HtmlValidate;
 
-namespace Atata.HtmlValidation.IntegrationTests
+namespace Atata.HtmlValidation.IntegrationTests;
+
+[TestFixture]
+public class PageObjectHtmlValidateExtensionsTests : UITestFixture
 {
-    [TestFixture]
-    public class PageObjectHtmlValidateExtensionsTests : UITestFixture
-    {
-        [Test]
-        public void ValidateHtml_WithoutErrors()
-        {
-            GoToTestPage("Errors0.html")
-                .ValidateHtml();
-        }
+    [Test]
+    public void ValidateHtml_WithoutErrors() =>
+        GoToTestPage("Errors0.html")
+            .ValidateHtml();
 
-        [Test]
-        public void ValidateHtml_WithErrors_WithOptions()
+    [Test]
+    public void ValidateHtml_WithErrors_WithOptions()
+    {
+        var options = new HtmlValidationOptions
         {
-            var options = new HtmlValidationOptions
-            {
-                OutputFormatter = HtmlValidateFormatter.Names.Json
-            };
+            OutputFormatter = HtmlValidateFormatter.Names.Json
+        };
 
-            var sut = GoToTestPage("Errors1.html");
+        var sut = GoToTestPage("Errors1.html");
 
-            var exception = Assert.Throws<NUnit.Framework.AssertionException>(
-                () => sut.ValidateHtml(options));
+        var exception = Assert.Throws<NUnit.Framework.AssertionException>(
+            () => sut.ValidateHtml(options));
 
-            exception.ToResultSubject()
-                .ValueOf(x => x.Message).Should.Contain("\"errorCount\"");
-        }
+        exception.ToResultSubject()
+            .ValueOf(x => x.Message).Should.Contain("\"errorCount\"");
+    }
 
-        [Test]
-        public void ValidateHtml_WithErrors_AsWarning()
-        {
-            GoToTestPage("Errors1.html")
-                .ValidateHtml(asWarning: true);
+    [Test]
+    public void ValidateHtml_WithErrors_AsWarning()
+    {
+        GoToTestPage("Errors1.html")
+            .ValidateHtml(asWarning: true);
 
-            var assertionResults = TestExecutionContext.CurrentContext.CurrentResult.AssertionResults;
+        var assertionResults = TestExecutionContext.CurrentContext.CurrentResult.AssertionResults;
 
-            assertionResults.ToSubject(nameof(assertionResults))
-                .ValueOf(x => x.Count).Should.Equal(1)
-                .ValueOf(x => x[0].Status).Should.Equal(NUnit.Framework.Interfaces.AssertionStatus.Warning);
+        assertionResults.ToSubject(nameof(assertionResults))
+            .ValueOf(x => x.Count).Should.Equal(1)
+            .ValueOf(x => x[0].Status).Should.Equal(NUnit.Framework.Interfaces.AssertionStatus.Warning);
 
-            assertionResults.Clear();
-        }
+        assertionResults.Clear();
+    }
 
-        private static OrdinaryPage GoToTestPage(string name)
-        {
-            string filePath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "TestPages", name);
-            string url = "file:///" + filePath;
+    private static OrdinaryPage GoToTestPage(string name)
+    {
+        string filePath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "TestPages", name);
+        string url = "file:///" + filePath;
 
-            return Go.To<OrdinaryPage>(url: url);
-        }
+        return Go.To<OrdinaryPage>(url: url);
     }
 }
diff --git a/test/Atata.HtmlValidation.IntegrationTests/SetUpFixture.cs b/test/Atata.HtmlValidation.IntegrationTests/SetUpFixture.cs
@@ -1,20 +1,17 @@
-﻿using NUnit.Framework;
+﻿namespace Atata.HtmlValidation.IntegrationTests;
 
-namespace Atata.HtmlValidation.IntegrationTests
+[SetUpFixture]
+public class SetUpFixture
 {
-    [SetUpFixture]
-    public class SetUpFixture
+    [OneTimeSetUp]
+    public void GlobalSetUp()
     {
-        [OneTimeSetUp]
-        public void GlobalSetUp()
-        {
-            AtataContext.GlobalConfiguration
-                .UseChrome()
-                    .WithArguments("start-maximized")
-                .UseCulture("en-US")
-                .UseAllNUnitFeatures();
+        AtataContext.GlobalConfiguration
+            .UseChrome()
+                .WithArguments("start-maximized")
+            .UseCulture("en-US")
+            .UseAllNUnitFeatures();
 
-            AtataContext.GlobalConfiguration.AutoSetUpDriverToUse();
-        }
+        AtataContext.GlobalConfiguration.AutoSetUpDriverToUse();
     }
 }
diff --git a/test/Atata.HtmlValidation.IntegrationTests/UITestFixture.cs b/test/Atata.HtmlValidation.IntegrationTests/UITestFixture.cs
@@ -1,21 +1,14 @@
-﻿using NUnit.Framework;
+﻿namespace Atata.HtmlValidation.IntegrationTests;
 
-namespace Atata.HtmlValidation.IntegrationTests
+[TestFixture]
+[Parallelizable(ParallelScope.Self)]
+public class UITestFixture
 {
-    [TestFixture]
-    [Parallelizable(ParallelScope.Self)]
-    public class UITestFixture
-    {
-        [SetUp]
-        public void SetUp()
-        {
-            AtataContext.Configure().Build();
-        }
+    [SetUp]
+    public void SetUp() =>
+        AtataContext.Configure().Build();
 
-        [TearDown]
-        public void TearDown()
-        {
-            AtataContext.Current?.CleanUp();
-        }
-    }
+    [TearDown]
+    public void TearDown() =>
+        AtataContext.Current?.CleanUp();
 }

Original file line number	Diff line number	Diff line change
`@@ -104,11 +104,9 @@ message is null`
`104`	`104`	`? new ArgumentNullException(argumentName)`
`105`	`105`	`: new ArgumentNullException(argumentName, message);`
`106`	`106`
`107`		`- private static string ConcatMessage(string primaryMessage, string secondaryMessage)`
`108`		`- {`
`109`		`- return string.IsNullOrEmpty(secondaryMessage)`
	`107`	`+ private static string ConcatMessage(string primaryMessage, string secondaryMessage) =>`
	`108`	`+ string.IsNullOrEmpty(secondaryMessage)`
`110`	`109`	`? primaryMessage`
`111`	`110`	`: $"{primaryMessage} {secondaryMessage}";`
`112`		`- }`
`113`	`111`	`}`
`114`	`112`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,9 +19,7 @@ public ValidateHtmlAttribute(TriggerEvents on = TriggerEvents.Init, TriggerPrior`
`19`	`19`	`/// </summary>`
`20`	`20`	`public bool AsWarning { get; set; }`
`21`	`21`
`22`		`- protected override void Execute<TOwner>(TriggerContext<TOwner> context)`
`23`		`- {`
	`22`	`+ protected override void Execute<TOwner>(TriggerContext<TOwner> context) =>`
`24`	`23`	`context.Component.Owner.ValidateHtml(asWarning: AsWarning);`
`25`		`- }`
`26`	`24`	`}`
`27`	`25`	`}`