UA-.NETStandard/tests/Opc.Ua.Core.Schema.Tests/SchemaProviderExtensionsTests.cs

/* ========================================================================
 * Copyright (c) 2005-2025 The OPC Foundation, Inc. All rights reserved.
 *
 * OPC Foundation MIT License 1.00
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * The complete license agreement can be found here:
 * http://opcfoundation.org/License/MIT/1.00/
 * ======================================================================*/

using System;
using NUnit.Framework;

namespace Opc.Ua.Schema.Tests
{
    /// <summary>
    /// Tests for the schema provider convenience extension methods.
    /// </summary>
    [TestFixture]
    [Category("Schema")]
    public class SchemaProviderExtensionsTests
    {
        [Test]
        public void GetJsonSchemaUsesCompactByDefault()
        {
            UaTypeDescription type = SchemaTestData.Structure(
                3001,
                "SampleType",
                SchemaTestData.Field("Id", SchemaTestData.BuiltIn(BuiltInType.Int32)));
            ISchemaProvider provider = SchemaTestData.CreateProvider(type);

            IUaSchema schema = provider.GetJsonSchema(type);

            Assert.That(schema.Format, Is.EqualTo(UaSchemaFormat.JsonCompact));
        }

        [Test]
        public void GetJsonSchemaVerboseUsesVerboseFlavor()
        {
            UaTypeDescription type = SchemaTestData.Structure(
                3001,
                "SampleType",
                SchemaTestData.Field("Id", SchemaTestData.BuiltIn(BuiltInType.Int32)));
            ISchemaProvider provider = SchemaTestData.CreateProvider(type);

            IUaSchema schema = provider.GetJsonSchema(type, verbose: true);

            Assert.That(schema.Format, Is.EqualTo(UaSchemaFormat.JsonVerbose));
        }

        [Test]
        public void CreateSchemaThrowsWhenNoGeneratorSupportsFormat()
        {
            UaTypeDescription type = SchemaTestData.Structure(
                3001,
                "SampleType",
                SchemaTestData.Field("Id", SchemaTestData.BuiltIn(BuiltInType.Int32)));
            var provider = new DefaultSchemaProvider(new DataTypeDefinitionRegistry(), []);

            Assert.That(
                () => provider.CreateSchema(type, UaSchemaFormat.JsonCompact),
                Throws.TypeOf<NotSupportedException>().With.Message.Contains("JsonCompact"));
        }

        [Test]
        public void TryGetJsonSchemaResolvesRegisteredType()
        {
            UaTypeDescription type = SchemaTestData.Structure(
                3001,
                "SampleType",
                SchemaTestData.Field("Id", SchemaTestData.BuiltIn(BuiltInType.Int32)));
            ISchemaProvider provider = SchemaTestData.CreateProvider(type);

            bool resolved = provider.TryGetJsonSchema(type.TypeId, out IUaSchema? schema);

            Assert.Multiple(() =>
            {
                Assert.That(resolved, Is.True);
                Assert.That(schema, Is.Not.Null);
            });
        }
    }
}