Update README, Docker configuration, and CI/CD pipeline; enhance email settings and application startup

Author: alnuaimicoder

.github/workflows/ci-cd.yml

@@ -0,0 +1,77 @@
+name: CI/CD
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  build-test:
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:15.1
+        env:
+          POSTGRES_DB: testdb
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+      redis:
+        image: redis:7.0
+        ports:
+          - 6379:6379
+        options: >-
+          --health-cmd "redis-cli ping" --health-interval 10s --health-timeout 5s --health-retries 5
+      mailpit:
+        image: axllent/mailpit:latest
+        ports:
+          - 3025:1025
+          - 8025:8025
+        options: >-
+          --health-cmd "nc -z localhost 1025" --health-interval 10s --health-timeout 5s --health-retries 5
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: "8.0.x"
+      - name: Restore dependencies
+        run: dotnet restore
+      - name: Build
+        run: dotnet build --no-restore --configuration Release
+      - name: Run Unit Tests
+        run: dotnet test ./tests/BookLibraryAPI.UnitTests/BookLibraryAPI.UnitTests.csproj --no-build --configuration Release --logger "trx;LogFileName=unit_tests.trx"
+      - name: Run Integration Tests
+        run: dotnet test ./tests/BookLibraryAPI.IntegrationTests/BookLibraryAPI.IntegrationTests.csproj --no-build --configuration Release --logger "trx;LogFileName=integration_tests.trx"
+      - name: Upload Test Results
+        uses: actions/upload-artifact@v4
+        with:
+          name: test-results
+          path: tests/**/*.trx
+
+  docker-deploy:
+    needs: build-test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Login to DockerHub
+        uses: docker/login-action@v3
+        with:
+          username: abdulwaisa
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Build and push app image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: src/Presentation/BookLibraryAPI.Presentation/Dockerfile
+          push: true
+          tags: abdulwaisa/booklibraryapi:latest
+      - name: Deploy with Docker Compose
+        run: |
+          docker compose -f compose.yaml up -d

README.md

@@ -209,3 +209,58 @@ Pull requests are welcome! Please follow the existing code style and add tests f
 
 ## License
 MIT
+
+## Recent Changes & Improvements
+
+### Docker & HTTPS
+- The API now supports HTTPS in Docker using a development certificate.
+- Default HTTPS port is `9443` (see `compose.yaml` and `appsettings.json`).
+- Access the API in Docker at: `https://localhost:9443/swagger`
+
+### Email Notification Reliability
+- The `Email` section in `appsettings.json` now includes a required `To` field to avoid null recipient errors.
+- SMTP configuration keys in code were fixed to match the settings (`SmtpHost`, `SmtpPort`).
+
+### CI/CD Pipeline
+- The GitHub Actions workflow (`.github/workflows/ci-cd.yml`) now includes:
+  - Build, test (unit & integration), and artifact upload.
+  - Docker image build and push to DockerHub.
+  - Docker Compose deployment.
+  - Mailpit service for email integration tests, ensuring all tests pass in CI.
+
+## How to Check if the Application is Running
+
+### Locally (Docker)
+1. Run:
+   ```sh
+   docker compose up -d
+   ```
+2. Visit:
+   - API: `https://localhost:9443/swagger`
+   - Mailpit UI: `http://localhost:8025`
+3. Check logs:
+   ```sh
+   docker compose logs app
+   ```
+
+### In CI/CD (GitHub Actions)
+- On every push/PR to `main`, the workflow will:
+  - Build and test the app.
+  - Deploy the latest image with Docker Compose.
+  - You can view workflow status and logs in the GitHub Actions tab.
+
+## Testing
+
+The project includes comprehensive unit and integration tests:
+
+- **Unit Tests:** Located in `tests/BookLibraryAPI.UnitTests`. Run with:
+  ```sh
+  dotnet test tests/BookLibraryAPI.UnitTests/BookLibraryAPI.UnitTests.csproj
+  ```
+- **Integration Tests:** Located in `tests/BookLibraryAPI.IntegrationTests`. These use Testcontainers for PostgreSQL, Redis, and Mailpit. Run with:
+  ```sh
+  dotnet test tests/BookLibraryAPI.IntegrationTests/BookLibraryAPI.IntegrationTests.csproj
+  ```
+- **CI/CD:** All tests are automatically run in GitHub Actions on every push and pull request to `main`. Test results are uploaded as artifacts.
+
+You can view test results in the GitHub Actions tab or by running the above commands locally.

compose.yaml

@@ -1,16 +1,61 @@
-services:
-  
+version: '3.8'
+services:
+  app:
+    build:
+      context: .
+      dockerfile: src/Presentation/BookLibraryAPI.Presentation/Dockerfile
+    container_name: booklibraryapi_app
+    environment:
+      - ASPNETCORE_ENVIRONMENT=Production
+      - ConnectionStrings__LibraryDbConnection=Host=book-lib-postgres;Port=5432;Database=librarydb;Username=postgres;Password=postgres
+      - ConnectionStrings__Redis=book-lib-redis:6379
+      - Email__SmtpHost=mailpit
+      - Email__SmtpPort=1025
+      - Email__From=admin@example.com
+      - ASPNETCORE_URLS=https://+:9443;http://+:8080
+      - ASPNETCORE_Kestrel__Certificates__Default__Password=Password123!
+      - ASPNETCORE_Kestrel__Certificates__Default__Path=/https/aspnet-dev-cert.pfx
+    ports:
+      - "8080:8080"
+      - "9443:9443"
+    depends_on:
+      - book-lib-postgres
+      - book-lib-redis
+      - mailpit
+    restart: unless-stopped
+
+  book-lib-postgres:
+    image: postgres:15.1
+    container_name: BookLibrary.Postgres
+    environment:
+      POSTGRES_DB: librarydb
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+    ports:
+      - "5432:5432"
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U postgres"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+    restart: unless-stopped
+
+  book-lib-redis:
+    image: redis:7.0
+    container_name: BookLibrary.Redis
+    ports:
+      - "6379:6379"
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+    restart: unless-stopped
+
   mailpit:
     image: axllent/mailpit:latest
     container_name: mailpit
     ports:
       - "8025:8025"   # Web UI
       - "3025:1025"   # SMTP (host:container)
     restart: unless-stopped
-    
-  book-lib-redis:
-    image: redis:latest
-    container_name: BookLibrary.Redis
-    restart: always
-    ports:
-      - "6379:6379"

src/Infrastructure/BookLibraryAPI.Infrastructure/Adapters/Email/EmailNotificationAdapter.cs

@@ -7,8 +7,8 @@
 namespace BookLibraryAPI.Infrastructure.Adapters.Email;
 
 public class EmailNotificationAdapter(
-    IConfiguration configuration, 
-    ILogger<EmailNotificationAdapter> logger) 
+    IConfiguration configuration,
+    ILogger<EmailNotificationAdapter> logger)
     : IEmailNotificationPort
 {
     public async Task SendWelcomeEmailAsync(string bookTitle, string author,
@@ -39,7 +39,7 @@ private async Task SendNotificationAsync(string to, string subject, string body,
             var message = new MimeMessage();
             var from = configuration["Email:From"];
             message.From.Add(new MailboxAddress("Library Management System", from));
-            
+
             message.To.Add(new MailboxAddress("", to));
             message.Subject = subject;
 
@@ -52,8 +52,8 @@ private async Task SendNotificationAsync(string to, string subject, string body,
 
             using var client = new SmtpClient();
             await client.ConnectAsync(
-                configuration["Email:Host"],
-                int.Parse(configuration["Email:Port"] ?? "8025"),
+                configuration["Email:SmtpHost"],
+                int.Parse(configuration["Email:SmtpPort"] ?? "1025"),
                 false,
                 cancellationToken);
 

src/Presentation/BookLibraryAPI.Presentation/Dockerfile

@@ -1,8 +1,10 @@
 FROM mcr.microsoft.com/dotnet/aspnet:8.0 AS base
-USER $APP_UID
 WORKDIR /app
 EXPOSE 8080
-EXPOSE 8081
+EXPOSE 9443
+
+# Copy dev certificate
+COPY ./src/Presentation/BookLibraryAPI.Presentation/aspnet-dev-cert.pfx /https/aspnet-dev-cert.pfx
 
 FROM mcr.microsoft.com/dotnet/sdk:8.0 AS build
 ARG BUILD_CONFIGURATION=Release

src/Presentation/BookLibraryAPI.Presentation/Program.cs

@@ -24,15 +24,12 @@
 
 var app = builder.Build();
 
-if (app.Environment.IsDevelopment())
-{
-    app.UseSwagger();
-    app.UseSwaggerUI();
-    
-    app.ApplyMigrations();
-    
-    app.Seed();
-}
+app.UseSwagger();
+app.UseSwaggerUI();
+
+app.ApplyMigrations();
+app.Seed();
+
 
 app.UseExceptionHandler();
 app.UseCustomExceptionHandler();

src/Presentation/BookLibraryAPI.Presentation/appsettings.json

@@ -1,4 +1,33 @@
 {
+  "Jwt": {
+    "Key": "ThisIsASecretKeyForJWTTokenGenerationThatShouldBeAtLeast32CharactersLongForSecurity",
+    "Issuer": "BookLibraryAPI",
+    "Audience": "BookLibraryAPIUsers"
+  },
+  "ConnectionStrings": {
+    "LibraryDbConnection": "Host=book-lib-postgres;Port=5432;Database=librarydb;Username=postgres;Password=postgres",
+    "Redis": "book-lib-redis:6379"
+  },
+  "Email": {
+    "SmtpHost": "mailpit",
+    "SmtpPort": 1025,
+    "From": "admin@example.com",
+    "To": "test@example.com"
+  },
+  "Kestrel": {
+    "Endpoints": {
+      "Http": {
+        "Url": "http://0.0.0.0:8080"
+      },
+      "Https": {
+        "Url": "https://0.0.0.0:9443",
+        "Certificate": {
+          "Path": "/https/aspnet-dev-cert.pfx",
+          "Password": "Password123!"
+        }
+      }
+    }
+  },
   "Logging": {
     "LogLevel": {
       "Default": "Information",