Merge pull request #18 from kapozade/feature/#11

Feature/#11

Author: kapozade

README.md

@@ -48,11 +48,13 @@ public async Task<IActionResult> GetAsync([FromRoute] long id,
 
 * You can enable open telemetry (Check [Template Options](https://github.com/kapozade/dotnet-api-template#template-options)). 
 
+* You can define database option by selecting one of the choice. (Check [Template Options](https://github.com/kapozade/dotnet-api-template#template-options)). Current options are PostgreSQL and MySQL. Default value is MySQL.
+
 ## Requirements
 The basic template depends on below resources.
 
 * .NET7
-* MySQL
+* MySQL or PostgreSQL (depending on your choice)
 * Redis
 
 If you would like to add outbox pattern functionality, you are required to have 
@@ -74,7 +76,7 @@ Run
 
 ```bash
 ## dotnet new supremeapi [options] [template options]
-dotnet new supremeapi -n "MyService" -eop -eot -erl
+dotnet new supremeapi -n "MyService" -eop -eot -erl -db mysql
 ```
 
 ## Template Options
@@ -85,6 +87,7 @@ dotnet new supremeapi -n "MyService" -eop -eot -erl
 | -eop, --enable-outbox-pattern | Enables outbox pattern by using [CAP](https://cap.dotnetcore.xyz/) |
 | -eot, --enable-open-telemetry | Adds open telemetry configuration with Jaeger support |
 | -erl, --enable-rate-limiting | Adds basic rate limiting action filters that uses Redis behind |
+| -db, --database | The target database. mysql and postgres are supported. Default value is mysql |
 
 ## Contributors
 
@@ -95,8 +98,9 @@ dotnet new supremeapi -n "MyService" -eop -eot -erl
 * Ardalis.Specification
 * EasyCaching
 * FluentValidation
-* DotNetCore.CAP
+* DotNetCore.CAP with RabbitMQ and MySQL or PostgreSQL (depending on your choice)
 * MediatR
+* Npgsql.EntityFrameworkCore.PostgreSQL
 * OpenTelemetry
 * Pomelo.EntityFrameworkCore
 * Scrutor

SupremeDotnetApiTemplate.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <PackageType>Template</PackageType>
-    <PackageVersion>1.2.0-rc.2</PackageVersion>
+    <PackageVersion>1.2.0</PackageVersion>
     <PackageId>Supreme.Dotnet.Api.Template</PackageId>
     <Title>Supreme API Template</Title>
     <Authors>Onur Kapçık</Authors>

templates/api/.template.config/dotnetcli.host.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json.schemastore.org/dotnetcli.host",
+  "symbolInfo":
+  {
+    "database": {
+      "longName": "database",
+      "shortName": "db"
+    },
+    "enable-outbox-pattern": {
+      "longName": "enable-outbox-pattern",
+      "shortName": "eop"
+    },
+    "enable-open-telemetry": {
+      "longName": "enable-open-telemetry",
+      "shortName": "eot"
+    },
+    "enable-rate-limiting": {
+      "longName": "enable-rate-limiting",
+      "shortName": "erl"
+    }
+  }
+}

templates/api/.template.config/template.json

@@ -22,6 +22,16 @@
             "defaultValue": "net7.0",
             "replaces": "{TargetFramework}"
         },
+        "database": {
+          "type": "parameter",
+          "description": "The target database",
+          "datatype": "choice",
+          "choices": [
+            {"choice": "mysql", "displayName": "mysql"},
+            {"choice": "postgres", "displayName": "postgres"}
+          ],
+          "defaultValue": "mysql"
+        },
         "enable-outbox-pattern":{
             "type": "parameter",
             "description": "Enables outbox pattern with CAP.",

templates/api/Directory.Build.targets

@@ -17,7 +17,6 @@
     <PackageReference Update="Microsoft.Extensions.Diagnostics.HealthChecks" Version="7.0.8" />
     <PackageReference Update="Microsoft.AspNetCore.Mvc.NewtonsoftJson" Version="7.0.5"/>
     <PackageReference Update="Microsoft.CodeAnalysis.CSharp.CodeStyle" Version="4.5.0" />
-    <PackageReference Update="Pomelo.EntityFrameworkCore.MySql" Version="7.0.0" />
     <PackageReference Update="Swashbuckle.AspNetCore" Version="6.5.0" />
     <PackageReference Update="Scrutor" Version="4.2.2"/>
     <PackageReference Update="Serilog" Version="2.12.0" />
@@ -29,16 +28,28 @@
     <PackageReference Update="Moq" Version="4.18.4" />
     <PackageReference Update="xunit" Version="2.4.2" />
     <PackageReference Update="xunit.runner.visualstudio" Version="2.4.5" />
+  </ItemGroup>
 
+  <ItemGroup Condition="'$(database)' == 'mysql'">
+    <PackageReference Update="Pomelo.EntityFrameworkCore.MySql" Version="7.0.0" />
+  </ItemGroup>
+  <ItemGroup Condition="'$(database)' == 'postgres'">
+    <PackageReference Update="Npgsql.EntityFrameworkCore.PostgreSQL" Version="7.0.4" />
   </ItemGroup>
 
   <ItemGroup Condition="$(enable-outbox-pattern)">
     <PackageReference Update="DotNetCore.CAP" Version="7.1.2" />
     <PackageReference Update="DotNetCore.CAP.RabbitMQ" Version="7.1.2" />
-    <PackageReference Update="DotNetCore.CAP.MySql" Version="7.1.2" />
     <PackageReference Update="DotNetCore.CAP.Dashboard" Version="7.1.2" />
   </ItemGroup>
 
+  <ItemGroup Condition="'$(database)' == 'mysql' And $(enable-outbox-pattern)">
+    <PackageReference Update="DotNetCore.CAP.MySql" Version="7.1.2" />
+  </ItemGroup>
+  <ItemGroup Condition="'$(database)' == 'postgres' And $(enable-outbox-pattern)">
+    <PackageReference Update="DotNetCore.CAP.PostgreSql" Version="7.1.2" />
+  </ItemGroup>
+
   <ItemGroup Condition="$(enable-open-telemetry)">
     <PackageReference Update="OpenTelemetry" Version="1.4.0" />
     <PackageReference Update="OpenTelemetry.Api" Version="1.4.0" />
@@ -50,7 +61,6 @@
     <PackageReference Update="OpenTelemetry.Instrumentation.Http" Version="1.0.0-rc9.14" />
     <PackageReference Update="OpenTelemetry.Instrumentation.SqlClient" Version="1.0.0-rc9.14" />
   </ItemGroup>
-
   <ItemGroup Condition="$(enable-rate-limiting)">
     <PackageReference Update="StackExchange.Redis" Version="2.6.111" />
   </ItemGroup>

templates/api/README.md

@@ -4,7 +4,7 @@
 
 * <b>.NET7</b>
 * <b>Redis</b>
-* <b>MySQL</b>
+* <b>MySQL or Postgres</b> (depending on your choice)
 * <b>Docker</b>
 
 ## How-to
@@ -27,7 +27,7 @@ Executing migrations and db update requires a working database. You can create a
 <br/>
 
 ```bash
-docker compose up -d mysql
+docker compose up -d database
 ````
 
 <i>Note: Before running below commands, be aware that those commands require `dotnet-ef` that should have already been installed globally. <br/>
@@ -70,7 +70,7 @@ Before running the app, make sure that all dependencies are up & running.
 ```bash
 docker compose up -d rabbitmq # If you didn't enable outbox pattern, you can skip this command.
 docker compose up -d jaeger # If you didn't enable open telemetry, you can skip this command.
-docker compose up -d mysql # Skip this if you already run this for Step #2.
+docker compose up -d database # Skip this if you already run this for Step #2.
 docker compose up -d redis
 docker compose up -d app
 ```

templates/api/container/Dockerfile.app

@@ -29,7 +29,7 @@ RUN apt-get update && \
     rm -rf /var/lib/apt/lists/*
 
 ENV ASPNETCORE_ENVIRONMENT=staging
-ENV DB_SERVER=mysql
+ENV DB_SERVER=database
 ENV DB_NAME=Supreme
 ENV DB_USER=sqlsa
 ENV DB_PASSWORD=SuperPass1

templates/api/docker-compose.yml

@@ -8,15 +8,16 @@ services:
       - "5000:5000"
     depends_on:
       - redis
-      - mysql
+      - database
 //#if (enable-outbox-pattern)
       - rabbitmq
 //#endif
 //#if (enable-open-telemetry)
       - jaeger
 //#endif
 
-  mysql:
+  database:
+//#if (database == "mysql")
     image: mysql:8.0
     container_name: mysql
     command: mysqld --default-authentication-plugin=mysql_native_password --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
@@ -27,6 +28,17 @@ services:
       - MYSQL_USER=sqlsa
       - MYSQL_PASSWORD=SuperPass1
       - MYSQL_DATABASE=Supreme
+//#endif
+//#if (database == "postgres")
+    image: postgres:latest
+    container_name: postgres
+    environment:
+      - POSTGRES_USER=sqlsa
+      - POSTGRES_PASSWORD=SuperPass1
+      - POSTGRES_DB=Supreme
+    ports:
+      - "5432:5432"
+//#endif
 
   redis:
     image: redis

templates/api/src/Supreme.Api/appsettings.json

@@ -1,6 +1,11 @@
 {
   "ConnectionStrings": {
+//#if (database == "mysql")
     "DatabaseConnection": "Server=localhost;database=Supreme;uid=root;pwd=root;Convert Zero Datetime=True;Connection Timeout=15;"
+//#endif
+//#if (database == "postgres")
+    "DatabaseConnection": "User ID=sqlsa;Password=SuperPass1;Server=localhost;Port=5432;Database=Supreme;Integrated Security=true; Pooling=true;Timeout=15"
+//#endif
   },
   "Serilog": {
     "MinimumLevel": "Information",

templates/api/src/Supreme.Api/appsettings.json.tmpl

@@ -1,6 +1,11 @@
 {
   "ConnectionStrings": {
+//#if (database == "mysql")
     "DatabaseConnection": "Server=$DB_SERVER;database=$DB_NAME;uid=$DB_USER;pwd=$DB_PASSWORD;Convert Zero Datetime=True;Connection Timeout=$DB_CONNECTION_TIMEOUT;"
+//#endif
+//#if (database == "postgres")
+    "DatabaseConnection": "User ID=$DB_USER;Password=$DB_PASSWORD;Server=$DB_SERVER;Port=5432;Database=$DB_NAME;Integrated Security=true;Pooling=true;Timeout=$DB_CONNECTION_TIMEOUT"
+//#endif
   },
   "Serilog": {
     "MinimumLevel": "Information",

templates/api/src/Supreme.Application/FooUseCases/CommandHandlers/CreateFooCommandHandler.cs

@@ -1,6 +1,5 @@
 using Supreme.Application.FooUseCases.Commands;
 using Supreme.Domain.Entities.Foo;
-using Supreme.Domain.Factories;
 using Supreme.Domain.Db;
 using MediatR;
 
@@ -19,7 +18,7 @@ IUnitOfWork unitOfWork
 
     public async Task<CreateFooCommandResult> Handle(CreateFooCommand request, CancellationToken cancellationToken)
     {
-        var foo = Foo.Create(request.Name, request.ExecutedBy, DateTimeFactory.Now());
+        var foo = Foo.Create(request.Name, request.ExecutedBy, DateTime.UtcNow);
         await _unitOfWork.FooRepository.AddAsync(foo, cancellationToken);
         await _unitOfWork.CommitChangesAsync(cancellationToken);
 

templates/api/src/Supreme.Application/Supreme.Application.csproj

@@ -5,7 +5,6 @@
     <TargetFramework>{TargetFramework}</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>

templates/api/src/Supreme.Domain/Factories/DateTimeFactory.cs

@@ -1,5 +1,4 @@
 using Supreme.Domain.DomainEvents;
-using Supreme.Domain.Factories;
 using System.Collections.Concurrent;
 
 namespace Supreme.Domain.SeedWork;
@@ -23,7 +22,7 @@ protected BaseEntity() { }
     protected void SetModificationAudit(int executedBy, DateTime? executedOn = null)
     {
         ModifiedBy = executedBy;
-        ModifiedOn = executedOn ?? DateTimeFactory.Now();
+        ModifiedOn = executedOn ?? DateTime.UtcNow;
     }
 
     protected void AddEvent(IDomainEvent @event)

templates/api/src/Supreme.Domain/SeedWork/BaseEntity.cs

@@ -5,7 +5,6 @@
     <TargetFramework>{TargetFramework}</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-    <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <Nullable>enable</Nullable>
   </PropertyGroup>
 

templates/api/src/Supreme.Domain/Supreme.Domain.csproj

@@ -17,10 +17,15 @@ public static void AddRepositoryInjections(this IServiceCollection services, ICo
                 var loggerFactory = serviceProvider.GetRequiredService<ILoggerFactory>();
                 dbContextOptions.UseLoggerFactory(loggerFactory);
 #endif
-                
-                dbContextOptions
+#if (database == "mysql")
+                   dbContextOptions
                     .UseMySql(configuration.GetConnectionString("DatabaseConnection"),
                         ServerVersion.AutoDetect(configuration.GetConnectionString("DatabaseConnection")));
+#endif
+#if (database == "postgres")
+                   dbContextOptions
+                    .UseNpgsql(configuration.GetConnectionString("DatabaseConnection"));
+#endif
             }
         );
 

templates/api/src/Supreme.Infrastructure/Db/RepositoryContextInjections.cs

@@ -2,7 +2,12 @@
 using Supreme.Domain.Outbox;
 using DotNetCore.CAP;
 using Microsoft.Extensions.DependencyInjection;
+#if (database == "mysql")
 using MySqlConnector;
+#endif
+#if (database == "postgres")
+using Npgsql;
+#endif
 using System.Data;
 
 namespace Supreme.Infrastructure.Outbox;
@@ -30,6 +35,7 @@ public async Task AddDelayedAsync<TEvent>(TEvent @event, int delayInSeconds, Can
 
     public IOutboxTransaction UseTransaction(IDbTransaction transaction)
     {
+#if (database == "mysql")
         if (transaction is not MySqlTransaction mySqlTransaction)
         {
             throw new DevelopmentException($"{nameof(IDbTransaction)} is not a {nameof(MySqlTransaction)}");
@@ -38,7 +44,18 @@ public IOutboxTransaction UseTransaction(IDbTransaction transaction)
         _capPublisher.Transaction.Value = ActivatorUtilities.CreateInstance<MySqlCapTransaction>(_capPublisher.ServiceProvider);
         var capTransaction = _capPublisher.Transaction.Value.Begin(mySqlTransaction, false);
         var capOutboxTransaction = new OutboxTransaction(capTransaction);
+#endif
+#if (database == "postgres")
+        if (transaction is not NpgsqlTransaction postgresTransaction)
+        {
+            throw new DevelopmentException($"{nameof(IDbTransaction)} is not a {nameof(NpgsqlTransaction)}");
+        }
 
+        _capPublisher.Transaction.Value = ActivatorUtilities.CreateInstance<PostgreSqlCapTransaction>(_capPublisher.ServiceProvider);
+        var capTransaction = _capPublisher.Transaction.Value.Begin(postgresTransaction, false);
+        var capOutboxTransaction = new OutboxTransaction(capTransaction);
+#endif
+
         return capOutboxTransaction;    
     }
 }