Feature/53

.github/pull_request_template.md

@@ -0,0 +1,43 @@
+# Pull Request
+
+## 📌 Summary
+
+<!-- What does this PR change and why? Keep it short and objective. -->
+
+## 🎯 Type of change
+
+- [ ] Feature
+- [ ] Bug fix
+- [ ] Refactor
+- [ ] Performance
+- [ ] Documentation
+- [ ] Chore / Build / CI
+
+## 🔗 Related work
+
+<!-- Link issue, task, or ticket (e.g. Closes #123) -->
+
+## 🧪 How was this tested?
+
+<!-- Describe tests you ran and important validation details. -->
+
+- [ ] Unit tests
+- [ ] Integration tests
+- [ ] Manual tests
+- [ ] Not applicable
+
+## ✅ Checklist
+
+- [ ] I have reviewed my own changes
+- [ ] I have updated documentation/comments when needed
+- [ ] I have added or updated tests when needed
+- [ ] I have verified no sensitive data/secrets were introduced
+- [ ] This PR is ready for review
+
+## 📝 Additional notes (optional)
+
+<!-- Anything reviewers should pay special attention to? -->
+
+## 🧾 Release notes (optional)
+
+<!-- User-facing impact, migration steps, or rollout notes. -->

.github/workflows/publish.yml

@@ -4,25 +4,38 @@ on:
   workflow_dispatch:
 
 jobs:
-  validate:
+  validate-template-full:
+    name: Validate Full Template
     uses: gpreviatti/github-actions-templates/.github/workflows/dotnet-validate.yml@v1
     with:
-      project: "hexagonal-solution-template"
-      organization: "gpreviatti"
-      unit_test_project_path: "./templates/tests/UnitTests/"
-      unit_test_verbosity: 'd'
+      build_path: "./templates/Full"
+      project: "hexagonal-solution-template-full"
+      unit_test_project_path: "./templates/Full/tests/UnitTests/"
       dotnet_version: "${{ vars.PROJECT_DOTNET_VERSION }}"
-      domain_stryker_config_path: "./templates/tests/UnitTests/stryker-config-domain.json"
-      application_stryker_config_path: "./templates/tests/UnitTests/stryker-config-application.json"
-      integration_test_project_path: "./templates/tests/IntegrationTests"
-      docker_compose_file_path: "./templates/docker-compose.yml"
+      domain_stryker_config_path: "./templates/Full/tests/UnitTests/stryker-config-domain.json"
+      application_stryker_config_path: "./templates/Full/tests/UnitTests/stryker-config-application.json"
+      integration_test_project_path: "./templates/Full/tests/IntegrationTests"
+      docker_compose_file_path: "./templates/Full/docker-compose.yml"
     secrets:
       sonar_token: ${{ secrets.SONAR_TOKEN }}
+
+  validate-template-bff:
+    name: Validate BFF Template
+    uses: gpreviatti/github-actions-templates/.github/workflows/dotnet-validate.yml@v1
+    with:
+      build_path: "./templates/Bff"
+      dotnet_version: "${{ vars.PROJECT_DOTNET_VERSION }}"
+      integration_test_project_path: "./templates/Bff/tests/IntegrationTests"
+      docker_compose_file_path: "./templates/Bff/docker-compose.yml"
+    secrets:
+      sonar_token: ${{ secrets.SONAR_TOKEN }}
+
   pack-and-publish:
-    needs: validate
+    name: Pack and Publish Template
+    needs: [validate-template-full, validate-template-bff]
     uses: gpreviatti/github-actions-templates/.github/workflows/dotnet-pack.yml@v1
     with:
       dotnet_version: "${{ vars.PROJECT_DOTNET_VERSION }}"
-      package_version: "10.0.3"
+      package_version: "10.1.0"
     secrets:
       nuget_api_key: ${{ secrets.NUGET_API_KEY }}

.github/workflows/validate.yml

@@ -5,18 +5,27 @@ on:
   workflow_dispatch:
 
 jobs:
-  validate:
+  validate-template-full:
+    name: Validate Full Template
     uses: gpreviatti/github-actions-templates/.github/workflows/dotnet-validate.yml@v1
     with:
-      project: "hexagonal-solution-template"
-      organization: "gpreviatti"
-      unit_test_project_path: "./templates/tests/UnitTests/"
-      unit_test_verbosity: 'd'
+      build_path: "./templates/Full"
+      sonar_project: "hexagonal-solution-template-full"
+      test_no_build: false
+      unit_test_project_path: "./templates/Full/tests/UnitTests/"
       dotnet_version: "${{ vars.PROJECT_DOTNET_VERSION }}"
-      domain_stryker_config_path: "./templates/tests/UnitTests/stryker-config-domain.json"
-      application_stryker_config_path: "./templates/tests/UnitTests/stryker-config-application.json"
-      integration_test_project_path: "./templates/tests/IntegrationTests"
-      docker_compose_file_path: "./templates/docker-compose.yml"
+      domain_stryker_config_path: "./templates/Full/tests/UnitTests/stryker-config-domain.json"
+      application_stryker_config_path: "./templates/Full/tests/UnitTests/stryker-config-application.json"
+      integration_test_project_path: "./templates/Full/tests/IntegrationTests"
+      docker_compose_file_path: "./templates/Full/docker-compose.yml"
     secrets:
       sonar_token: ${{ secrets.SONAR_TOKEN }}
-
+
+  validate-template-bff:
+    name: Validate BFF Template
+    uses: gpreviatti/github-actions-templates/.github/workflows/dotnet-validate.yml@v1
+    with:
+      build_path: "./templates/Bff"
+      dotnet_version: "${{ vars.PROJECT_DOTNET_VERSION }}"
+      integration_test_project_path: "./templates/Bff/tests/IntegrationTests"
+      docker_compose_file_path: "./templates/Bff/docker-compose.yml"

.vscode/launch.json

@@ -0,0 +1,47 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Full [Development]",
+            "type": "coreclr",
+            "request": "launch",
+            "preLaunchTask": "build",
+            // If you have changed target frameworks, make sure to update the program path.
+            "program": "${workspaceFolder}/templates/Full/src/WebApp/bin/Debug/net10.0/WebApp.dll",
+            "args": [],
+            "cwd": "${workspaceFolder}/templates/Full/src/WebApp",
+            "stopAtEntry": false,
+            "serverReadyAction": {
+                "action": "openExternally",
+                "pattern": "\\bNow listening on:\\s+(https?://\\S+)"
+            },
+            "env": {
+                "ASPNETCORE_ENVIRONMENT": "Development"
+            },
+            "sourceFileMap": {
+                "/Views": "${workspaceFolder}/Views"
+            }
+        },
+        {
+            "name": "Bff [Development]",
+            "type": "coreclr",
+            "request": "launch",
+            "preLaunchTask": "build",
+            // If you have changed target frameworks, make sure to update the program path.
+            "program": "${workspaceFolder}/templates/Bff/src/WebApp/bin/Debug/net10.0/WebApp.dll",
+            "args": [],
+            "cwd": "${workspaceFolder}/templates/Bff/src/WebApp",
+            "stopAtEntry": false,
+            "serverReadyAction": {
+                "action": "openExternally",
+                "pattern": "\\bNow listening on:\\s+(https?://\\S+)"
+            },
+            "env": {
+                "ASPNETCORE_ENVIRONMENT": "Development"
+            },
+            "sourceFileMap": {
+                "/Views": "${workspaceFolder}/Views"
+            }
+        },
+    ]
+}

.vscode/tasks.json

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

GPreviatti.Template.Hexagonal.Solution.csproj

@@ -4,7 +4,7 @@
     <PackageId>GPreviatti.Template.Hexagonal.Solution</PackageId>
     <Title>Hexagonal architecture solution template</Title>
     <Authors>Giovanni Brunno Previatti</Authors>
-    <Description>Solution following Hexagonal architecture and best praticies.</Description>
+    <Description>Solution following Hexagonal architecture and best practices.</Description>
     <PackageTags>template;hexagonal-architecture;clean-architecture;ddd;net8</PackageTags>
     <TargetFramework>net10.0</TargetFramework>
     <IncludeContentInPack>true</IncludeContentInPack>
@@ -18,10 +18,14 @@
     <RepositoryUrl>git://github.com/gpreviatti/hexagonal-solution-template</RepositoryUrl>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <PackageReleaseNotes>
-      - Add docker support
-      - Add docker-compose file for load tests
-      - Add automatic assembly mapping for entities
-      - Simplify load tests methods definitions
+      - Add new new template with BFF architecture
+      - Remove Repository pattern since it's not needed with modern EF Core and adds unnecessary complexity
+      - Update dependencies to latest versions
+      - Update GitHub Actions workflows to test and analyze both templates
+      - Improve OpenTelemetry configuration and add more metrics and traces
+      - Remove Aspire Dashboard
+      - Add Grafana, Prometheus, Tempo and Loki configuration with Docker Compose for easier local development and testing of observability features
+      - Change DB to PostgreSQL since it's more widely used in production than SQL Server and works better with Docker
     </PackageReleaseNotes>
   </PropertyGroup>
   <ItemGroup>

templates/Bff/.template.config/template.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json.schemastore.org/template",
+  "author": "Giovanni Brunno Previatti",
+  "identity": "Hexagonal.Solution.Template.Bff",
+  "name": "Hexagonal solution template Bff",
+  "description": "Solution template following hexagonal architecture structure best practices for backend for frontend (BFF) applications",
+  "shortName": "bff",
+  "sourceName": "Hexagonal.Solution.Template.Bff",
+  "classifications": [
+    "common",
+    "template",
+    "hexagonal-architecture"
+  ],
+  "tags": {
+    "language": "C#",
+    "type": "project"
+  },
+  "preferNameDirectory": true
+}

templates/Directory.Build.props → templates/Bff/Directory.Build.props

@@ -4,8 +4,9 @@
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <AnalysisLevel>latest</AnalysisLevel>
+    <AnalysisMode>Recommended</AnalysisMode>
+    <RestorePackagesWithLockFile>true</RestorePackagesWithLockFile>
+    <InvariantGlobalization>false</InvariantGlobalization>
   </PropertyGroup>
-  <ItemGroup>
-    <PackageVersion Include="SonarAnalyzer.CSharp" Version="[9.0.0,)" />
-  </ItemGroup>
 </Project>

templates/Bff/Directory.Packages.props

@@ -0,0 +1,46 @@
+<Project>
+  <PropertyGroup>
+    <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
+    <CentralPackageTransitivePinningEnabled>true</CentralPackageTransitivePinningEnabled>
+    <NoWarn>$(NoWarn);NU1507</NoWarn>
+  </PropertyGroup>
+  <ItemGroup>
+    <PackageVersion Include="SonarAnalyzer.CSharp" Version="10.18.0.131500" />
+    <PackageVersion Include="AspNetCore.HealthChecks.Redis" Version="9.0.0" />
+    <PackageVersion Include="AspNetCore.HealthChecks.UI.Client" Version="9.0.0" />
+    <PackageVersion Include="AspNetCore.HealthChecks.Uris" Version="9.0.0" />
+    <PackageVersion Include="AutoFixture" Version="4.18.1" />
+    <PackageVersion Include="coverlet.collector" Version="8.0.1" />
+    <PackageVersion Include="FluentValidation" Version="12.1.1" />
+    <PackageVersion Include="FluentValidation.DependencyInjectionExtensions" Version="12.1.1" />
+    <PackageVersion Include="Grpc.AspNetCore" Version="2.76.0" />
+    <PackageVersion Include="Microsoft.AspNetCore.Mvc.Testing" Version="10.0.5" />
+    <PackageVersion Include="Microsoft.AspNetCore.OpenApi" Version="10.0.5" />
+    <PackageVersion Include="Microsoft.AspNetCore.TestHost" Version="10.0.5" />
+    <PackageVersion Include="Microsoft.Extensions.Caching.Hybrid" Version="10.4.0" />
+    <PackageVersion Include="Microsoft.Extensions.Caching.StackExchangeRedis" Version="10.0.5" />
+    <PackageVersion Include="Microsoft.Extensions.DependencyInjection" Version="10.0.5" />
+    <PackageVersion Include="Microsoft.Extensions.Http.Polly" Version="10.0.5" />
+    <PackageVersion Include="Microsoft.Extensions.Logging" Version="10.0.5" />
+    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.3.0" />
+    <PackageVersion Include="Moq" Version="4.20.72" />
+    <PackageVersion Include="NetArchTest.Rules" Version="1.3.2" />
+    <PackageVersion Include="Newtonsoft.Json" Version="13.0.4" />
+    <PackageVersion Include="OpenTelemetry.Extensions" Version="1.14.0-beta.1" />
+    <PackageVersion Include="OpenTelemetry.Exporter.Console" Version="1.15.0" />
+    <PackageVersion Include="OpenTelemetry.Extensions.Hosting" Version="1.15.0" />
+    <PackageVersion Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.15.0" />
+    <PackageVersion Include="OpenTelemetry.Instrumentation.AspNetCore" Version="1.15.1" />
+    <PackageVersion Include="OpenTelemetry.Instrumentation.Http" Version="1.15.0" />
+    <PackageVersion Include="OpenTelemetry.Instrumentation.Process" Version="1.15.0-beta.1" />
+    <PackageVersion Include="OpenTelemetry.Instrumentation.Runtime" Version="1.15.0" />
+    <PackageVersion Include="OpenTelemetry.Instrumentation.GrpcNetClient" Version="1.15.0-beta.1" />
+    <PackageVersion Include="OpenTelemetry.Instrumentation.StackExchangeRedis" Version="1.15.0-beta.1" />
+    <PackageVersion Include="Scalar.AspNetCore" Version="2.13.11" />
+    <PackageVersion Include="System.Net.Http" Version="4.3.4" />
+    <PackageVersion Include="System.Text.RegularExpressions" Version="4.3.1" />
+    <PackageVersion Include="xunit" Version="2.9.3" />
+    <PackageVersion Include="xunit.extensibility.core" Version="2.9.3" />
+    <PackageVersion Include="xunit.runner.visualstudio" Version="3.1.5" />
+  </ItemGroup>
+</Project>

templates/Bff/Dockerfile

@@ -0,0 +1,19 @@
+FROM mcr.microsoft.com/dotnet/sdk:10.0 AS build-env
+WORKDIR /app
+
+COPY . .
+
+WORKDIR /app/src/WebApp
+RUN dotnet restore \
+    && dotnet publish -c Release -o /app/out
+
+FROM mcr.microsoft.com/dotnet/aspnet:10.0
+WORKDIR /app
+COPY --from=build-env /app/out .
+
+RUN apt-get update \
+    && apt-get install -y curl
+
+EXPOSE 5011
+
+ENTRYPOINT ["dotnet", "WebApp.dll", "--urls", "http://+:5011"]

templates/Bff/Dockerfile.MockApi

@@ -0,0 +1,19 @@
+FROM mcr.microsoft.com/dotnet/sdk:10.0 AS build-env
+WORKDIR /app
+
+COPY . .
+
+WORKDIR /app/src/MockApi
+RUN dotnet restore \
+    && dotnet publish -c Release -o /app/out
+
+FROM mcr.microsoft.com/dotnet/aspnet:10.0
+WORKDIR /app
+COPY --from=build-env /app/out .
+
+RUN apt-get update \
+    && apt-get install -y curl
+
+EXPOSE 5012
+
+ENTRYPOINT ["dotnet", "MockApi.dll", "--urls", "http://+:5012"]