src/Compilers/Core/CodeAnalysisTest/Emit/EmitOptionsTests.cs - main - githubmirror/roslyn

src/Compilers/Core/CodeAnalysisTest/Emit/EmitOptionsTests.cs
148 строк7 KB
Jan Jones
Detect data section string literal hash collisions (#77061)
11 фев 2025, 12:35
11 фев 2025, 12:3519c9b9e
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

#nullable disable

using System;
using System.Collections.Immutable;
using System.Security.Cryptography;
using Microsoft.CodeAnalysis.Emit;
using Microsoft.CodeAnalysis.Text;
using Roslyn.Test.Utilities;
using Roslyn.Utilities;
using Xunit;

namespace Microsoft.CodeAnalysis.UnitTests
{
    public class EmitOptionsTests : TestBase
    {
        private void TestProperty<T>(
            Func<EmitOptions, T, EmitOptions> factory,
            Func<EmitOptions, T> getter,
            T validNonDefaultValue)
        {
            var oldOpt1 = EmitOptions.Default;

            var validDefaultValue = getter(oldOpt1);

            // we need non-default value to test Equals and GetHashCode
            Assert.NotEqual(validNonDefaultValue, validDefaultValue);

            // check that the assigned value can be read:
            var newOpt1 = factory(oldOpt1, validNonDefaultValue);
            Assert.Equal(validNonDefaultValue, getter(newOpt1));

            // check that creating new options with the same value yields the same options instance:
            var newOpt1_alias = factory(newOpt1, validNonDefaultValue);
            Assert.Same(newOpt1_alias, newOpt1);

            // check that Equals and GetHashCode work
            var newOpt2 = factory(oldOpt1, validNonDefaultValue);
            Assert.False(newOpt1.Equals(oldOpt1));
            Assert.True(newOpt1.Equals(newOpt2));

            Assert.Equal(newOpt1.GetHashCode(), newOpt2.GetHashCode());

            // test default(T):
            Assert.NotNull(factory(oldOpt1, default));
        }

        [Fact]
        public void WithXxx()
        {
            TestProperty((old, value) => old.WithFileAlignment(value), opt => opt.FileAlignment, 2048);
            TestProperty((old, value) => old.WithBaseAddress(value), opt => opt.BaseAddress, 100UL);
            TestProperty((old, value) => old.WithHighEntropyVirtualAddressSpace(value), opt => opt.HighEntropyVirtualAddressSpace, true);
            TestProperty((old, value) => old.WithSubsystemVersion(value), opt => opt.SubsystemVersion, SubsystemVersion.Windows2000);
            TestProperty((old, value) => old.WithRuntimeMetadataVersion(value), opt => opt.RuntimeMetadataVersion, "v12345");
            TestProperty((old, value) => old.WithPdbFilePath(value), opt => opt.PdbFilePath, @"c:\temp\a.pdb");
            TestProperty((old, value) => old.WithPdbChecksumAlgorithm(value), opt => opt.PdbChecksumAlgorithm, new HashAlgorithmName());
            TestProperty((old, value) => old.WithPdbChecksumAlgorithm(value), opt => opt.PdbChecksumAlgorithm, HashAlgorithmName.SHA384);
            TestProperty((old, value) => old.WithOutputNameOverride(value), opt => opt.OutputNameOverride, @"x.dll");
            TestProperty((old, value) => old.WithDebugInformationFormat(value), opt => opt.DebugInformationFormat,
                PathUtilities.IsUnixLikePlatform ? DebugInformationFormat.Pdb : DebugInformationFormat.PortablePdb);
            TestProperty((old, value) => old.WithTolerateErrors(value), opt => opt.TolerateErrors, true);
            TestProperty((old, value) => old.WithIncludePrivateMembers(value), opt => opt.IncludePrivateMembers, false);
            TestProperty((old, value) => old.WithInstrumentationKinds(value), opt => opt.InstrumentationKinds, ImmutableArray.Create(InstrumentationKind.TestCoverage));
        }

        /// <summary>
        /// If this test fails, please update the <see cref="EmitOptions.GetHashCode"/>
        /// and <see cref="EmitOptions.Equals(EmitOptions)"/> methods to
        /// make sure they are doing the right thing with your new field and then update the baseline
        /// here.
        /// </summary>
        [Fact]
        public void TestFieldsForEqualsAndGetHashCode()
        {
            ReflectionAssert.AssertPublicAndInternalFieldsAndProperties(
                typeof(EmitOptions),
                nameof(EmitOptions.EmitMetadataOnly),
                nameof(EmitOptions.SubsystemVersion),
                nameof(EmitOptions.FileAlignment),
                nameof(EmitOptions.HighEntropyVirtualAddressSpace),
                nameof(EmitOptions.BaseAddress),
                nameof(EmitOptions.DebugInformationFormat),
                nameof(EmitOptions.OutputNameOverride),
                nameof(EmitOptions.PdbFilePath),
                nameof(EmitOptions.PdbChecksumAlgorithm),
                nameof(EmitOptions.RuntimeMetadataVersion),
                nameof(EmitOptions.TolerateErrors),
                nameof(EmitOptions.IncludePrivateMembers),
                nameof(EmitOptions.InstrumentationKinds),
                nameof(EmitOptions.DefaultSourceFileEncoding),
                nameof(EmitOptions.FallbackSourceFileEncoding),
                nameof(EmitOptions.TestOnly_DataToHexViaXxHash128));
        }

        [Fact]
        public void TestCtors()
        {
            var options1 = new EmitOptions(
                metadataOnly: true,
                debugInformationFormat: DebugInformationFormat.Embedded,
                pdbFilePath: "A",
                outputNameOverride: "B",
                fileAlignment: 1,
                baseAddress: 2,
                highEntropyVirtualAddressSpace: true,
                subsystemVersion: SubsystemVersion.Windows2000,
                runtimeMetadataVersion: "C",
                tolerateErrors: true,
                includePrivateMembers: false);

            var options2 = new EmitOptions(
                metadataOnly: true,
                debugInformationFormat: DebugInformationFormat.Embedded,
                pdbFilePath: "A",
                outputNameOverride: "B",
                fileAlignment: 1,
                baseAddress: 2,
                highEntropyVirtualAddressSpace: true,
                subsystemVersion: SubsystemVersion.Windows2000,
                runtimeMetadataVersion: "C",
                tolerateErrors: true,
                includePrivateMembers: false,
                instrumentationKinds: ImmutableArray.Create(InstrumentationKind.TestCoverage));

            var options3 = new EmitOptions(
                metadataOnly: true,
                debugInformationFormat: DebugInformationFormat.Embedded,
                pdbFilePath: "A",
                outputNameOverride: "B",
                fileAlignment: 1,
                baseAddress: 2,
                highEntropyVirtualAddressSpace: true,
                subsystemVersion: SubsystemVersion.Windows2000,
                runtimeMetadataVersion: "C",
                tolerateErrors: true,
                includePrivateMembers: false,
                instrumentationKinds: ImmutableArray.Create(InstrumentationKind.TestCoverage),
                pdbChecksumAlgorithm: HashAlgorithmName.MD5); // CodeQL [SM02196] This is testing an algorithm that our codebase must support for PDBs

            Assert.Equal(options1, options2.WithInstrumentationKinds(default));
            Assert.Equal(options2, options3.WithPdbChecksumAlgorithm(HashAlgorithmName.SHA256));
        }
    }
}