chore(test): tests global

Author: DD-Arras

.env

@@ -23,7 +23,7 @@ DATA_DIR=%kernel.project_dir%/var/data
 #---------------------------------------------
 # GPF Entrepot
 #---------------------------------------------
-API_URL=https://validtri.mut-dev.ign.fr/api/validations/
+API_URL=https://validtri.mut-dev.ign.fr/api/validation/
 
 #---------------------------------------------
 # docker defaults

docs/specs/validator-api.yml

@@ -17,7 +17,7 @@ tags:
     description: "Une demande de validation de documents"
 
 paths:
-  /api/validations/:
+  /api/validation/:
     post:
       tags:
         - validation
@@ -47,7 +47,7 @@ paths:
               schema:
                 $ref: "#/components/schemas/Error"
 
-  /api/validations/{uid}:
+  /api/validation/{uid}:
     get:
       tags:
         - validation
@@ -159,7 +159,7 @@ paths:
 
 
 
-  /api/validations/{uid}/results.csv:
+  /api/validation/{uid}/results.csv:
     get:
       tags:
         - validation
@@ -194,7 +194,7 @@ paths:
                 $ref: "#/components/schemas/Error"
 
 
-  /api/validations/{uid}/files/source:
+  /api/validation/{uid}/files/source:
     get:
       tags:
         - validation
@@ -228,7 +228,7 @@ paths:
               schema:
                 $ref: "#/components/schemas/Error"
 
-  /api/validations/{uid}/files/normalized:
+  /api/validation/{uid}/files/normalized:
     get:
       tags:
         - validation

docs/user-guide.md

@@ -6,7 +6,7 @@ Exemple de requête :
 
 ```bash
 curl --request POST \
-  --url ${base_url}/api/validations/ \
+  --url ${base_url}/api/validation/ \
   --header 'Content-Type: multipart/form-data' \
   --header 'content-type: multipart/form-data; boundary=---011000010111000001101001' \
   --form dataset=@92022_PLU_20200415.zip;type=application/x-zip-compressed
@@ -20,7 +20,7 @@ Exemple de requête :
 
 ```bash
 curl --request PATCH \
-  --url  ${base_url}/api/validations/k392kn8syily29qjj18959hs \
+  --url  ${base_url}/api/validation/k392kn8syily29qjj18959hs \
   --header 'Content-Type: application/json' \
   --data '{
             "srs": "EPSG:2154",
@@ -36,7 +36,7 @@ Exemple de requête :
 
 ```bash
 curl --request GET \
-  --url ${base_url}/api/validations/k392kn8syily29qjj18959hs
+  --url ${base_url}/api/validation/k392kn8syily29qjj18959hs
 ```
 
 ### États possibles d'une validation :
@@ -57,7 +57,7 @@ Exemple de requête :
 
 ```bash
 curl --request GET \
-  --url ${base_url}/api/validations/k392kn8syily29qjj18959hs/files/normalized
+  --url ${base_url}/api/validation/k392kn8syily29qjj18959hs/files/normalized
 ```
 
 Le résultat de cette requête est un fichier compressé (zip) nommé {nom_dataset}-normalized.zip et contenant les données normalisées par le validateur.
@@ -66,7 +66,7 @@ Il est également possible de récupérer les fichiers originaux de la validatio
 
 ```bash
 curl --request GET \
-  --url ${base_url}/api/validations/k392kn8syily29qjj18959hs/files/source
+  --url ${base_url}/api/validation/k392kn8syily29qjj18959hs/files/source
 ```
 
 
@@ -76,7 +76,7 @@ Exemple de requête :
 
 ```bash
 curl --request DELETE \
-  --url ${base_url}/api/validations/k392kn8syily29qjj18959hs
+  --url ${base_url}/api/validation/k392kn8syily29qjj18959hs
 ```
 
 Si la suppression se déroule correctement, le statut de réponse sera 204 sans contenu.

package.json

@@ -9,7 +9,7 @@
   },
   "dependencies": {},
   "devDependencies": {
-    "@ignf/validator-client": "git+https://github.com/IGNF/validator-api-client.git#v0.5.3",
+    "@ignf/validator-client": "git+https://github.com/IGNF/validator-api-client.git#v0.5.5",
     "copy-webpack-plugin": "^9.0.1",
     "webpack": "^5.44.0",
     "webpack-cli": "^4.7.2",

src/DataFixtures/ValidationsFixtures.php

@@ -5,6 +5,7 @@
 use App\Entity\Validation;
 use App\Service\ValidatorArgumentsService;
 use App\Storage\ValidationsStorage;
+use App\Validation\ValidationFactory;
 use Doctrine\Bundle\FixturesBundle\Fixture;
 use Doctrine\Persistence\ObjectManager;
 use RuntimeException;
@@ -73,7 +74,8 @@ private function addSampleArchive(Validation $validation, $filename)
             throw new RuntimeException('Sample file not found : ' . $originalPath);
         }
 
-        $validationDirectory = $this->validationsStorage->getDirectory($validation);
+        $this->validationsStorage->init($validation);
+        $validationDirectory = $this->validationsStorage->getPath();
         $fs = new Filesystem();
         $validation->setDatasetName(str_replace('.zip', '', $filename));
         $fs->copy(
@@ -90,15 +92,17 @@ public function load(ObjectManager $em): void
          * validation_no_args - a validation with no args
          */
         $validationNoArgs = new Validation();
+        $validationNoArgs->setUid(ValidationFactory::generateUid());
         $this->addSampleArchive($validationNoArgs, self::FILENAME_SUP_PM3);
         $em->persist($validationNoArgs);
-        $this->addReference(self::VALIDATION_NO_ARGS, $validationNoArgs);
+        $this->addReference( self::VALIDATION_NO_ARGS, $validationNoArgs);
 
         /*
          * validation_archived - a validation that has already been archived
          * (no file, archived)
          */
         $valArchived = new Validation();
+        $valArchived->setUid(ValidationFactory::generateUid());
         $valArchived->setDatasetName('130010853_PM3_60_20180516');
         $valArchived->setStatus(Validation::STATUS_ARCHIVED);
         $em->persist($valArchived);
@@ -110,12 +114,14 @@ public function load(ObjectManager $em): void
         $args = [
             'srs' => 'EPSG:2154',
             'model' => 'https://ignf.github.io/validator/validator-plugin-cnig/src/test/resources/config/cnig_SUP_PM3_2016.json',
+            'keepData' => false
         ];
         $args = $this->valArgsService->validate(\json_encode($args));
 
         $valWithArgs = new Validation();
+        $valWithArgs->setUid(ValidationFactory::generateUid());
         $this->addSampleArchive($valWithArgs, self::FILENAME_SUP_PM3);
-        $valWithArgs->setStatus(Validation::STATUS_PENDING);
+        $valWithArgs->setStatus(Validation::STATUS_WAITING_ARGS);
         $valWithArgs->setArguments($args);
         $em->persist($valWithArgs);
         $this->addReference(self::VALIDATION_WITH_ARGS, $valWithArgs);
@@ -127,12 +133,15 @@ public function load(ObjectManager $em): void
         $args = [
             'srs' => 'EPSG:2154',
             'model' => 'https://www.geoportail-urbanisme.gouv.fr/standard/cnig_SUP_PM3_2016-test.json',
+            'keepData' => false
         ];
         $args = $this->valArgsService->validate(\json_encode($args));
 
         $valWithBadArgs = new Validation();
+        $valWithBadArgs->setUid(ValidationFactory::generateUid());
+
         $this->addSampleArchive($valWithBadArgs, self::FILENAME_SUP_PM3);
-        $valWithBadArgs->setStatus(Validation::STATUS_PENDING);
+        $valWithBadArgs->setStatus(Validation::STATUS_WAITING_ARGS);
         $valWithBadArgs->setArguments($args);
         $em->persist($valWithBadArgs);
         $this->addReference(self::VALIDATION_WITH_BAD_ARGS, $valWithBadArgs);
@@ -143,12 +152,15 @@ public function load(ObjectManager $em): void
         $args = [
             'srs' => 'EPSG:2154',
             'model' => 'https://ignf.github.io/validator/validator-plugin-cnig/src/test/resources/config/cnig_SUP_PM3_2016.json',
+            'keepData' => false
         ];
         $args = $this->valArgsService->validate(\json_encode($args));
 
         $valInvalidRegex = new Validation();
+        $valInvalidRegex->setUid(ValidationFactory::generateUid());
+
         $this->addSampleArchive($valInvalidRegex, self::FILENAME_INVALID_REGEX);
-        $valInvalidRegex->setStatus(Validation::STATUS_PENDING);
+        $valInvalidRegex->setStatus(Validation::STATUS_WAITING_ARGS);
         $valInvalidRegex->setArguments($args);
         $em->persist($valInvalidRegex);
         $this->addReference(self::VALIDATION_INVALID_REGEX, $valInvalidRegex);

src/Entity/.gitignore

@@ -94,21 +94,21 @@ class Validation
     /**
      * Model to use for validation
      *
-     * @ORM\Column(type="text", nullable=false)
+     * @ORM\Column(type="text", nullable=true)
      */
     private $model;
 
     /**
      * SRS to use for validation
      *
-     * @ORM\Column(type="text", nullable=false)
+     * @ORM\Column(type="text", nullable=true)
      */
     private $srs;
 
     /**
      * Whether to keep validation data
      *
-     * @ORM\Column(type="boolean", nullable=false)
+     * @ORM\Column(type="boolean", nullable=true)
      */
     private $keepData;
 
@@ -122,14 +122,14 @@ class Validation
     /**
      * Date of creation
      *
-     * @ORM\Column(type="datetime", nullable=false)
+     * @ORM\Column(type="datetime", nullable=true)
      */
     private $dateCreation;
 
     /**
      * Status
      *
-     * @ORM\Column(type="string", length=16, nullable=false, options={"default":"waiting_for_args"}, columnDefinition="character varying(16) CHECK (status IN ('waiting_for_args','uploadable','patchable','waiting_valid','validated','error','aborted','archived'))")
+     * @ORM\Column(type="string", length=16, nullable=true, options={"default":"waiting_for_args"}, columnDefinition="character varying(16) CHECK (status IN ('waiting_for_args','uploadable','patchable','waiting_valid','validated','error','aborted','archived'))")
      */
     private $status;
 
@@ -172,7 +172,7 @@ class Validation
     /**
      * Whether the validation is currently being processed
      *
-     * @ORM\Column(type="boolean", nullable=false)
+     * @ORM\Column(type="boolean", nullable=true)
      */
     private bool $processing;
 

src/Entity/Validation.php

@@ -23,8 +23,12 @@ public function __construct($projectDir)
      * @return array
      * @throws ApiException
      */
-    public function validate(string $args)
+    public function validate(?string $args)
     {
+        if ($args === null){
+            throw new ApiException("No arguments provided", Response::HTTP_BAD_REQUEST);
+        }
+
         $args = json_decode($args);
 
         $validator = new Validator();

src/Service/ValidatorArgumentsService.php

@@ -77,7 +77,7 @@ function saveFile($file, Validation $validation)
         $this->storage->write($file, true);
     }
 
-    private function generateUid($length = 24)
+    public static function generateUid($length = 24)
     {
         $randomUid = "";
 

src/Validation/ValidationFactory.php

@@ -44,51 +44,6 @@ public function __construct(
         $this->client = $client;
     }
 
-    /**
-     * Archive a given validation removing all local files.
-     *
-     * @param Validation $validation
-     * @return void
-     */
-    public function archive(Validation $validation)
-    {
-        $this->logger->info('Validation[{uid}] : archive removing all files...', [
-            'uid' => $validation->getUid(),
-        ]);
-        $validationDirectory = $this->storage->getDirectory($validation);
-        $fs = new Filesystem();
-        if ($fs->exists($validationDirectory)) {
-            $this->logger->debug('Validation[{uid}] : remove validation directory ...', [
-                'uid' => $validation->getUid(),
-                'validationDirectory' => $validationDirectory,
-            ]);
-            $fs->remove($validationDirectory);
-        }
-
-        // Delete from storage
-        $this->logger->info('Validation[{uid}] : remove upload files', [
-            'uid' => $validation->getUid(),
-        ]);
-        $uploadDirectory = $this->storage->getUploadDirectory($validation);
-        if ($this->storage->getStorage()->directoryExists($uploadDirectory)) {
-            $this->storage->getStorage()->deleteDirectory($uploadDirectory);
-        }
-        $this->logger->info('Validation[{uid}] : remove output files', [
-            'uid' => $validation->getUid(),
-        ]);
-        $outputDirectory = $this->storage->getOutputDirectory($validation);
-        if ($this->storage->getStorage()->directoryExists($outputDirectory)) {
-            $this->storage->getStorage()->deleteDirectory($outputDirectory);
-        }
-        $this->logger->info('Validation[{uid}] : archive removing all files : completed', [
-            'uid' => $validation->getUid(),
-            'status' => Validation::STATUS_ARCHIVED,
-        ]);
-        $validation->setStatus(Validation::STATUS_ARCHIVED);
-        $this->em->persist($validation);
-        $this->em->flush();
-    }
-
     /**
      * Process next pending validation.
      *
@@ -338,13 +293,16 @@ private function cleanUp(Validation $validation)
             'uid' => $validation->getUid(),
         ]);
 
-
-
         $this->storage->cleanLocal();
 
         // clean gpf
     }
 
+    public function archive(Validation $validation): void
+    {
+        $this->cleanUp($validation);
+    }
+
     /**
      * @return ValidationRepository
      */