osu-framework/osu.Framework.SourceGeneration.Tests/AbstractGeneratorTests.cs

// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reflection;

namespace osu.Framework.SourceGeneration.Tests
{
    public abstract class AbstractGeneratorTests
    {
        private const string assembly_namespace = "osu.Framework.SourceGeneration.Tests.Resources";

        protected virtual string ResourceNamespace => string.Empty;

        /// <summary>
        /// This method is kind of SILLY and is a HACK.
        /// It exists because the order in which sources are present affects the order in which the Roslyn test class compares files.
        /// To get around this, filenames can be prefixed with '[0|1|2|3|etc]' indices to file names to get them into the correct order, which will be removed by this method.
        /// </summary>
        private void removeNameIndices(IList<(string filename, string content)> sources)
        {
            for (int i = 0; i < sources.Count; i++)
            {
                string name = sources[i].filename;

                if (!name.StartsWith('['))
                    continue;

                sources[i] = (name[(name.IndexOf(']') + 1)..], sources[i].content);
            }
        }

        private string getFileNameFromResourceName(string resourceNamespace, string resourceName)
        {
            string extension = Path.GetExtension(resourceName);

            resourceName = resourceName.Replace(resourceNamespace, string.Empty).Substring(1)
                                       .Replace(extension, string.Empty);

            // .txt files are converted to .cs.
            resourceName = extension == ".txt" ? $"{resourceName}.cs" : $"{resourceName}{extension}";

            return resourceName;
        }

        protected void GetTestSources(
            string name,
            out (string filename, string content)[] commonSources,
            out (string filename, string content)[] sources,
            out (string filename, string content)[] commonGenerated,
            out (string filename, string content)[] generated)
        {
            string baseNamespace = assembly_namespace;
            if (!string.IsNullOrEmpty(ResourceNamespace))
                baseNamespace += $".{ResourceNamespace}";

            string commonSourcesNamespace = $"{baseNamespace}.CommonSources";
            string commonGeneratedNamespace = $"{baseNamespace}.CommonGenerated";
            string sourcesNamespace = $"{baseNamespace}.{name}.Sources";
            string generatedNamespace = $"{baseNamespace}.{name}.Generated";

            Assembly assembly = Assembly.GetExecutingAssembly();
            string[] resourceNames = assembly.GetManifestResourceNames();

            var commonSourceFiles = new List<(string filename, string content)>();
            var sourceFiles = new List<(string filename, string content)>();
            var commonGeneratedFiles = new List<(string filename, string content)>();
            var generatedFiles = new List<(string filename, string content)>();

            foreach (string file in resourceNames.Where(n => n.StartsWith(commonSourcesNamespace, StringComparison.Ordinal)))
                commonSourceFiles.Add((getFileNameFromResourceName(commonSourcesNamespace, file), readResourceStream(assembly, file)));

            foreach (string file in resourceNames.Where(n => n.StartsWith(commonGeneratedNamespace, StringComparison.Ordinal)))
                commonGeneratedFiles.Add((getFileNameFromResourceName(commonGeneratedNamespace, file), readResourceStream(assembly, file)));

            foreach (string file in resourceNames.Where(n => n.StartsWith(sourcesNamespace, StringComparison.Ordinal)))
                sourceFiles.Add((getFileNameFromResourceName(sourcesNamespace, file), readResourceStream(assembly, file)));

            foreach (string file in resourceNames.Where(n => n.StartsWith(generatedNamespace, StringComparison.Ordinal)))
                generatedFiles.Add((getFileNameFromResourceName(generatedNamespace, file), readResourceStream(assembly, file)));

            removeNameIndices(commonSourceFiles);
            removeNameIndices(sourceFiles);
            removeNameIndices(commonGeneratedFiles);
            removeNameIndices(generatedFiles);

            commonSources = commonSourceFiles.ToArray();
            sources = sourceFiles.ToArray();
            commonGenerated = commonGeneratedFiles.ToArray();
            generated = generatedFiles.ToArray();
        }

        private string readResourceStream(Assembly asm, string resource)
        {
            using (var stream = asm.GetManifestResourceStream(resource)!)
            using (var sr = new StreamReader(stream))
                return sr.ReadToEnd().ReplaceLineEndings("\r\n");
        }
    }
}