release: v0.1.0

.github/release.yml

@@ -0,0 +1,14 @@
+changelog:
+  categories:
+    - title: Enhancements 🎉
+      labels:
+        - enhancement
+    - title: Bugs 🐛
+      labels:
+        - bug
+    - title: Docs 📖
+      labels:
+        - documentation
+    - title: Other Changes
+      labels:
+        - '*'

.github/workflows/branches.yml

@@ -20,16 +20,23 @@ jobs:
         run: |
           echo "Current base branch: $BASE_BRANCH"
           echo "Branch rule exception: Continuous Integration branches allowed to be merged into main"
+      - name: Branch is develop being merged to main for release
+        if: ${{ github.base_ref == 'main' && github.head_ref == 'develop' }}
+        env:
+          BASE_BRANCH: ${{ github.base_ref }}
+        run: |
+          echo "Current base branch: $BASE_BRANCH"
+          echo "Branch rule exception: Develop branch is being merged into main"
       - name: Branch is not based on develop
-        if: ${{ github.base_ref != 'develop' && !startsWith(github.head_ref, 'ci/') }}
+        if: ${{ github.base_ref != 'develop' && github.head_ref != 'develop' && !startsWith(github.head_ref, 'ci/') }}
         env:
           BASE_BRANCH: ${{ github.base_ref }}
         run: |
           echo "Current base branch: $BASE_BRANCH"
           echo "PRs should only ever be merged into develop"
           exit 1
       - name: Branch verified as based on develop branch
-        if: ${{ github.base_ref == 'develop' && !startsWith(github.head_ref, 'ci/') }}
+        if: ${{ github.base_ref == 'develop' && github.head_ref != 'develop' && !startsWith(github.head_ref, 'ci/') }}
         env:
           BASE_BRANCH: ${{ github.base_ref }}
         run: |

.run/WAW.API_ IIS Express.run.xml

@@ -0,0 +1,17 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="WAW.API: IIS Express" type="LaunchSettings" factoryName=".NET Launch Settings Profile">
+    <option name="LAUNCH_PROFILE_PROJECT_FILE_PATH" value="$PROJECT_DIR$/WAW.API/WAW.API.csproj" />
+    <option name="LAUNCH_PROFILE_TFM" value="net6.0" />
+    <option name="LAUNCH_PROFILE_NAME" value="IIS Express" />
+    <option name="USE_EXTERNAL_CONSOLE" value="0" />
+    <option name="USE_MONO" value="0" />
+    <option name="RUNTIME_ARGUMENTS" value="" />
+    <option name="GENERATE_APPLICATIONHOST_CONFIG" value="1" />
+    <option name="SHOW_IIS_EXPRESS_OUTPUT" value="0" />
+    <option name="SEND_DEBUG_REQUEST" value="1" />
+    <option name="ADDITIONAL_IIS_EXPRESS_ARGUMENTS" value="" />
+    <method v="2">
+      <option name="Build" />
+    </method>
+  </configuration>
+</component>

.run/WAW.API_ Standalone.run.xml

@@ -0,0 +1,17 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="WAW.API: Standalone" type="LaunchSettings" factoryName=".NET Launch Settings Profile">
+    <option name="LAUNCH_PROFILE_PROJECT_FILE_PATH" value="$PROJECT_DIR$/WAW.API/WAW.API.csproj" />
+    <option name="LAUNCH_PROFILE_TFM" value="net6.0" />
+    <option name="LAUNCH_PROFILE_NAME" value="Standalone" />
+    <option name="USE_EXTERNAL_CONSOLE" value="0" />
+    <option name="USE_MONO" value="0" />
+    <option name="RUNTIME_ARGUMENTS" value="" />
+    <option name="GENERATE_APPLICATIONHOST_CONFIG" value="1" />
+    <option name="SHOW_IIS_EXPRESS_OUTPUT" value="0" />
+    <option name="SEND_DEBUG_REQUEST" value="1" />
+    <option name="ADDITIONAL_IIS_EXPRESS_ARGUMENTS" value="" />
+    <method v="2">
+      <option name="Build" />
+    </method>
+  </configuration>
+</component>

.vscode/extensions.json

@@ -0,0 +1,5 @@
+{
+  "recommendations": [
+    "ms-dotnettools.csharp"
+  ]
+}

.vscode/launch.json

@@ -0,0 +1,35 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      // Use IntelliSense to find out which attributes exist for C# debugging
+      // Use hover for the description of the existing attributes
+      // For further information visit https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md
+      "name": ".NET Core Launch (web)",
+      "type": "coreclr",
+      "request": "launch",
+      "preLaunchTask": "build",
+      // If you have changed target frameworks, make sure to update the program path.
+      "program": "${workspaceFolder}/WAW.API/bin/Debug/net6.0/WAW.API.dll",
+      "args": [],
+      "cwd": "${workspaceFolder}/WAW.API",
+      "stopAtEntry": false,
+      // Enable launching a web browser when ASP.NET Core starts. For more information: https://aka.ms/VSCode-CS-LaunchJson-WebBrowser
+      "serverReadyAction": {
+        "action": "openExternally",
+        "pattern": "\\bNow listening on:\\s+(https?://\\S+)"
+      },
+      "env": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      },
+      "sourceFileMap": {
+        "/Views": "${workspaceFolder}/Views"
+      }
+    },
+    {
+      "name": ".NET Core Attach",
+      "type": "coreclr",
+      "request": "attach"
+    }
+  ]
+}

.vscode/tasks.json

@@ -0,0 +1,41 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "build",
+      "command": "dotnet",
+      "type": "process",
+      "args": [
+        "build",
+        "${workspaceFolder}/WAW.API/WAW.API.csproj",
+        "/property:GenerateFullPaths=true",
+        "/consoleloggerparameters:NoSummary"
+      ],
+      "problemMatcher": "$msCompile"
+    },
+    {
+      "label": "publish",
+      "command": "dotnet",
+      "type": "process",
+      "args": [
+        "publish",
+        "${workspaceFolder}/WAW.API/WAW.API.csproj",
+        "/property:GenerateFullPaths=true",
+        "/consoleloggerparameters:NoSummary"
+      ],
+      "problemMatcher": "$msCompile"
+    },
+    {
+      "label": "watch",
+      "command": "dotnet",
+      "type": "process",
+      "args": [
+        "watch",
+        "run",
+        "--project",
+        "${workspaceFolder}/WAW.API/WAW.API.csproj"
+      ],
+      "problemMatcher": "$msCompile"
+    }
+  ]
+}

WAW.API.Tests/Drivers/Driver.cs

@@ -1,5 +1,3 @@
-using System;
+namespace WAW.API.Tests.Drivers;
 
-namespace WAW.API.Tests.Drivers {
-  public class Driver {}
-}
+public class Driver {}

WAW.API.Tests/Features/Company.feature

@@ -0,0 +1,62 @@
+Feature: Companies API
+As a developer
+I want to manage Companies through an API
+In order to make it available for client applications.
+
+  Scenario: Get all Companies
+    Given I am a Companies client
+    And the Companies repository has data
+      | Id | Name        | Address      | Email           |
+      | 1  | Google Inc. | Lima, PE     | google@fake.com |
+      | 2  | Meta Inc.   | Santiago, CH | meta@fake.com   |
+    When a GET request is sent to Companies
+    Then a CompanyResource response with status 200 is received
+    And a list of CompanyResources is included in the body
+      | Id | Name        | Address      | Email           |
+      | 1  | Google Inc. | Lima, PE     | google@fake.com |
+      | 2  | Meta Inc.   | Santiago, CH | meta@fake.com   |
+
+  Scenario: Add Company with data
+    Given I am a Companies client
+    And the Companies repository has data
+      | Id | Name        | Address      | Email           |
+      | 1  | Google Inc. | Lima, PE     | google@fake.com |
+      | 2  | Meta Inc.   | Santiago, CH | meta@fake.com   |
+    When a POST request is sent to Companies
+      | Name   | Address          | Email           |
+      | Oracle | Buenos Aires, AR | oracle@fake.com |
+    Then a CompanyResource response with status 200 is received
+    And a CompanyResource is included in the body
+      | Id | Name   | Address          | Email           |
+      | 3  | Oracle | Buenos Aires, AR | oracle@fake.com |
+
+  Scenario: Add invalid Company
+    Given I am a Companies client
+    When a POST request is sent to Companies
+      | Name | Address   | Email            |
+      |      | Quito, EC | company@fake.com |
+    Then a CompanyResource response with status 400 is received
+    And a CompanyResource Error Message is included in the body
+      | Message                     |
+      | The Name field is required. |
+
+  Scenario: Update existing Company
+    Given I am a Companies client
+    And the Companies repository has data
+      | Id | Name        | Address  | Email           |
+      | 1  | Google Inc. | Lima, PE | google@fake.com |
+    When a PUT request is sent to Companies with Id 1
+      | Name        | Address    | Email              |
+      | Google Inc. | Huacho, PE | newgoogle@fake.com |
+    Then a CompanyResource response with status 200 is received
+    And a CompanyResource is included in the body
+      | Id | Name        | Address    | Email              |
+      | 1  | Google Inc. | Huacho, PE | newgoogle@fake.com |
+
+  Scenario: Delete existing Company
+    Given I am a Companies client
+    And the Companies repository has data
+      | Id | Name        | Address  | Email           |
+      | 1  | Google Inc. | Lima, PE | google@fake.com |
+    When a DELETE request is sent to Companies with Id 1
+    Then a CompanyResource response with status 200 is received

WAW.API.Tests/Helpers/AppFactory.cs

@@ -0,0 +1,43 @@
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.Mvc.Testing;
+using Microsoft.AspNetCore.TestHost;
+using Microsoft.EntityFrameworkCore;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+using WAW.API.Shared.Persistence.Contexts;
+
+namespace WAW.API.Tests.Helpers;
+
+public static class AppFactory {
+  public static WebApplicationFactory<Program> GetWebApplicationFactory() {
+    return new WebApplicationFactory<Program>().WithWebHostBuilder(
+      builder => {
+        builder.ConfigureTestServices(
+          services => {
+            var descriptor = services.SingleOrDefault(d => d.ServiceType == typeof(DbContextOptions<AppDbContext>));
+            if (descriptor is not null) {
+              services.Remove(descriptor);
+            }
+
+            services.AddDbContext<AppDbContext>(
+              options => options.UseInMemoryDatabase("InMemoryTestDatabase")
+                .LogTo(Console.WriteLine, LogLevel.Information)
+                .EnableSensitiveDataLogging()
+                .EnableDetailedErrors()
+            );
+
+            var provider = services.BuildServiceProvider();
+            var scope = provider.CreateScope();
+            var scopedServices = scope.ServiceProvider;
+            var ctx = scopedServices.GetRequiredService<AppDbContext>();
+
+            ctx.Database.EnsureDeleted();
+            ctx.Database.EnsureCreated();
+          }
+        );
+
+        builder.UseEnvironment("Testing");
+      }
+    );
+  }
+}

WAW.API.Tests/Helpers/TextError.cs

@@ -0,0 +1,5 @@
+namespace WAW.API.Tests.Helpers;
+
+public class TextError {
+  public string Message { get; set; } = string.Empty;
+}

WAW.API.Tests/Hooks/CompanyHooks.cs

@@ -0,0 +1,38 @@
+using BoDi;
+using Microsoft.AspNetCore.Mvc.Testing;
+using WAW.API.Employers.Domain.Repositories;
+using WAW.API.Shared.Domain.Repositories;
+using WAW.API.Tests.Helpers;
+
+namespace WAW.API.Tests.Hooks;
+
+[Binding]
+public class CompanyHooks {
+  private readonly IObjectContainer objectContainer;
+
+  public CompanyHooks(IObjectContainer objectContainer) {
+    this.objectContainer = objectContainer;
+  }
+
+  [BeforeScenario]
+  public async Task RegisterServices() {
+    var factory = AppFactory.GetWebApplicationFactory();
+    await ClearData(factory);
+    objectContainer.RegisterInstanceAs(factory);
+    var companiesRepository = factory.Services.GetService(typeof(ICompanyRepository)) as ICompanyRepository;
+    objectContainer.RegisterInstanceAs(companiesRepository);
+    var unitOfWork = factory.Services.GetService(typeof(IUnitOfWork)) as IUnitOfWork;
+    objectContainer.RegisterInstanceAs(unitOfWork);
+  }
+
+  private static async Task ClearData(WebApplicationFactory<Program> factory) {
+    if (factory.Services.GetService(typeof(ICompanyRepository)) is not ICompanyRepository companyRepository) {
+      return;
+    }
+
+    var entities = await companyRepository.ListAll();
+    foreach (var entity in entities) {
+      companyRepository.Remove(entity);
+    }
+  }
+}