added swagger for automatic API Documentation

Reviewed-on: #29

.gitea/workflows/build.yml

@@ -5,21 +5,20 @@ on:
   push:
     branches: [ "development", "main", "staging" ]
     tags: [ "v*.*.*" ]
-  pull_request:
-    branches: [ "development", "main", "staging" ]
 
 env:
   DOTNET_VERSION: '8.0.x'
   DOCKER_IMAGE_NAME: watcher-server
   REGISTRY_URL: git.triggermeelmo.com
   DOCKER_PLATFORMS: 'linux/amd64,linux/arm64'
-  TAG: ${{ github.ref == 'refs/heads/main' && 'latest' || github.ref == 'refs/heads/development' && 'development' || github.ref_type == 'tag' && github.ref_name || 'pr' }}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
-  build-and-test:
+  dotnet-build-and-test:
     runs-on: ubuntu-latest
-    env:
-      RUNNER_TOOL_CACHE: /toolcache # Runner Tool Cache
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -44,11 +43,12 @@ jobs:
 
   set-tag:
     name: Set Tag Name
+    needs: [dotnet-build-and-test]
+    #if: ${{ !failure() && !cancelled() && github.event_name != 'pull_request' }}
     runs-on: ubuntu-latest
-    env:
-      RUNNER_TOOL_CACHE: /toolcache
     outputs:
       tag_name: ${{ steps.set_tag.outputs.tag_name }}
+      should_tag: ${{ steps.set_tag.outputs.should_tag }}
     steps:
       - uses: actions/checkout@v4
 
@@ -72,21 +72,33 @@ jobs:
             major=$((major + 1))
             minor=0
             patch=0
+            new_tag="v${major}.${minor}.${patch}"
+            echo "tag_name=${new_tag}" >> $GITHUB_OUTPUT
+            echo "should_tag=true" >> $GITHUB_OUTPUT
+            echo "Creating new major version tag: ${new_tag}"
+            
           elif [[ "${GITHUB_REF}" == "refs/heads/development" ]]; then
             minor=$((minor + 1))
             patch=0
-          else
-            patch=$((patch + 1))
-          fi
-
             new_tag="v${major}.${minor}.${patch}"
             echo "tag_name=${new_tag}" >> $GITHUB_OUTPUT
+            echo "should_tag=true" >> $GITHUB_OUTPUT
+            echo "Creating new minor version tag: ${new_tag}"
+            
+          elif [[ "${GITHUB_REF}" == "refs/heads/staging" ]]; then
+            patch=$((patch + 1))
+            new_tag="v${major}.${minor}.${patch}"
+            echo "tag_name=${new_tag}" >> $GITHUB_OUTPUT
+            echo "should_tag=true" >> $GITHUB_OUTPUT
+            echo "Creating new patch version tag: ${new_tag}"
+          fi
 
   docker-build-and-push:
     runs-on: ubuntu-latest
-    env:
-      RUNNER_TOOL_CACHE: /toolcache # Runner Tool Cache
-    needs: [build-and-test, set-tag]
+    needs: [dotnet-build-and-test, set-tag]
+    if: | 
+      needs.set-tag.outputs.should_tag == 'true' &&
+      github.event_name != 'pull_request'
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -110,10 +122,11 @@ jobs:
 
   tag:
     name: Create Tag
-    needs: [docker-build-and-push]
+    needs: [docker-build-and-push, set-tag]
+    if: |
+      needs.set-tag.outputs.should_tag == 'true' &&
+      github.event_name != 'pull_request'
     runs-on: ubuntu-latest
-    env:
-      RUNNER_TOOL_CACHE: /toolcache
     steps:
       - uses: actions/checkout@v4
         with:
@@ -128,5 +141,6 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
+          echo "Creating new tag: ${{ needs.set-tag.outputs.tag_name }}"
           git tag ${{ needs.set-tag.outputs.tag_name }}
           git push origin ${{ needs.set-tag.outputs.tag_name }}

Tests/servicediscovery.py

@@ -0,0 +1,28 @@
+import json
+import urllib.request
+
+url = "http://localhost:5000/monitoring/service-discovery"
+payload = {
+"ServerId": 1,
+"ContainerId": "aaaaaaaaaaaa",
+"Name": "test-Name",
+"Image": "test-Image"
+}
+
+data = json.dumps(payload).encode("utf-8")
+req = urllib.request.Request(
+url,
+data=data,
+headers={"Content-Type": "application/json"},
+method="POST"
+)
+
+try:
+    with urllib.request.urlopen(req) as response:
+        resp_data = response.read().decode("utf-8")
+        print("Status Code:", response.status)
+        print("Response:", resp_data)
+except Exception as e:
+    print("Fehler beim Senden der Request:", e)
+
+    

Watcher/Controllers/MonitoringController.cs

@@ -12,7 +12,7 @@ using Watcher.ViewModels;
 
 namespace Watcher.Controllers;
 
-public class RegistrationDto
+public class HardwareDto
 {
     // Server Identity
     [Required]
@@ -101,9 +101,9 @@ public class MonitoringController : Controller
     }
 
 
-    // Endpoint, an dem sich neue Agents registrieren
-    [HttpPost("register-agent-by-id")]
-    public async Task<IActionResult> Register([FromBody] RegistrationDto dto)
+    // Endpoint, an den der Agent seine Hardwareinformationen schickt
+    [HttpPost("hardware-info")]
+    public async Task<IActionResult> Register([FromBody] HardwareDto dto)
     {
         // Gültigkeit des Payloads prüfen
         if (!ModelState.IsValid)
@@ -140,7 +140,8 @@ public class MonitoringController : Controller
         return NotFound("No Matching Server found.");
     }
 
-    [HttpGet("server-id-by-ip")]
+    // Endpoint, an dem sich ein Agent initial registriert
+    [HttpGet("register")]
     public async Task<IActionResult> GetServerIdByIp([FromQuery] string IpAddress)
     {
         var server = await _context.Servers
@@ -252,6 +253,8 @@ public class MonitoringController : Controller
                 Name = dto.Name
             };
 
+            _logger.LogInformation(container.Name + " added for Host " + container.ServerId);
+
             _context.Containers.Add(container);
             await _context.SaveChangesAsync();
         }

Watcher/Program.cs

@@ -1,5 +1,6 @@
 using Microsoft.AspNetCore.Authentication.OpenIdConnect;
 using Microsoft.EntityFrameworkCore;
+using Microsoft.OpenApi.Models;
 
 using Serilog;
 
@@ -36,11 +37,17 @@ builder.Services.AddHttpContextAccessor();
 
 // Storage Singleton
 builder.Services.AddSingleton<IDashboardStore, DashboardStore>();
+builder.Services.AddSingleton<ISystemStore, SystemStore>();
 
 // Background Services
 builder.Services.AddHostedService<NetworkCheck>();
 builder.Services.AddHostedService<DatabaseCheck>();
 
+// Swagger API-Dokumentation
+builder.Services.AddSwaggerGen(options =>
+{
+    options.SwaggerDoc("v1", new OpenApiInfo { Title = "Watcher-Server API", Version = "v1" });
+});
 
 // ---------- Konfiguration ----------
 DotNetEnv.Env.Load();
@@ -212,6 +219,8 @@ if (!app.Environment.IsDevelopment())
 app.UseHttpsRedirection();
 app.UseRouting();
 
+app.UseSwagger();
+
 app.UseAuthentication();
 app.UseAuthorization();
 
@@ -222,4 +231,11 @@ app.MapControllerRoute(
     pattern: "{controller=Home}/{action=Index}/{id?}"
     );
 
+app.MapSwagger();
+
+app.UseSwaggerUI(options =>
+{
+    options.SwaggerEndpoint("v1/swagger.json", "Watcher-Server API v1");
+});
+
 app.Run();

Watcher/Services/ISystemStore.cs

@@ -0,0 +1,9 @@
+namespace Watcher.Services;
+
+public interface ISystemStore
+{
+    Boolean NewVersionAvailable { get; set; }
+
+    Double DatabaseSize { get; set; }
+
+}

Watcher/Services/SystemMangement.cs

@@ -0,0 +1,42 @@
+using System.Net.Http;
+
+namespace Watcher.Services;
+
+public class SystemManagement : BackgroundService
+{
+    private readonly ILogger<NetworkCheck> _logger;
+
+    private ISystemStore _SystemStore;
+
+    public SystemManagement(ILogger<NetworkCheck> logger, ISystemStore SystemStore)
+    {
+        _logger = logger;
+        _SystemStore = SystemStore;
+
+    }
+
+    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
+    {
+        // Todo: Umstellen auf einmal alle 24h
+        var timer = new PeriodicTimer(TimeSpan.FromSeconds(30));
+
+        while (await timer.WaitForNextTickAsync(stoppingToken))
+        {
+            // Hintergrundprozess abwarten
+            await checkForNewDockerImageVersion();
+
+            // 5 Sekdunden Offset
+            await Task.Delay(TimeSpan.FromSeconds(5), stoppingToken);
+        }
+    }
+
+    public Task checkForNewDockerImageVersion()
+    {
+        return Task.CompletedTask;
+    }
+
+    public Task createDailySqliteBackup()
+    {
+        return Task.CompletedTask;
+    }
+}

Watcher/Services/SystemStore.cs

@@ -0,0 +1,9 @@
+namespace Watcher.Services;
+
+public class SystemStore: ISystemStore
+{
+    public Boolean NewVersionAvailable { get; set; }
+
+    public Double DatabaseSize { get; set; }
+
+}

Watcher/Watcher.csproj

@@ -23,6 +23,7 @@
     <PackageReference Include="Microsoft.AspNetCore.Authentication.OpenIdConnect" Version="8.0.6" />
     <PackageReference Include="Serilog.AspNetCore" Version="9.0.0" />
     <PackageReference Include="Serilog.Sinks.File" Version="7.0.0" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="9.0.6" />
   </ItemGroup>
 
 </Project>