Merge pull request #80 from itk-dev/feature/5566_maintenance_contract-by-martin

Feature/5566 maintenance contract by martin

Author: martinyde

.env

@@ -63,3 +63,8 @@ VAULT_SECRET_ID="CHANGE_ME_IN_LOCAL_ENV"
 
 # The number of old results for each server/result-type combination
 APP_KEEP_RESULTS=5
+
+###> economics ###
+APP_ECONOMICS_URI=https://economics.itkdev.dk
+APP_ECONOMICS_API_KEY=changeme
+###< economics ###

.github/workflows/doctrine.yaml

@@ -0,0 +1,64 @@
+name: Doctrine
+
+env:
+    COMPOSE_USER: root
+
+on:
+    pull_request:
+    push:
+        branches:
+            - main
+            - develop
+
+jobs:
+    validate-doctrine-schema:
+        name: Validate Doctrine Schema
+        runs-on: ubuntu-latest
+        env:
+            APP_ENV: prod
+
+        steps:
+            - uses: actions/checkout@v6
+
+            - name: Create docker network
+              run: |
+                  docker network create frontend
+
+            - name: Run Composer Install
+              run: |
+                  docker compose run --rm phpfpm composer install
+
+            - name: Run Doctrine Migrations
+              run: |
+                  docker compose run --rm phpfpm bin/console doctrine:migrations:migrate --no-interaction
+
+            - name: Setup messenger "failed" doctrine transport to ensure db schema is updated
+              run: |
+                  docker compose run --rm phpfpm bin/console messenger:setup-transports failed
+
+            - name: Validate Doctrine schema
+              run: |
+                  docker compose run --rm phpfpm bin/console doctrine:schema:validate
+
+    load-fixtures:
+        name: Load Doctrine fixtures
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v6
+
+            - name: Create docker network
+              run: |
+                  docker network create frontend
+
+            - name: Run Composer Install
+              run: |
+                  docker compose run --rm phpfpm composer install --no-interaction
+
+            - name: Run Doctrine Migrations
+              run: |
+                  docker compose run --rm phpfpm bin/console doctrine:migrations:migrate --no-interaction
+
+            - name: Load fixtures
+              run: |
+                  docker compose run --rm phpfpm composer fixtures

.github/workflows/pr.yaml

@@ -3,24 +3,6 @@ name: Review
 env:
     COMPOSE_USER: runner
 jobs:
-    validate-doctrine-schema:
-        runs-on: ubuntu-latest
-        name: Validate Doctrine Schema
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v6
-
-            - name: Create docker network
-              run: docker network create frontend
-
-            - name: Install and validate
-              run: |
-                  docker compose up --detach
-                  docker compose exec phpfpm composer install --no-interaction
-                  docker compose exec phpfpm bin/console doctrine:migrations:migrate --no-interaction
-                  docker compose exec phpfpm bin/console messenger:setup-transports failed
-                  docker compose exec phpfpm bin/console doctrine:schema:validate
-
     phpstan:
         runs-on: ubuntu-latest
         name: PHPStan
@@ -65,23 +47,6 @@ jobs:
             #       fail_ci_if_error: true
             #       flags: unittests
 
-    fixtures:
-        runs-on: ubuntu-latest
-        name: Load fixtures
-        steps:
-            - name: Checkout
-              uses: actions/checkout@v6
-
-            - name: Create docker network
-              run: docker network create frontend
-
-            - name: Load fixtures
-              run: |
-                  docker compose up --detach
-                  docker compose exec phpfpm composer install --no-interaction
-                  docker compose exec phpfpm bin/console doctrine:migrations:migrate --no-interaction
-                  docker compose exec phpfpm composer fixtures
-
     build-assets:
         runs-on: ubuntu-latest
         name: Build assets

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+- [#80](https://github.com/itk-dev/devops_itksites/pull/80) 5566: Service agreements
+  - Add security contract entity with crud controller
+  - Add Abstract full crud controller and extend on it in some cases
+  - Add economics service and sync action/command for service agreement synchronization
 - [#81](https://github.com/itk-dev/devops_itksites/pull/81) 5564: Asset Mapper migration
   - Add Symfony Asset Mapper bundle and importmap
 - Add Renovate auto-patch + auto-release pipeline (Phase 1 fork validation)

config/packages/framework.yaml

@@ -13,6 +13,14 @@ framework:
     #esi: true
     #fragments: true
 
+    http_client:
+        scoped_clients:
+            economics.client:
+                base_uri: '%env(APP_ECONOMICS_URI)%'
+                scope: '%env(APP_ECONOMICS_URI)%'
+                headers:
+                    x-api-key: '%env(APP_ECONOMICS_API_KEY)%'
+
 when@test:
     framework:
         test: true

migrations/Version20260520101548.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DoctrineMigrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20260520101548 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return '';
+    }
+
+    public function up(Schema $schema): void
+    {
+        // this up() migration is auto-generated, please modify it to your needs
+        $this->addSql('CREATE TABLE security_contract (id BINARY(16) NOT NULL, created_at DATETIME NOT NULL, modified_at DATETIME NOT NULL, created_by VARCHAR(255) DEFAULT \'\' NOT NULL, modified_by VARCHAR(255) DEFAULT \'\' NOT NULL, economics_id INT NOT NULL, project_name VARCHAR(255) NOT NULL, client_name VARCHAR(255) DEFAULT NULL, hosting_provider VARCHAR(255) DEFAULT NULL, document_url VARCHAR(255) DEFAULT NULL, monthly_price DOUBLE PRECISION DEFAULT NULL, valid_from DATE DEFAULT NULL, valid_to DATE DEFAULT NULL, active TINYINT NOT NULL, eol TINYINT NOT NULL, leantime_url VARCHAR(255) DEFAULT NULL, client_contact_name VARCHAR(255) DEFAULT NULL, client_contact_email VARCHAR(255) DEFAULT NULL, dedicated_server TINYINT NOT NULL, server_size VARCHAR(255) DEFAULT NULL, git_repos LONGTEXT DEFAULT NULL, system_owner_notices JSON DEFAULT NULL, project_tracker_key VARCHAR(255) DEFAULT NULL, quarterly_hours DOUBLE PRECISION DEFAULT NULL, cybersecurity_price DOUBLE PRECISION DEFAULT NULL, cybersecurity_note LONGTEXT DEFAULT NULL, UNIQUE INDEX UNIQ_8AE4AF8B4416F7E8 (economics_id), PRIMARY KEY (id)) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_ci`');
+    }
+
+    public function down(Schema $schema): void
+    {
+        // this down() migration is auto-generated, please modify it to your needs
+        $this->addSql('DROP TABLE security_contract');
+    }
+}

phpstan.dist.neon

@@ -1,5 +1,8 @@
 parameters:
     level: 6
+    # Require a reason on every @phpstan-ignore so the next reader knows
+    # why a check was suppressed. https://phpstan.org/user-guide/ignoring-errors#requiring-comments-for-@phpstan-ignore
+    reportIgnoresWithoutComments: true
     paths:
         - bin/
         - config/

src/Command/SyncServiceAgreementsCommand.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace App\Command;
+
+use App\Service\ServiceAgreementSyncService;
+use Symfony\Component\Console\Attribute\AsCommand;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+#[AsCommand(
+    name: 'app:economics:sync-agreements',
+    description: 'Sync service agreements from Economics',
+)]
+class SyncServiceAgreementsCommand extends Command
+{
+    public function __construct(
+        private readonly ServiceAgreementSyncService $syncService,
+    ) {
+        parent::__construct();
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $io = new SymfonyStyle($input, $output);
+
+        try {
+            $count = $this->syncService->syncAll();
+
+            $io->success(sprintf('Synced %d service agreements successfully.', $count));
+        } catch (\Throwable $e) {
+            $io->error($e->getMessage());
+
+            return Command::FAILURE;
+        }
+
+        return Command::SUCCESS;
+    }
+}

src/Controller/Admin/AbstractFullCrudController.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace App\Controller\Admin;
+
+use App\Trait\ExportCrudControllerTrait;
+use EasyCorp\Bundle\EasyAdminBundle\Config\Action;
+use EasyCorp\Bundle\EasyAdminBundle\Config\ActionGroup;
+use EasyCorp\Bundle\EasyAdminBundle\Config\Actions;
+use EasyCorp\Bundle\EasyAdminBundle\Config\Assets;
+use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;
+use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractCrudController;
+
+abstract class AbstractFullCrudController extends AbstractCrudController
+{
+    use ExportCrudControllerTrait;
+
+    #[\Override]
+    public function configureCrud(Crud $crud): Crud
+    {
+        return $crud->showEntityActionsInlined();
+    }
+
+    #[\Override]
+    public function configureActions(Actions $actions): Actions
+    {
+        // Remove default actions
+        $actions
+            ->remove(Crud::PAGE_INDEX, Action::EDIT)
+            ->remove(Crud::PAGE_INDEX, Action::DELETE);
+
+        // Re-add default actions as grouped action.
+        $groupedDefaultActions = ActionGroup::new('default', 'Default')
+            ->addMainAction(
+                Action::new('show', 'Show')
+                    ->linkToCrudAction(Action::DETAIL)
+            )
+            ->addAction(
+                Action::new('edit', 'Edit')
+                    ->linkToCrudAction(Action::EDIT)
+                    ->setIcon('fa fa-edit')
+            )
+            ->addDivider()
+            ->addAction(
+                Action::new('delete', 'Delete')
+                    ->linkToCrudAction(Action::DELETE)
+                    ->setIcon('fa fa-trash')
+                    ->setCssClass('btn-danger text-danger')
+            );
+
+        return $actions
+            ->add(Crud::PAGE_INDEX, $groupedDefaultActions)
+            ->add(Crud::PAGE_INDEX, $this->createExportAction())
+            ->update(Crud::PAGE_INDEX, Action::NEW,
+                static fn (Action $action) => $action->setIcon('fa fa-plus')
+            )
+        ;
+    }
+
+    #[\Override]
+    public function configureAssets(Assets $assets): Assets
+    {
+        return $assets
+            ->addWebpackEncoreEntry('easyadmin');
+    }
+}

src/Controller/Admin/DashboardController.php

@@ -37,7 +37,7 @@ public function index(): Response
     public function configureDashboard(): Dashboard
     {
         return Dashboard::new()
-            ->setTitle('<img src="/img/itk-sites-logo.png" width="170px" alt="ITK sites">')
+            ->setTitle('<img src="/img/itk-sites-logo.png" width="170px" alt="ITK sites logo">')
             ->setFaviconPath('img/favicon.ico')
             ->renderContentMaximized();
     }
@@ -52,6 +52,7 @@ public function configureMenuItems(): iterable
         yield MenuItem::linkTo(DomainCrudController::class, 'Domains', 'fas fa-link');
         yield MenuItem::linkTo(OIDCCrudController::class, 'OIDC', 'fas fa-key');
         yield MenuItem::linkTo(ServiceCertificateCrudController::class, 'Service certificates', 'fas fa-lock');
+        yield MenuItem::linkTo(SecurityContractCrudController::class, 'Service Agreements', 'fas fa-file-contract');
         yield MenuItem::section('Dependencies');
         yield MenuItem::linkTo(PackageCrudController::class, 'Packages', 'fas fa-cube');
         yield MenuItem::linkTo(PackageVersionCrudController::class, 'Package Versions', 'fas fa-cubes');