[WIP] Setup integration tests using SpecFlow

.github/workflows/dotnet.yml

@@ -0,0 +1,80 @@
+name: .NET
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+defaults:
+  run: 
+    working-directory: ./Src
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    # Service containers to run with `container-job`
+    services:
+      # Label used to access the service container
+      postgres:
+        # Docker Hub image
+        image: postgres
+        # Provide the password for postgres
+        env:
+          POSTGRES_PASSWORD: git-ci-pass
+          POSTGRES_USER: git-ci
+          POSTGRES_DB: postgres
+        ports:
+          # Maps tcp port 5432 on service container to the host
+          - 5432:5432
+        # Set health checks to wait until postgres has started
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v1
+      with:
+        dotnet-version: 5.0.x
+    - name: Restore dependencies
+      run: dotnet restore DeUrgenta.sln
+    - name: Build
+      run: dotnet build --no-restore /p:ContinuousIntegrationBuild=true DeUrgenta.sln
+    - name: Apply migrations for test db
+      run: |
+        dotnet tool install --global dotnet-ef
+        dotnet ef database update  --no-build --project DeUrgenta.Domain --startup-project DeUrgenta.Api --context DeUrgentaContext --connection "Server=localhost;Port=5432;Database=de-urgenta-specs-db;User Id=git-ci;Password=git-ci-pass;"
+        dotnet ef database update  --no-build --project DeUrgenta.User.Api --startup-project DeUrgenta.Api --context UserDbContext --connection "Server=localhost;Port=5432;Database=de-urgenta-specs-db;User Id=git-ci;Password=git-ci-pass;"
+    - name: Run unit & integration tests
+      run: dotnet test --no-build --verbosity normal /p:CollectCoverage=true /p:CoverletOutputFormat=opencover DeUrgenta.sln
+      env:
+        # Connection string
+        ConnectionStrings__TestingDbConnectionString: Server=localhost;Port=5432;Database=de-urgenta-specs-db;User Id=git-ci;Password=git-ci-pass; 
+    - name: Upload dotnet test results
+      uses: codecov/codecov-action@v1
+    - name: Run specs
+      run: |
+        dotnet tool install --global SpecFlow.Plus.LivingDoc.CLI
+        dotnet test DeUrgenta.Specs.sln
+      env:
+        # Connection strings
+        ConnectionStrings__DbConnectionString: Server=localhost;Port=5432;Database=de-urgenta-specs-db;User Id=git-ci;Password=git-ci-pass;
+        ConnectionStrings__IdentityDbConnectionString: Server=localhost;Port=5432;Database=de-urgenta-specs-db;User Id=git-ci;Password=git-ci-pass;
+
+    - name: Generate living doc 
+      run: |
+        cd ./Specs/DeUrgenta.Specs/bin/Debug/net5.0
+        livingdoc test-assembly DeUrgenta.Specs.dll -t TestExecution.json
+      if: always()
+
+    - uses: actions/upload-artifact@v2
+      with:
+        name: living-doc
+        path: ./Src/Specs/DeUrgenta.Specs/bin/Debug/net5.0/LivingDoc.html
+        if-no-files-found: error # 'warn' or 'ignore' are also available, defaults to `warn`
+      if: always()
+

Src/DeUrgenta.Admin.Api/DeUrgenta.Admin.Api.csproj

@@ -11,8 +11,8 @@
 	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="CSharpFunctionalExtensions" Version="2.15.1" />
-		<PackageReference Include="FluentValidation" Version="10.3.0" />
+		<PackageReference Include="CSharpFunctionalExtensions" Version="2.20.4" />
+		<PackageReference Include="FluentValidation" Version="10.3.6" />
 		<PackageReference Include="MediatR" Version="9.0.0" />
 		<PackageReference Include="Microsoft.Extensions.Configuration.UserSecrets" Version="5.0.0" />
 		<PackageReference Include="Swashbuckle.AspNetCore.Filters" Version="6.1.0" />

Src/DeUrgenta.Api/DeUrgenta.Api.csproj

@@ -15,12 +15,12 @@
 
 	<ItemGroup>
 		<PackageReference Include="AspNetCoreRateLimit" Version="4.0.1" />
-		<PackageReference Include="FluentValidation" Version="10.3.0" />
-		<PackageReference Include="FluentValidation.AspNetCore" Version="10.3.0" />
+		<PackageReference Include="FluentValidation" Version="10.3.6" />
+		<PackageReference Include="FluentValidation.AspNetCore" Version="10.3.6" />
 		<PackageReference Include="Hellang.Middleware.ProblemDetails" Version="5.3.0" />
 		<PackageReference Include="MediatR.Extensions.Microsoft.DependencyInjection" Version="9.0.0" />
-		<PackageReference Include="MicroElements.Swashbuckle.FluentValidation" Version="5.2.0" />
-		<PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="5.0.4">
+		<PackageReference Include="MicroElements.Swashbuckle.FluentValidation" Version="5.4.0" />
+		<PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="5.0.10">
 			<PrivateAssets>all</PrivateAssets>
 			<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 		</PackageReference>

Src/DeUrgenta.Api/Extensions/SwaggerExtensions.cs

@@ -8,6 +8,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.OpenApi.Models;
 using Swashbuckle.AspNetCore.Filters;
+using Swashbuckle.AspNetCore.SwaggerGen;
 using Swashbuckle.AspNetCore.SwaggerUI;
 
 namespace DeUrgenta.Api.Extensions
@@ -26,13 +27,20 @@ public static IServiceCollection AddSwaggerFor(this IServiceCollection services,
                     In = ParameterLocation.Header,
                     Name = "Authorization",
                     BearerFormat = "JWT",
-                    Description = "JWT Authorization header using the Bearer scheme."
+                    Description = "JWT Authorization header using the Bearer scheme.",
+                    Reference = new OpenApiReference
+                    {
+                        Type = ReferenceType.SecurityScheme,
+                        Id = "Bearer"
+                    },
                 };
+
                 c.AddSecurityDefinition("Bearer", jwtSecurityScheme);
                 c.AddSecurityRequirement(new OpenApiSecurityRequirement
                 {
                     { jwtSecurityScheme, Array.Empty<string>() }
                 });
+                c.CustomOperationIds(apiDesc => apiDesc.TryGetMethodInfo(out var methodInfo) ? methodInfo.Name : $"{apiDesc.ActionDescriptor.RouteValues["controller"]}_{apiDesc.ActionDescriptor.RouteValues["action"]}_{apiDesc.HttpMethod}");
 
                 c.OperationFilter<AuthorizeCheckOperationFilter>();
                 c.OperationFilter<AcceptLanguageHeaderParameterOperationFilter>();
@@ -46,7 +54,7 @@ public static IServiceCollection AddSwaggerFor(this IServiceCollection services,
                     Contact = new OpenApiContact
                     {
                         Name = "Code4Romania",
-                        Email = string.Empty,
+                        Email = "code4ro@code4.ro",
                         Url = new Uri("https://code4.ro/"),
                     },
                     License = new OpenApiLicense

Src/DeUrgenta.Backpack.Api/CommandHandlers/UpdateBackpackItemHandler.cs

@@ -41,8 +41,8 @@ public UpdateBackpackItemHandler(IValidateRequest<UpdateBackpackItem> validator,
             {
                 Id = backpackItem.Id,
                 BackpackId = backpackItem.BackpackId,
-                Name = backpackItem.Name,
                 Amount = backpackItem.Amount,
+                Name = backpackItem.Name,
                 Category = backpackItem.Category,
                 ExpirationDate = backpackItem.ExpirationDate,
                 Version = backpackItem.Version

Src/DeUrgenta.Backpack.Api/DeUrgenta.Backpack.Api.csproj

@@ -11,8 +11,8 @@
 	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="CSharpFunctionalExtensions" Version="2.15.1" />
-		<PackageReference Include="FluentValidation" Version="10.3.0" />
+		<PackageReference Include="CSharpFunctionalExtensions" Version="2.20.4" />
+		<PackageReference Include="FluentValidation" Version="10.3.6" />
 		<PackageReference Include="MediatR" Version="9.0.0" />
 		<PackageReference Include="Swashbuckle.AspNetCore.Filters" Version="6.1.0" />
 	</ItemGroup>

Src/DeUrgenta.Certifications.Api/DeUrgenta.Certifications.Api.csproj

@@ -11,9 +11,9 @@
 
 	<ItemGroup>
 		<PackageReference Include="AWSSDK.Extensions.NETCore.Setup" Version="3.7.1" />
-		<PackageReference Include="AWSSDK.S3" Version="3.7.3.1" />
-		<PackageReference Include="CSharpFunctionalExtensions" Version="2.15.3" />
-		<PackageReference Include="FluentValidation" Version="10.3.0" />
+		<PackageReference Include="AWSSDK.S3" Version="3.7.3.4" />
+		<PackageReference Include="CSharpFunctionalExtensions" Version="2.20.4" />
+		<PackageReference Include="FluentValidation" Version="10.3.6" />
 		<PackageReference Include="MediatR" Version="9.0.0" />
 		<PackageReference Include="Swashbuckle.AspNetCore.Filters" Version="6.1.0" />
 	</ItemGroup>

Src/DeUrgenta.Common/DeUrgenta.Common.csproj

@@ -9,9 +9,9 @@
 
 
 	<ItemGroup>
-		<PackageReference Include="FluentValidation" Version="10.3.0" />
+		<PackageReference Include="FluentValidation" Version="10.3.6" />
 		<PackageReference Include="MediatR" Version="9.0.0" />
-		<PackageReference Include="Microsoft.EntityFrameworkCore" Version="5.0.4" />
+		<PackageReference Include="Microsoft.EntityFrameworkCore" Version="5.0.10" />
 		<PackageReference Include="Swashbuckle.AspNetCore.Filters" Version="6.1.0" />
 		<PackageReference Include="CSharpFunctionalExtensions" Version="2.15.1" />
 

Src/DeUrgenta.Content.Api/DeUrgenta.Content.Api.csproj

@@ -12,7 +12,7 @@
 
   <ItemGroup>
     <PackageReference Include="CSharpFunctionalExtensions" Version="2.15.1" />
-		<PackageReference Include="FluentValidation" Version="10.3.0" />
+		<PackageReference Include="FluentValidation" Version="10.3.6" />
 		<PackageReference Include="MediatR" Version="9.0.0" />
 		<PackageReference Include="Swashbuckle.AspNetCore.Filters" Version="6.1.0" />
   </ItemGroup>

Src/DeUrgenta.Domain.Identity/DeUrgenta.Domain.Identity.csproj

@@ -11,7 +11,7 @@
 	</PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.EntityFrameworkCore" Version="5.0.4" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore" Version="5.0.10" />
     <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="5.0.2" />
     <PackageReference Include="Microsoft.AspNetCore.Identity.EntityFrameworkCore" Version="5.0.2" />
   </ItemGroup>

Src/DeUrgenta.Domain.RecurringJobs/DeUrgenta.Domain.RecurringJobs.csproj

@@ -7,8 +7,8 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.EntityFrameworkCore" Version="5.0.4" />
-    <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="5.0.2" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore" Version="5.0.10" />
+    <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="5.0.10" />
   </ItemGroup>
 
 </Project>

Src/DeUrgenta.Events.Api/DeUrgenta.Events.Api.csproj

@@ -10,8 +10,8 @@
 	</PropertyGroup>
 
 	<ItemGroup>
-		<PackageReference Include="CSharpFunctionalExtensions" Version="2.15.3" />
-		<PackageReference Include="FluentValidation" Version="10.3.0" />
+		<PackageReference Include="CSharpFunctionalExtensions" Version="2.20.4" />
+		<PackageReference Include="FluentValidation" Version="10.3.6" />
 		<PackageReference Include="MediatR" Version="9.0.0" />
 		<PackageReference Include="Swashbuckle.AspNetCore.Filters" Version="6.1.0" />
 	</ItemGroup>

Src/DeUrgenta.Group.Api/Controllers/GroupController.cs

@@ -115,67 +115,6 @@ public async Task<ActionResult<GroupModel>> UpdateGroupAsync([FromRoute] Guid gr
             return await _mapper.MapToActionResult(result);
         }
 
-        /// <summary>
-        /// Gets a list of group members
-        /// </summary>
-        [HttpGet]
-        [Route("{groupId:guid}/members")]
-        [SwaggerResponse(StatusCodes.Status200OK, "List of group members", typeof(IImmutableList<GroupMemberModel>))]
-        [SwaggerResponse(StatusCodes.Status400BadRequest, "A business rule was violated", typeof(ProblemDetails))]
-        [SwaggerResponse(StatusCodes.Status500InternalServerError, "Something bad happened", typeof(ProblemDetails))]
-
-        [SwaggerResponseExample(StatusCodes.Status200OK, typeof(GetGroupMembersResponseExample))]
-        [SwaggerResponseExample(StatusCodes.Status400BadRequest, typeof(BusinessRuleViolationResponseExample))]
-        [SwaggerResponseExample(StatusCodes.Status500InternalServerError, typeof(ApplicationErrorResponseExample))]
-        public async Task<ActionResult<IImmutableList<GroupMemberModel>>> GetGroupMembersAsync([FromRoute] Guid groupId)
-        {
-            var sub = User.Claims.FirstOrDefault(c => c.Type == "sub")?.Value;
-            var query = new GetGroupMembers(sub, groupId);
-            var result = await _mediator.Send(query);
-
-            return await _mapper.MapToActionResult(result);
-        }
-
-        /// <summary>
-        /// Removes a user from group members
-        /// </summary>
-        [HttpDelete]
-        [Route("{groupId:guid}/member/{userId:guid}")]
-        [SwaggerResponse(StatusCodes.Status204NoContent, "User removed from members")]
-        [SwaggerResponse(StatusCodes.Status400BadRequest, "A business rule was violated", typeof(ProblemDetails))]
-        [SwaggerResponse(StatusCodes.Status500InternalServerError, "Something bad happened", typeof(ProblemDetails))]
-
-        [SwaggerResponseExample(StatusCodes.Status400BadRequest, typeof(BusinessRuleViolationResponseExample))]
-        [SwaggerResponseExample(StatusCodes.Status500InternalServerError, typeof(ApplicationErrorResponseExample))]
-        public async Task<ActionResult> RemoveMemberAsync([FromRoute] Guid groupId, [FromRoute] Guid userId)
-        {
-            var sub = User.Claims.FirstOrDefault(c => c.Type == "sub")?.Value;
-            var command = new RemoveFromGroup(sub, groupId, userId);
-            var result = await _mediator.Send(command);
-
-            return await _mapper.MapToActionResult(result);
-        }
-
-        /// <summary>
-        /// Removes current user from group members
-        /// </summary>
-        [HttpPut]
-        [Route("{groupId:guid}/member/leave")]
-        [SwaggerResponse(StatusCodes.Status204NoContent, "User removed from members")]
-        [SwaggerResponse(StatusCodes.Status400BadRequest, "A business rule was violated", typeof(ProblemDetails))]
-        [SwaggerResponse(StatusCodes.Status500InternalServerError, "Something bad happened", typeof(ProblemDetails))]
-
-        [SwaggerResponseExample(StatusCodes.Status400BadRequest, typeof(BusinessRuleViolationResponseExample))]
-        [SwaggerResponseExample(StatusCodes.Status500InternalServerError, typeof(ApplicationErrorResponseExample))]
-        public async Task<IActionResult> LeaveGroupAsync([FromRoute] Guid groupId)
-        {
-            var sub = User.Claims.FirstOrDefault(c => c.Type == "sub")?.Value;
-            var command = new LeaveGroup(sub, groupId);
-            var result = await _mediator.Send(command);
-
-            return await _mapper.MapToActionResult(result);
-        }
-
         /// <summary>
         /// Delete a group
         /// </summary>
@@ -196,93 +135,5 @@ public async Task<IActionResult> DeleteGroupAsync([FromRoute] Guid groupId)
 
             return await _mapper.MapToActionResult(result);
         }
-
-        /// <summary>
-        /// Gets group safe location
-        /// </summary>
-        /// <returns></returns>
-        [HttpGet("{groupId:guid}/safe-locations")]
-        [SwaggerResponse(StatusCodes.Status200OK, "Get safe locations of a group", typeof(IImmutableList<SafeLocationResponseModel>))]
-        [SwaggerResponse(StatusCodes.Status500InternalServerError, "Something bad happened", typeof(ProblemDetails))]
-
-        [SwaggerResponseExample(StatusCodes.Status200OK, typeof(GetGroupSafeLocationsResponseExample))]
-        [SwaggerResponseExample(StatusCodes.Status500InternalServerError, typeof(ApplicationErrorResponseExample))]
-        public async Task<ActionResult<IImmutableList<SafeLocationResponseModel>>> GetGroupSafeLocationsAsync([FromRoute] Guid groupId)
-        {
-            var sub = User.Claims.FirstOrDefault(c => c.Type == "sub")?.Value;
-            var query = new GetGroupSafeLocations(sub, groupId);
-            var result = await _mediator.Send(query);
-
-            return await _mapper.MapToActionResult(result);
-        }
-
-        /// <summary>
-        /// Adds a new group safe location
-        /// </summary>
-        /// <returns></returns>
-        [HttpPost]
-        [Route("{groupId:guid}/safe-location")]
-        [SwaggerResponse(StatusCodes.Status200OK, "New group safe location", typeof(SafeLocationModel))]
-        [SwaggerResponse(StatusCodes.Status400BadRequest, "A business rule was violated", typeof(ProblemDetails))]
-        [SwaggerResponse(StatusCodes.Status500InternalServerError, "Something bad happened", typeof(ProblemDetails))]
-
-        [SwaggerRequestExample(typeof(SafeLocationRequest), typeof(AddOrUpdateSafeLocationRequestExample))]
-        [SwaggerResponseExample(StatusCodes.Status200OK, typeof(AddOrUpdateSafeLocationResponseExample))]
-        [SwaggerResponseExample(StatusCodes.Status400BadRequest, typeof(BusinessRuleViolationResponseExample))]
-        [SwaggerResponseExample(StatusCodes.Status500InternalServerError, typeof(ApplicationErrorResponseExample))]
-        public async Task<ActionResult<SafeLocationResponseModel>> CreateNewSafeLocationAsync([FromRoute] Guid groupId, [FromBody] SafeLocationRequest safeLocation)
-        {
-            var sub = User.Claims.FirstOrDefault(c => c.Type == "sub")?.Value;
-            var query = new AddSafeLocation(sub, groupId, safeLocation);
-            var result = await _mediator.Send(query);
-
-            return await _mapper.MapToActionResult(result);
-        }
-
-        /// <summary>
-        /// Updates a group safe location
-        /// </summary>
-        /// <returns></returns>
-        [HttpPut]
-        [Route("safe-location/{locationId:guid}")]
-
-        [SwaggerResponse(StatusCodes.Status200OK, "Updated group safe location", typeof(SafeLocationResponseModel))]
-        [SwaggerResponse(StatusCodes.Status400BadRequest, "A business rule was violated", typeof(ProblemDetails))]
-        [SwaggerResponse(StatusCodes.Status500InternalServerError, "Something bad happened", typeof(ProblemDetails))]
-
-        [SwaggerRequestExample(typeof(SafeLocationRequest), typeof(AddOrUpdateSafeLocationRequestExample))]
-        [SwaggerResponseExample(StatusCodes.Status200OK, typeof(AddOrUpdateSafeLocationResponseExample))]
-        [SwaggerResponseExample(StatusCodes.Status400BadRequest, typeof(BusinessRuleViolationResponseExample))]
-        [SwaggerResponseExample(StatusCodes.Status500InternalServerError, typeof(ApplicationErrorResponseExample))]
-        public async Task<ActionResult<SafeLocationResponseModel>> UpdateSafeLocationAsync([FromRoute] Guid locationId, [FromBody] SafeLocationRequest safeLocation)
-        {
-            var sub = User.Claims.FirstOrDefault(c => c.Type == "sub")?.Value;
-            var query = new UpdateSafeLocation(sub, locationId, safeLocation);
-            var result = await _mediator.Send(query);
-
-            return await _mapper.MapToActionResult(result);
-        }
-
-        /// <summary>
-        /// Delete a group safe location
-        /// </summary>
-        /// <returns></returns>
-        [HttpDelete]
-        [Route("safe-location/{locationId:guid}")]
-
-        [SwaggerResponse(StatusCodes.Status204NoContent, "Group safe location was deleted")]
-        [SwaggerResponse(StatusCodes.Status400BadRequest, "A business rule was violated", typeof(ProblemDetails))]
-        [SwaggerResponse(StatusCodes.Status500InternalServerError, "Something bad happened", typeof(ProblemDetails))]
-
-        [SwaggerResponseExample(StatusCodes.Status400BadRequest, typeof(BusinessRuleViolationResponseExample))]
-        [SwaggerResponseExample(StatusCodes.Status500InternalServerError, typeof(ApplicationErrorResponseExample))]
-        public async Task<IActionResult> DeleteSafeLocationAsync([FromRoute] Guid locationId)
-        {
-            var sub = User.Claims.FirstOrDefault(c => c.Type == "sub")?.Value;
-            var command = new DeleteSafeLocation(sub, locationId);
-            var result = await _mediator.Send(command);
-
-            return await _mapper.MapToActionResult(result);
-        }
     }
 }