#283, #340 Adding WithoutEntity and Entities by providing model and key/s.

Author: vaptsarov

src/MyTested.AspNetCore.Mvc.EntityFrameworkCore/Builders/Contracts/Data/IWithoutDbContextBuilder.cs

@@ -6,13 +6,51 @@
 
     public interface IWithoutDbContextBuilder
     {
+        /// <summary>
+        /// Remove entity by providing its primary key from the registered <see cref="DbContext"/>.
+        /// </summary>
+        /// <typeparam name="TEntity">Entity model type for which the provided key is related to.</typeparam>
+        /// <param name="key">Primary key of entity to remove from the registered <see cref="DbContext"/>.</param>
+        /// <returns>The same <see cref="DbContext"/> builder.</returns>
+        IAndWithoutDbContextBuilder WithoutEntityByKey<TEntity>(object key)
+            where TEntity : class;
+
+        /// <summary>
+        /// Remove entity by providing its primary key from the registered <see cref="DbContext"/>.
+        /// </summary>
+        /// <typeparam name="TDbContext">Type of <see cref="DbContext"/> to set up.</typeparam>
+        /// <typeparam name="TEntity">Entity model type for which the provided key is related to.</typeparam>
+        /// <param name="key">Primary key of entity to remove from the registered <see cref="DbContext"/>.</param>
+        /// <returns>The same <see cref="DbContext"/> builder.</returns>
+        IAndWithoutDbContextBuilder WithoutEntityByKey<TDbContext, TEntity>(object key)
+            where TDbContext : DbContext;
+
+        /// <summary>
+        /// Remove entities by providing their primary keys from the registered <see cref="DbContext"/>.
+        /// </summary>
+        /// <typeparam name="TEntity">Entity model type for which the provided key is related to.</typeparam>
+        /// <param name="keys">Primary keys for entities to remove from the registered <see cref="DbContext"/>.</param>
+        /// <returns>The same <see cref="DbContext"/> builder.</returns>
+        IAndWithoutDbContextBuilder WithoutEntitiesByKeys<TEntity>(IEnumerable<object> keys)
+            where TEntity : class;
+
+        /// <summary>
+        /// Remove entities by providing their primary keys from the registered <see cref="DbContext"/>.
+        /// </summary>
+        /// <typeparam name="TDbContext">Type of <see cref="DbContext"/> to set up.</typeparam>
+        /// <typeparam name="TEntity">Entity model type for which the provided keys are related to.</typeparam>
+        /// <param name="keys">Primary keys for entities to remove from the registered <see cref="DbContext"/>.</param>
+        /// <returns>The same <see cref="DbContext"/> builder.</returns>
+        IAndWithoutDbContextBuilder WithoutEntitiesByKeys<TDbContext, TEntity>(IEnumerable<object> keys)
+            where TDbContext : DbContext;
+
         /// <summary>
         /// Remove entity from the registered <see cref="DbContext"/>.
         /// </summary>
         /// <param name="entity">Entity to remove from the registered <see cref="DbContext"/>.</param>
         /// <returns>The same <see cref="DbContext"/> builder.</returns>
         IAndWithoutDbContextBuilder WithoutEntity(object entity);
-
+            
         /// <summary>
         /// Remove entity from the registered <see cref="DbContext"/>.
         /// </summary>

src/MyTested.AspNetCore.Mvc.EntityFrameworkCore/Builders/Data/WithoutDbContextBuilder.cs

@@ -23,6 +23,52 @@ public WithoutDbContextBuilder(HttpTestContext testContext)
         {
         }
 
+        /// <inheritdoc />
+        public IAndWithoutDbContextBuilder WithoutEntityByKey<TEntity>(object key)
+            where TEntity : class
+            => this.WithoutEntityByKey<DbContext, TEntity>(key);
+
+        /// <inheritdoc />
+        public IAndWithoutDbContextBuilder WithoutEntityByKey<TDbContext, TEntity>(object key)
+            where TDbContext : DbContext
+        {
+            var dbContext = this.TestContext.GetDbContext<TDbContext>();
+
+            var entity = dbContext.Find(typeof(TEntity), key);
+            if (entity == null)
+                return this;
+
+            dbContext.Remove(entity);
+            dbContext.SaveChanges();
+
+            return this;
+        }
+
+        /// <inheritdoc />
+        public IAndWithoutDbContextBuilder WithoutEntitiesByKeys<TEntity>(IEnumerable<object> keys)
+            where TEntity : class
+            => this.WithoutEntitiesByKeys<DbContext, TEntity>(keys);
+
+        /// <inheritdoc />
+        public IAndWithoutDbContextBuilder WithoutEntitiesByKeys<TDbContext, TEntity>(IEnumerable<object> keys)
+            where TDbContext : DbContext
+        {
+            var dbContext = this.TestContext.GetDbContext<TDbContext>();
+
+            var entityType = typeof(TEntity);
+            var entities = keys
+                .Select(key => dbContext.Find(entityType, key))
+                .Where(entity => entity != null);
+
+            if (entities.Any() == false)
+                return this;
+
+            dbContext.RemoveRange(entities);
+            dbContext.SaveChanges();
+
+            return this;
+        }
+
         /// <inheritdoc />
         public IAndWithoutDbContextBuilder WithoutEntity(object entity)
             => this.WithoutEntity<DbContext>(entity);
@@ -31,7 +77,7 @@ public IAndWithoutDbContextBuilder WithoutEntity(object entity)
         public IAndWithoutDbContextBuilder WithoutEntity<TDbContext>(object entity)
             where TDbContext : DbContext
             => this.WithoutEntities<TDbContext>(entity);
-            
+
         /// <inheritdoc />
         public IAndWithoutDbContextBuilder WithoutEntities(IEnumerable<object> entities)
             => this.WithoutEntities(dbContext => dbContext.RemoveRange(entities));

test/MyTested.AspNetCore.Mvc.EntityFrameworkCore.Test/BuildersTests/ControllersTests/ControllerBuilderTests.cs

@@ -705,5 +705,111 @@ public void WithoutSetReturnsCorrectDataWhenDeletingNonExistingObjects()
                 .ShouldReturn()
                 .NotFound();
         }
+
+        [Fact]
+        public void WithoutDataByProvidingModelAndKeyInBuilderShouldRemoveTheCorrectObject()
+        {
+            MyApplication
+                .StartsFrom<TestStartup>()
+                .WithServices(services => services.AddDbContext<CustomDbContext>());
+
+            var model = new CustomModel
+            {
+                Id = 1,
+                Name = "Test"
+            };
+
+            MyController<DbContextController>
+                .Instance()
+                .WithData(model)
+                .WithoutData(data => data.WithoutEntityByKey<CustomModel>(model.Id))
+                .Calling(c => c.Get(model.Id))
+                .ShouldReturn()
+                .NotFound();
+        }
+
+        [Fact]
+        public void WithoutDataByProvidingNonExistingModelAndKeyInBuilderShouldRemoveTheCorrectObject()
+        {
+            MyApplication
+                .StartsFrom<TestStartup>()
+                .WithServices(services => services.AddDbContext<CustomDbContext>());
+
+            var model = new CustomModel
+            {
+                Id = 1,
+                Name = "Test"
+            };
+
+            var keyToRemove = int.MaxValue;
+            MyController<DbContextController>
+                .Instance()
+                .WithData(model)
+                .WithoutData(data => data.WithoutEntityByKey<CustomModel>(keyToRemove))
+                .Calling(c => c.Get(model.Id))
+                .ShouldReturn()
+                .Ok(ok => ok
+                    .WithModelOfType<CustomModel>()
+                    .Passing(cm => cm.Name.Equals(model.Name)));
+        }
+
+        [Fact]
+        public void WithoutDataByProvidingModelAndMultpleKeysInBuilderShouldRemoveTheCorrectObjects()
+        {
+            MyApplication
+                .StartsFrom<TestStartup>()
+                .WithServices(services => services.AddDbContext<CustomDbContext>());
+
+            var models = new List<CustomModel>
+            {
+                new CustomModel
+                {
+                    Id = 1,
+                    Name = "Test1"
+                },
+                new CustomModel
+                {
+                    Id = 2,
+                    Name = "Test2"
+                },
+            };
+
+            var keys = models.Select(x => x.Id as object).ToList();
+            MyController<DbContextController>
+                .Instance()
+                .WithData(models)
+                .WithoutData(data => data.WithoutEntitiesByKeys<CustomModel>(keys))
+                .Calling(c => c.Get(models[0].Id))
+                .ShouldReturn()
+                .NotFound();
+        }
+
+        [Fact]
+        public void WithoutDataByProvidingNonExistingModelAndMultpleKeysInBuilderShouldRemoveTheCorrectObjects()
+        {
+            MyApplication
+                .StartsFrom<TestStartup>()
+                .WithServices(services => services.AddDbContext<CustomDbContext>());
+
+            var models = new List<CustomModel>
+            {
+                new CustomModel
+                {
+                    Id = 1,
+                    Name = "Test1"
+                }
+            };
+
+            var keys = new List<object> { int.MaxValue };
+            MyController<DbContextController>
+                .Instance()
+                .WithData(models)
+                .WithoutData(data => data.WithoutEntitiesByKeys<CustomModel>(keys))
+                .Calling(c => c.Get(models[0].Id))
+                .ShouldReturn()
+                .Ok(ok => ok
+                    .WithModelOfType<CustomModel>()
+                    .Passing(cm => cm.Name.Equals(models[0].Name)));
+        }
     }
 }