66 create contracts template

.github/workflows/publish.yml

@@ -10,7 +10,6 @@ jobs:
     with:
       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/Full/tests/UnitTests/stryker-config-domain.json"
@@ -31,12 +30,22 @@ jobs:
     secrets:
       sonar_token: ${{ secrets.SONAR_TOKEN }}
 
+  validate-contracts-template:
+    name: Validate Contracts Template
+    uses: gpreviatti/github-actions-templates/.github/workflows/dotnet-validate.yml@v1
+    with:
+      build_path: "./templates/Contracts"
+      dotnet_version: "${{ vars.PROJECT_DOTNET_VERSION }}"
+      unit_test_project_path: "./templates/Contracts/tests/UnitTests/"
+      default_stryker_config_path: "./templates/Contracts/tests/UnitTests/stryker-config.json"
+      sonar_validation: false
+
   pack-and-publish:
     name: Pack and Publish Template
-    needs: [validate-template-full, validate-template-bff]
+    needs: [validate-template-full, validate-template-bff, validate-contracts-template]
     uses: gpreviatti/github-actions-templates/.github/workflows/dotnet-pack.yml@v1
     with:
       dotnet_version: "${{ vars.PROJECT_DOTNET_VERSION }}"
-      package_version: "10.1.0"
+      package_version: "10.2.0"
     secrets:
       nuget_api_key: ${{ secrets.NUGET_API_KEY }}

.github/workflows/validate.yml

@@ -11,7 +11,6 @@ jobs:
     with:
       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/Full/tests/UnitTests/stryker-config-domain.json"
@@ -28,4 +27,14 @@ jobs:
       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"
+      docker_compose_file_path: "./templates/Bff/docker-compose.yml"
+
+  validate-contracts-template:
+    name: Validate Contracts Template
+    uses: gpreviatti/github-actions-templates/.github/workflows/dotnet-validate.yml@v1
+    with:
+      build_path: "./templates/Contracts"
+      dotnet_version: "${{ vars.PROJECT_DOTNET_VERSION }}"
+      unit_test_project_path: "./templates/Contracts/tests/UnitTests/"
+      default_stryker_config_path: "./templates/Contracts/tests/UnitTests/stryker-config.json"
+      sonar_validation: false

GPreviatti.Template.Hexagonal.Solution.csproj

@@ -18,14 +18,11 @@
     <RepositoryUrl>git://github.com/gpreviatti/hexagonal-solution-template</RepositoryUrl>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <PackageReleaseNotes>
-      - 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
+      - Add new Contracts-only template (`hexagonal-solution-contracts`) with shared request/response contracts, DTOs and gRPC protobuf definitions
+      - Add unit tests in the Contracts template to validate contract instantiation and default values
+      - Add dedicated Contracts template solution file and template-level README
+      - Update root README with usage/help commands and guidance for the new Contracts template
+      - Optimize Contracts template package management by removing unused package versions
     </PackageReleaseNotes>
   </PropertyGroup>
   <ItemGroup>

Readme.md

@@ -6,6 +6,12 @@
 
 This is a dotnet solution template from projects based on hexagonal architecture and best practices
 
+## Available templates
+
+- `hexagonal-solution-full`: Full hexagonal architecture template (Domain, Application, Infrastructure, WebApp, tests and load tests).
+- `hexagonal-solution-bff`: Backend-for-Frontend focused template with HTTP/gRPC integration patterns and integration/load tests.
+- `hexagonal-solution-contracts`: Contracts-only template for shared request/response models, DTOs, gRPC protobuf definitions and unit tests.
+
 ## Used Technologies
 
 - FluentValidation
@@ -15,6 +21,7 @@ This is a dotnet solution template from projects based on hexagonal architecture
 - Xunit
 - Moq
 - AutoFixture
+- gRPC / Protobuf
 - Docker and Docker Compose
 - K6
 - Stryker
@@ -46,6 +53,14 @@ To create only the BFF template you can use the following command
 dotnet new hexagonal-solution-bff -n HexagonalSolution
 ```
 
+To create only the Contracts template you can use the following command
+
+```bash
+dotnet new hexagonal-solution-contracts -n HexagonalSolution
+```
+
+The Contracts template is recommended when you want a lightweight shared library for API and messaging contracts that can be reused across services.
+
 If you had any doubts about the existing parameters you can also use -h to get more information
 
 ```bash
@@ -58,6 +73,12 @@ or
 dotnet new hexagonal-solution-bff -h
 ```
 
+or
+
+```bash
+dotnet new hexagonal-solution-contracts -h
+```
+
 If you want to update the template to the latest version just execute the following command
 
 ```bash

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

@@ -7,9 +7,11 @@
   "shortName": "hexagonal-solution-bff",
   "sourceName": "Hexagonal.Solution.Template.Bff",
   "classifications": [
-    "common",
-    "template",
-    "hexagonal-architecture"
+    "Common",
+    "Template",
+    "Hexagonal-Architecture",
+    "Backend-For-Frontend",
+    "BFF"
   ],
   "tags": {
     "language": "C#",

templates/Contracts/.editorconfig

@@ -0,0 +1,197 @@
+# editorconfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Default settings:
+# A newline ending every file
+# Use 4 spaces as indentation
+[*]
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+# Generated code
+[*{_AssemblyInfo.cs,.notsupported.cs,AsmOffsets.cs}]
+generated_code = true
+
+# C# files
+[*.cs]
+# New line preferences
+csharp_new_line_before_open_brace = all
+csharp_new_line_before_else = true
+csharp_new_line_before_catch = true
+csharp_new_line_before_finally = true
+csharp_new_line_before_members_in_object_initializers = true
+csharp_new_line_before_members_in_anonymous_types = true
+csharp_new_line_between_query_expression_clauses = true
+
+# Indentation preferences
+csharp_indent_block_contents = true
+csharp_indent_braces = false
+csharp_indent_case_contents = true
+csharp_indent_case_contents_when_block = true
+csharp_indent_switch_labels = true
+csharp_indent_labels = one_less_than_current
+
+# Modifier preferences
+csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
+
+# avoid this. unless absolutely necessary
+dotnet_style_qualification_for_field = false:suggestion
+dotnet_style_qualification_for_property = false:suggestion
+dotnet_style_qualification_for_method = false:suggestion
+dotnet_style_qualification_for_event = false:suggestion
+
+# Types: use keywords instead of BCL types, and permit var only when the type is clear
+csharp_style_var_for_built_in_types = false:suggestion
+csharp_style_var_when_type_is_apparent = false:none
+csharp_style_var_elsewhere = true:suggestion
+dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion
+dotnet_style_predefined_type_for_member_access = true:suggestion
+
+# name all constant fields using PascalCase
+dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols  = constant_fields
+dotnet_naming_rule.constant_fields_should_be_pascal_case.style    = pascal_case_style
+dotnet_naming_symbols.constant_fields.applicable_kinds   = field
+dotnet_naming_symbols.constant_fields.required_modifiers = const
+dotnet_naming_style.pascal_case_style.capitalization = pascal_case
+
+# static fields should have s_ prefix
+dotnet_naming_rule.static_fields_should_have_prefix.severity = suggestion
+dotnet_naming_rule.static_fields_should_have_prefix.symbols  = static_fields
+dotnet_naming_rule.static_fields_should_have_prefix.style    = static_prefix_style
+dotnet_naming_symbols.static_fields.applicable_kinds   = field
+dotnet_naming_symbols.static_fields.required_modifiers = static
+dotnet_naming_symbols.static_fields.applicable_accessibilities = private, internal, private_protected
+dotnet_naming_style.static_prefix_style.required_prefix = s_
+dotnet_naming_style.static_prefix_style.capitalization = camel_case
+
+# internal and private fields should be _camelCase
+dotnet_naming_rule.camel_case_for_private_internal_fields.severity = suggestion
+dotnet_naming_rule.camel_case_for_private_internal_fields.symbols  = private_internal_fields
+dotnet_naming_rule.camel_case_for_private_internal_fields.style    = camel_case_underscore_style
+dotnet_naming_symbols.private_internal_fields.applicable_kinds = field
+dotnet_naming_symbols.private_internal_fields.applicable_accessibilities = private, internal
+dotnet_naming_style.camel_case_underscore_style.required_prefix = _
+dotnet_naming_style.camel_case_underscore_style.capitalization = camel_case
+
+# Code style defaults
+csharp_using_directive_placement = outside_namespace:suggestion
+dotnet_sort_system_directives_first = true
+csharp_prefer_braces = true:silent
+csharp_preserve_single_line_blocks = true:none
+csharp_preserve_single_line_statements = false:none
+csharp_prefer_static_local_function = true:suggestion
+csharp_prefer_simple_using_statement = false:none
+csharp_style_prefer_switch_expression = true:suggestion
+csharp_style_namespace_declarations = file_scoped:warning
+dotnet_style_readonly_field = true:suggestion
+
+# Expression-level preferences
+dotnet_style_object_initializer = true:suggestion
+dotnet_style_collection_initializer = true:suggestion
+dotnet_style_explicit_tuple_names = true:suggestion
+dotnet_style_coalesce_expression = true:suggestion
+dotnet_style_null_propagation = true:suggestion
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion
+dotnet_style_prefer_inferred_tuple_names = true:suggestion
+dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
+dotnet_style_prefer_auto_properties = true:suggestion
+dotnet_style_prefer_conditional_expression_over_assignment = true:silent
+dotnet_style_prefer_conditional_expression_over_return = true:silent
+csharp_prefer_simple_default_expression = true:suggestion
+
+# Expression-bodied members
+csharp_style_expression_bodied_methods = true:suggestion
+csharp_style_expression_bodied_constructors = true:silent
+csharp_style_expression_bodied_operators = true:silent
+csharp_style_expression_bodied_properties = true:silent
+csharp_style_expression_bodied_indexers = true:silent
+csharp_style_expression_bodied_accessors = true:silent
+csharp_style_expression_bodied_lambdas = true:silent
+csharp_style_expression_bodied_local_functions = true:silent
+
+# Pattern matching
+csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
+csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
+csharp_style_inlined_variable_declaration = true:suggestion
+
+# Null checking preferences
+csharp_style_throw_expression = true:suggestion
+csharp_style_conditional_delegate_call = true:suggestion
+
+# Other features
+csharp_style_prefer_index_operator = false:none
+csharp_style_prefer_range_operator = false:none
+csharp_style_pattern_local_over_anonymous_function = false:none
+
+# Space preferences
+csharp_space_after_cast = true
+csharp_space_after_colon_in_inheritance_clause = true
+csharp_space_after_comma = true
+csharp_space_after_dot = false
+csharp_space_after_keywords_in_control_flow_statements = true
+csharp_space_after_semicolon_in_for_statement = true
+csharp_space_around_binary_operators = before_and_after
+csharp_space_around_declaration_statements = do_not_ignore
+csharp_space_before_colon_in_inheritance_clause = true
+csharp_space_before_comma = false
+csharp_space_before_dot = false
+csharp_space_before_open_square_brackets = false
+csharp_space_before_semicolon_in_for_statement = false
+csharp_space_between_empty_square_brackets = false
+csharp_space_between_method_call_empty_parameter_list_parentheses = false
+csharp_space_between_method_call_name_and_opening_parenthesis = false
+csharp_space_between_method_call_parameter_list_parentheses = false
+csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
+csharp_space_between_method_declaration_name_and_open_parenthesis = false
+csharp_space_between_method_declaration_parameter_list_parentheses = false
+csharp_space_between_parentheses = false
+csharp_space_between_square_brackets = false
+
+# S3216: "ConfigureAwait(false)" should be used
+dotnet_diagnostic.S3216.severity = none
+
+# S2360: Optional parameters should not be used
+dotnet_diagnostic.S2360.severity = none
+
+# CS8618: Non-nullable field must contain a non-null value when exiting constructor. Consider adding the 'required' modifier or declaring as nullable.
+dotnet_diagnostic.CS8618.severity = none
+
+# CA1873: Avoid potentially expensive logging
+dotnet_diagnostic.CA1873.severity = none
+
+# Xml project files
+[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,nativeproj,locproj}]
+indent_size = 2
+
+[*.{csproj,vbproj,proj,nativeproj,locproj}]
+charset = utf-8
+
+# Xml build files
+[*.builds]
+indent_size = 2
+
+# Xml files
+[*.{xml,stylecop,resx,ruleset}]
+indent_size = 2
+
+# Xml config files
+[*.{props,targets,config,nuspec}]
+indent_size = 2
+
+# YAML config files
+[*.{yml,yaml}]
+indent_size = 2
+
+# Shell scripts
+[*.sh]
+end_of_line = lf
+[*.{cmd,bat}]
+end_of_line = crlf
+
+[*.{sql,json}]
+insert_final_newline = false

templates/Contracts/.template.config/template.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "http://json.schemastore.org/template",
+  "author": "Giovanni Brunno Previatti",
+  "identity": "Hexagonal.Solution.Template.Contracts",
+  "name": "Hexagonal solution template Contracts",
+  "description": "Solution template focused on shared contracts for hexagonal architecture",
+  "shortName": "hexagonal-solution-contracts",
+  "sourceName": "Hexagonal.Solution.Template.Contracts",
+  "classifications": [
+    "Common",
+    "Template",
+    "Hexagonal-Architecture",
+    "Contracts"
+  ],
+  "tags": {
+    "language": "C#",
+    "type": "project"
+  },
+  "preferNameDirectory": true
+}

templates/Contracts/Directory.Build.props

@@ -0,0 +1,12 @@
+<Project>
+  <PropertyGroup>
+    <TargetFramework>net10.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <AnalysisLevel>latest</AnalysisLevel>
+    <AnalysisMode>Recommended</AnalysisMode>
+    <RestorePackagesWithLockFile>true</RestorePackagesWithLockFile>
+    <InvariantGlobalization>false</InvariantGlobalization>
+  </PropertyGroup>
+</Project>

templates/Contracts/Directory.Packages.props

@@ -0,0 +1,14 @@
+<Project>
+  <PropertyGroup>
+    <ManagePackageVersionsCentrally>true</ManagePackageVersionsCentrally>
+    <CentralPackageTransitivePinningEnabled>true</CentralPackageTransitivePinningEnabled>
+    <NoWarn>$(NoWarn);NU1507</NoWarn>
+  </PropertyGroup>
+  <ItemGroup>
+    <PackageVersion Include="coverlet.collector" Version="8.0.1" />
+    <PackageVersion Include="Grpc.AspNetCore" Version="2.76.0" />
+    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.3.0" />
+    <PackageVersion Include="xunit" Version="2.9.3" />
+    <PackageVersion Include="xunit.runner.visualstudio" Version="3.1.5" />
+  </ItemGroup>
+</Project>