Adminapi23 rc.0 - merge to main check point

.github/workflows/api-e2e-mssql-multitenant.yml

@@ -43,6 +43,9 @@ jobs:
       - name: Copy admin console folder to docker context
         run: cp -r ../EdFi.Ods.AdminApi.AdminConsole ../../Docker/Application
 
+      - name: Copy admin api common folder to docker context
+        run: cp -r ../EdFi.Ods.AdminApi.Common ../../Docker/Application
+
       - name: Copy nuget config to docker context
         run: cp ../NuGet.Config ../../Docker/Application
 

.github/workflows/api-e2e-mssql-singletenant.yml

@@ -43,6 +43,9 @@ jobs:
       - name: Copy admin console folder to docker context
         run: cp -r ../EdFi.Ods.AdminApi.AdminConsole ../../Docker/Application
 
+      - name: Copy admin api common folder to docker context
+        run: cp -r ../EdFi.Ods.AdminApi.Common ../../Docker/Application
+
       - name: Copy nuget config to docker context
         run: cp ../NuGet.Config ../../Docker/Application
 

.github/workflows/api-e2e-pgsql-multitenant.yml

@@ -43,6 +43,9 @@ jobs:
       - name: Copy admin console folder to docker context
         run: cp -r ../EdFi.Ods.AdminApi.AdminConsole ../../Docker/Application
 
+      - name: Copy admin api common folder to docker context
+        run: cp -r ../EdFi.Ods.AdminApi.Common ../../Docker/Application
+
       - name: Copy nuget config to docker context
         run: cp ../NuGet.Config ../../Docker/Application
 

.github/workflows/api-e2e-pgsql-singletenant.yml

@@ -40,6 +40,7 @@ jobs:
           mkdir ../../Docker/Application
           cp -r ../EdFi.Ods.AdminApi ../../Docker/Application
           cp -r ../EdFi.Ods.AdminApi.AdminConsole ../../Docker/Application
+          cp -r ../EdFi.Ods.AdminApi.Common ../../Docker/Application
 
       - name: Copy nuget config to docker context
         run: cp ../NuGet.Config ../../Docker/Application

.github/workflows/on-pullrequest-dockerfile-ac.yml

@@ -0,0 +1,95 @@
+  # SPDX-License-Identifier: Apache-2.0
+  # Licensed to the Ed-Fi Alliance under one or more agreements.
+  # The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0.
+  # See the LICENSE and NOTICES files in the project root for more information.
+
+  name: On Pull Request - Dockerfile - Admin Console
+
+  on:
+    push:
+      branches:
+        - adminapi23-rc.*
+    workflow_dispatch:
+
+  env:
+    DOCKER_USERNAME: ${{ vars.DOCKER_USERNAME }}
+    DOCKER_HUB_TOKEN: ${{ secrets.DOCKER_HUB_TOKEN }}
+    IMAGE_NAME: ${{ vars.IMAGE_NAME }}
+
+  permissions: read-all
+
+  jobs:
+    docker-analysis:
+      runs-on: ubuntu-latest
+      permissions:
+        security-events: write
+        pull-requests: write
+      strategy:
+        fail-fast: false
+        matrix:
+          dockerfile:
+            [
+              { name: "development", path: "Docker/dev.pgsql.Dockerfile", type: "local" }
+            ]
+      steps:
+        - name: Checkout code
+          uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
+
+        - name: Set IMAGE_TAG
+          id: set-image-tag
+          run: |
+            if [ "${{ github.event_name }}" == "pull_request" ]; then
+              echo "IMAGE_TAG=${{ github.base_ref }}" >> $GITHUB_ENV
+            else
+              echo "IMAGE_TAG=${{ github.ref_name }}" >> $GITHUB_ENV
+            fi
+
+        - name: Copy application folder to docker context
+          if: ${{ matrix.dockerfile.type == 'local' }}
+          run: |
+            mkdir Docker/Application
+            cp -r ./Application/EdFi.Ods.AdminApi ./Docker/Application
+            cp -r ./Application/EdFi.Ods.AdminApi.AdminConsole ./Docker/Application
+            cp -r ./Application/EdFi.Ods.AdminApi.Common ./Docker/Application
+            cp ./Application/NuGet.Config ./Docker/Application
+
+        - uses: hadolint/hadolint-action@54c9adbab1582c2ef04b2016b760714a4bfde3cf # v3.1.0
+          name: Run Linter on ${{ matrix.dockerfile.name }} Dockerfile
+          with:
+            dockerfile: ${{ matrix.dockerfile.path }}
+            failure-threshold: error
+
+        - name: Log in to Docker Hub
+          uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0
+          with:
+            username: ${{ env.DOCKER_USERNAME }}
+            password: ${{ env.DOCKER_HUB_TOKEN }}
+
+        - name: Build
+          run: |
+            path=${{matrix.dockerfile.path}}
+            folder=${path%/*}
+            cd $folder
+            dockerfile=$(echo ${{matrix.dockerfile.path}} | awk -F"/" '{print $NF}')
+
+            docker build -f $dockerfile -t ${{ matrix.dockerfile.name }} --build-arg="VERSION=${{ env.IMAGE_TAG }}" .
+
+        - name: Analyze
+          uses: docker/scout-action@67eb1afe777307506aaecb9acd9a0e0389cb99ae # v1.5.0
+          with:
+            command: cves
+            image: local://${{ matrix.dockerfile.name }}
+            sarif-file: sarif-${{ matrix.dockerfile.name }}.output.json
+            summary: true
+
+        - name: Push Image on Docker Hub
+          run: |
+            docker image tag ${{ matrix.dockerfile.name }} ${{ env.IMAGE_NAME }}:${{ env.IMAGE_TAG }}
+            docker push ${{ env.IMAGE_NAME }}:${{ env.IMAGE_TAG }}
+
+        - name: Upload SARIF result
+          id: upload-sarif
+          if: ${{ github.event_name != 'pull_request_target' }}
+          uses: github/codeql-action/upload-sarif@cf7e9f23492505046de9a37830c3711dd0f25bb3 #codeql-bundle-v2.16.2
+          with:
+            sarif_file: sarif-${{ matrix.dockerfile.name }}.output.json

.github/workflows/on-pullrequest-dockerfile.yml

@@ -50,6 +50,7 @@ jobs:
           mkdir Docker/Application
           cp -r ./Application/EdFi.Ods.AdminApi ./Docker/Application
           cp -r ./Application/EdFi.Ods.AdminApi.AdminConsole ./Docker/Application
+          cp -r ./Application/EdFi.Ods.AdminApi.Common ./Docker/Application
           cp ./Application/NuGet.Config ./Docker/Application
 
       - name: Set Version Numbers

Application/Ed-Fi-ODS-AdminApi.sln

@@ -19,7 +19,11 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "IntegrationTests", "Integra
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "EdFi.Ods.AdminApi.DBTests", "EdFi.Ods.AdminApi.DBTests\EdFi.Ods.AdminApi.DBTests.csproj", "{73259EC2-4AA0-40C2-9C60-8AB1BF369CF5}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "EdFi.Ods.AdminApi.AdminConsole", "EdFi.Ods.AdminApi.AdminConsole\EdFi.Ods.AdminApi.AdminConsole.csproj", "{0F34C4F6-F7A2-442A-9E54-FCBD9A00F914}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "EdFi.Ods.AdminApi.AdminConsole", "EdFi.Ods.AdminApi.AdminConsole\EdFi.Ods.AdminApi.AdminConsole.csproj", "{0F34C4F6-F7A2-442A-9E54-FCBD9A00F914}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "EdFi.Ods.AdminConsole.DBTests", "EdFi.Ods.AdminConsole.DBTests\EdFi.Ods.AdminConsole.DBTests.csproj", "{A2DC17AC-66C2-4119-BB47-4266E8ACB055}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "EdFi.Ods.AdminApi.Common", "EdFi.Ods.AdminApi.Common\EdFi.Ods.AdminApi.Common.csproj", "{C9C86866-562B-4EA3-9AAC-F3297F0754D6}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -61,13 +65,30 @@ Global
 		{0F34C4F6-F7A2-442A-9E54-FCBD9A00F914}.Release|Any CPU.Build.0 = Release|Any CPU
 		{0F34C4F6-F7A2-442A-9E54-FCBD9A00F914}.Release|x64.ActiveCfg = Release|Any CPU
 		{0F34C4F6-F7A2-442A-9E54-FCBD9A00F914}.Release|x64.Build.0 = Release|Any CPU
+		{A2DC17AC-66C2-4119-BB47-4266E8ACB055}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{A2DC17AC-66C2-4119-BB47-4266E8ACB055}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{A2DC17AC-66C2-4119-BB47-4266E8ACB055}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{A2DC17AC-66C2-4119-BB47-4266E8ACB055}.Debug|x64.Build.0 = Debug|Any CPU
+		{A2DC17AC-66C2-4119-BB47-4266E8ACB055}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{A2DC17AC-66C2-4119-BB47-4266E8ACB055}.Release|Any CPU.Build.0 = Release|Any CPU
+		{A2DC17AC-66C2-4119-BB47-4266E8ACB055}.Release|x64.ActiveCfg = Release|Any CPU
+		{A2DC17AC-66C2-4119-BB47-4266E8ACB055}.Release|x64.Build.0 = Release|Any CPU
+		{C9C86866-562B-4EA3-9AAC-F3297F0754D6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{C9C86866-562B-4EA3-9AAC-F3297F0754D6}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{C9C86866-562B-4EA3-9AAC-F3297F0754D6}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{C9C86866-562B-4EA3-9AAC-F3297F0754D6}.Debug|x64.Build.0 = Debug|Any CPU
+		{C9C86866-562B-4EA3-9AAC-F3297F0754D6}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{C9C86866-562B-4EA3-9AAC-F3297F0754D6}.Release|Any CPU.Build.0 = Release|Any CPU
+		{C9C86866-562B-4EA3-9AAC-F3297F0754D6}.Release|x64.ActiveCfg = Release|Any CPU
+		{C9C86866-562B-4EA3-9AAC-F3297F0754D6}.Release|x64.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{F62C9CF6-A632-4894-B61A-674198DAB86E} = {9A9D18B4-718D-4681-BAFE-A1C42E18A7CC}
 		{73259EC2-4AA0-40C2-9C60-8AB1BF369CF5} = {D8A26B59-6DAD-4046-9DDE-00D2CFDAE9B6}
+		{A2DC17AC-66C2-4119-BB47-4266E8ACB055} = {D8A26B59-6DAD-4046-9DDE-00D2CFDAE9B6}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {30CF2BE4-58CA-4598-9B59-D334FC971A0F}

Application/EdFi.Ods.AdminApi.AdminConsole/EdFi.Ods.AdminApi.AdminConsole.csproj

@@ -1,21 +1,57 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
   </PropertyGroup>
 
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+    <TreatWarningsAsErrors>False</TreatWarningsAsErrors>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
+    <TreatWarningsAsErrors>False</TreatWarningsAsErrors>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Compile Remove="Mockdata\**" />
+    <EmbeddedResource Remove="Mockdata\**" />
+    <None Remove="Mockdata\**" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="Asp.Versioning.Http" Version="8.1.0" />
-    <PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="8.0.1" />
+    <PackageReference Include="AutoMapper" Version="13.0.1" />
+    <PackageReference Include="FluentValidation.AspNetCore" Version="11.3.0" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore" Version="8.0.7" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Abstractions" Version="8.0.8" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Design" Version="8.0.7">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="8.0.7" />
+    <PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="8.0.7">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="9.0.0" />
+    <PackageReference Include="Microsoft.NETCore.App" Version="2.1.30" />
     <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
-    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.7.0" />
-    <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="6.7.0" />
+    <PackageReference Include="Npgsql" Version="8.0.6" />
+    <PackageReference Include="Npgsql.EntityFrameworkCore.PostgreSQL" Version="8.0.4" />
+    <PackageReference Include="Rijndael256" Version="3.2.0" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="7.1.0" />
+    <PackageReference Include="Swashbuckle.AspNetCore.Annotations" Version="7.1.0" />
+    <PackageReference Include="System.Text.Json" Version="9.0.0" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <Folder Include="Infrastructure\DataAccess\Artifacts\" />
   </ItemGroup>
 
   <ItemGroup>
-    <Folder Include="Mockdata\" />
+    <ProjectReference Include="..\EdFi.Ods.AdminApi.Common\EdFi.Ods.AdminApi.Common.csproj" />
   </ItemGroup>
 
 </Project>

Application/EdFi.Ods.AdminApi.AdminConsole/Features/Healthcheck/AddHealthCheck.cs

@@ -0,0 +1,79 @@
+// SPDX-License-Identifier: Apache-2.0
+// Licensed to the Ed-Fi Alliance under one or more agreements.
+// The Ed-Fi Alliance licenses this file to you under the Apache License, Version 2.0.
+// See the LICENSE and NOTICES files in the project root for more information.
+
+using System.ComponentModel.DataAnnotations;
+using EdFi.Ods.AdminApi.AdminConsole.Infrastructure.Services.HealthChecks.Commands;
+using EdFi.Ods.AdminApi.Common.Features;
+using EdFi.Ods.AdminApi.Common.Infrastructure;
+using FluentValidation;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Routing;
+using Newtonsoft.Json;
+using Swashbuckle.AspNetCore.Annotations;
+
+namespace EdFi.Ods.AdminApi.AdminConsole.Features.Healthcheck;
+public class AddHealthCheck : IFeature
+{
+    public void MapEndpoints(IEndpointRouteBuilder endpoints)
+    {
+        AdminApiEndpointBuilder.MapPost(endpoints, "/healthcheck", Execute)
+      .WithRouteOptions(b => b.WithResponseCode(201))
+      .BuildForVersions(AdminApiVersions.AdminConsole);
+    }
+
+    public async Task<IResult> Execute(Validator validator, IAddHealthCheckCommand addHealthCheckCommand, AddHealthCheckRequest request)
+    {
+        await validator.GuardAsync(request);
+        var addedHealthCheck = await addHealthCheckCommand.Execute(request);
+        return Results.Created($"/healthcheck/{addedHealthCheck.DocId}", null);
+    }
+
+    [SwaggerSchema(Title = nameof(AddHealthCheckRequest))]
+    public class AddHealthCheckRequest : IAddHealthCheckModel
+    {
+        [Required]
+        public int DocId { get; set; }
+        [Required]
+        public int InstanceId { get; set; }
+        [Required]
+        public int EdOrgId { get; set; }
+        [Required]
+        public int TenantId { get; set; }
+        [Required]
+        public string Document { get; set; }
+    }
+
+    public class Validator : AbstractValidator<AddHealthCheckRequest>
+    {
+        public Validator()
+        {
+            RuleFor(m => m.InstanceId)
+                 .NotNull();
+
+            RuleFor(m => m.EdOrgId)
+                 .NotNull();
+
+            RuleFor(m => m.TenantId)
+                 .NotNull();
+
+            RuleFor(m => m.Document)
+                 .NotNull()
+                 .Must(BeValidDocument).WithMessage("Document must be a valid JSON.");
+        }
+
+        private bool BeValidDocument(string document)
+        {
+            try
+            {
+                Newtonsoft.Json.Linq.JToken.Parse(document);
+                return true;
+            }
+            catch (Newtonsoft.Json.JsonReaderException)
+            {
+                return false;
+            }
+        }
+    }
+}