Run Blazor E2E tests on SauceLabs

Author: ajaybhargavb

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

@@ -6,3 +6,4 @@
 
 [assembly: TestFramework("Microsoft.AspNetCore.E2ETesting.XunitTestFrameworkWithAssemblyFixture", "Microsoft.AspNetCore.Components.E2ETests")]
 [assembly: AssemblyFixture(typeof(SeleniumStandaloneServer))]
+[assembly: AssemblyFixture(typeof(SauceConnectServer))]

src/Components/test/E2ETest/Infrastructure/ServerFixtures/AspNetSiteServerFixture.cs

@@ -6,6 +6,7 @@
 using System.IO;
 using System.Linq;
 using System.Reflection;
+using Microsoft.AspNetCore.E2ETesting;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.Hosting;
 
@@ -34,9 +35,15 @@ protected override IHost CreateWebHost()
             var assembly = ApplicationAssembly ?? BuildWebHostMethod.Method.DeclaringType.Assembly;
             var sampleSitePath = FindSampleOrTestSitePath(assembly.FullName);
 
+            var host = "127.0.0.1";
+            if (E2ETestOptions.Instance.SauceTest)
+            {
+                host = E2ETestOptions.Instance.Sauce.HostName;
+            }
+
             return BuildWebHostMethod(new[]
             {
-                "--urls", "http://127.0.0.1:0",
+                "--urls", $"http://{host}:0",
                 "--contentroot", sampleSitePath,
                 "--environment", Environment.ToString(),
             }.Concat(AdditionalArguments).ToArray());

src/Components/test/E2ETest/Infrastructure/ServerFixtures/DevHostServerFixture.cs

@@ -1,6 +1,7 @@
 // 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 Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.Hosting.Server;
 using Microsoft.AspNetCore.Http.Features;
@@ -24,9 +25,15 @@ protected override IHost CreateWebHost()
             ContentRoot = FindSampleOrTestSitePath(
                 typeof(TProgram).Assembly.FullName);
 
+            var host = "127.0.0.1";
+            if (E2ETestOptions.Instance.SauceTest)
+            {
+                host = E2ETestOptions.Instance.Sauce.HostName;
+            }
+
             var args = new List<string>
             {
-                "--urls", "http://127.0.0.1:0",
+                "--urls", $"http://{host}:0",
                 "--contentroot", ContentRoot,
                 "--pathbase", PathBase,
                 "--applicationpath", typeof(TProgram).Assembly.Location,

src/Components/test/E2ETest/Infrastructure/ServerFixtures/ServerFixture.cs

@@ -8,6 +8,7 @@
 using System.Reflection;
 using System.Runtime.ExceptionServices;
 using System.Threading;
+using Microsoft.AspNetCore.E2ETesting;
 
 namespace Microsoft.AspNetCore.Components.E2ETest.Infrastructure.ServerFixtures
 {
@@ -22,7 +23,15 @@ public abstract class ServerFixture : IDisposable
         public ServerFixture()
         {
             _rootUriInitializer = new Lazy<Uri>(() =>
-                new Uri(StartAndGetRootUri()));
+            {
+                var uri = new Uri(StartAndGetRootUri());
+                if (E2ETestOptions.Instance.SauceTest)
+                {
+                    uri = new UriBuilder(uri.Scheme, E2ETestOptions.Instance.Sauce.HostName, uri.Port).Uri;
+                }
+
+                return uri;
+            });
         }
 
         public abstract void Dispose();

src/Components/test/E2ETest/Infrastructure/ServerFixtures/StaticSiteServerFixture.cs

@@ -4,6 +4,7 @@
 using System;
 using System.IO;
 using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.E2ETesting;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.Hosting;
 
@@ -26,13 +27,19 @@ protected override IHost CreateWebHost()
 
             var sampleSitePath = FindSampleOrTestSitePath(SampleSiteName);
 
+            var host = "127.0.0.1";
+            if (E2ETestOptions.Instance.SauceTest)
+            {
+                host = E2ETestOptions.Instance.Sauce.HostName;
+            }
+
             return new HostBuilder()
                 .ConfigureWebHost(webHostBuilder => webHostBuilder
                     .UseKestrel()
                     .UseContentRoot(sampleSitePath)
                     .UseWebRoot(string.Empty)
                     .UseStartup<StaticSiteStartup>()
-                    .UseUrls("http://127.0.0.1:0"))
+                    .UseUrls($"http://{host}:0"))
                 .Build();
         }
 

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

@@ -8,7 +8,6 @@
 using OpenQA.Selenium.Support.UI;
 using System;
 using System.Linq;
-using System.Threading.Tasks;
 using Xunit;
 using Xunit.Abstractions;
 

src/Components/test/E2ETest/e2eTestSettings.json

@@ -1,4 +1,11 @@
 {
   "DefaultWaitTimeoutInSeconds": 20,
-  "ScreenShotsPath": "../../screenshots"
+  "ScreenShotsPath": "../../screenshots",
+  "SauceTest":  true,
+  "Sauce": {
+    "Username": "placeholder",
+    "AccessKey": "placeholder",
+    "TunnelIdentifier": "blazor-e2e-sc-proxy-tunnel",
+    "HostName": "sauce.local"
+  }
 }

src/Components/test/E2ETest/package.json

@@ -6,11 +6,18 @@
   "private": true,
   "scripts": {
     "selenium-standalone": "selenium-standalone",
-    "prepare": "selenium-standalone install"
+    "prepare": "selenium-standalone install",
+    "sauce": "ts-node ./scripts/sauce.ts"
   },
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
+    "sauce-connect-launcher": "^1.3.1",
     "selenium-standalone": "^6.15.4"
+  },
+  "devDependencies": {
+    "@types/node": "^13.1.7",
+    "ts-node": "^8.6.2",
+    "typescript": "^3.7.5"
   }
 }

src/Components/test/E2ETest/scripts/sauce.ts

@@ -0,0 +1,82 @@
+import { EOL } from "os";
+import * as _fs from "fs";
+import { promisify } from "util";
+
+// Promisify things from fs we want to use.
+const fs = {
+    createWriteStream: _fs.createWriteStream,
+    exists: promisify(_fs.exists),
+    mkdir: promisify(_fs.mkdir),
+    appendFile: promisify(_fs.appendFile),
+    readFile: promisify(_fs.readFile),
+};
+
+process.on("unhandledRejection", (reason) => {
+    console.error(`Unhandled promise rejection: ${reason}`);
+    process.exit(1);
+});
+
+let sauceUser = null;
+let sauceKey = null;
+let tunnelIdentifier = null;
+let hostName = null;
+
+for (let i = 0; i < process.argv.length; i += 1) {
+    switch (process.argv[i]) {
+        case "--sauce-user":
+            i += 1;
+            sauceUser = process.argv[i];
+            break;
+        case "--sauce-key":
+            i += 1;
+            sauceKey = process.argv[i];
+            break;
+        case "--sauce-tunnel":
+            i += 1;
+            tunnelIdentifier = process.argv[i];
+            break;
+        case "--use-hostname":
+            i += 1;
+            hostName = process.argv[i];
+            break;
+    }
+}
+
+const HOSTSFILE_PATH = process.platform === "win32" ? `${process.env.SystemRoot}\\System32\\drivers\\etc\\hosts` : null;
+
+(async () => {
+
+    if (hostName) {
+        // Register a custom hostname in the hosts file (requires Admin, but AzDO agents run as Admin)
+        // Used to work around issues in Sauce Labs.
+        if (process.platform !== "win32") {
+            throw new Error("Can't use '--use-hostname' on non-Windows platform.");
+        }
+
+        try {
+
+            console.log(`Updating Hosts file (${HOSTSFILE_PATH}) to register host name '${hostName}'`);
+            await fs.appendFile(HOSTSFILE_PATH, `${EOL}127.0.0.1 ${hostName}${EOL}`);
+
+        } catch (error) {
+            console.log(`Unable to update hosts file at ${HOSTSFILE_PATH}. Error: ${error}`);
+        }
+    }
+
+
+    // Creates a persistent proxy tunnel using Sauce Connect.
+    var sauceConnectLauncher = require('sauce-connect-launcher');
+
+    sauceConnectLauncher({
+        username: sauceUser,
+        accessKey: sauceKey,
+        tunnelIdentifier: tunnelIdentifier,
+    }, function (err, sauceConnectProcess) {
+        if (err) {
+            console.error(err.message);
+            return;
+        }
+
+        console.log("Sauce Connect ready");
+    });
+})();