Add validation for unique column names

johaDev · Oct 8, 2015 · e6e9449 · e6e9449
1 parent f3c7726
commit e6e9449
Showing 21 changed files with 184 additions and 8 deletions.
diff --git a/src/EntityFramework.MicrosoftSqlServer/EntityFramework.MicrosoftSqlServer.csproj b/src/EntityFramework.MicrosoftSqlServer/EntityFramework.MicrosoftSqlServer.csproj
@@ -45,6 +45,7 @@
     </Compile>
     <Compile Include="Infrastructure\SqlServerDbContextOptionsBuilder.cs" />
     <Compile Include="Internal\SqlServerModelSource.cs" />
+    <Compile Include="Internal\SqlServerModelValidator.cs" />
     <Compile Include="Internal\SqlServerOptionsExtension.cs" />
     <Compile Include="Metadata\Conventions\Internal\SqlServerConventionSetBuilder.cs" />
     <Compile Include="Metadata\Conventions\Internal\SqlServerValueGenerationStrategyConvention.cs" />

diff --git a/...mework.MicrosoftSqlServer/Extensions/SqlServerEntityFrameworkServicesBuilderExtensions.cs b/...mework.MicrosoftSqlServer/Extensions/SqlServerEntityFrameworkServicesBuilderExtensions.cs
@@ -41,6 +41,7 @@ public static EntityFrameworkServicesBuilder AddSqlServer([NotNull] this EntityF
                 .AddSingleton<SqlServerModelSource>()
                 .AddSingleton<SqlServerAnnotationProvider>()
                 .AddSingleton<SqlServerMigrationsAnnotationProvider>()
+                .AddScoped<SqlServerModelValidator>()
                 .AddScoped<ISqlServerUpdateSqlGenerator, SqlServerUpdateSqlGenerator>()
                 .AddScoped<ISqlServerSequenceValueGeneratorFactory, SqlServerSequenceValueGeneratorFactory>()
                 .AddScoped<SqlServerModificationCommandBatchFactory>()

diff --git a/src/EntityFramework.MicrosoftSqlServer/Internal/SqlServerModelValidator.cs b/src/EntityFramework.MicrosoftSqlServer/Internal/SqlServerModelValidator.cs
@@ -0,0 +1,17 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using JetBrains.Annotations;
+using Microsoft.Data.Entity.Metadata;
+using Microsoft.Extensions.Logging;
+
+namespace Microsoft.Data.Entity.Internal
+{
+    public class SqlServerModelValidator : RelationalModelValidator
+    {
+        public SqlServerModelValidator([NotNull] ILogger<RelationalModelValidator> loggerFactory, [NotNull] IRelationalAnnotationProvider relationalExtensions)
+            : base(loggerFactory, relationalExtensions)
+        {
+        }
+    }
+}
diff --git a/src/EntityFramework.MicrosoftSqlServer/Storage/Internal/SqlServerDatabaseProviderServices.cs b/src/EntityFramework.MicrosoftSqlServer/Storage/Internal/SqlServerDatabaseProviderServices.cs
@@ -53,5 +53,6 @@ public SqlServerDatabaseProviderServices([NotNull] IServiceProvider services)
         public override ISqlQueryGeneratorFactory SqlQueryGeneratorFactory => GetService<SqlServerQuerySqlGeneratorFactory>();
         public override IEntityQueryModelVisitorFactory EntityQueryModelVisitorFactory => GetService<SqlServerQueryModelVisitorFactory>();
         public override ICompiledQueryCacheKeyGenerator CompiledQueryCacheKeyGenerator => GetService<SqlServerCompiledQueryCacheKeyGenerator>();
+        public override IModelValidator ModelValidator => GetService<SqlServerModelValidator>();
     }
 }
diff --git a/src/EntityFramework.Relational/Internal/RelationalModelValidator.cs b/src/EntityFramework.Relational/Internal/RelationalModelValidator.cs
@@ -27,6 +27,7 @@ public override void Validate(IModel model)
             base.Validate(model);
 
             EnsureDistinctTableNames(model);
+            EnsureDistinctColumnNames(model);
             ValidateInheritanceMapping(model);
         }
 
@@ -46,6 +47,22 @@ protected virtual void EnsureDistinctTableNames([NotNull] IModel model)
             }
         }
 
+        protected virtual void EnsureDistinctColumnNames([NotNull] IModel model)
+        {
+            foreach (var entityType in model.EntityTypes)
+            {
+                var columns = new HashSet<string>();
+                foreach (var property in entityType.GetProperties())
+                {
+                    var name = _relationalExtensions.For(property).ColumnName;
+                    if (!columns.Add(name))
+                    {
+                        ShowError(RelationalStrings.DuplicateColumnName(name, entityType.Name, property.Name));
+                    }
+                }
+            }
+        }
+
         protected virtual void ValidateInheritanceMapping([NotNull] IModel model)
         {
             var roots = new HashSet<IEntityType>();

diff --git a/src/EntityFramework.Relational/Properties/RelationalStrings.Designer.cs b/src/EntityFramework.Relational/Properties/RelationalStrings.Designer.cs
diff --git a/src/EntityFramework.Relational/Properties/RelationalStrings.resx b/src/EntityFramework.Relational/Properties/RelationalStrings.resx
@@ -295,4 +295,7 @@
   <data name="RelationalLoggerExecutingCommand" xml:space="preserve">
     <value>Executing DbCommand: [Parameters=[{parameters}], CommandType='{commandType}', CommandTimeout='{commandTimeout}']{newLine}{newLine}{commandText}{newLine}</value>
   </data>
+  <data name="DuplicateColumnName" xml:space="preserve">
+    <value>Cannot use column name '{columnName}' in entity '{entityType}' for property '{property}' since it is being used for another property.</value>
+  </data>
 </root>
diff --git a/src/EntityFramework.Sqlite/EntityFramework.Sqlite.csproj b/src/EntityFramework.Sqlite/EntityFramework.Sqlite.csproj
@@ -59,6 +59,7 @@
       <Link>Extensions\SharedTypeExtensions.cs</Link>
     </Compile>
     <Compile Include="Infrastructure\Internal\SqliteModelSource.cs" />
+    <Compile Include="Infrastructure\Internal\SqliteModelValidator.cs" />
     <Compile Include="Infrastructure\Internal\SqliteOptionsExtension.cs" />
     <Compile Include="Metadata\Builders\SqliteEntityTypeBuilderExtensions.cs" />
     <Compile Include="Metadata\Builders\SqliteReferenceCollectionBuilderExtensions.cs" />

diff --git a/src/EntityFramework.Sqlite/Infrastructure/Internal/SqliteModelValidator.cs b/src/EntityFramework.Sqlite/Infrastructure/Internal/SqliteModelValidator.cs
@@ -0,0 +1,18 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using JetBrains.Annotations;
+using Microsoft.Data.Entity.Internal;
+using Microsoft.Data.Entity.Metadata;
+using Microsoft.Extensions.Logging;
+
+namespace Microsoft.Data.Entity.Infrastructure.Internal
+{
+    public class SqliteModelValidator : RelationalModelValidator
+    {
+        public SqliteModelValidator([NotNull] ILogger<RelationalModelValidator> loggerFactory, [NotNull] IRelationalAnnotationProvider relationalExtensions)
+            : base(loggerFactory, relationalExtensions)
+        {
+        }
+    }
+}
diff --git a/src/EntityFramework.Sqlite/Infrastructure/SqliteEntityFrameworkServicesBuilderExtensions.cs b/src/EntityFramework.Sqlite/Infrastructure/SqliteEntityFrameworkServicesBuilderExtensions.cs
@@ -40,6 +40,7 @@ public static EntityFrameworkServicesBuilder AddSqlite([NotNull] this EntityFram
                 .AddSingleton<SqliteModelSource>()
                 .AddSingleton<SqliteMigrationsAnnotationProvider>()
                 .AddSingleton<SqliteConventionSetBuilder>()
+                .AddScoped<SqliteModelValidator>()
                 .AddScoped<SqliteUpdateSqlGenerator>()
                 .AddScoped<SqliteModificationCommandBatchFactory>()
                 .AddScoped<SqliteDatabaseProviderServices>()

diff --git a/src/EntityFramework.Sqlite/Storage/SqliteDatabaseProviderServices.cs b/src/EntityFramework.Sqlite/Storage/SqliteDatabaseProviderServices.cs
@@ -6,6 +6,7 @@
 using JetBrains.Annotations;
 using Microsoft.Data.Entity.Infrastructure;
 using Microsoft.Data.Entity.Infrastructure.Internal;
+using Microsoft.Data.Entity.Internal;
 using Microsoft.Data.Entity.Metadata;
 using Microsoft.Data.Entity.Metadata.Conventions.Internal;
 using Microsoft.Data.Entity.Metadata.Internal;
@@ -47,5 +48,6 @@ public SqliteDatabaseProviderServices([NotNull] IServiceProvider services)
         public override IMemberTranslator CompositeMemberTranslator => GetService<SqliteCompositeMemberTranslator>();
         public override IMigrationsAnnotationProvider MigrationsAnnotationProvider => GetService<SqliteMigrationsAnnotationProvider>();
         public override ISqlQueryGeneratorFactory SqlQueryGeneratorFactory => GetService<SqliteQuerySqlGeneratorFactory>();
+        public override IModelValidator ModelValidator => GetService<SqliteModelValidator>();
     }
 }
diff --git a/.../EntityFramework.MicrosoftSqlServer.Tests/EntityFramework.MicrosoftSqlServer.Tests.csproj b/.../EntityFramework.MicrosoftSqlServer.Tests/EntityFramework.MicrosoftSqlServer.Tests.csproj
@@ -46,6 +46,7 @@
     <Compile Include="Migrations\SqlServerModelDifferTest.cs" />
     <Compile Include="SqlServerDatabaseCreatorTest.cs" />
     <Compile Include="SqlServerDbContextOptionsExtensionsTest.cs" />
+    <Compile Include="SqlServerModelValidatorTest.cs" />
     <Compile Include="SqlServerOptionsExtensionTest.cs" />
     <Compile Include="SqlServerConnectionTest.cs" />
     <Compile Include="SqlServerDatabaseSourceTest.cs" />

diff --git a/...amework.MicrosoftSqlServer.Tests/SqlServerEntityFrameworkServicesBuilderExtensionsTest.cs b/...amework.MicrosoftSqlServer.Tests/SqlServerEntityFrameworkServicesBuilderExtensionsTest.cs
@@ -40,6 +40,7 @@ public override void Services_wire_up_correctly()
             VerifyScoped<SqlServerHistoryRepository>();
             VerifyScoped<SqlServerCompositeMethodCallTranslator>();
             VerifyScoped<SqlServerCompositeMemberTranslator>();
+            VerifyScoped<SqlServerModelValidator>();
         }
 
         public SqlServerEntityFrameworkServicesBuilderExtensionsTest()

diff --git a/test/EntityFramework.MicrosoftSqlServer.Tests/SqlServerModelValidatorTest.cs b/test/EntityFramework.MicrosoftSqlServer.Tests/SqlServerModelValidatorTest.cs
@@ -0,0 +1,41 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using Microsoft.Data.Entity.Internal;
+using Microsoft.Data.Entity.Metadata;
+using Microsoft.Data.Entity.Metadata.Conventions.Internal;
+using Microsoft.Data.Entity.Tests;
+using Microsoft.Data.Entity.Tests.TestUtilities;
+using Microsoft.Extensions.Logging;
+
+namespace Microsoft.Data.Entity.SqlServer.Tests
+{
+    public class SqlServerModelValidatorTest : RelationalModelValidatorTest
+    {
+        public override void Detects_duplicate_column_names()
+        {
+            var modelBuilder = new ModelBuilder(new CoreConventionSetBuilder().CreateConventionSet());
+            modelBuilder.Entity<Product>();
+            modelBuilder.Entity<Product>().Property(b => b.Name).ForSqlServerHasColumnName("Id");
+
+            VerifyError(RelationalStrings.DuplicateColumnName("Id", typeof(Product).FullName, "Name"), modelBuilder.Model);
+        }
+
+        private class Product
+        {
+            public int Id { get; set; }
+            public string Name { get; set; }
+        }
+
+        protected override ModelValidator CreateModelValidator()
+            => new SqlServerModelValidator(
+                new Logger<SqlServerModelValidator>(
+                    new ListLoggerFactory(Log, l => l == typeof(SqlServerModelValidator).FullName)),
+                new TestSqlServerAnnotationProvider());
+    }
+
+    public class TestSqlServerAnnotationProvider : TestAnnotationProvider
+    {
+        public override IRelationalPropertyAnnotations For(IProperty property) => new SqlServerPropertyAnnotations(property);
+    }
+}
diff --git a/test/EntityFramework.Relational.Tests/RelationalModelValidatorTest.cs b/test/EntityFramework.Relational.Tests/RelationalModelValidatorTest.cs
@@ -2,6 +2,8 @@
 // Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
 
 using Microsoft.Data.Entity.Internal;
+using Microsoft.Data.Entity.Metadata.Conventions;
+using Microsoft.Data.Entity.Metadata.Conventions.Internal;
 using Microsoft.Data.Entity.Tests.Infrastructure;
 using Microsoft.Data.Entity.Tests.TestUtilities;
 using Microsoft.Extensions.Logging;
@@ -74,6 +76,16 @@ public virtual void Does_not_detect_duplicate_table_names_for_inherited_entities
             CreateModelValidator().Validate(model);
         }
 
+        [Fact]
+        public virtual void Detects_duplicate_column_names()
+        {
+            var modelBuilder = new ModelBuilder(new CoreConventionSetBuilder().CreateConventionSet());
+            modelBuilder.Entity<Product>();
+            modelBuilder.Entity<Product>().Property(b => b.Name).HasColumnName("Id");
+
+            VerifyError(RelationalStrings.DuplicateColumnName("Id", typeof(Product).FullName, "Name"), modelBuilder.Model);
+        }
+
         [Fact]
         public virtual void Passes_for_non_hierarchical_model()
         {
@@ -152,6 +164,12 @@ protected class Generic<T> : Abstract
         {
         }
 
+        private class Product
+        {
+            public int Id { get; set; }
+            public string Name { get; set; }
+        }
+
         protected override ModelValidator CreateModelValidator()
             => new RelationalModelValidator(
                 new Logger<RelationalModelValidator>(

diff --git a/test/EntityFramework.Relational.Tests/TestAnnotationProvider.cs b/test/EntityFramework.Relational.Tests/TestAnnotationProvider.cs
@@ -7,11 +7,11 @@ namespace Microsoft.Data.Entity.Tests
 {
     public class TestAnnotationProvider : IRelationalAnnotationProvider
     {
-        public IRelationalEntityTypeAnnotations For(IEntityType entityType) => entityType.TestProvider();
-        public IRelationalForeignKeyAnnotations For(IForeignKey foreignKey) => foreignKey.TestProvider();
-        public IRelationalIndexAnnotations For(IIndex index) => index.TestProvider();
-        public IRelationalKeyAnnotations For(IKey key) => key.TestProvider();
-        public IRelationalModelAnnotations For(IModel model) => model.TestProvider();
-        public IRelationalPropertyAnnotations For(IProperty property) => property.TestProvider();
+        public virtual IRelationalEntityTypeAnnotations For(IEntityType entityType) => entityType.TestProvider();
+        public virtual IRelationalForeignKeyAnnotations For(IForeignKey foreignKey) => foreignKey.TestProvider();
+        public virtual IRelationalIndexAnnotations For(IIndex index) => index.TestProvider();
+        public virtual IRelationalKeyAnnotations For(IKey key) => key.TestProvider();
+        public virtual IRelationalModelAnnotations For(IModel model) => model.TestProvider();
+        public virtual IRelationalPropertyAnnotations For(IProperty property) => property.TestProvider();
     }
 }
diff --git a/test/EntityFramework.Sqlite.Tests/ApiConsistencyTest.cs b/test/EntityFramework.Sqlite.Tests/ApiConsistencyTest.cs
@@ -4,7 +4,7 @@
 using System.Reflection;
 using Microsoft.Data.Entity.Storage.Internal;
 
-namespace Microsoft.Data.Entity.Sqlite
+namespace Microsoft.Data.Entity.Sqlite.Tests
 {
     public class ApiConsistencyTest : ApiConsistencyTestBase
     {

diff --git a/test/EntityFramework.Sqlite.Tests/EntityFramework.Sqlite.Tests.csproj b/test/EntityFramework.Sqlite.Tests/EntityFramework.Sqlite.Tests.csproj
@@ -44,6 +44,7 @@
     <Compile Include="Migrations\SqliteMigrationSqlGeneratorTest.cs" />
     <Compile Include="Migrations\SqliteHistoryRepositoryTest.cs" />
     <Compile Include="Infrastructure\SqliteEntityFrameworkServicesBuilderExtensionsTest.cs" />
+    <Compile Include="SqliteModelValidatorTest.cs" />
     <Compile Include="Storage\SqliteSqlGeneratorTest.cs" />
     <Compile Include="Update\SqliteUpdateSqlGeneratorTest.cs" />
     <Compile Include="Storage\SqliteTypeMappingTest.cs" />

diff --git a/...amework.Sqlite.Tests/Infrastructure/SqliteEntityFrameworkServicesBuilderExtensionsTest.cs b/...amework.Sqlite.Tests/Infrastructure/SqliteEntityFrameworkServicesBuilderExtensionsTest.cs
@@ -40,6 +40,7 @@ public override void Services_wire_up_correctly()
             VerifyScoped<SqliteHistoryRepository>();
             VerifyScoped<SqliteCompositeMethodCallTranslator>();
             VerifyScoped<SqliteCompositeMemberTranslator>();
+            VerifyScoped<SqliteModelValidator>();
         }
 
         public SqliteEntityFrameworkServicesBuilderExtensionsTest()

diff --git a/test/EntityFramework.Sqlite.Tests/SqliteDbContextOptionsBuilderExtensionsTest.cs b/test/EntityFramework.Sqlite.Tests/SqliteDbContextOptionsBuilderExtensionsTest.cs
@@ -6,7 +6,7 @@
 using Microsoft.Data.Sqlite;
 using Xunit;
 
-namespace Microsoft.Data.Entity
+namespace Microsoft.Data.Entity.Sqlite.Tests
 {
     public class SqliteDbContextOptionsBuilderExtensionsTest
     {

diff --git a/test/EntityFramework.Sqlite.Tests/SqliteModelValidatorTest.cs b/test/EntityFramework.Sqlite.Tests/SqliteModelValidatorTest.cs
@@ -0,0 +1,43 @@
+// Copyright (c) .NET Foundation. All rights reserved.
+// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
+
+using Microsoft.Data.Entity.Infrastructure.Internal;
+using Microsoft.Data.Entity.Internal;
+using Microsoft.Data.Entity.Metadata;
+using Microsoft.Data.Entity.Metadata.Conventions.Internal;
+using Microsoft.Data.Entity.Metadata.Internal;
+using Microsoft.Data.Entity.Tests;
+using Microsoft.Data.Entity.Tests.TestUtilities;
+using Microsoft.Extensions.Logging;
+
+namespace Microsoft.Data.Entity.Sqlite.Tests
+{
+    public class SqliteModelValidatorTest : RelationalModelValidatorTest
+    {
+        public override void Detects_duplicate_column_names()
+        {
+            var modelBuilder = new ModelBuilder(new CoreConventionSetBuilder().CreateConventionSet());
+            modelBuilder.Entity<Product>();
+            modelBuilder.Entity<Product>().Property(b => b.Name).ForSqliteHasColumnName("Id");
+
+            VerifyError(RelationalStrings.DuplicateColumnName("Id", typeof(Product).FullName, "Name"), modelBuilder.Model);
+        }
+
+        private class Product
+        {
+            public int Id { get; set; }
+            public string Name { get; set; }
+        }
+
+        protected override ModelValidator CreateModelValidator()
+            => new SqliteModelValidator(
+                new Logger<SqliteModelValidator>(
+                    new ListLoggerFactory(Log, l => l == typeof(SqliteModelValidator).FullName)),
+                new TestSqliteAnnotationProvider());
+    }
+
+    public class TestSqliteAnnotationProvider : TestAnnotationProvider
+    {
+        public override IRelationalPropertyAnnotations For(IProperty property) => new RelationalPropertyAnnotations(property, SqliteAnnotationNames.Prefix);
+    }
+}