squidex/tools/TestSuite/TestSuite.ApiTests/ContentScriptingTests.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;

#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 ContentScriptingTests(CreatedAppFixture fixture) : IClassFixture<CreatedAppFixture>
{
    private readonly string schemaName = $"schema-{Guid.NewGuid()}";

    public CreatedAppFixture _ { get; } = fixture;

    [Fact]
    public async Task Should_create_content_with_scripting()
    {
        var scripts = new SchemaScriptsDto
        {
            Create = @$"
                    ctx.data.{TestEntityData.NumberField}.iv *= 2;
                    replace()",
        };

        // STEP 1: Create a schema.
        await TestEntity.CreateSchemaAsync(_.Client.Schemas, schemaName, scripts);


        // STEP 2: Create content.
        var contents = _.Client.Contents<TestEntity, TestEntityData>(schemaName);

        var content = await contents.CreateAsync(
            new TestEntityData
            {
                Number = 13,
            });

        Assert.Equal(26, content.Data.Number);
    }

    [Fact]
    public async Task Should_query_content_with_scripting()
    {
        var scripts = new SchemaScriptsDto
        {
            Query = @$"
                    ctx.data.{TestEntityData.NumberField}.iv *= 2;
                    replace()",
        };

        // STEP 1: Create a schema.
        await TestEntity.CreateSchemaAsync(_.Client.Schemas, schemaName, scripts);


        // STEP 2: Create content.
        var contents = _.Client.Contents<TestEntity, TestEntityData>(schemaName);

        var content = await contents.CreateAsync(
            new TestEntityData
            {
                Number = 13,
            },
            ContentCreateOptions.AsPublish);

        Assert.Equal(26, content.Data.Number);
    }

    [Fact]
    public async Task Should_query_content_with_scripting_and_prepare_script()
    {
        var scripts = new SchemaScriptsDto
        {
            QueryPre = @$"
                    ctx.test = 17",
            Query = @$"
                    ctx.data.{TestEntityData.NumberField}.iv = ctx.test + 2;
                    replace()",
        };

        // STEP 1: Create a schema.
        await TestEntity.CreateSchemaAsync(_.Client.Schemas, schemaName, scripts);


        // STEP 2: Create content.
        var contents = _.Client.Contents<TestEntity, TestEntityData>(schemaName);

        var content = await contents.CreateAsync(
            new TestEntityData
            {
                Number = 99,
            },
            ContentCreateOptions.AsPublish);

        Assert.Equal(19, content.Data.Number);
    }

    [Fact]
    public async Task Should_create_bulk_content_with_scripting()
    {
        // STEP 1: Create a schema.
        var scripts = new SchemaScriptsDto
        {
            Create = @$"
                    ctx.data.{TestEntityData.NumberField}.iv = incrementCounter('${schemaName}');
                    replace()",
        };

        await TestEntity.CreateSchemaAsync(_.Client.Schemas, schemaName, scripts);


        // STEP 2: Create content with a value that triggers the schema.
        var contents = _.Client.Contents<TestEntity, TestEntityData>(schemaName);

        var results = await contents.BulkUpdateAsync(
            new BulkUpdate
            {
                DoNotScript = false,
                DoNotValidate = false,
                Jobs =
                [
                    new BulkUpdateJob
                    {
                        Type = BulkUpdateType.Upsert,
                        Data = new
                        {
                            number = new
                            {
                                iv = 99,
                            },
                        },
                    },
                ],
                Publish = true,
            });

        Assert.Single(results);
        Assert.Null(results[0].Error);


        // STEP 2: Query content.
        var content = await contents.GetAsync(results[0].ContentId);

        Assert.True(content.Data.Number > 0);
    }

    [Fact]
    public async Task Should_create_bulk_content_with_disabled_scripting()
    {
        // STEP 1: Create a schema.
        var scripts = new SchemaScriptsDto
        {
            Create = @$"
                    ctx.data.{TestEntityData.NumberField}.iv = incrementCounter('${schemaName}');
                    replace()",
        };

        await TestEntity.CreateSchemaAsync(_.Client.Schemas, schemaName, scripts);


        // STEP 1: Create content with a value that triggers the schema.
        var contents = _.Client.Contents<TestEntity, TestEntityData>(schemaName);

        var results = await contents.BulkUpdateAsync(
            new BulkUpdate
            {
                DoNotScript = true,
                DoNotValidate = false,
                Jobs =
                [
                    new BulkUpdateJob
                    {
                        Type = BulkUpdateType.Upsert,
                        Data = new
                        {
                            number = new
                            {
                                iv = 99,
                            },
                        },
                    },
                ],
                Publish = true,
            });

        Assert.Single(results);
        Assert.Null(results[0].Error);


        // STEP 2: Query content.
        var content = await contents.GetAsync(results[0].ContentId);

        Assert.Equal(99, content.Data.Number);
    }
}