UA-.NETStandard/Fuzzing/Encoders/Fuzz.Tools/Encoders.Testcases.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.IO;
using System.Text;

namespace Opc.Ua.Fuzzing
{
    public static partial class Testcases
    {
        public enum TestCaseEncoders
        {
            Binary = 0,
            Json = 1,
            Xml = 2
        }

        public static readonly string[] TestcaseEncoderSuffixes = [".Binary", ".Json", ".Xml"];

        /// <summary>
        /// Run the encoder test cases
        /// </summary>
        /// <param name="workPath"></param>
        /// <param name="telemetry">The telemetry context to use to create obvservability instruments</param>
        public static void Run(string workPath, ITelemetryContext telemetry)
        {
            // Create the Testcases for the binary decoder.
            FuzzableCode.MessageContext = ServiceMessageContext.Create(telemetry);
            string pathSuffix = TestcaseEncoderSuffixes[(int)TestCaseEncoders.Binary];
            string pathTarget = workPath + pathSuffix + Path.DirectorySeparatorChar;
            foreach (MessageEncoder messageEncoder in MessageEncoders)
            {
                byte[] message;
                using (var encoder = new BinaryEncoder(FuzzableCode.MessageContext))
                {
                    messageEncoder(encoder);
                    message = encoder.CloseAndReturnBuffer();
                }

                // Test the fuzz targets with the message.
                FuzzableCode.LibfuzzBinaryDecoder(message);
                FuzzableCode.LibfuzzBinaryEncoder(message);
                using (var stream = new MemoryStream(message))
                {
                    FuzzableCode.AflfuzzBinaryDecoder(stream);
                }
                using (var stream = new MemoryStream(message))
                {
                    FuzzableCode.AflfuzzBinaryEncoder(stream);
                }
                using (var stream = new MemoryStream(message))
                {
                    FuzzableCode.FuzzBinaryDecoderCore(stream, true);
                }

                string fileName = Path.Combine(
                    pathTarget,
                    $"{messageEncoder.Method.Name}.bin".ToLowerInvariant());
                File.WriteAllBytes(fileName, message);
            }

            // Create the Testcases for the json decoder.
            pathSuffix = TestcaseEncoderSuffixes[(int)TestCaseEncoders.Json];
            pathTarget = workPath + pathSuffix + Path.DirectorySeparatorChar;
            foreach (MessageEncoder messageEncoder in MessageEncoders)
            {
                byte[] message;
                using (var memoryStream = new MemoryStream(0x1000))
                using (var encoder = new JsonEncoder(memoryStream, FuzzableCode.MessageContext))
                {
                    messageEncoder(encoder);
                    encoder.Close();
                    message = memoryStream.ToArray();
                }

                // Test the fuzz targets with the message.
                FuzzableCode.LibfuzzJsonDecoder(message);
                FuzzableCode.LibfuzzJsonEncoder(message);
                string json = Encoding.UTF8.GetString(message);
                FuzzableCode.AflfuzzJsonDecoder(json);
                FuzzableCode.AflfuzzJsonEncoder(json);
                FuzzableCode.FuzzJsonDecoderCore(json, true);

                string fileName = Path.Combine(
                    pathTarget,
                    $"{messageEncoder.Method.Name}.json".ToLowerInvariant());
                File.WriteAllBytes(fileName, message);
            }

            // Create the Testcases for the xml decoder.
            pathSuffix = TestcaseEncoderSuffixes[(int)TestCaseEncoders.Xml];
            pathTarget = workPath + pathSuffix + Path.DirectorySeparatorChar;
            foreach (MessageEncoder messageEncoder in MessageEncoders)
            {
                string xml;
                using (var encoder = new XmlEncoder(FuzzableCode.MessageContext))
                {
                    encoder.SetMappingTables(
                        FuzzableCode.MessageContext.NamespaceUris,
                        FuzzableCode.MessageContext.ServerUris);
                    messageEncoder(encoder);
                    xml = encoder.CloseAndReturnText();
                }

                // Test the fuzz targets with the message.
                byte[] message = Encoding.UTF8.GetBytes(xml);
                using (var stream = new MemoryStream(message))
                {
                    FuzzableCode.AflfuzzXmlDecoder(stream);
                }
                using (var stream = new MemoryStream(message))
                {
                    FuzzableCode.AflfuzzXmlEncoder(stream);
                }
                using (var stream = new MemoryStream(message))
                {
                    FuzzableCode.FuzzXmlDecoderCore(stream, true);
                }
                FuzzableCode.LibfuzzXmlDecoder(message);
                FuzzableCode.LibfuzzXmlEncoder(message);

                string fileName = Path.Combine(
                    pathTarget,
                    $"{messageEncoder.Method.Name}.xml".ToLowerInvariant());
                File.WriteAllBytes(fileName, Encoding.UTF8.GetBytes(xml));
            }
        }
    }
}