[Infrastructure improvements] (#8275)

* Improved selenium start and tear down
  * Selenium is set up and torn down in an assembly fixture.
  * Selenium is initialized lazily and in a non-blocking way.
  * Selenium processes are tracked as part of the build and their pids
    written to a file on disk for cleanup in the event of unexpected
    termination of the test process.
  * Browser fixture retries with linear backoff to create a remote
    driver. Under heavy load (like when we are doing a simultaneous NPM
    restore) the selenium server can become unresponsive so we retry
    three times, with a longer comand timeout allowance each time up to
    a max of 3 minutes.
* Moved test project setup to build time instead of runtime.
  * Added target PrepareForTest to create the required files for testing
    * The template creation folder.
    * The template props file to use our built packages.
    * The folder for the custom hive.
  * Added assembly metadata attributes to find all the data we need to
    run the tests.
    * Path to the artifacts shipping packages folder.
    * Path to the artifacts non-shipping packages folder.
    * Path to the test templates creation folder.
    * Path to use for the custom templating hive used in tests.
  * Proper cleanup as part of the build
    * Remove the test templates creation folder.
    * Remove the test packages restore path.
    * Recreate the test templates creation folder.
    * Recreate the test packages restore path.
  * Generated Directory.Build.Props and Directory.Build.Targets in the
    test templates creation folder.
  * Cleaned up potentially stale templatetestsprops.
* Improved test flows
  * Initialization is done lazily and asynchronously.
    * Selenium
    * Browser fixture
    * Template initialization.
  * Flattened test flows to avoid assertions inside deep callstacks.
    * All assertions happen at the test level with improved error messages.
      * With the exception of the migrations assertions.
    * Assertions contain information about which step failed, for what
      project and what failure details.
  * Broke down tests to perform individual steps instead of mixing build
    and publish.
    * Publish project.
    * Build project. (Debug)
    * Run built project.
    * Run published project.
  * Concentrated build logic into the Project class.
    * Context between the different steps of a test is maintained in
      this class.
    * All operations that require coordination are performed within this
      class.
      * There is a lock for dotnet and a lock for nodejs. When building
        SPAs we acquire the nodejs lock to correctly prevent multiple
        runs of nodejs in parallel.

[ApiAuthorization template cleanups]
  * Fix preview3 issues with breaking changes on Entity framework by
    manually configuring the model in ApiAuthorizationDbContext.
  * Add app.db to the project file when using local db.
  * Fix linting errors on angular template.
  * Fix react tests
  * Add tests to cover new auth options in the SPA templates.

Author: javiercn

.azure/pipelines/ci.yml

@@ -341,6 +341,8 @@ jobs:
     beforeBuild:
     - bash: "./eng/scripts/install-nginx-linux.sh"
       displayName: Installing Nginx
+    - bash: "echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p"
+      displayName: Increase inotify limit
     afterBuild:
     - bash: ./build.sh --no-build --ci --test -p:RunFlakyTests=true
       displayName: Run Flaky Tests

.azure/pipelines/jobs/default-build.yml

@@ -125,6 +125,8 @@ jobs:
       displayName: Install JDK 11
     - powershell: Write-Host "##vso[task.prependpath]$env:JAVA_HOME\bin"
       displayName: Prepend JAVA bin folder to the PATH.
+    - powershell: Write-Host "##vso[task.setvariable variable=SeleniumProcessTrackingFolder]$(BuildDirectory)\obj\selenium\"
+      displayName: Add Selenium process tracking folder environment variable
     - powershell: ./eng/scripts/InstallGoogleChrome.ps1
       displayName: Install chrome
   - ${{ if and(eq(variables['System.TeamProject'], 'internal'), eq(parameters.agentOs, 'Windows'), eq(parameters.codeSign, 'true')) }}:

eng/scripts/KillProcesses.ps1

@@ -22,6 +22,22 @@ function _killJavaInstances() {
     }
 }
 
+function _killSeleniumTrackedProcesses() {
+    $files = Get-ChildItem $env:SeleniumProcessTrackingFolder -ErrorAction SilentlyContinue;
+    # PID files have a format of <<pid>>.<<guid>>.pid
+    $pids = $files |
+        Where-Object { $_.Name -match "([0-9]+)\..*?.pid"; } |
+        Foreach-Object { $Matches[1] };
+
+    foreach ($currentPid in $pids) {
+        try {
+            & cmd /c "taskkill /T /F /PID $currentPid 2>&1"
+        } catch {
+            Write-Host "Failed to kill process: $currentPid"
+        }
+    }
+}
+
 _kill dotnet.exe
 _kill testhost.exe
 _kill iisexpress.exe
@@ -35,6 +51,7 @@ _kill chrome.exe
 _kill h2spec.exe
 _kill WerFault.exe
 _killJavaInstances
+_killSeleniumTrackedProcesses
 
 if (Get-Command iisreset -ErrorAction ignore) {
     iisreset /restart

src/Components/test/E2ETest/Infrastructure/AssemblyInfo.AssemblyFixtures.cs

@@ -0,0 +1,8 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using Microsoft.AspNetCore.E2ETesting;
+using Xunit;
+
+[assembly: TestFramework("Microsoft.AspNetCore.E2ETesting.XunitTestFrameworkWithAssemblyFixture", "Microsoft.AspNetCore.Components.E2ETests")]
+[assembly: AssemblyFixture(typeof(SeleniumStandaloneServer))]

src/Components/test/E2ETest/ServerExecutionTests/ServerComponentRenderingTest.cs

@@ -32,7 +32,7 @@ public void ThrowsIfRenderIsRequestedOutsideSyncContext()
 
             appElement.FindElement(By.Id("run-without-dispatch")).Click();
 
-            WaitAssert.Contains(
+            Browser.Contains(
                 $"{typeof(InvalidOperationException).FullName}: The current thread is not associated with the renderer's synchronization context",
                 () => result.Text);
         }

src/Components/test/E2ETest/ServerExecutionTests/ServerSideAppTest.cs

@@ -8,6 +8,7 @@
 using OpenQA.Selenium.Support.UI;
 using System;
 using System.Linq;
+using System.Threading.Tasks;
 using Xunit;
 using Xunit.Abstractions;
 
@@ -23,12 +24,14 @@ public ServerSideAppTest(
         {
             _serverFixture.Environment = AspNetEnvironment.Development;
             _serverFixture.BuildWebHostMethod = ComponentsApp.Server.Program.BuildWebHost;
+        }
 
+        protected override void InitializeAsyncCore()
+        {
             Navigate("/", noReload: false);
             WaitUntilLoaded();
         }
 
-
         [Fact]
         public void HasTitle()
         {
@@ -56,13 +59,13 @@ public void NavMenuHighlightsCurrentLocation()
             Browser.FindElement(By.LinkText("Counter")).Click();
 
             // Verify we're now on the counter page, with that nav link (only) highlighted
-            WaitAssert.Equal("Counter", () => Browser.FindElement(mainHeaderSelector).Text);
+            Browser.Equal("Counter", () => Browser.FindElement(mainHeaderSelector).Text);
             Assert.Collection(Browser.FindElements(activeNavLinksSelector),
                 item => Assert.Equal("Counter", item.Text));
 
             // Verify we can navigate back to home too
             Browser.FindElement(By.LinkText("Home")).Click();
-            WaitAssert.Equal("Hello, world!", () => Browser.FindElement(mainHeaderSelector).Text);
+            Browser.Equal("Hello, world!", () => Browser.FindElement(mainHeaderSelector).Text);
             Assert.Collection(Browser.FindElements(activeNavLinksSelector),
                 item => Assert.Equal("Home", item.Text));
         }
@@ -72,7 +75,7 @@ public void HasCounterPage()
         {
             // Navigate to "Counter"
             Browser.FindElement(By.LinkText("Counter")).Click();
-            WaitAssert.Equal("Counter", () => Browser.FindElement(By.TagName("h1")).Text);
+            Browser.Equal("Counter", () => Browser.FindElement(By.TagName("h1")).Text);
 
             // Observe the initial value is zero
             var countDisplayElement = Browser.FindElement(By.CssSelector("h1 + p"));
@@ -81,19 +84,19 @@ public void HasCounterPage()
             // Click the button; see it counts
             var button = Browser.FindElement(By.CssSelector(".main button"));
             button.Click();
-            WaitAssert.Equal("Current count: 1", () => countDisplayElement.Text);
+            Browser.Equal("Current count: 1", () => countDisplayElement.Text);
             button.Click();
-            WaitAssert.Equal("Current count: 2", () => countDisplayElement.Text);
+            Browser.Equal("Current count: 2", () => countDisplayElement.Text);
             button.Click();
-            WaitAssert.Equal("Current count: 3", () => countDisplayElement.Text);
+            Browser.Equal("Current count: 3", () => countDisplayElement.Text);
         }
 
         [Fact]
         public void HasFetchDataPage()
         {
             // Navigate to "Fetch Data"
             Browser.FindElement(By.LinkText("Fetch data")).Click();
-            WaitAssert.Equal("Weather forecast", () => Browser.FindElement(By.TagName("h1")).Text);
+            Browser.Equal("Weather forecast", () => Browser.FindElement(By.TagName("h1")).Text);
 
             // Wait until loaded
             var tableSelector = By.CssSelector("table.table");

src/Components/test/E2ETest/Tests/BinaryHttpClientTest.cs

@@ -8,6 +8,7 @@
 using OpenQA.Selenium;
 using OpenQA.Selenium.Support.UI;
 using System;
+using System.Threading.Tasks;
 using Xunit;
 using Xunit.Abstractions;
 
@@ -16,7 +17,7 @@ namespace Microsoft.AspNetCore.Components.E2ETest.Tests
     public class BinaryHttpClientTest : BasicTestAppTestBase, IClassFixture<AspNetSiteServerFixture>
     {
         readonly ServerFixture _apiServerFixture;
-        readonly IWebElement _appElement;
+        IWebElement _appElement;
         IWebElement _responseStatus;
         IWebElement _responseStatusText;
         IWebElement _testOutcome;
@@ -30,11 +31,14 @@ public BinaryHttpClientTest(
         {
             apiServerFixture.BuildWebHostMethod = TestServer.Program.BuildWebHost;
             _apiServerFixture = apiServerFixture;
+        }
 
+        protected override void InitializeAsyncCore()
+        {
             Navigate(ServerPathBase, noReload: true);
             _appElement = MountTestComponent<BinaryHttpRequestsComponent>();
         }
-        
+
         [Fact]
         public void CanSendAndReceiveBytes()
         {