Merge pull request #32 from thgO-O/chore/add-ci

[Chore] Add E2E, CI and update to BTCPay .NET 10

Author: thgO-O

.github/workflows/playwright.yml

@@ -0,0 +1,73 @@
+name: Playwright UI Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  playwright:
+    runs-on: ubuntu-22.04
+    env:
+      CI: true
+      PLAYWRIGHT_HEADLESS: true
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Initialize submodules
+        run: git submodule update --init --recursive
+
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 10.0.x
+
+      - name: Restore dependencies
+        run: dotnet restore BTCPayServer.Plugins.Depix.Tests/BTCPayServer.Plugins.Depix.Tests.csproj /p:RazorCompileOnBuild=true
+
+      - name: Build BTCPay test host
+        run: dotnet build submodules/btcpayserver/BTCPayServer.Tests/BTCPayServer.Tests.csproj -c Debug --no-restore /p:RazorCompileOnBuild=true -maxcpucount:1
+
+      - name: Build DePix plugin
+        run: dotnet build BTCPayServer.Plugins.Depix/BTCPayServer.Plugins.Depix.csproj -c Debug --no-restore /p:RazorCompileOnBuild=true -maxcpucount:1
+
+      - name: Build DePix Playwright tests
+        run: dotnet build BTCPayServer.Plugins.Depix.Tests/BTCPayServer.Plugins.Depix.Tests.csproj -c Debug --no-restore --no-dependencies -maxcpucount:1
+
+      - name: Get Playwright version
+        id: playwright-version
+        run: |
+          PLAYWRIGHT_VERSION=$(grep -oP 'Microsoft\.Playwright" Version="\K[^"]+' BTCPayServer.Plugins.Depix.Tests/BTCPayServer.Plugins.Depix.Tests.csproj)
+          echo "version=$PLAYWRIGHT_VERSION" >> "$GITHUB_OUTPUT"
+
+      - name: Cache Playwright browsers
+        uses: actions/cache@v4
+        id: playwright-cache
+        with:
+          path: ~/.cache/ms-playwright
+          key: ${{ runner.os }}-playwright-${{ steps.playwright-version.outputs.version }}-${{ hashFiles('BTCPayServer.Plugins.Depix.Tests/BTCPayServer.Plugins.Depix.Tests.csproj') }}
+          restore-keys: |
+            ${{ runner.os }}-playwright-${{ steps.playwright-version.outputs.version }}-
+
+      - name: Install Playwright browsers
+        run: pwsh BTCPayServer.Plugins.Depix.Tests/bin/Debug/net10.0/playwright.ps1 install --with-deps
+
+      - name: Start BTCPay test infrastructure
+        env:
+          DOCKER_BUILDKIT: 1
+          COMPOSE_DOCKER_CLI_BUILD: 1
+        run: docker compose -f submodules/btcpayserver/BTCPayServer.Tests/docker-compose.yml up -d dev --build
+
+      - name: Run Playwright UI tests
+        run: dotnet test BTCPayServer.Plugins.Depix.Tests/BTCPayServer.Plugins.Depix.Tests.csproj -c Debug --no-build --filter "Category=PlaywrightUITest"
+
+      - name: Cleanup Docker
+        if: always()
+        run: docker compose -f submodules/btcpayserver/BTCPayServer.Tests/docker-compose.yml down --volumes

.gitmodules

@@ -1,5 +1,5 @@
 [submodule "btcpayserver"]
-	path = btcpayserver
+	path = submodules/btcpayserver
 	url = https://github.com/btcpayserver/btcpayserver
 [submodule "submodules/liquidplus"]
 	path = submodules/liquidplus

BTCPayServer.Plugins.Depix.Tests/BTCPayServer.Plugins.Depix.Tests.csproj

@@ -0,0 +1,25 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFramework>net10.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <IsPackable>false</IsPackable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="18.3.0" />
+    <PackageReference Include="Microsoft.Playwright" Version="1.57.0" />
+    <PackageReference Include="xunit" Version="2.9.3" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="3.1.5">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\BTCPayServer.Plugins.Depix\BTCPayServer.Plugins.Depix.csproj" />
+    <ProjectReference Include="..\submodules\btcpayserver\BTCPayServer.Tests\BTCPayServer.Tests.csproj">
+      <AdditionalProperties>RazorCompileOnBuild=true</AdditionalProperties>
+    </ProjectReference>
+  </ItemGroup>
+</Project>

BTCPayServer.Plugins.Depix.Tests/DepixPlaywrightTester.cs

@@ -0,0 +1,89 @@
+using System;
+using System.Net.Http;
+using System.Reflection;
+using System.Threading;
+using System.Threading.Tasks;
+using BTCPayServer.Tests;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Playwright;
+
+namespace BTCPayServer.Plugins.Depix.Tests;
+
+public class DepixPlaywrightTester : PlaywrightTester
+{
+    private static readonly FieldInfo BrowserBackingField =
+        typeof(PlaywrightTester).GetField("<Browser>k__BackingField", BindingFlags.Instance | BindingFlags.NonPublic)
+        ?? throw new InvalidOperationException("Could not access PlaywrightTester.Browser backing field.");
+
+    public new async Task StartAsync()
+    {
+        Server.PayTester.NoCSP = true;
+        TaskCanceledException? syncTimeout = null;
+
+        try
+        {
+            await Server.StartAsync();
+        }
+        catch (TaskCanceledException ex)
+        {
+            syncTimeout = ex;
+        }
+
+        if (syncTimeout is not null)
+        {
+            if (!await ServerRespondsAsync())
+                throw syncTimeout;
+
+            TestLogs.LogInformation("BTCPay host is reachable; continuing after sync wait timeout caused by DePix chain registration.");
+        }
+
+        var builder = new ConfigurationBuilder();
+        builder.AddUserSecrets("AB0AC1DD-9D26-485B-9416-56A33F268117");
+        builder.AddEnvironmentVariables();
+        var conf = builder.Build();
+        var playwright = await Playwright.CreateAsync();
+        var browser = await playwright.Chromium.LaunchAsync(new BrowserTypeLaunchOptions
+        {
+            Headless = Server.PayTester.InContainer || conf["PLAYWRIGHT_HEADLESS"] == "true",
+            ExecutablePath = conf["PLAYWRIGHT_EXECUTABLE"],
+            SlowMo = 0,
+            Args = ["--disable-frame-rate-limit"]
+        });
+        BrowserBackingField.SetValue(this, browser);
+
+        var context = await browser.NewContextAsync();
+        Page = await context.NewPageAsync();
+        ServerUri = Server.PayTester.ServerUri;
+
+        TestLogs.LogInformation($"Playwright: Using {Page.GetType()}");
+        TestLogs.LogInformation($"Playwright: Browsing to {ServerUri}");
+
+        await GoToRegister();
+        await Page.AssertNoError();
+    }
+
+    private async Task<bool> ServerRespondsAsync()
+    {
+        using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(10));
+
+        while (!cts.IsCancellationRequested)
+        {
+            try
+            {
+                using var response = await Server.PayTester.HttpClient.GetAsync("/", cts.Token);
+                return (int)response.StatusCode < 500;
+            }
+            catch (OperationCanceledException) when (cts.IsCancellationRequested)
+            {
+                break;
+            }
+            catch (HttpRequestException)
+            {
+            }
+
+            await Task.Delay(250, cts.Token);
+        }
+
+        return false;
+    }
+}

BTCPayServer.Plugins.Depix.Tests/PixServerSettingsTests.cs

@@ -0,0 +1,59 @@
+using System;
+using System.Threading.Tasks;
+using BTCPayServer.Abstractions.Models;
+using BTCPayServer.Tests;
+using Microsoft.Playwright;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace BTCPayServer.Plugins.Depix.Tests;
+
+[Collection(SharedPluginTestCollection.CollectionName)]
+public class PixServerSettingsTests : PlaywrightBaseTest
+{
+    public PixServerSettingsTests(SharedPluginTestFixture fixture, ITestOutputHelper output)
+        : base(fixture, output)
+    {
+    }
+
+    [Fact(Timeout = TestUtils.TestTimeout)]
+    [Trait("Category", "PlaywrightUITest")]
+    public async Task CannotSaveServerSettingsWithoutApiKey()
+    {
+        await InitializeAdminAsync();
+        await GoToPixServerSettingsAsync();
+
+        await Page.GetByRole(AriaRole.Heading, new() { Name = "Pix Server Settings" }).WaitForAsync();
+        await Page.GetByRole(AriaRole.Button, new() { Name = "Save" }).ClickAsync();
+
+        await Tester.FindAlertMessage(StatusMessageModel.StatusSeverity.Error, "Set the DePix API key first.");
+        Assert.Contains("/server/depix/settings", Page.Url);
+    }
+
+    [Fact(Timeout = TestUtils.TestTimeout)]
+    [Trait("Category", "PlaywrightUITest")]
+    public async Task CanRegenerateServerWebhookSecret()
+    {
+        await InitializeAdminAsync();
+        await SeedValidServerPixConfigAsync(useWhitelist: true, passFeeToCustomer: true);
+        await GoToPixServerSettingsAsync();
+
+        Assert.True(await Page.Locator("#UseWhitelist").IsCheckedAsync());
+        Assert.True(await Page.Locator("#PassFeeToCustomer").IsCheckedAsync());
+
+        await Page.Locator("#RegenerateWebhookSecret").SetCheckedAsync(true);
+        await Page.GetByRole(AriaRole.Button, new() { Name = "Save" }).ClickAsync();
+
+        await Tester.FindAlertMessage(partialText: "DePix server configuration applied");
+
+        var oneShotSecret = await Page.Locator("#OneShotSecret").InputValueAsync();
+        Assert.Matches("^[0-9a-f]{64}$", oneShotSecret);
+
+        await Page.ReloadAsync();
+
+        Assert.Equal(0, await Page.Locator("#OneShotSecret").CountAsync());
+        Assert.Contains("stored securely", await Page.Locator("#WebhookSecretDisplay").InputValueAsync(), StringComparison.OrdinalIgnoreCase);
+        Assert.True(await Page.Locator("#UseWhitelist").IsCheckedAsync());
+        Assert.True(await Page.Locator("#PassFeeToCustomer").IsCheckedAsync());
+    }
+}

BTCPayServer.Plugins.Depix.Tests/PixSettingsTests.cs

@@ -0,0 +1,75 @@
+using System.Threading.Tasks;
+using BTCPayServer.Tests;
+using Microsoft.Playwright;
+using Xunit;
+using Xunit.Abstractions;
+
+namespace BTCPayServer.Plugins.Depix.Tests;
+
+[Collection(SharedPluginTestCollection.CollectionName)]
+public class PixSettingsTests : PlaywrightBaseTest
+{
+    public PixSettingsTests(SharedPluginTestFixture fixture, ITestOutputHelper output)
+        : base(fixture, output)
+    {
+    }
+
+    [Fact(Timeout = TestUtils.TestTimeout)]
+    [Trait("Category", "PlaywrightUITest")]
+    public async Task CanOpenPixSettingsWhenPluginLoaded()
+    {
+        await InitializeStoreOwnerAsync();
+        await GoToPixSettingsAsync();
+
+        await Page.GetByRole(AriaRole.Heading, new() { Name = "Pix Settings" }).WaitForAsync();
+        await Page.Locator("#ApiKey").WaitForAsync();
+        await Page.GetByText("DePix is not configured.", new() { Exact = false }).WaitForAsync();
+
+        Assert.Contains($"/stores/{Tester.StoreId}/pix/settings", Page.Url);
+    }
+
+    [Fact(Timeout = TestUtils.TestTimeout)]
+    [Trait("Category", "PlaywrightUITest")]
+    public async Task CanSaveAndPersistPixStoreSettings()
+    {
+        await InitializeStoreOwnerAsync();
+        await SeedValidStorePixConfigAsync();
+        await GoToPixSettingsAsync();
+
+        await Page.Locator("#IsEnabled").SetCheckedAsync(true);
+        await Page.Locator("#PassFeeToCustomer").SetCheckedAsync(true);
+        await Page.Locator("#UseWhitelist").SetCheckedAsync(true);
+        await Page.GetByRole(AriaRole.Button, new() { Name = "Save" }).ClickAsync();
+
+        await Tester.FindAlertMessage(partialText: "Pix configuration applied");
+
+        Assert.True(await Page.Locator("#IsEnabled").IsCheckedAsync());
+        Assert.True(await Page.Locator("#PassFeeToCustomer").IsCheckedAsync());
+        Assert.True(await Page.Locator("#UseWhitelist").IsCheckedAsync());
+    }
+
+    [Fact(Timeout = TestUtils.TestTimeout)]
+    [Trait("Category", "PlaywrightUITest")]
+    public async Task CanEnablePixUsingServerLevelConfiguration()
+    {
+        await InitializeStoreOwnerAsync();
+        await SeedValidServerPixConfigAsync();
+        await GoToPixSettingsAsync();
+
+        await Page.GetByText("server-level DePix Api Key configuration", new() { Exact = false }).WaitForAsync();
+        Assert.Equal(0, await Page.Locator("#PassFeeToCustomer").CountAsync());
+        Assert.Equal(0, await Page.Locator("#UseWhitelist").CountAsync());
+
+        await Page.Locator("#IsEnabled").SetCheckedAsync(true);
+        await Page.GetByRole(AriaRole.Button, new() { Name = "Save" }).ClickAsync();
+
+        await Tester.FindAlertMessage(partialText: "Pix configuration applied");
+        Assert.True(await Page.Locator("#IsEnabled").IsCheckedAsync());
+
+        var storeConfig = await GetStorePixConfigAsync();
+        Assert.NotNull(storeConfig);
+        Assert.True(storeConfig!.IsEnabled);
+        Assert.Null(storeConfig.EncryptedApiKey);
+        Assert.Null(storeConfig.WebhookSecretHashHex);
+    }
+}