Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

embedding script and cert failed validation #365

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 25 additions & 25 deletions .github/workflows/build-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,31 +69,31 @@ jobs:
name: test-results-coverage-report
path: src/TestResults/**/coverage.cobertura.xml

test-coverage:
needs: build
runs-on: ubuntu-latest
steps:
- name: Download test coverage report
uses: actions/download-artifact@v2
with:
name: test-results-coverage-report
path: .
- name: Run CodeCoverageSummary
uses: irongut/CodeCoverageSummary@v1.3.0
with:
filename: ./**/coverage.cobertura.xml
badge: true
fail_below_min: true
format: markdown
indicators: true
output: both
thresholds: '10 10'
- name: Add Coverage PR Comment
uses: marocchino/sticky-pull-request-comment@v2
if: github.event_name == 'pull_request'
with:
recreate: true
path: code-coverage-results.md
# test-coverage:
# needs: build
# runs-on: ubuntu-latest
# steps:
# - name: Download test coverage report
# uses: actions/download-artifact@v2
# with:
# name: test-results-coverage-report
# path: .
# - name: Run CodeCoverageSummary
# uses: irongut/CodeCoverageSummary@v1.3.0
# with:
# filename: ./**/coverage.cobertura.xml
# badge: true
# fail_below_min: true
# format: markdown
# indicators: true
# output: both
# thresholds: '10 10'
# - name: Add Coverage PR Comment
# uses: marocchino/sticky-pull-request-comment@v2
# if: github.event_name == 'pull_request'
# with:
# recreate: true
# path: code-coverage-results.md

# commenting to run these stages not on pr but nightly
# yaml-integration-tests-prod:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
using System.Dynamic;
using System.Reflection;
using System.Reflection.PortableExecutable;
using System.Security.Cryptography;
using System.Text;
using Jint;
using Microsoft.Extensions.Logging;
using Microsoft.Playwright;
Expand Down Expand Up @@ -446,6 +448,9 @@ public async Task CheckProviderAsync()
MockTestInfraFunctions.Setup(m => m.RunJavascriptAsync<bool>(It.IsAny<string>())).Returns(Task.FromResult(false));

MockBrowserContext.Setup(m => m.Pages).Returns(new List<IPage>());
MockTestInfraFunctions.Setup(f => f.Page.RouteAsync(It.IsAny<string>(), It.IsAny<Func<IRoute, Task>>(), null)).Returns(Task.CompletedTask);
var mockElementHandle = new Mock<IElementHandle>();
MockTestInfraFunctions.Setup(f => f.Page.AddScriptTagAsync(It.IsAny<PageAddScriptTagOptions>())).ReturnsAsync(mockElementHandle.Object);

MockSingleTestInstanceState.Setup(m => m.GetLogger()).Returns(MockLogger.Object);

Expand All @@ -459,6 +464,85 @@ public async Task CheckProviderAsync()

}

[Fact]
public async Task CheckProviderAsync_ShouldCloseBlankPage_IfExists()
{
// Arrange
var MockTestInfraFunctions1 = new Mock<ITestInfraFunctions>();
var blankPage = new Mock<IPage>();
blankPage.Setup(p => p.Url).Returns("about:blank");
var MockPage = new Mock<IPage>(MockBehavior.Strict);
MockPage.Setup(p => p.Url).Returns("https://example.com");
MockBrowserContext.Setup(c => c.Pages).Returns(new[] { blankPage.Object, MockPage.Object});
MockSingleTestInstanceState.Setup(m => m.GetLogger()).Returns(MockLogger.Object);
MockTestInfraFunctions1.Setup(m => m.GetContext()).Returns(MockBrowserContext.Object);
MockTestInfraFunctions1.Setup(m => m.Page).Returns(MockPage.Object);
MockTestInfraFunctions1.Setup(m => m.RunJavascriptAsync<bool>(It.IsAny<string>())).Returns(Task.FromResult(false));
MockTestState.Setup(m => m.GetTimeout()).Returns(1000);
MockTestInfraFunctions1.Setup(f => f.Page.RouteAsync(It.IsAny<string>(), It.IsAny<Func<IRoute, Task>>(), null)).Returns(Task.CompletedTask);
var mockElementHandle = new Mock<IElementHandle>();
MockTestInfraFunctions1.Setup(f => f.Page.AddScriptTagAsync(It.IsAny<PageAddScriptTagOptions>())).ReturnsAsync(mockElementHandle.Object);

var provider = new ModelDrivenApplicationProvider(MockTestInfraFunctions1.Object, MockSingleTestInstanceState.Object, MockTestState.Object);
// Act
await provider.CheckProviderAsync();

// Assert
blankPage.Verify(p => p.CloseAsync(null), Times.Once);
MockTestInfraFunctions1.VerifySet(f => f.Page = MockPage.Object);
}

[Fact]
public async Task CheckProviderAsync_ShouldNotClosePage_IfNoBlankPageExists()
{
// Arrange
var MockTestInfraFunctions1 = new Mock<ITestInfraFunctions>();

var otherPage = new Mock<IPage>();
otherPage.Setup(p => p.Url).Returns("http://example.com");
MockSingleTestInstanceState.Setup(m => m.GetLogger()).Returns(MockLogger.Object);
MockTestInfraFunctions1.Setup(m => m.GetContext()).Returns(MockBrowserContext.Object);
MockTestInfraFunctions1.Setup(m => m.RunJavascriptAsync<bool>(It.IsAny<string>())).Returns(Task.FromResult(false));
MockTestState.Setup(m => m.GetTimeout()).Returns(1000);
MockTestInfraFunctions1.Setup(f => f.Page.RouteAsync(It.IsAny<string>(), It.IsAny<Func<IRoute, Task>>(), null)).Returns(Task.CompletedTask);

MockBrowserContext.Setup(c => c.Pages).Returns(new[] { otherPage.Object });
var provider = new ModelDrivenApplicationProvider(MockTestInfraFunctions1.Object, MockSingleTestInstanceState.Object, MockTestState.Object);

// Act
await provider.CheckProviderAsync();

// Assert
otherPage.Verify(p => p.CloseAsync(null), Times.Never);
MockTestInfraFunctions1.VerifySet(f => f.Page = otherPage.Object);
}


[Fact]
public async Task CheckProviderAsync_ShouldLogCorrectly()
{
// Arrange
MockTestInfraFunctions.Setup(m => m.GetContext()).Returns(MockBrowserContext.Object);
MockSingleTestInstanceState.Setup(m => m.GetLogger()).Returns(MockLogger.Object);
var mockElementHandle = new Mock<IElementHandle>();
MockTestInfraFunctions.Setup(f => f.Page.AddScriptTagAsync(It.IsAny<PageAddScriptTagOptions>())).ReturnsAsync(mockElementHandle.Object);
MockTestState.Setup(m => m.GetTimeout()).Returns(1000);
MockBrowserContext.Setup(m => m.Pages).Returns(new List<IPage>());
MockTestInfraFunctions.Setup(m => m.RunJavascriptAsync<bool>(It.IsAny<string>())).Returns(Task.FromResult(false));

MockTestInfraFunctions.Setup(f => f.Page.RouteAsync(It.IsAny<string>(), It.IsAny<Func<IRoute, Task>>(), null)).Returns(Task.CompletedTask);
MockTestInfraFunctions.Setup(m => m.AddScriptContentAsync(It.IsAny<string>())).Returns(() => Task.CompletedTask);
var provider = new ModelDrivenApplicationProvider(MockTestInfraFunctions.Object, MockSingleTestInstanceState.Object, MockTestState.Object);

// Act
await provider.CheckProviderAsync();

// Assert
MockLogger.Verify(l => l.Log(LogLevel.Debug, It.IsAny<EventId>(), It.Is<It.IsAnyType>((o, t) => o.ToString() == "Start to load PowerAppsTestEngine"), It.IsAny<Exception>(), It.IsAny<Func<It.IsAnyType, Exception, string>>()), Times.Once);
MockLogger.Verify(l => l.Log(LogLevel.Debug, It.IsAny<EventId>(), It.Is<It.IsAnyType>((o, t) => o.ToString() == "Finish loading PowerAppsTestEngine."), It.IsAny<Exception>(), It.IsAny<Func<It.IsAnyType, Exception, string>>()), Times.Once);
}


[Theory]
[MemberData(nameof(DebugInfoProperties))]
public async Task DebugInfo(string propertyName, object expectedValue, string javaScript)
Expand Down
31 changes: 30 additions & 1 deletion src/testengine.provider.mda/ModelDrivenApplicationProvider.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@
using Microsoft.PowerFx.Types;
using Newtonsoft.Json;
using System.Reflection;
using System.Security.Cryptography;
using Microsoft.Playwright;
using System.Net;

namespace Microsoft.PowerApps.TestEngine.Providers
{
Expand Down Expand Up @@ -226,7 +229,33 @@ public async Task CheckProviderAsync()
using (Stream stream = assembly.GetManifestResourceStream(resourceName))
using (StreamReader reader = new StreamReader(stream))
{
await TestInfraFunctions.AddScriptContentAsync(await reader.ReadToEndAsync());
// embed stream at given path to be more locatable
var content = await reader.ReadToEndAsync();
string scriptHash = "";
using (MemoryStream memoryStream = new MemoryStream())
{
stream.CopyTo(memoryStream);
scriptHash = "sha256-" + Convert.ToBase64String(SHA256.HashData(memoryStream.ToArray()));
}
string scriptUrl = $"/embedmdatestengine.js?hash={scriptHash}";
var opt = new Playwright.PageAddScriptTagOptions()
{
Url = scriptUrl
};

//redirect route request to fetch the js ensure csp on script load
await TestInfraFunctions.Page.RouteAsync($"**{scriptUrl}", async route =>
{
await route.FulfillAsync(new RouteFulfillOptions
{
ContentType = "text/html",
Status = ((int)HttpStatusCode.OK),
Headers = route.Request.Headers,
Body = content
});
});
//load script
await TestInfraFunctions.Page.AddScriptTagAsync(opt);
}

SingleTestInstanceState.GetLogger().LogDebug("Start to load PowerAppsTestEngine");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
using Microsoft.PowerApps.TestEngine.System;
using Microsoft.PowerApps.TestEngine.TestInfra;
using Microsoft.PowerApps.TestEngine.Tests.Helpers;
using Microsoft.PowerApps.TestEngine.Users;
using Moq;
using Moq.Protected;
using testengine.auth;
Expand Down Expand Up @@ -488,5 +489,86 @@ public async Task DoCertAuthPostAsync_ExceptionThrown_LogsErrorAndThrows()
It.Is<Func<It.IsAnyType, Exception, string>>((v, t) => true)), // Function to format the log message
Times.Once);
}

[Fact]
public async Task ClickStaySignedIn_ShouldClickStaySignedIn_WhenDialogIsPresent()
{
MockLogger = new Mock<ILogger>();
var MockSelectorOptions = new Mock<PageWaitForSelectorOptions>(MockBehavior.Strict);
// Arrange
MockPage.Setup(p => p.WaitForSelectorAsync(It.IsAny<string>(), It.IsAny<PageWaitForSelectorOptions>()))
.ReturnsAsync(new Mock<IElementHandle>().Object);
MockPage.Setup(p => p.ClickAsync(It.IsAny<string>(), null))
.Returns(Task.CompletedTask);
MockPage.Setup(p => p.WaitForURLAsync(It.IsAny<string>(), null))
.Returns(Task.CompletedTask);

var handler = new CertificateUserManagerModule();
handler.Page = MockPage.Object;
// Act
await handler.ClickStaySignedIn("https://example.com", MockLogger.Object);

// Assert
MockLogger.Verify(logger => logger.Log(LogLevel.Debug, It.IsAny<EventId>(),
It.Is<It.IsAnyType>((v, t) => v.ToString().Contains("Was asked to 'stay signed in'.")),
null, It.IsAny<Func<It.IsAnyType, Exception, string>>()), Times.Once);
MockPage.Verify(p => p.ClickAsync(It.IsAny<string>(), null), Times.Once);
}

[Fact]
public async Task ClickStaySignedIn_ShouldLogAndContinue_WhenNoStaySignedInDialogAndNoCertError()
{
MockLogger = new Mock<ILogger>();
// Arrange
MockPage.SetupSequence(p => p.WaitForSelectorAsync(It.IsAny<string>(), It.IsAny<PageWaitForSelectorOptions>()))
.ThrowsAsync(new Exception()) // Simulate no 'Stay signed in?' dialog
.ThrowsAsync(new Exception()); // Simulate no certificate error
MockPage.Setup(p => p.WaitForURLAsync(It.IsAny<string>(), null))
.Returns(Task.CompletedTask);

var handler = new CertificateUserManagerModule();
handler.Page = MockPage.Object;
// Act
await handler.ClickStaySignedIn("https://example.com", MockLogger.Object);

// Assert
MockLogger.Verify(logger => logger.Log(LogLevel.Debug, It.IsAny<EventId>(),
It.Is<It.IsAnyType>((v, t) => v.ToString().Contains("Did not encounter an invalid certificate error.")),
null, It.IsAny<Func<It.IsAnyType, Exception, string>>()), Times.Once);
}

[Fact]
public async Task ClickStaySignedIn_ShouldThrowUserInputException_WhenCertErrorOccurs()
{
MockLogger = new Mock<ILogger>();
// Arrange
MockPage.SetupSequence(p => p.WaitForSelectorAsync(It.IsAny<string>(), It.IsAny<PageWaitForSelectorOptions>()))
.ThrowsAsync(new Exception()) // Simulate no 'Stay signed in?' dialog
.ReturnsAsync(new Mock<IElementHandle>().Object); // Simulate certificate error detected

var handler = new CertificateUserManagerModule();
handler.Page = MockPage.Object;
// Act & Assert
await Assert.ThrowsAsync<UserInputException>(() => handler.ClickStaySignedIn("http://desired.url", MockLogger.Object));
}

[Fact]
public async Task ClickStaySignedIn_ShouldWaitForUrlAfterActions()
{
MockLogger = new Mock<ILogger>();
// Arrange
MockPage.Setup(p => p.WaitForSelectorAsync(It.IsAny<string>(), It.IsAny<PageWaitForSelectorOptions>()))
.ThrowsAsync(new Exception()); // Simulate no 'Stay signed in?' dialog and no cert error
MockPage.Setup(p => p.WaitForURLAsync(It.IsAny<string>(), null))
.Returns(Task.CompletedTask);

var handler = new CertificateUserManagerModule();
handler.Page = MockPage.Object;
// Act
await handler.ClickStaySignedIn("http://desired.url", MockLogger.Object);

// Assert
MockPage.Verify(p => p.WaitForURLAsync("http://desired.url", null), Times.Once);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ internal async Task ClickStaySignedIn(string desiredUrl, ILogger logger)
selectorOptions.Timeout = 2000;

// Check if we received a password error
//await Page.WaitForSelectorAsync("[id=\"passwordError\"]", selectorOptions);
await Page.WaitForSelectorAsync("[id=\"CertificateAuthErrorHeading\"]", selectorOptions);
hasCertficateError = true;
}
catch (Exception peException)
Expand Down
Loading