Implemented Puppeteer.launch tests (#79)

Meir017 · kblok · commit e3e40dd81448 · 2018-03-08T09:58:32.000-03:00
* added Network redirects should report SecurityDetails test

* fixed Network redirects should report SecurityDetails test

* added should reject all promises when browser is closed test

* fixed test NetworkRedirectsShouldReportSecurityDetails

* added should reject if executable path is invalid test

* fixed throw NavigationException

* fixed Network redirects should report SecurityDetails test

* fixed should reject if executable path is invalid test

* added userDataDir option &amp; userDataDir argument tests

* cleaned usings

* added should return the default chrome arguments test

* working version

* cleaned ForceKillChrome
diff --git a/lib/PuppeteerSharp.TestServer/Startup.cs b/lib/PuppeteerSharp.TestServer/Startup.cs
@@ -5,6 +5,7 @@
 using System.Threading.Tasks;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.Rewrite;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 
@@ -31,6 +32,8 @@ public void ConfigureServices(IServiceCollection services)
 
         public void Configure(IApplicationBuilder app)
         {
+            app.UseRewriter(new RewriteOptions()
+                .AddRedirect("plzredirect", "empty.html"));
             app.UseStaticFiles();
         }
     }
diff --git a/lib/PuppeteerSharp.Tests/Puppeteer/PuppeteerLaunchTests.cs b/lib/PuppeteerSharp.Tests/Puppeteer/PuppeteerLaunchTests.cs
@@ -1,4 +1,9 @@
-﻿using System.Threading.Tasks;
+﻿using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Net;
+using System.Threading.Tasks;
 using Xunit;
 
 namespace PuppeteerSharp.Tests.Puppeteer
@@ -34,5 +39,87 @@ public async Task ShouldWorkInRealLife()
 
             await browser.CloseAsync();
         }
+
+        [Fact(Skip = "test is not part of v1.0.0")]
+        public async Task NetworkRedirectsShouldReportSecurityDetails()
+        {
+            var options = TestConstants.DefaultBrowserOptions();
+            options.IgnoreHTTPSErrors = true;
+
+            var browser = await PuppeteerSharp.Puppeteer.LaunchAsync(options, TestConstants.ChromiumRevision);
+            var page = await browser.NewPageAsync();
+
+            var responses = new List<Response>();
+            page.ResponseCreated += (sender, e) => responses.Add(e.Response);
+
+            await page.GoToAsync(TestConstants.HttpsPrefix + "/plzredirect");
+            Assert.Equal(2, responses.Count);
+            Assert.Equal(HttpStatusCode.Redirect, responses[0].Status);
+            var securityDetails = responses[0].SecurityDetails;
+            Assert.Equal("TLS 1.2", securityDetails.Protocol);
+
+            await page.CloseAsync();
+            await browser.CloseAsync();
+        }
+
+        [Fact(Skip = "https://github.com/kblok/puppeteer-sharp/issues/76")]
+        public async Task ShouldRejectAllPromisesWhenBrowserIsClosed()
+        {
+            var browser = await PuppeteerSharp.Puppeteer.LaunchAsync(TestConstants.DefaultBrowserOptions(), TestConstants.ChromiumRevision);
+            var page = await browser.NewPageAsync();
+
+            var neverResolves = page.EvaluateHandle("() => new Promise(r => {})");
+            await browser.CloseAsync();
+
+            await neverResolves;
+            var exception = await Assert.ThrowsAsync<Exception>(() => neverResolves);
+            Assert.Contains("Protocol error", exception.Message);
+        }
+
+        [Fact]
+        public async Task ShouldRejectIfExecutablePathIsInvalid()
+        {
+            var options = TestConstants.DefaultBrowserOptions();
+            options.ExecutablePath = "random-invalid-path";
+
+            var exception = await Assert.ThrowsAsync<FileNotFoundException>(() => PuppeteerSharp.Puppeteer.LaunchAsync(options, TestConstants.ChromiumRevision));
+            Assert.Equal("Failed to launch chrome! path to executable does not exist", exception.Message);
+            Assert.Equal(options.ExecutablePath, exception.FileName);
+        }
+
+        [Fact]
+        public async Task UserDataDirOption()
+        {
+            var userDataDir = Launcher.GetTemporaryDirectory();
+            var options = TestConstants.DefaultBrowserOptions();
+            options.UserDataDir = userDataDir;
+
+            var browser = await PuppeteerSharp.Puppeteer.LaunchAsync(options, TestConstants.ChromiumRevision);
+            Assert.True(Directory.GetFiles(userDataDir).Length > 0);
+            await browser.CloseAsync();
+            Assert.True(Directory.GetFiles(userDataDir).Length > 0);
+            // Directory.Delete(userDataDir, true);
+        }
+
+        [Fact]
+        public async Task UserDataDirArgument()
+        {
+            var userDataDir = Launcher.GetTemporaryDirectory();
+            var options = TestConstants.DefaultBrowserOptions();
+            options.Args = options.Args.Concat(new[] { $"--user-data-dir={userDataDir}" }).ToArray();
+
+            var browser = await PuppeteerSharp.Puppeteer.LaunchAsync(options, TestConstants.ChromiumRevision);
+            Assert.True(Directory.GetFiles(userDataDir).Length > 0);
+            await browser.CloseAsync();
+            Assert.True(Directory.GetFiles(userDataDir).Length > 0);
+            // Directory.Delete(userDataDir, true);
+        }
+
+        [Fact]
+        public void ShouldReturnTheDefaultChromeArguments()
+        {
+            var args = PuppeteerSharp.Puppeteer.DefaultArgs;
+            Assert.Contains("--no-first-run", args);
+        }
     }
 }
diff --git a/lib/PuppeteerSharp/Launcher.cs b/lib/PuppeteerSharp/Launcher.cs
@@ -13,7 +13,7 @@ namespace PuppeteerSharp
 {
     public class Launcher
     {
-        private static readonly string[] _defaultArgs = {
+        internal static readonly string[] DefaultArgs = {
             "--disable-background-networking",
             "--disable-background-timer-throttling",
             "--disable-client-side-phishing-detection",
@@ -30,7 +30,7 @@ public class Launcher
             "--safebrowsing-disable-auto-update",
         };
 
-        public static readonly string[] _automationArgs = {
+        internal static readonly string[] AutomationArgs = {
             "--enable-automation",
             "--password-store=basic",
             "--use-mock-keychain"
@@ -44,27 +44,27 @@ public class Launcher
 
         internal async Task<Browser> LaunchAsync(LaunchOptions options, int chromiumRevision)
         {
-            var chromeArguments = new List<string>(_defaultArgs);
+            var chromeArguments = new List<string>(DefaultArgs);
 
             if (options.AppMode)
             {
                 options.Headless = false;
             }
             else
             {
-                chromeArguments.AddRange(_automationArgs);
+                chromeArguments.AddRange(AutomationArgs);
             }
 
-            if (options.Args.Any(i => i.StartsWith("--user-data-dir", StringComparison.Ordinal)))
+            if (!options.Args.Any(i => i.StartsWith("--user-data-dir", StringComparison.Ordinal)))
             {
                 if (string.IsNullOrEmpty(options.UserDataDir))
                 {
                     _temporaryUserDataDir = GetTemporaryDirectory();
-                    chromeArguments.Add($"--user-data-dir=${_temporaryUserDataDir}");
+                    chromeArguments.Add($"--user-data-dir={_temporaryUserDataDir}");
                 }
                 else
                 {
-                    chromeArguments.Add($"--user-data-dir=${options.UserDataDir}");
+                    chromeArguments.Add($"--user-data-dir={options.UserDataDir}");
                 }
             }
 
@@ -92,6 +92,10 @@ internal async Task<Browser> LaunchAsync(LaunchOptions options, int chromiumRevi
                 var revisionInfo = downloader.RevisionInfo(Downloader.CurrentPlatform, chromiumRevision);
                 chromeExecutable = revisionInfo.ExecutablePath;
             }
+            if (!File.Exists(chromeExecutable))
+            {
+                throw new FileNotFoundException("Failed to launch chrome! path to executable does not exist", chromeExecutable);
+            }
 
             if (options.Args.Any())
             {
@@ -104,7 +108,7 @@ internal async Task<Browser> LaunchAsync(LaunchOptions options, int chromiumRevi
 
             SetEnvVariables(_chromeProcess.StartInfo.Environment, options.Env, Environment.GetEnvironmentVariables());
 
-            if(!options.DumpIO)
+            if (!options.DumpIO)
             {
                 _chromeProcess.StartInfo.RedirectStandardOutput = false;
                 _chromeProcess.StartInfo.RedirectStandardError = false;
@@ -215,6 +219,7 @@ private async Task ForceKillChrome()
             if (_chromeProcess.Id != 0 && Process.GetProcessById(_chromeProcess.Id) != null)
             {
                 _chromeProcess.Kill();
+                _chromeProcess.WaitForExit();
             }
 
             if (_temporaryUserDataDir != null)
diff --git a/lib/PuppeteerSharp/NetworkManager.cs b/lib/PuppeteerSharp/NetworkManager.cs
@@ -184,7 +184,8 @@ private void OnResponseReceived(MessageEventArgs e)
                     _client,
                     request,
                     (HttpStatusCode)e.MessageData.response.status,
-                    ((JObject)e.MessageData.response.headers).ToObject<Dictionary<string, object>>());
+                    ((JObject)e.MessageData.response.headers).ToObject<Dictionary<string, object>>(),
+                    e.MessageData.response.securityDetails?.ToObject<SecurityDetails>());
 
                 request.Response = response;
 
@@ -284,9 +285,9 @@ private void HandleRequestStart(string requestId, string interceptionId, string
             });
         }
 
-        private void HandleRequestRedirect(Request request, HttpStatusCode redirectStatus, Dictionary<string, object> redirectHeaders)
+        private void HandleRequestRedirect(Request request, HttpStatusCode redirectStatus, Dictionary<string, object> redirectHeaders, SecurityDetails securityDetails = null)
         {
-            var response = new Response(_client, request, redirectStatus, redirectHeaders);
+            var response = new Response(_client, request, redirectStatus, redirectHeaders, securityDetails);
             request.Response = response;
             _requestIdToRequest.Remove(request.RequestId);
 
@@ -346,7 +347,8 @@ private void OnRequestWillBeSent(MessageEventArgs e)
                 HandleRequestRedirect(
                     request,
                     (HttpStatusCode)e.MessageData.redirectResponse.status,
-                    e.MessageData.redirectResponse.headers.ToObject<Dictionary<string, object>>());
+                    e.MessageData.redirectResponse.headers.ToObject<Dictionary<string, object>>(),
+                    e.MessageData.redirectResponse.securityDetails?.ToObject<SecurityDetails>());
             }
 
             HandleRequestStart(
diff --git a/lib/PuppeteerSharp/Page.cs b/lib/PuppeteerSharp/Page.cs
@@ -688,7 +688,7 @@ private async Task Navigate(Session client, string url, string referrer)
 
             if (response.errorText != null)
             {
-                throw new NavigationException(response.errorText);
+                throw new NavigationException(response.errorText.ToString());
             }
         }
 
diff --git a/lib/PuppeteerSharp/Puppeteer.cs b/lib/PuppeteerSharp/Puppeteer.cs
@@ -6,6 +6,8 @@ namespace PuppeteerSharp
 {
     public class Puppeteer
     {
+        public static string[] DefaultArgs => Launcher.DefaultArgs;
+
         public static async Task<Browser> LaunchAsync(LaunchOptions options, int chromiumRevision)
         {
             return await new Launcher().LaunchAsync(options, chromiumRevision);
diff --git a/lib/PuppeteerSharp/Response.cs b/lib/PuppeteerSharp/Response.cs
@@ -13,7 +13,7 @@ public class Response
         private bool _ok;
         private string _url;
 
-        public Response(Session client, Request request, HttpStatusCode status, Dictionary<string, object> headers)
+        public Response(Session client, Request request, HttpStatusCode status, Dictionary<string, object> headers, SecurityDetails securityDetails)
         {
             _client = client;
             Request = request;
@@ -26,7 +26,7 @@ public Response(Session client, Request request, HttpStatusCode status, Dictiona
             {
                 Headers[keyValue.Key] = keyValue.Value;
             }
-
+            SecurityDetails = securityDetails;
         }
 
         #region Properties
@@ -38,6 +38,7 @@ public Response(Session client, Request request, HttpStatusCode status, Dictiona
         public Task<string> ContentTask => ContentTaskWrapper.Task;
         public TaskCompletionSource<string> ContentTaskWrapper { get; internal set; }
         public Request Request { get; internal set; }
+        public SecurityDetails SecurityDetails { get; internal set; }
         #endregion
 
         #region Public Methods
diff --git a/lib/PuppeteerSharp/SecurityDetails.cs b/lib/PuppeteerSharp/SecurityDetails.cs
@@ -0,0 +1,26 @@
+﻿using System.Collections.Generic;
+using System.Net;
+using System.Threading.Tasks;
+using Newtonsoft.Json.Linq;
+
+namespace PuppeteerSharp
+{
+    public class SecurityDetails
+    {
+        public SecurityDetails(string subjectName, string issuer, int validFrom, int validTo, string protocol)
+        {
+            SubjectName = subjectName;
+            Issuer = issuer;
+            ValidFrom = validFrom;
+            ValidTo = validTo;
+            Protocol = protocol;
+        }
+
+        public string SubjectName { get; }
+        public string Issuer { get; }
+        public int ValidFrom { get; }
+        public int ValidTo { get; }
+        public string Protocol { get; }
+
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`using System.Threading.Tasks;`
`6`	`6`	`using Microsoft.AspNetCore.Builder;`
`7`	`7`	`using Microsoft.AspNetCore.Hosting;`
	`8`	`+using Microsoft.AspNetCore.Rewrite;`
`8`	`9`	`using Microsoft.Extensions.Configuration;`
`9`	`10`	`using Microsoft.Extensions.DependencyInjection;`
`10`	`11`
`@@ -31,6 +32,8 @@ public void ConfigureServices(IServiceCollection services)`
`31`	`32`
`32`	`33`	`public void Configure(IApplicationBuilder app)`
`33`	`34`	`{`
	`35`	`+ app.UseRewriter(new RewriteOptions()`
	`36`	`+ .AddRedirect("plzredirect", "empty.html"));`
`34`	`37`	`app.UseStaticFiles();`
`35`	`38`	`}`
`36`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ namespace PuppeteerSharp`
`13`	`13`	`{`
`14`	`14`	`public class Launcher`
`15`	`15`	`{`
`16`		`- private static readonly string[] _defaultArgs = {`
	`16`	`+ internal static readonly string[] DefaultArgs = {`
`17`	`17`	`"--disable-background-networking",`
`18`	`18`	`"--disable-background-timer-throttling",`
`19`	`19`	`"--disable-client-side-phishing-detection",`
`@@ -30,7 +30,7 @@ public class Launcher`
`30`	`30`	`"--safebrowsing-disable-auto-update",`
`31`	`31`	`};`
`32`	`32`
`33`		`- public static readonly string[] _automationArgs = {`
	`33`	`+ internal static readonly string[] AutomationArgs = {`
`34`	`34`	`"--enable-automation",`
`35`	`35`	`"--password-store=basic",`
`36`	`36`	`"--use-mock-keychain"`
`@@ -44,27 +44,27 @@ public class Launcher`
`44`	`44`
`45`	`45`	`internal async Task<Browser> LaunchAsync(LaunchOptions options, int chromiumRevision)`
`46`	`46`	`{`
`47`		`- var chromeArguments = new List<string>(_defaultArgs);`
	`47`	`+ var chromeArguments = new List<string>(DefaultArgs);`
`48`	`48`
`49`	`49`	`if (options.AppMode)`
`50`	`50`	`{`
`51`	`51`	`options.Headless = false;`
`52`	`52`	`}`
`53`	`53`	`else`
`54`	`54`	`{`
`55`		`- chromeArguments.AddRange(_automationArgs);`
	`55`	`+ chromeArguments.AddRange(AutomationArgs);`
`56`	`56`	`}`
`57`	`57`
`58`		`- if (options.Args.Any(i => i.StartsWith("--user-data-dir", StringComparison.Ordinal)))`
	`58`	`+ if (!options.Args.Any(i => i.StartsWith("--user-data-dir", StringComparison.Ordinal)))`
`59`	`59`	`{`
`60`	`60`	`if (string.IsNullOrEmpty(options.UserDataDir))`
`61`	`61`	`{`
`62`	`62`	`_temporaryUserDataDir = GetTemporaryDirectory();`
`63`		`- chromeArguments.Add($"--user-data-dir=${_temporaryUserDataDir}");`
	`63`	`+ chromeArguments.Add($"--user-data-dir={_temporaryUserDataDir}");`
`64`	`64`	`}`
`65`	`65`	`else`
`66`	`66`	`{`
`67`		`- chromeArguments.Add($"--user-data-dir=${options.UserDataDir}");`
	`67`	`+ chromeArguments.Add($"--user-data-dir={options.UserDataDir}");`
`68`	`68`	`}`
`69`	`69`	`}`
`70`	`70`
`@@ -92,6 +92,10 @@ internal async Task<Browser> LaunchAsync(LaunchOptions options, int chromiumRevi`
`92`	`92`	`var revisionInfo = downloader.RevisionInfo(Downloader.CurrentPlatform, chromiumRevision);`
`93`	`93`	`chromeExecutable = revisionInfo.ExecutablePath;`
`94`	`94`	`}`
	`95`	`+ if (!File.Exists(chromeExecutable))`
	`96`	`+ {`
	`97`	`+ throw new FileNotFoundException("Failed to launch chrome! path to executable does not exist", chromeExecutable);`
	`98`	`+ }`
`95`	`99`
`96`	`100`	`if (options.Args.Any())`
`97`	`101`	`{`
`@@ -104,7 +108,7 @@ internal async Task<Browser> LaunchAsync(LaunchOptions options, int chromiumRevi`
`104`	`108`
`105`	`109`	`SetEnvVariables(_chromeProcess.StartInfo.Environment, options.Env, Environment.GetEnvironmentVariables());`
`106`	`110`
`107`		`- if(!options.DumpIO)`
	`111`	`+ if (!options.DumpIO)`
`108`	`112`	`{`
`109`	`113`	`_chromeProcess.StartInfo.RedirectStandardOutput = false;`
`110`	`114`	`_chromeProcess.StartInfo.RedirectStandardError = false;`
`@@ -215,6 +219,7 @@ private async Task ForceKillChrome()`
`215`	`219`	`if (_chromeProcess.Id != 0 && Process.GetProcessById(_chromeProcess.Id) != null)`
`216`	`220`	`{`
`217`	`221`	`_chromeProcess.Kill();`
	`222`	`+ _chromeProcess.WaitForExit();`
`218`	`223`	`}`
`219`	`224`
`220`	`225`	`if (_temporaryUserDataDir != null)`
Original file line number	Diff line number	Diff line change
`@@ -688,7 +688,7 @@ private async Task Navigate(Session client, string url, string referrer)`
`688`	`688`
`689`	`689`	`if (response.errorText != null)`
`690`	`690`	`{`
`691`		`- throw new NavigationException(response.errorText);`
	`691`	`+ throw new NavigationException(response.errorText.ToString());`
`692`	`692`	`}`
`693`	`693`	`}`
`694`	`694`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,8 @@ namespace PuppeteerSharp`
`6`	`6`	`{`
`7`	`7`	`public class Puppeteer`
`8`	`8`	`{`
	`9`	`+ public static string[] DefaultArgs => Launcher.DefaultArgs;`
	`10`	`+`
`9`	`11`	`public static async Task<Browser> LaunchAsync(LaunchOptions options, int chromiumRevision)`
`10`	`12`	`{`
`11`	`13`	`return await new Launcher().LaunchAsync(options, chromiumRevision);`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ public class Response`
`13`	`13`	`private bool _ok;`
`14`	`14`	`private string _url;`
`15`	`15`
`16`		`- public Response(Session client, Request request, HttpStatusCode status, Dictionary<string, object> headers)`
	`16`	`+ public Response(Session client, Request request, HttpStatusCode status, Dictionary<string, object> headers, SecurityDetails securityDetails)`
`17`	`17`	`{`
`18`	`18`	`_client = client;`
`19`	`19`	`Request = request;`
`@@ -26,7 +26,7 @@ public Response(Session client, Request request, HttpStatusCode status, Dictiona`
`26`	`26`	`{`
`27`	`27`	`Headers[keyValue.Key] = keyValue.Value;`
`28`	`28`	`}`
`29`		`-`
	`29`	`+ SecurityDetails = securityDetails;`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`#region Properties`
`@@ -38,6 +38,7 @@ public Response(Session client, Request request, HttpStatusCode status, Dictiona`
`38`	`38`	`public Task<string> ContentTask => ContentTaskWrapper.Task;`
`39`	`39`	`public TaskCompletionSource<string> ContentTaskWrapper { get; internal set; }`
`40`	`40`	`public Request Request { get; internal set; }`
	`41`	`+ public SecurityDetails SecurityDetails { get; internal set; }`
`41`	`42`	`#endregion`
`42`	`43`
`43`	`44`	`#region Public Methods`