squidex/tools/TestSuite/TestSuite.ApiTests/BackupTests.cs

// ==========================================================================
//  Squidex Headless CMS
// ==========================================================================
//  Copyright (c) Squidex UG (haftungsbeschraenkt)
//  All rights reserved. Licensed under the MIT license.
// ==========================================================================

using Squidex.ClientLibrary;
using TestSuite.Fixtures;
using TestSuite.Model;
using TestSuite.Utils;

#pragma warning disable CS0612 // Type or member is obsolete
#pragma warning disable CS0618 // Type or member is obsolete
#pragma warning disable SA1300 // Element should begin with upper-case letter
#pragma warning disable SA1507 // Code should not contain multiple blank lines in a row

namespace TestSuite.ApiTests;

public class BackupTests(ClientFixture fixture) : IClassFixture<ClientFixture>
{
    private readonly string appName = Guid.NewGuid().ToString();
    private readonly string appNameRestore = $"{Guid.NewGuid()}-restore";
    private readonly string schemaName = $"schema-{Guid.NewGuid()}";

    public ClientFixture _ { get; } = fixture;

    [Fact]
    public async Task Should_backup_and_restore_app()
    {
        // Load the backup from another URL, because the public URL is might not be accessible for the server.
        var backupUrl = TestHelpers.GetAndPrintValue("config:backupUrl", _.Url);

        // STEP 0: Create app.
        var (app, _) = await _.PostAppAsync(appName);


        // STEP 1: Prepare app.
        await PrepareAppAsync(app);


        // STEP 2: Create backup.
        await app.Backups.PostBackupAsync();


        // STEP 3: Get obsolete backup.
        var backup = await app.Backups.PollAsync(x => x.Status is JobStatus.Completed or JobStatus.Failed);

        Assert.Equal(JobStatus.Completed, backup?.Status);


        // STEP 4: Get obsolete backup.
        var job = await app.Jobs.PollAsync(x => x.Status is JobStatus.Completed or JobStatus.Failed);

        Assert.Equal(JobStatus.Completed, job?.Status);


        // STEP 5: Restore backup.
        var uri = new Uri(new Uri(backupUrl), backup?.Links["download"].Href);

        var restoreRequest = new RestoreRequestDto
        {
            Url = uri,
            // Choose a new app name, because the old one is deleted.
            Name = appNameRestore,
        };

        await _.Client.Backups.PostRestoreJobAsync(restoreRequest);


        // STEP 6: Wait for the backup.
        var restore = await app.Backups.PollRestoreAsync(x => x.Url == uri && x.Status is JobStatus.Completed or JobStatus.Failed);

        Assert.Equal(JobStatus.Completed, restore?.Status);
    }

    [Fact]
    public async Task Should_backup_and_restore_app_with_deleted_app()
    {
        // Load the backup from another URL, because the public URL is might not be accessible for the server.
        var backupUrl = TestHelpers.GetAndPrintValue("config:backupUrl", _.Url);

        // STEP 0: Create app.
        var (app, _) = await _.PostAppAsync(appNameRestore);


        // STEP 1: Prepare app.
        await PrepareAppAsync(app);


        // STEP 2: Create backup.
        await app.Backups.PostBackupAsync();


        // STEP 3: Get obsolete backup.
        var backup = await app.Backups.PollAsync(x => x.Status is JobStatus.Completed or JobStatus.Failed);

        Assert.Equal(JobStatus.Completed, backup?.Status);


        // STEP 4: Get obsolete backup.
        var job = await app.Jobs.PollAsync(x => x.Status is JobStatus.Completed or JobStatus.Failed);

        Assert.Equal(JobStatus.Completed, job?.Status);


        // STEP 4: Delete app.
        await app.Apps.DeleteAppAsync();


        // STEP 5: Restore backup.
        var uri = new Uri(new Uri(backupUrl), backup?.Links["download"].Href);

        var restoreRequest = new RestoreRequestDto
        {
            Url = uri,
            // Restore the old app name, because it has been deleted anyway.
            Name = appName,
        };

        await app.Backups.PostRestoreJobAsync(restoreRequest);


        // STEP 6: Wait for the backup.
        var restore = await app.Backups.PollRestoreAsync(x => x.Url == uri && x.Status is JobStatus.Completed or JobStatus.Failed);

        Assert.Equal(JobStatus.Completed, restore?.Status);
    }

    private async Task PrepareAppAsync(ISquidexClient app)
    {
        // Create a test schema.
        await TestEntity.CreateSchemaAsync(app.Schemas, schemaName);

        var contents = app.Contents<TestEntity, TestEntityData>(schemaName);

        await contents.CreateAsync(
            new TestEntityData
            {
                Number = 1,
            });


        // Upload a test asset
        var fileInfo = new FileInfo("Assets/logo-squared.png");

        await using (var stream = fileInfo.OpenRead())
        {
            var upload = new FileParameter(stream, fileInfo.Name, "image/png");

            await app.Assets.PostAssetAsync(file: upload);
        }


        // Create a workflow
        var workflowRequest = new AddWorkflowDto
        {
            Name = "workflow",
        };

        await app.Apps.PostWorkflowAsync(workflowRequest);


        // Create a language
        var languageRequest = new AddLanguageDto
        {
            Language = "de",
        };

        await app.Apps.PostLanguageAsync(languageRequest);
    }
}