AutoConfigTests.cs

// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

namespace Cli.Tests;

/// <summary>
/// Tests for the auto-config CLI command.
/// </summary>
[TestClass]
public class AutoConfigTests
{
    private IFileSystem? _fileSystem;
    private FileSystemRuntimeConfigLoader? _runtimeConfigLoader;

    [TestInitialize]
    public void TestInitialize()
    {
        _fileSystem = FileSystemUtils.ProvisionMockFileSystem();
        _runtimeConfigLoader = new FileSystemRuntimeConfigLoader(_fileSystem);

        ILoggerFactory loggerFactory = TestLoggerSupport.ProvisionLoggerFactory();
        ConfigGenerator.SetLoggerForCliConfigGenerator(loggerFactory.CreateLogger<ConfigGenerator>());
        SetCliUtilsLogger(loggerFactory.CreateLogger<Utils>());
    }

    [TestCleanup]
    public void TestCleanup()
    {
        _fileSystem = null;
        _runtimeConfigLoader = null;
    }

    /// <summary>
    /// Tests that a new autoentities definition is successfully created with patterns.
    /// </summary>
    [TestMethod]
    public void TestCreateAutoentitiesDefinition_WithPatterns()
    {
        // Arrange
        InitOptions initOptions = CreateBasicInitOptionsForMsSqlWithConfig(config: TEST_RUNTIME_CONFIG_FILE);
        Assert.IsTrue(ConfigGenerator.TryGenerateConfig(initOptions, _runtimeConfigLoader!, _fileSystem!));

        AutoConfigOptions options = new(
            definitionName: "test-def",
            patternsInclude: new[] { "dbo.%", "sys.%" },
            patternsExclude: new[] { "dbo.internal%" },
            patternsName: "{schema}_{table}",
            config: TEST_RUNTIME_CONFIG_FILE
        );

        // Act
        bool success = ConfigGenerator.TryConfigureAutoentities(options, _runtimeConfigLoader!, _fileSystem!);

        // Assert
        Assert.IsTrue(success);
        Assert.IsTrue(_runtimeConfigLoader!.TryLoadConfig(TEST_RUNTIME_CONFIG_FILE, out RuntimeConfig? config));
        Assert.IsNotNull(config.Autoentities);
        Assert.IsTrue(config.Autoentities.Autoentities.ContainsKey("test-def"));

        Autoentity autoentity = config.Autoentities.Autoentities["test-def"];
        Assert.AreEqual(2, autoentity.Patterns.Include.Length);
        Assert.AreEqual("dbo.%", autoentity.Patterns.Include[0]);
        Assert.AreEqual("sys.%", autoentity.Patterns.Include[1]);
        Assert.AreEqual(1, autoentity.Patterns.Exclude.Length);
        Assert.AreEqual("dbo.internal%", autoentity.Patterns.Exclude[0]);
        Assert.AreEqual("{schema}_{table}", autoentity.Patterns.Name);
    }

    /// <summary>
    /// Tests that template options are correctly configured for an autoentities definition.
    /// </summary>
    [TestMethod]
    public void TestConfigureAutoentitiesDefinition_WithTemplateOptions()
    {
        // Arrange
        InitOptions initOptions = CreateBasicInitOptionsForMsSqlWithConfig(config: TEST_RUNTIME_CONFIG_FILE);
        Assert.IsTrue(ConfigGenerator.TryGenerateConfig(initOptions, _runtimeConfigLoader!, _fileSystem!));

        AutoConfigOptions options = new(
            definitionName: "test-def",
            templateRestEnabled: true,
            templateGraphqlEnabled: false,
            templateMcpDmlTools: "true",
            templateCacheEnabled: true,
            templateCacheTtlSeconds: 30,
            templateCacheLevel: "L1",
            templateHealthEnabled: true,
            config: TEST_RUNTIME_CONFIG_FILE
        );

        // Act
        bool success = ConfigGenerator.TryConfigureAutoentities(options, _runtimeConfigLoader!, _fileSystem!);

        // Assert
        Assert.IsTrue(success);
        Assert.IsTrue(_runtimeConfigLoader!.TryLoadConfig(TEST_RUNTIME_CONFIG_FILE, out RuntimeConfig? config));

        Autoentity autoentity = config.Autoentities!.Autoentities["test-def"];
        Assert.IsTrue(autoentity.Template.Rest.Enabled);
        Assert.IsFalse(autoentity.Template.GraphQL.Enabled);
        Assert.IsTrue(autoentity.Template.Mcp!.DmlToolEnabled);
        Assert.AreEqual(true, autoentity.Template.Cache.Enabled);
        Assert.AreEqual(30, autoentity.Template.Cache.TtlSeconds);
        Assert.AreEqual(EntityCacheLevel.L1, autoentity.Template.Cache.Level);
        Assert.IsTrue(autoentity.Template.Health.Enabled);
    }

    /// <summary>
    /// Tests that an existing autoentities definition is successfully updated.
    /// </summary>
    [TestMethod]
    public void TestUpdateExistingAutoentitiesDefinition()
    {
        // Arrange
        InitOptions initOptions = CreateBasicInitOptionsForMsSqlWithConfig(config: TEST_RUNTIME_CONFIG_FILE);
        Assert.IsTrue(ConfigGenerator.TryGenerateConfig(initOptions, _runtimeConfigLoader!, _fileSystem!));

        // Create initial definition
        AutoConfigOptions initialOptions = new(
            definitionName: "test-def",
            patternsInclude: new[] { "dbo.%" },
            templateCacheTtlSeconds: 10,
            permissions: new[] { "anonymous", "read" },
            config: TEST_RUNTIME_CONFIG_FILE
        );
        Assert.IsTrue(ConfigGenerator.TryConfigureAutoentities(initialOptions, _runtimeConfigLoader!, _fileSystem!));

        // Update definition
        AutoConfigOptions updateOptions = new(
            definitionName: "test-def",
            patternsExclude: new[] { "dbo.internal%" },
            templateCacheTtlSeconds: 60,
            permissions: new[] { "authenticated", "create,read,update,delete" },
            config: TEST_RUNTIME_CONFIG_FILE
        );

        // Act
        bool success = ConfigGenerator.TryConfigureAutoentities(updateOptions, _runtimeConfigLoader!, _fileSystem!);

        // Assert
        Assert.IsTrue(success);
        Assert.IsTrue(_runtimeConfigLoader!.TryLoadConfig(TEST_RUNTIME_CONFIG_FILE, out RuntimeConfig? config));

        Autoentity autoentity = config.Autoentities!.Autoentities["test-def"];
        // Include should remain from initial setup
        Assert.AreEqual(1, autoentity.Patterns.Include.Length);
        Assert.AreEqual("dbo.%", autoentity.Patterns.Include[0]);
        // Exclude should be added
        Assert.AreEqual(1, autoentity.Patterns.Exclude.Length);
        Assert.AreEqual("dbo.internal%", autoentity.Patterns.Exclude[0]);
        // Cache TTL should be updated
        Assert.AreEqual(60, autoentity.Template.Cache.TtlSeconds);
        // Permissions should be replaced
        Assert.AreEqual(1, autoentity.Permissions.Length);
        Assert.AreEqual("authenticated", autoentity.Permissions[0].Role);
    }

    /// <summary>
    /// Tests that permissions are correctly parsed and applied.
    /// </summary>
    [TestMethod]
    public void TestConfigureAutoentitiesDefinition_WithMultipleActions()
    {
        // Arrange
        InitOptions initOptions = CreateBasicInitOptionsForMsSqlWithConfig(config: TEST_RUNTIME_CONFIG_FILE);
        Assert.IsTrue(ConfigGenerator.TryGenerateConfig(initOptions, _runtimeConfigLoader!, _fileSystem!));

        AutoConfigOptions options = new(
            definitionName: "test-def",
            permissions: new[] { "authenticated", "create,read,update,delete" },
            config: TEST_RUNTIME_CONFIG_FILE
        );

        // Act
        bool success = ConfigGenerator.TryConfigureAutoentities(options, _runtimeConfigLoader!, _fileSystem!);

        // Assert
        Assert.IsTrue(success);
        Assert.IsTrue(_runtimeConfigLoader!.TryLoadConfig(TEST_RUNTIME_CONFIG_FILE, out RuntimeConfig? config));

        Autoentity autoentity = config.Autoentities!.Autoentities["test-def"];
        Assert.AreEqual(1, autoentity.Permissions.Length);
        Assert.AreEqual("authenticated", autoentity.Permissions[0].Role);
        Assert.AreEqual(4, autoentity.Permissions[0].Actions.Length);
    }

    /// <summary>
    /// Tests that invalid MCP dml-tool value is handled correctly.
    /// </summary>
    [TestMethod]
    public void TestConfigureAutoentitiesDefinition_InvalidMcpDmlTool()
    {
        // Arrange
        InitOptions initOptions = CreateBasicInitOptionsForMsSqlWithConfig(config: TEST_RUNTIME_CONFIG_FILE);
        Assert.IsTrue(ConfigGenerator.TryGenerateConfig(initOptions, _runtimeConfigLoader!, _fileSystem!));

        AutoConfigOptions options = new(
            definitionName: "test-def",
            templateMcpDmlTools: "invalid-value",
            permissions: new[] { "anonymous", "read" },
            config: TEST_RUNTIME_CONFIG_FILE
        );

        // Act
        bool success = ConfigGenerator.TryConfigureAutoentities(options, _runtimeConfigLoader!, _fileSystem!);

        // Assert - Should fail due to invalid MCP value
        Assert.IsFalse(success);
    }

    /// <summary>
    /// Tests that invalid cache level value is handled correctly.
    /// </summary>
    [TestMethod]
    public void TestConfigureAutoentitiesDefinition_InvalidCacheLevel()
    {
        // Arrange
        InitOptions initOptions = CreateBasicInitOptionsForMsSqlWithConfig(config: TEST_RUNTIME_CONFIG_FILE);
        Assert.IsTrue(ConfigGenerator.TryGenerateConfig(initOptions, _runtimeConfigLoader!, _fileSystem!));

        AutoConfigOptions options = new(
            definitionName: "test-def",
            templateCacheLevel: "InvalidLevel",
            permissions: new[] { "anonymous", "read" },
            config: TEST_RUNTIME_CONFIG_FILE
        );

        // Act
        bool success = ConfigGenerator.TryConfigureAutoentities(options, _runtimeConfigLoader!, _fileSystem!);

        // Assert - Should fail due to invalid cache level
        Assert.IsFalse(success);
    }

    /// <summary>
    /// Tests that multiple autoentities definitions can coexist.
    /// </summary>
    [TestMethod]
    public void TestMultipleAutoentitiesDefinitions()
    {
        // Arrange
        InitOptions initOptions = CreateBasicInitOptionsForMsSqlWithConfig(config: TEST_RUNTIME_CONFIG_FILE);
        Assert.IsTrue(ConfigGenerator.TryGenerateConfig(initOptions, _runtimeConfigLoader!, _fileSystem!));

        // Create first definition
        AutoConfigOptions options1 = new(
            definitionName: "def-1",
            patternsInclude: new[] { "dbo.%" },
            permissions: new[] { "anonymous", "read" },
            config: TEST_RUNTIME_CONFIG_FILE
        );
        Assert.IsTrue(ConfigGenerator.TryConfigureAutoentities(options1, _runtimeConfigLoader!, _fileSystem!));

        // Create second definition
        AutoConfigOptions options2 = new(
            definitionName: "def-2",
            patternsInclude: new[] { "sys.%" },
            permissions: new[] { "authenticated", "*" },
            config: TEST_RUNTIME_CONFIG_FILE
        );

        // Act
        bool success = ConfigGenerator.TryConfigureAutoentities(options2, _runtimeConfigLoader!, _fileSystem!);

        // Assert
        Assert.IsTrue(success);
        Assert.IsTrue(_runtimeConfigLoader!.TryLoadConfig(TEST_RUNTIME_CONFIG_FILE, out RuntimeConfig? config));
        Assert.AreEqual(2, config.Autoentities!.Autoentities.Count);
        Assert.IsTrue(config.Autoentities.Autoentities.ContainsKey("def-1"));
        Assert.IsTrue(config.Autoentities.Autoentities.ContainsKey("def-2"));
    }

    /// <summary>
    /// Tests that attempting to configure autoentities without a config file fails.
    /// </summary>
    [TestMethod]
    public void TestConfigureAutoentitiesDefinition_NoConfigFile()
    {
        // Arrange
        AutoConfigOptions options = new(
            definitionName: "test-def",
            permissions: new[] { "anonymous", "read" }
        );

        // Act
        bool success = ConfigGenerator.TryConfigureAutoentities(options, _runtimeConfigLoader!, _fileSystem!);

        // Assert
        Assert.IsFalse(success);
    }
}