EntityFrameworkCore.Jet/test/EFCore.Jet.FunctionalTests/EverythingIsBytesJetTest.cs

// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.

using System;
using System.Collections.Generic;
using EntityFrameworkCore.Jet.FunctionalTests.TestUtilities;
using Microsoft.EntityFrameworkCore.Diagnostics;
using EntityFrameworkCore.Jet.Storage.Internal;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Storage;
using Microsoft.EntityFrameworkCore.TestUtilities;
using Microsoft.Extensions.DependencyInjection;
using Xunit;
using System.Linq;

// ReSharper disable InconsistentNaming
namespace EntityFrameworkCore.Jet.FunctionalTests
{
    public class EverythingIsBytesJetTest : BuiltInDataTypesTestBase<EverythingIsBytesJetTest.EverythingIsBytesJetFixture>
    {
        public EverythingIsBytesJetTest(EverythingIsBytesJetFixture fixture)
            : base(fixture)
        {
        }

        [ConditionalFact]
        public virtual void Columns_have_expected_data_types()
        {
            var actual = BuiltInDataTypesJetTest.QueryForColumnTypes(
                CreateContext(),
                nameof(ObjectBackedDataTypes),
                nameof(NullableBackedDataTypes),
                nameof(NonNullableBackedDataTypes),
                nameof(AnimalDetails));

            const string expected = @"Animal.Id ---> `varbinary` [MaxLength = 4]
AnimalIdentification.AnimalId ---> `varbinary` [MaxLength = 4]
AnimalIdentification.Id ---> `varbinary` [MaxLength = 4]
AnimalIdentification.Method ---> `varbinary` [MaxLength = 4]
BinaryForeignKeyDataType.BinaryKeyDataTypeId ---> `nullable varbinary` [MaxLength = 900]
BinaryForeignKeyDataType.Id ---> `varbinary` [MaxLength = 4]
BinaryKeyDataType.Ex ---> `nullable varbinary` [MaxLength = -1]
BinaryKeyDataType.Id ---> `varbinary` [MaxLength = 900]
BuiltInDataTypes.Enum16 ---> `varbinary` [MaxLength = 2]
BuiltInDataTypes.Enum32 ---> `varbinary` [MaxLength = 4]
BuiltInDataTypes.Enum64 ---> `varbinary` [MaxLength = 8]
BuiltInDataTypes.Enum8 ---> `varbinary` [MaxLength = 1]
BuiltInDataTypes.EnumS8 ---> `varbinary` [MaxLength = 1]
BuiltInDataTypes.EnumU16 ---> `varbinary` [MaxLength = 2]
BuiltInDataTypes.EnumU32 ---> `varbinary` [MaxLength = 4]
BuiltInDataTypes.EnumU64 ---> `varbinary` [MaxLength = 8]
BuiltInDataTypes.Id ---> `varbinary` [MaxLength = 4]
BuiltInDataTypes.PartitionId ---> `varbinary` [MaxLength = 4]
BuiltInDataTypes.TestBoolean ---> `varbinary` [MaxLength = 1]
BuiltInDataTypes.TestByte ---> `varbinary` [MaxLength = 1]
BuiltInDataTypes.TestCharacter ---> `varbinary` [MaxLength = 2]
BuiltInDataTypes.TestDateTime ---> `varbinary` [MaxLength = 8]
BuiltInDataTypes.TestDateTimeOffset ---> `varbinary` [MaxLength = 12]
BuiltInDataTypes.TestDecimal ---> `varbinary` [MaxLength = 16]
BuiltInDataTypes.TestDouble ---> `varbinary` [MaxLength = 8]
BuiltInDataTypes.TestInt16 ---> `varbinary` [MaxLength = 2]
BuiltInDataTypes.TestInt32 ---> `varbinary` [MaxLength = 4]
BuiltInDataTypes.TestInt64 ---> `varbinary` [MaxLength = 8]
BuiltInDataTypes.TestSignedByte ---> `varbinary` [MaxLength = 1]
BuiltInDataTypes.TestSingle ---> `varbinary` [MaxLength = 4]
BuiltInDataTypes.TestTimeSpan ---> `varbinary` [MaxLength = 8]
BuiltInDataTypes.TestUnsignedInt16 ---> `varbinary` [MaxLength = 2]
BuiltInDataTypes.TestUnsignedInt32 ---> `varbinary` [MaxLength = 4]
BuiltInDataTypes.TestUnsignedInt64 ---> `varbinary` [MaxLength = 8]
BuiltInDataTypesShadow.Enum16 ---> `varbinary` [MaxLength = 2]
BuiltInDataTypesShadow.Enum32 ---> `varbinary` [MaxLength = 4]
BuiltInDataTypesShadow.Enum64 ---> `varbinary` [MaxLength = 8]
BuiltInDataTypesShadow.Enum8 ---> `varbinary` [MaxLength = 1]
BuiltInDataTypesShadow.EnumS8 ---> `varbinary` [MaxLength = 1]
BuiltInDataTypesShadow.EnumU16 ---> `varbinary` [MaxLength = 2]
BuiltInDataTypesShadow.EnumU32 ---> `varbinary` [MaxLength = 4]
BuiltInDataTypesShadow.EnumU64 ---> `varbinary` [MaxLength = 8]
BuiltInDataTypesShadow.Id ---> `varbinary` [MaxLength = 4]
BuiltInDataTypesShadow.PartitionId ---> `varbinary` [MaxLength = 4]
BuiltInDataTypesShadow.TestBoolean ---> `varbinary` [MaxLength = 1]
BuiltInDataTypesShadow.TestByte ---> `varbinary` [MaxLength = 1]
BuiltInDataTypesShadow.TestCharacter ---> `varbinary` [MaxLength = 2]
BuiltInDataTypesShadow.TestDateTime ---> `varbinary` [MaxLength = 8]
BuiltInDataTypesShadow.TestDateTimeOffset ---> `varbinary` [MaxLength = 12]
BuiltInDataTypesShadow.TestDecimal ---> `varbinary` [MaxLength = 16]
BuiltInDataTypesShadow.TestDouble ---> `varbinary` [MaxLength = 8]
BuiltInDataTypesShadow.TestInt16 ---> `varbinary` [MaxLength = 2]
BuiltInDataTypesShadow.TestInt32 ---> `varbinary` [MaxLength = 4]
BuiltInDataTypesShadow.TestInt64 ---> `varbinary` [MaxLength = 8]
BuiltInDataTypesShadow.TestSignedByte ---> `varbinary` [MaxLength = 1]
BuiltInDataTypesShadow.TestSingle ---> `varbinary` [MaxLength = 4]
BuiltInDataTypesShadow.TestTimeSpan ---> `varbinary` [MaxLength = 8]
BuiltInDataTypesShadow.TestUnsignedInt16 ---> `varbinary` [MaxLength = 2]
BuiltInDataTypesShadow.TestUnsignedInt32 ---> `varbinary` [MaxLength = 4]
BuiltInDataTypesShadow.TestUnsignedInt64 ---> `varbinary` [MaxLength = 8]
BuiltInNullableDataTypes.Enum16 ---> `nullable varbinary` [MaxLength = 2]
BuiltInNullableDataTypes.Enum32 ---> `nullable varbinary` [MaxLength = 4]
BuiltInNullableDataTypes.Enum64 ---> `nullable varbinary` [MaxLength = 8]
BuiltInNullableDataTypes.Enum8 ---> `nullable varbinary` [MaxLength = 1]
BuiltInNullableDataTypes.EnumS8 ---> `nullable varbinary` [MaxLength = 1]
BuiltInNullableDataTypes.EnumU16 ---> `nullable varbinary` [MaxLength = 2]
BuiltInNullableDataTypes.EnumU32 ---> `nullable varbinary` [MaxLength = 4]
BuiltInNullableDataTypes.EnumU64 ---> `nullable varbinary` [MaxLength = 8]
BuiltInNullableDataTypes.Id ---> `varbinary` [MaxLength = 4]
BuiltInNullableDataTypes.PartitionId ---> `varbinary` [MaxLength = 4]
BuiltInNullableDataTypes.TestByteArray ---> `nullable varbinary` [MaxLength = -1]
BuiltInNullableDataTypes.TestNullableBoolean ---> `nullable varbinary` [MaxLength = 1]
BuiltInNullableDataTypes.TestNullableByte ---> `nullable varbinary` [MaxLength = 1]
BuiltInNullableDataTypes.TestNullableCharacter ---> `nullable varbinary` [MaxLength = 2]
BuiltInNullableDataTypes.TestNullableDateTime ---> `nullable varbinary` [MaxLength = 8]
BuiltInNullableDataTypes.TestNullableDateTimeOffset ---> `nullable varbinary` [MaxLength = 12]
BuiltInNullableDataTypes.TestNullableDecimal ---> `nullable varbinary` [MaxLength = 16]
BuiltInNullableDataTypes.TestNullableDouble ---> `nullable varbinary` [MaxLength = 8]
BuiltInNullableDataTypes.TestNullableInt16 ---> `nullable varbinary` [MaxLength = 2]
BuiltInNullableDataTypes.TestNullableInt32 ---> `nullable varbinary` [MaxLength = 4]
BuiltInNullableDataTypes.TestNullableInt64 ---> `nullable varbinary` [MaxLength = 8]
BuiltInNullableDataTypes.TestNullableSignedByte ---> `nullable varbinary` [MaxLength = 1]
BuiltInNullableDataTypes.TestNullableSingle ---> `nullable varbinary` [MaxLength = 4]
BuiltInNullableDataTypes.TestNullableTimeSpan ---> `nullable varbinary` [MaxLength = 8]
BuiltInNullableDataTypes.TestNullableUnsignedInt16 ---> `nullable varbinary` [MaxLength = 2]
BuiltInNullableDataTypes.TestNullableUnsignedInt32 ---> `nullable varbinary` [MaxLength = 4]
BuiltInNullableDataTypes.TestNullableUnsignedInt64 ---> `nullable varbinary` [MaxLength = 8]
BuiltInNullableDataTypes.TestString ---> `nullable varbinary` [MaxLength = -1]
BuiltInNullableDataTypesShadow.Enum16 ---> `nullable varbinary` [MaxLength = 2]
BuiltInNullableDataTypesShadow.Enum32 ---> `nullable varbinary` [MaxLength = 4]
BuiltInNullableDataTypesShadow.Enum64 ---> `nullable varbinary` [MaxLength = 8]
BuiltInNullableDataTypesShadow.Enum8 ---> `nullable varbinary` [MaxLength = 1]
BuiltInNullableDataTypesShadow.EnumS8 ---> `nullable varbinary` [MaxLength = 1]
BuiltInNullableDataTypesShadow.EnumU16 ---> `nullable varbinary` [MaxLength = 2]
BuiltInNullableDataTypesShadow.EnumU32 ---> `nullable varbinary` [MaxLength = 4]
BuiltInNullableDataTypesShadow.EnumU64 ---> `nullable varbinary` [MaxLength = 8]
BuiltInNullableDataTypesShadow.Id ---> `varbinary` [MaxLength = 4]
BuiltInNullableDataTypesShadow.PartitionId ---> `varbinary` [MaxLength = 4]
BuiltInNullableDataTypesShadow.TestByteArray ---> `nullable varbinary` [MaxLength = -1]
BuiltInNullableDataTypesShadow.TestNullableBoolean ---> `nullable varbinary` [MaxLength = 1]
BuiltInNullableDataTypesShadow.TestNullableByte ---> `nullable varbinary` [MaxLength = 1]
BuiltInNullableDataTypesShadow.TestNullableCharacter ---> `nullable varbinary` [MaxLength = 2]
BuiltInNullableDataTypesShadow.TestNullableDateTime ---> `nullable varbinary` [MaxLength = 8]
BuiltInNullableDataTypesShadow.TestNullableDateTimeOffset ---> `nullable varbinary` [MaxLength = 12]
BuiltInNullableDataTypesShadow.TestNullableDecimal ---> `nullable varbinary` [MaxLength = 16]
BuiltInNullableDataTypesShadow.TestNullableDouble ---> `nullable varbinary` [MaxLength = 8]
BuiltInNullableDataTypesShadow.TestNullableInt16 ---> `nullable varbinary` [MaxLength = 2]
BuiltInNullableDataTypesShadow.TestNullableInt32 ---> `nullable varbinary` [MaxLength = 4]
BuiltInNullableDataTypesShadow.TestNullableInt64 ---> `nullable varbinary` [MaxLength = 8]
BuiltInNullableDataTypesShadow.TestNullableSignedByte ---> `nullable varbinary` [MaxLength = 1]
BuiltInNullableDataTypesShadow.TestNullableSingle ---> `nullable varbinary` [MaxLength = 4]
BuiltInNullableDataTypesShadow.TestNullableTimeSpan ---> `nullable varbinary` [MaxLength = 8]
BuiltInNullableDataTypesShadow.TestNullableUnsignedInt16 ---> `nullable varbinary` [MaxLength = 2]
BuiltInNullableDataTypesShadow.TestNullableUnsignedInt32 ---> `nullable varbinary` [MaxLength = 4]
BuiltInNullableDataTypesShadow.TestNullableUnsignedInt64 ---> `nullable varbinary` [MaxLength = 8]
BuiltInNullableDataTypesShadow.TestString ---> `nullable varbinary` [MaxLength = -1]
EmailTemplate.Id ---> `varbinary` [MaxLength = 16]
EmailTemplate.TemplateType ---> `varbinary` [MaxLength = 4]
MaxLengthDataTypes.ByteArray5 ---> `nullable varbinary` [MaxLength = 5]
MaxLengthDataTypes.ByteArray9000 ---> `nullable varbinary` [MaxLength = -1]
MaxLengthDataTypes.Id ---> `varbinary` [MaxLength = 4]
MaxLengthDataTypes.String3 ---> `nullable varbinary` [MaxLength = 3]
MaxLengthDataTypes.String9000 ---> `nullable varbinary` [MaxLength = -1]
StringForeignKeyDataType.Id ---> `varbinary` [MaxLength = 4]
StringForeignKeyDataType.StringKeyDataTypeId ---> `nullable varbinary` [MaxLength = 900]
StringKeyDataType.Id ---> `varbinary` [MaxLength = 900]
UnicodeDataTypes.Id ---> `varbinary` [MaxLength = 4]
UnicodeDataTypes.StringAnsi ---> `nullable varbinary` [MaxLength = -1]
UnicodeDataTypes.StringAnsi3 ---> `nullable varbinary` [MaxLength = 3]
UnicodeDataTypes.StringAnsi9000 ---> `nullable varbinary` [MaxLength = -1]
UnicodeDataTypes.StringDefault ---> `nullable varbinary` [MaxLength = -1]
UnicodeDataTypes.StringUnicode ---> `nullable varbinary` [MaxLength = -1]
";

            Assert.Equal(expected, actual, ignoreLineEndingDifferences: true);
        }

        public override void Can_read_back_mapped_enum_from_collection_first_or_default()
        {
            // The query needs to generate TOP 1
        }

        public override void Can_read_back_bool_mapped_as_int_through_navigation()
        {
            // Column is mapped as int rather than byte[]
        }

        public class EverythingIsBytesJetFixture : BuiltInDataTypesFixtureBase
        {
            public override bool StrictEquality => true;

            public override bool SupportsAnsi => true;

            public override bool SupportsUnicodeToAnsiConversion => false;

            public override bool SupportsLargeStringComparisons => true;

            protected override string StoreName { get; } = "EverythingIsBytes";

            protected override ITestStoreFactory TestStoreFactory => JetBytesTestStoreFactory.Instance;

            public override bool SupportsBinaryKeys => true;

            public override bool SupportsDecimalComparisons => true;

            public override DateTime DefaultDateTime => new DateTime();
            public override bool PreservesDateTimeKind { get; }

            public override string ReallyLargeString
            {
                get
                {
                    //Jet max is 255
                    var res = string.Join("", Enumerable.Repeat("testphrase", 25));
                    return res;
                }
            }

            public override int LongStringLength => 255;

            public override DbContextOptionsBuilder AddOptions(DbContextOptionsBuilder builder)
                => base
                    .AddOptions(builder)
                    .ConfigureWarnings(
                        c => c.Log(JetEventId.DecimalTypeDefaultWarning));
        }

        public class JetBytesTestStoreFactory : JetTestStoreFactory
        {
            public static new JetBytesTestStoreFactory Instance { get; } = new JetBytesTestStoreFactory();

            public override IServiceCollection AddProviderServices(IServiceCollection serviceCollection)
                => base.AddProviderServices(
                    serviceCollection.AddSingleton<IRelationalTypeMappingSource, JetBytesTypeMappingSource>());
        }

        public class JetBytesTypeMappingSource : RelationalTypeMappingSource
        {
            private readonly JetByteArrayTypeMapping _rowversion
                = new JetByteArrayTypeMapping("rowversion", size: 8);

            private readonly JetByteArrayTypeMapping _variableLengthBinary
                = new JetByteArrayTypeMapping();

            private readonly JetByteArrayTypeMapping _fixedLengthBinary
                = new JetByteArrayTypeMapping(fixedLength: true);

            private readonly Dictionary<string, RelationalTypeMapping> _storeTypeMappings;

            public JetBytesTypeMappingSource(
                TypeMappingSourceDependencies dependencies,
                RelationalTypeMappingSourceDependencies relationalDependencies)
                : base(dependencies, relationalDependencies)
            {
                _storeTypeMappings
                    = new Dictionary<string, RelationalTypeMapping>(StringComparer.OrdinalIgnoreCase)
                    {
                        { "binary varying", _variableLengthBinary },
                        { "binary", _fixedLengthBinary },
                        { "image", _variableLengthBinary },
                        { "rowversion", _rowversion },
                        { "varbinary", _variableLengthBinary }
                    };
            }

            protected override RelationalTypeMapping FindMapping(in RelationalTypeMappingInfo mappingInfo)
                => FindRawMapping(mappingInfo)?.Clone(mappingInfo);

            private RelationalTypeMapping FindRawMapping(RelationalTypeMappingInfo mappingInfo)
            {
                var clrType = mappingInfo.ClrType;
                var storeTypeName = mappingInfo.StoreTypeName;
                var storeTypeNameBase = mappingInfo.StoreTypeNameBase;

                if (storeTypeName != null)
                {
                    if (_storeTypeMappings.TryGetValue(storeTypeName, out var mapping)
                        || _storeTypeMappings.TryGetValue(storeTypeNameBase, out mapping))
                    {
                        return clrType == null
                            || mapping.ClrType == clrType
                                ? mapping
                                : null;
                    }
                }

                if (clrType == typeof(byte[]))
                {
                    if (mappingInfo.IsRowVersion == true)
                    {
                        return _rowversion;
                    }

                    var isFixedLength = mappingInfo.IsFixedLength == true;

                    var size = mappingInfo.Size ?? (mappingInfo.IsKeyOrIndex ? (int?)255 : null);
                    if (size > 510)
                    {
                        size = isFixedLength ? 510 : (int?)null;
                    }

                    return new JetByteArrayTypeMapping(
                        "varbinary(" + (size == null ? "510" : size.ToString()) + ")",
                        size,
                        isFixedLength,
                        storeTypePostfix: size == null ? StoreTypePostfix.None : (StoreTypePostfix?)null);
                }

                return null;
            }
        }
    }
}