release new version

.github/workflows/codeql.yml

@@ -0,0 +1,74 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "dev", main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "dev" ]
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'csharp' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #     echo "Run, Build Application using script"
+    #     ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/versioning.yml

@@ -0,0 +1,21 @@
+name: Bump version
+on:
+  push:
+    branches:
+      - main
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Bump version and push tag
+        id: tag_version
+        uses: mathieudutour/github-tag-action@v6.1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Create a GitHub release
+        uses: ncipollo/release-action@v1
+        with:
+          tag: ${{ steps.tag_version.outputs.new_tag }}
+          name: Release ${{ steps.tag_version.outputs.new_tag }}
+          body: ${{ steps.tag_version.outputs.changelog }}

Dockerfile

@@ -25,7 +25,7 @@ CMD ["dotnet", "test", "--logger:trx"]
 # Publish stage
 FROM build AS publish
 WORKDIR /app/src/Api
-RUN dotnet publish -c Release -o /app/publish
+RUN dotnet publish -c Release --no-restore -o /app/publish
 
 # Final stage
 FROM mcr.microsoft.com/dotnet/aspnet:6.0-focal AS runtime

docker-compose.test.yml

@@ -8,8 +8,8 @@ services:
     ports:
       - '8888:80'
     environment:
-      - ASPNETCORE_ENVIRONMENT=Development
-      - PROFILE_DatabaseSettings__ConnectionString=Server=database;Port=5432;Database=mytestdb;User ID=profiletester;Password=supasupasecured;
+      - ASPNETCORE_ENVIRONMENT=Testing
+      - PROFILE_DatabaseSettings__ConnectionString=Server=database;Port=5432;Database=mytestdb;User ID=profiletester;Password=supasupasecured;Include Error Detail=true
     depends_on:
       database:
         condition: service_started

docker-compose.yml

@@ -8,6 +8,15 @@ services:
     environment:
       - ASPNETCORE_ENVIRONMENT=Development
       - PROFILE_DatabaseSettings__ConnectionString=Server=database;Port=5432;Database=mydb;User ID=profiletest;Password=supasecured;
+      - PROFILE_JweSettings__SigningKeyId=4bd28be8eac5414fb01c5cbe343b50144bd28be8eac5414fb01c5cbe343b50144bd28be8eac5414fb01c5cbe343b50144bd28be8eac5414fb01c5cbe343b50144bd28be8eac5414fb01c5cbe343b5014
+      - PROFILE_JweSettings__EncryptionKeyId=4bd28be8eac5414fb01c5cbe343b5014
+      - PROFILE_JweSettings__TokenLifetime=00:20:00
+      - PROFILE_JweSettings__RefreshTokenLifetimeInDays=3
+      - PROFILE_MailSettings__ClientUrl=https://send.api.mailtrap.io/api/send
+      - PROFILE_MailSettings__Token=745f040659edff0ce87b545567da72d2
+      - PROFILE_MailSettings__SenderName=ProFile
+      - PROFILE_MailSettings__SenderEmail=profile@ezarp.dev
+      - PROFILE_MailSettings__TemplateUuid=9d6a8f25-65e9-4819-be7d-106ce077acf1
     depends_on:
       database:
         condition: service_started
@@ -20,4 +29,9 @@ services:
       - POSTGRES_PASSWORD=supasecured
       - POSTGRES_DB=mydb
     ports:
-      - '5432:5432'
+      - '5432:5432'
+    volumes:
+      - pg_data:/var/lib/postgresql/data
+
+volumes:
+  pg_data:

src/Api/Api.csproj

@@ -4,6 +4,7 @@
         <TargetFramework>net6.0</TargetFramework>
         <Nullable>enable</Nullable>
         <ImplicitUsings>enable</ImplicitUsings>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
     </PropertyGroup>
 
     <ItemGroup>
@@ -13,6 +14,8 @@
       </PackageReference>
       <PackageReference Include="Serilog.AspNetCore" Version="6.1.0" />
       <PackageReference Include="Serilog.Enrichers.Environment" Version="2.2.0" />
+      <PackageReference Include="Serilog.Expressions" Version="3.4.1" />
+      <PackageReference Include="Serilog.Sinks.PostgreSQL.Alternative" Version="3.5.0" />
       <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" />
     </ItemGroup>
 

src/Api/Common/CORSPolicy.cs

@@ -0,0 +1,7 @@
+namespace Api.Common;
+
+public static class CORSPolicy
+{
+    public static string Development = "devEnvironment";
+    public static string Production = "prodEnvironment";
+}

src/Api/ConfigureServices.cs

@@ -1,15 +1,24 @@
+using System.Reflection;
+using Api.Common;
 using Api.Middlewares;
 using Api.Policies;
+using Api.Services;
+using Application.Common.Interfaces;
 using Microsoft.AspNetCore.Mvc.ApplicationModels;
+using Microsoft.OpenApi.Models;
 
 namespace Api;
 
 public static class ConfigureServices
 {
-    public static IServiceCollection AddApiServices(this IServiceCollection services)
+    public static IServiceCollection AddApiServices(this IServiceCollection services, IConfiguration configuration)
     {
+        // TODO: Move this away in the future
+        var frontendBaseUrl = configuration.GetValue<string>("BASE_FRONTEND_URL") ?? "http://localhost";
+
         // Register services
         services.AddServices();
+        services.AddHostedService<BackgroundWorkers>();
 
         services.AddControllers(opt =>
             opt.Conventions.Add(new RouteTokenTransformerConvention(new SlugifyParameterTransformer())));
@@ -18,19 +27,39 @@ public static IServiceCollection AddApiServices(this IServiceCollection services
 
         services.AddCors(options =>
         {
-            options.AddPolicy("AllowAllOrigins", builder =>
+            options.AddPolicy(CORSPolicy.Development, builder =>
+            {
+                builder.SetIsOriginAllowed(_ => true);
+                builder.AllowAnyHeader();
+                builder.AllowAnyMethod();
+                builder.AllowCredentials();
+            });
+
+            options.AddPolicy(CORSPolicy.Production, builder =>
             {
-                builder.AllowAnyOrigin();
+                builder.WithOrigins(frontendBaseUrl);
                 builder.AllowAnyHeader();
                 builder.AllowAnyMethod();
+                builder.AllowCredentials();
             });
         });
 
         services.AddHttpContextAccessor();
 
         // For swagger
         services.AddEndpointsApiExplorer();
-        services.AddSwaggerGen();
+        services.AddSwaggerGen(options =>
+        {
+            options.SwaggerDoc("v1", new OpenApiInfo
+            {
+                Version = "v1",
+                Title = "ProFile API",
+                Description = "An ASP.NET Core Web API for managing documents",
+            });
+
+            var xmlFilename = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
+            options.IncludeXmlComments(Path.Combine(AppContext.BaseDirectory, xmlFilename));
+        });
 
         return services;
     }
@@ -39,6 +68,7 @@ private static IServiceCollection AddServices(this IServiceCollection services)
     {
         // In order for ExceptionMiddleware to work
         services.AddScoped<ExceptionMiddleware>();
+        services.AddScoped<ICurrentUserService, CurrentUserService>();
 
         return services;
     }