Merge pull request #25 from itk-dev/feature/ITSTYR-81_symfony6upgrade

feature/ITSTYR 81 symfony6upgrade

Author: cableman

.docker/data/.gitignore

@@ -0,0 +1,5 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore
+!Readme.md

.docker/data/README.md

@@ -0,0 +1,26 @@
+# .docker/data
+
+Please map persistent volumes to this directory on the servers.
+
+If a container needs to persist data between restarts you can map the relevant files in the container to ``docker/data/<container-name>`.
+
+## RabbitMQ example
+If you are using RabbitMQ running in a container as a message broker you need to configure a persistent volume for RabbitMQs data directory to avoid losing message on container restarts.
+
+```yaml
+# docker-compose.server.override.yml
+
+services:
+  rabbit:
+    image: rabbitmq:3.9-management-alpine
+    hostname: "${COMPOSE_PROJECT_NAME}"
+    networks:
+      - app
+      - frontend
+    environment:
+      - "RABBITMQ_DEFAULT_USER=${RABBITMQ_USER}"
+      - "RABBITMQ_DEFAULT_PASS=${RABBITMQ_PASSWORD}"
+      - "RABBITMQ_ERLANG_COOKIE=${RABBITMQ_ERLANG_COOKIE}"
+    volumes:
+      - ".docker/data/rabbitmq:/var/lib/rabbitmq/mnesia/"
+```

.docker/vhost.conf

@@ -9,6 +9,10 @@ server {
     }
 
     location ~ ^/index\.php(/|$) {
+        fastcgi_buffers 16 32k;
+        fastcgi_buffer_size 64k;
+        fastcgi_busy_buffers_size 64k;
+
         fastcgi_pass phpfpm:9000;
         fastcgi_split_path_info ^(.+\.php)(/.*)$;
         include fastcgi_params;

.env

@@ -22,10 +22,14 @@ MAILER_URL=smtp://mailhog:1025
 ###< symfony/swiftmailer-bundle ###
 
 ###> doctrine/doctrine-bundle ###
-# Format described at http://docs.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url
-# For an SQLite database, use: "sqlite:///%kernel.project_dir%/var/data.db"
-# Configure your db driver and server_version in config/packages/doctrine.yaml
-DATABASE_URL=mysql://db:db@mariadb:3306/db
+# Format described at https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url
+# IMPORTANT: You MUST configure your server version, either here or in config/packages/doctrine.yaml
+#
+# DATABASE_URL="sqlite:///%kernel.project_dir%/var/data.db"
+# DATABASE_URL="mysql://app:!ChangeMe!@127.0.0.1:3306/app?serverVersion=8.0.32&charset=utf8mb4"
+# DATABASE_URL="mysql://app:!ChangeMe!@127.0.0.1:3306/app?serverVersion=10.11.2-MariaDB&charset=utf8mb4"
+# DATABASE_URL=mysql://db:db@mariadb:3306/db
+DATABASE_URL="mysql://db:db@mariadb:3306/db?serverVersion=10.11.2-MariaDB&charset=utf8mb4"
 ###< doctrine/doctrine-bundle ###
 
 ###> fos/fos-user-bundle ###

.env.test

@@ -0,0 +1,6 @@
+# define your env variables for the test env here
+KERNEL_CLASS='App\Kernel'
+APP_SECRET='$ecretf0rt3st'
+SYMFONY_DEPRECATIONS_HELPER=999999
+PANTHER_APP_ENV=panther
+PANTHER_ERROR_SCREENSHOT_DIR=./var/error-screenshots

.gitignore

@@ -1,21 +1,28 @@
+### IDE ###
+.idea
+## IDE ###
 ###> symfony/framework-bundle ###
+/.env.local
+/.env.local.php
+/.env.*.local
+/config/secrets/prod/prod.decrypt.private.php
 /public/bundles/
 /var/
 /vendor/
+/testdata/
 ###< symfony/framework-bundle ###
 
-###> symfony/webpack-encore-pack ###
-/node_modules/
-/public/build/
-npm-debug.log
-yarn-error.log
-###< symfony/webpack-encore-pack ###
-
 ###> symfony/phpunit-bridge ###
-.phpunit
+.phpunit.result.cache
 /phpunit.xml
 ###< symfony/phpunit-bridge ###
 
-###> symfony/web-server-bundle ###
-/.web-server-pid
-###< symfony/web-server-bundle ###
+### <Coding standard> ###
+.php-cs-fixer.cache
+### <Coding standard> ###
+
+### OTHER ###
+###> friendsofphp/php-cs-fixer ###
+/.php-cs-fixer.php
+/.php-cs-fixer.cache
+###< friendsofphp/php-cs-fixer ###

.php-cs-fixer.dist.php

@@ -0,0 +1,18 @@
+<?php
+
+$finder = (new PhpCsFixer\Finder())
+    ->in(__DIR__)
+    ->exclude(['var', 'vendor', 'node_modules'])
+
+;
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@Symfony' => true,
+        'multiline_whitespace_before_semicolons' => ['strategy' => 'new_line_for_chained_calls'],
+        // @see https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/rules/import/ordered_imports.rst
+        'ordered_imports' => ['imports_order' => ['const', 'class', 'function']],
+    ])
+
+    ->setFinder($finder)
+;

.php-version

@@ -3,30 +3,93 @@ Styringsværktøj til IT projekter
 
 ## Setup locally
 
+### Preset
+Make sure you have a set of JSON files for testing import Commands.
+
 ### Start Docker containers
 
 ```sh
-docker-compose up -d
-docker-compose exec phpfpm composer install
-docker-compose exec phpfpm bin/console doctrine:migrations:migrate --no-interaction
+docker compose up -d
+docker compose exec phpfpm composer install
+docker compose exec phpfpm bin/console doctrine:migrations:migrate --no-interaction
 ```
 
 ### Create a super admin user
 
 ```sh
-docker-compose exec phpfpm bin/console fos:user:create --super-admin
+docker compose exec phpfpm bin/console SuperUser
 ```
 
 ### Access the site
 
 You should now be able to browse to the application
 
 ```
-open http://$(docker-compose port nginx 80)
+
+open "http://$(docker-compose port nginx 8080)"
+
 ```
 
 ## Import systems and reports
 ```sh
-bin/console itstyr:import:system PATH
-bin/console itstyr:import:report PATH
+docker compose exec phpfpm bin/console itstyr:import:system PATH
+docker compose exec phpfpm bin/console itstyr:import:report PATH
+```
+
+### Flowchart
+
+A helpful flowchart over the Entities, and Joinedtables.
+Ilustrative figures meaning:
+1. Database = Database
+2. Black square = Entities
+3. Grey square = relations
+4. Hexagon = Joinedtables
+5. arrow = relation between DB and Entity
+6. bulletin = shows the mapping Entities in Jointables, and JoinCollums
+
+```mermaid
+flowchart TD
+ Answers[Answers]
+ Category[Category]
+ Group[Group]
+ ImportRun[ImportrRun]
+ Question[Question]
+ Report[Report]
+ SelServiceAFI[SelServiceAFI]
+ System[System]
+ Theme[Theme]
+ ThemeCategory[ThemeCategory]
+ User[User]
+ 
+ fos_user_user_group{{JoinTable: fos_user_user_group }}
+ group_system_themes{{JoinTable: group_system_themes }}
+ group_report_themes{{JoinTable: group_report_themes }}
+
+ Database[(Database)] --> Answers & Category & Group & ImportRun & Question  & Report & SelServiceAFI & System & Theme & ThemeCategory & User
+
+ User---|ManyToMany| Group
+  User -- JoinTable User and Group --o fos_user_user_group
+
+ Group---|ManyToMany| Report
+ Group---|ManyToMany| System
+ Group---|ManyToMany| Theme
+  Group -- JoinTable Theme and Group --o group_system_themes
+ Group---|ManyToMany| Theme
+  Group -- JoinTable Theme and Group --o group_report_themes
+
+ Report --- |ManyToOne| Answers
+
+ System --- |ManyToOne| Answers
+ System --- |ManyToMany| SelServiceAFI
+
+ Theme --- |ManyToOne| ThemeCategory
+ 
+ Answers --- |ManyToOne| Question
+  Question -- JoinCollum Answers and Question --o Answers
+
+ ThemeCategory --- |ManyToOne| Category
+  Category -- JoinCollum ThemeCategory and Category --o ThemeCategory
+
+ Question --- |ManyToOne| Category
 ```
+

README.md

@@ -3,37 +3,19 @@
 
 use App\Kernel;
 use Symfony\Bundle\FrameworkBundle\Console\Application;
-use Symfony\Component\Console\Input\ArgvInput;
-use Symfony\Component\Debug\Debug;
-use Symfony\Component\Dotenv\Dotenv;
 
-set_time_limit(0);
-
-require __DIR__.'/../vendor/autoload.php';
-
-if (!class_exists(Application::class)) {
-    throw new \RuntimeException('You need to add "symfony/framework-bundle" as a Composer dependency.');
+if (!is_dir(dirname(__DIR__).'/vendor')) {
+    throw new LogicException('Dependencies are missing. Try running "composer install".');
 }
 
-if (!isset($_SERVER['APP_ENV'])) {
-    if (!class_exists(Dotenv::class)) {
-        throw new \RuntimeException('APP_ENV environment variable is not defined. You need to define environment variables for configuration or add "symfony/dotenv" as a Composer dependency to load variables from a .env file.');
-    }
-    (new Dotenv())->load(__DIR__.'/../.env');
+if (!is_file(dirname(__DIR__).'/vendor/autoload_runtime.php')) {
+    throw new LogicException('Symfony Runtime is missing. Try running "composer require symfony/runtime".');
 }
 
-$input = new ArgvInput();
-$env = $input->getParameterOption(['--env', '-e'], $_SERVER['APP_ENV'] ?? 'dev', true);
-$debug = (bool) ($_SERVER['APP_DEBUG'] ?? ('prod' !== $env)) && !$input->hasParameterOption('--no-debug', true);
+require_once dirname(__DIR__).'/vendor/autoload_runtime.php';
 
-if ($debug) {
-    umask(0000);
-
-    if (class_exists(Debug::class)) {
-        Debug::enable();
-    }
-}
+return function (array $context) {
+    $kernel = new Kernel($context['APP_ENV'], (bool) $context['APP_DEBUG']);
 
-$kernel = new Kernel($env, $debug);
-$application = new Application($kernel);
-$application->run($input);
+    return new Application($kernel);
+};