Silverfish/proton-bridge
1
0
Fork 1
mirror of https://github.com/ProtonMail/proton-bridge.git synced 2025-12-10 04:36:43 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

test(BRIDGE-133): Bridge E2E UI tests for Windows

Browse Source
This commit is contained in:
Gjorgji Slamkov
2024-09-17 05:23:08 +00:00
parent bfe67f3005
commit 5b874657cb
12 changed files with 398 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -7,6 +7,7 @@
*~ *~
.idea .idea
.vscode .vscode
.vs
# Test files # Test files
godog.test godog.test
@ -35,6 +36,8 @@ cmd/Import-Export/deploy
proton-bridge proton-bridge
cmd/Desktop-Bridge/*.exe cmd/Desktop-Bridge/*.exe
cmd/launcher/*.exe cmd/launcher/*.exe
bin/
obj/
# Jetbrains (CLion, Golang) cmake build dirs # Jetbrains (CLion, Golang) cmake build dirs
cmake-build-*/ cmake-build-*/

35
tests/e2e/ui_tests/windows_os/ProtonMailBridge.UI.Tests.csproj Normal file
View File

@ -0,0 +1,35 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net8.0-windows7.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<IsPackable>false</IsPackable>
<IsTestProject>true</IsTestProject>
<PlatformTarget>x64</PlatformTarget>
<Platforms>AnyCPU;x64</Platforms>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="coverlet.collector" Version="6.0.2">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="FlaUI.Core" Version="4.0.0" />
<PackageReference Include="FlaUI.UIA3" Version="4.0.0" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.0" />
<PackageReference Include="NUnit" Version="4.2.1" />
<PackageReference Include="NUnit.Analyzers" Version="4.3.0">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="NUnit3TestAdapter" Version="4.6.0" />
<PackageReference Include="System.Drawing.Common" Version="8.0.8" />
</ItemGroup>
<ItemGroup>
<Using Include="NUnit.Framework" />
</ItemGroup>
</Project>

29
tests/e2e/ui_tests/windows_os/Results/HomeResult.cs Normal file
View File

@ -0,0 +1,29 @@
using FlaUI.Core.AutomationElements;
using FlaUI.Core.Definitions;
namespace ProtonMailBridge.UI.Tests.Results
{
public class HomeResult : UIActions
{
private Button SignOutButton => AccountView.FindFirstDescendant(cf => cf.ByControlType(ControlType.Button).And(cf.ByName("Sign out"))).AsButton();
private AutomationElement NotificationWindow => Window.FindFirstDescendant(cf => cf.ByControlType(ControlType.Window));
private TextBox FreeAccountErrorText => NotificationWindow.FindFirstDescendant(cf => cf.ByControlType(ControlType.Text)).AsTextBox();
private TextBox SignedOutAccount => AccountView.FindFirstDescendant(cf => cf.ByControlType(ControlType.Text)).AsTextBox();
public HomeResult CheckIfLoggedIn()
{
Assert.That(SignOutButton.IsAvailable, Is.True);
return this;
}
public HomeResult CheckIfFreeAccountErrorIsDisplayed(string ErrorText)
{
Assert.That(FreeAccountErrorText.Name == ErrorText, Is.True);
return this;
}
public HomeResult CheckIfAccountIsSignedOut()
{
Assert.That(SignedOutAccount.IsAvailable, Is.True);
return this;
}
}
}

43
tests/e2e/ui_tests/windows_os/TestSession.cs Normal file
View File

@ -0,0 +1,43 @@
using System;
using System.Threading;
using FlaUI.Core.AutomationElements;
using FlaUI.Core;
using FlaUI.UIA3;
using ProtonMailBridge.UI.Tests.TestsHelper;
using FlaUI.Core.Input;
namespace ProtonMailBridge.UI.Tests
{
public class TestSession
{
public static Application App;
protected static Application Service;
protected static Window Window;
protected static void ClientCleanup()
{
App.Kill();
App.Dispose();
// Give some time to properly exit the app
Thread.Sleep(2000);
}
public static void LaunchApp()
{
string appExecutable = TestData.AppExecutable;
Application.Launch(appExecutable);
Wait.UntilInputIsProcessed(TestData.FiveSecondsTimeout);
App = Application.Attach("bridge-gui.exe");
try
{
Window = App.GetMainWindow(new UIA3Automation(), TestData.ThirtySecondsTimeout);
}
catch (System.TimeoutException)
{
Assert.Fail("Failed to get window of application!");
}
}
}
}

51
tests/e2e/ui_tests/windows_os/Tests/LoginLogoutTests.cs Normal file
View File

@ -0,0 +1,51 @@
using NUnit.Framework;
using ProtonMailBridge.UI.Tests.TestsHelper;
using ProtonMailBridge.UI.Tests.Windows;
using ProtonMailBridge.UI.Tests.Results;
namespace ProtonMailBridge.UI.Tests.Tests
{
[TestFixture]
public class LoginLogoutTests : TestSession
{
private readonly LoginWindow _loginWindow = new();
private readonly HomeWindow _mainWindow = new();
private readonly HomeResult _homeResult = new();
private readonly string FreeAccountErrorText = "Bridge is exclusive to our mail paid plans. Upgrade your account to use Bridge.";
[Test]
public void LoginAsPaidUser()
{
_loginWindow.SignIn(TestUserData.GetPaidUser());
_homeResult.CheckIfLoggedIn();
}
[Test]
public void LoginAsFreeUser()
{
_loginWindow.SignIn(TestUserData.GetFreeUser());
_homeResult.CheckIfFreeAccountErrorIsDisplayed(FreeAccountErrorText);
}
[Test]
public void SuccessfullLogout()
{
_loginWindow.SignIn(TestUserData.GetPaidUser());
_mainWindow.SignOutAccount();
_homeResult.CheckIfAccountIsSignedOut();
}
[SetUp]
public void TestInitialize()
{
LaunchApp();
}
[TearDown]
public void TestCleanup()
{
_mainWindow.RemoveAccount();
ClientCleanup();
}
}
}

16
tests/e2e/ui_tests/windows_os/TestsHelper/TestData.cs Normal file
View File

@ -0,0 +1,16 @@
using System;
using System.Linq;
using System.IO;
namespace ProtonMailBridge.UI.Tests.TestsHelper
{
public static class TestData
{
public static TimeSpan FiveSecondsTimeout => TimeSpan.FromSeconds(5);
public static TimeSpan TenSecondsTimeout => TimeSpan.FromSeconds(10);
public static TimeSpan ThirtySecondsTimeout => TimeSpan.FromSeconds(30);
public static TimeSpan OneMinuteTimeout => TimeSpan.FromSeconds(60);
public static TimeSpan RetryInterval => TimeSpan.FromMilliseconds(1000);
public static string AppExecutable => "C:\\Program Files\\Proton AG\\Proton Mail Bridge\\bridge-gui.exe";
}
}

58
tests/e2e/ui_tests/windows_os/TestsHelper/TestUserData.cs Normal file
View File

@ -0,0 +1,58 @@
using System;
namespace ProtonMailBridge.UI.Tests.TestsHelper
{
public class TestUserData
{
public string Username { get; set; }
public string Password { get; set; }
public TestUserData(string username, string password)
{
Username = username;
Password = password;
}
public static TestUserData GetFreeUser()
{
(string username, string password) = GetusernameAndPassword("BRIDGE_FLAUI_FREE_USER");
return new TestUserData(username, password);
}
public static TestUserData GetPaidUser()
{
(string username, string password) = GetusernameAndPassword("BRIDGE_FLAUI_PAID_USER");
return new TestUserData(username, password);
}
public static TestUserData GetIncorrectCredentialsUser()
{
return new TestUserData("IncorrectUsername", "IncorrectPass");
}
private static (string, string) GetusernameAndPassword(string userType)
{
// Get the environment variable for the user and check if missing
// When changing or adding an environment variable, you must restart Visual Studio
// if you have it open while doing this
string? str = Environment.GetEnvironmentVariable(userType);
if (string.IsNullOrEmpty(str))
{
throw new Exception($"Missing environment variable: {userType}");
}
// Check if the environment variable contains only one ':'
// The ':' character must be between the username/email and password
string ch = ":";
if ((str.IndexOf(ch) != str.LastIndexOf(ch)) | (str.IndexOf(ch) == -1))
{
throw new Exception(
$"Environment variable {str} must contain one ':' and it must be between username and password!"
);
}
string[] split = str.Split(':');
return (split[0], split[1]);
}
}
}

14
tests/e2e/ui_tests/windows_os/UIActions.cs Normal file
View File

@ -0,0 +1,14 @@
using System;
using FlaUI.Core.AutomationElements;
using FlaUI.Core.Definitions;
using FlaUI.Core.Input;
using FlaUI.Core.Tools;
using NUnit.Framework;
namespace ProtonMailBridge.UI.Tests
{
public class UIActions : TestSession
{
public AutomationElement AccountView => Window.FindFirstDescendant(cf => cf.ByControlType(ControlType.Pane));
}
}

34
tests/e2e/ui_tests/windows_os/Windows/HomeWindow.cs Normal file
View File

@ -0,0 +1,34 @@
using FlaUI.Core.AutomationElements;
using FlaUI.Core.Definitions;
using System;
namespace ProtonMailBridge.UI.Tests.Windows
{
public class HomeWindow : UIActions
{
private AutomationElement[] AccountViewButtons => AccountView.FindAllChildren(cf => cf.ByControlType(ControlType.Button));
private Button RemoveAccountButton => AccountViewButtons[1].AsButton();
private AutomationElement RemoveAccountConfirmModal => Window.FindFirstDescendant(cf => cf.ByControlType(ControlType.Window));
private Button ConfirmRemoveAccountButton => RemoveAccountConfirmModal.FindFirstDescendant(cf => cf.ByControlType(ControlType.Button).And(cf.ByName("Remove this account"))).AsButton();
private Button SignOutButton => AccountView.FindFirstDescendant(cf => cf.ByControlType(ControlType.Button).And(cf.ByName("Sign out"))).AsButton();
public HomeWindow RemoveAccount()
{
try
{
RemoveAccountButton.Click();
ConfirmRemoveAccountButton.Click();
}
catch (System.NullReferenceException)
{
ClientCleanup();
}
return this;
}
public HomeWindow SignOutAccount()
{
SignOutButton.Click();
return this;
}
}
}

49
tests/e2e/ui_tests/windows_os/Windows/LoginWindow.cs Normal file
View File

@ -0,0 +1,49 @@
using FlaUI.Core.AutomationElements;
using FlaUI.Core.Input;
using FlaUI.Core.Definitions;
using ProtonMailBridge.UI.Tests.TestsHelper;
namespace ProtonMailBridge.UI.Tests.Windows
{
public class LoginWindow : UIActions
{
private AutomationElement[] InputFields => Window.FindAllDescendants(cf => cf.ByControlType(ControlType.Edit));
private TextBox UsernameInput => InputFields[0].AsTextBox();
private TextBox PasswordInput => InputFields[1].AsTextBox();
private Button SignInButton => Window.FindFirstDescendant(cf => cf.ByControlType(ControlType.Button).And(cf.ByName("Sign in"))).AsButton();
private Button StartSetupButton => Window.FindFirstDescendant(cf => cf.ByName("Start setup")).AsButton();
private Button SetUpLater => Window.FindFirstDescendant(cf => cf.ByName("Setup later")).AsButton();
public LoginWindow SignIn(TestUserData user)
{
ClickStartSetupButton();
EnterCredentials(user);
Wait.UntilInputIsProcessed(TestData.TenSecondsTimeout);
SetUpLater?.Click();
return this;
}
public LoginWindow SignIn(string username, string password)
{
TestUserData user = new TestUserData(username, password);
SignIn(user);
return this;
}
public LoginWindow ClickStartSetupButton()
{
StartSetupButton?.Click();
return this;
}
public LoginWindow EnterCredentials(TestUserData user)
{
UsernameInput.Text = user.Username;
PasswordInput.Text = user.Password;
SignInButton.Click();
return this;
}
}
}

35
tests/e2e/ui_tests/windows_os/app.config Normal file
View File

@ -0,0 +1,35 @@
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<runtime>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.Drawing.Common" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral"/>
<bindingRedirect oldVersion="0.0.0.0-8.0.0.0" newVersion="8.0.0.0"/>
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity name="System.Diagnostics.PerformanceCounter" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral"/>
<bindingRedirect oldVersion="0.0.0.0-8.0.0.0" newVersion="8.0.0.0"/>
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity name="System.Runtime.CompilerServices.Unsafe" publicKeyToken="b03f5f7f11d50a3a" culture="neutral"/>
<bindingRedirect oldVersion="0.0.0.0-6.0.0.0" newVersion="6.0.0.0"/>
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity name="System.Reflection.Metadata" publicKeyToken="b03f5f7f11d50a3a" culture="neutral"/>
<bindingRedirect oldVersion="0.0.0.0-8.0.0.0" newVersion="8.0.0.0"/>
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity name="System.Diagnostics.DiagnosticSource" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral"/>
<bindingRedirect oldVersion="0.0.0.0-8.0.0.1" newVersion="8.0.0.1"/>
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity name="System.Memory" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral"/>
<bindingRedirect oldVersion="0.0.0.0-4.0.1.2" newVersion="4.0.1.2"/>
</dependentAssembly>
<dependentAssembly>
<assemblyIdentity name="System.Collections.Immutable" publicKeyToken="b03f5f7f11d50a3a" culture="neutral"/>
<bindingRedirect oldVersion="0.0.0.0-8.0.0.0" newVersion="8.0.0.0"/>
</dependentAssembly>
</assemblyBinding>
</runtime>
<startup><supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.8"/></startup></configuration>

31
tests/e2e/ui_tests/windows_os/ui_tests.sln Normal file
View File

@ -0,0 +1,31 @@

Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 17
VisualStudioVersion = 17.11.35208.52
MinimumVisualStudioVersion = 10.0.40219.1
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ProtonMailBridge.UI.Tests", "ProtonMailBridge.UI.Tests.csproj", "{027E5266-E353-4095-AF24-B3ED240EACAA}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Debug|x64 = Debug|x64
Release|Any CPU = Release|Any CPU
Release|x64 = Release|x64
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{027E5266-E353-4095-AF24-B3ED240EACAA}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{027E5266-E353-4095-AF24-B3ED240EACAA}.Debug|Any CPU.Build.0 = Debug|Any CPU
{027E5266-E353-4095-AF24-B3ED240EACAA}.Debug|x64.ActiveCfg = Debug|x64
{027E5266-E353-4095-AF24-B3ED240EACAA}.Debug|x64.Build.0 = Debug|x64
{027E5266-E353-4095-AF24-B3ED240EACAA}.Release|Any CPU.ActiveCfg = Release|Any CPU
{027E5266-E353-4095-AF24-B3ED240EACAA}.Release|Any CPU.Build.0 = Release|Any CPU
{027E5266-E353-4095-AF24-B3ED240EACAA}.Release|x64.ActiveCfg = Release|x64
{027E5266-E353-4095-AF24-B3ED240EACAA}.Release|x64.Build.0 = Release|x64
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {817DD45A-EA2C-4F16-A680-5810DADCE4E7}
EndGlobalSection
EndGlobal