From 6afd5a95c88eaa527a99c65a65cbac458391f913 Mon Sep 17 00:00:00 2001 From: jmkerloch Date: Mon, 13 Mar 2023 12:15:53 +0100 Subject: [PATCH 1/5] feat(init): no stop of service if source or resource dir is empty --- src/js/resources/resourceManager.js | 2 +- src/js/sources/sourceManager.js | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/js/resources/resourceManager.js b/src/js/resources/resourceManager.js index ac13fe5..80e9221 100644 --- a/src/js/resources/resourceManager.js +++ b/src/js/resources/resourceManager.js @@ -88,7 +88,7 @@ module.exports = class resourceManager { if (fileList.length === 0) { LOGGER.warn("Le dossier " + directory + " est vide"); - return false; + return true; } for (let i = 0; i < fileList.length; i++) { diff --git a/src/js/sources/sourceManager.js b/src/js/sources/sourceManager.js index fe30acc..b3b226a 100644 --- a/src/js/sources/sourceManager.js +++ b/src/js/sources/sourceManager.js @@ -176,7 +176,7 @@ module.exports = class sourceManager { if (fileList.length === 0) { LOGGER.warn("Le dossier " + directory + " est vide"); - return false; + return true; } for (let i = 0; i < fileList.length; i++) { @@ -1005,8 +1005,8 @@ module.exports = class sourceManager { LOGGER.info("Connexion de l'ensemble des sources..."); if (this._loadedSourceId.length === 0) { - LOGGER.error("Aucune source n'est disponible"); - return false; + LOGGER.warn("Aucune source n'est disponible"); + return true; } try { From 69f421f7d466b769d651e3b9dfd55eb4e90a283b Mon Sep 17 00:00:00 2001 From: jmkerloch Date: Mon, 13 Mar 2023 15:10:06 +0100 Subject: [PATCH 2/5] feat(test): add test for log in case of empty source or resource dir --- src/js/resources/resourceManager.js | 2 +- src/js/sources/sourceManager.js | 2 +- .../cucumber/features/conf-service.feature | 16 ++++++++++++++++ .../cucumber/features/support/steps.js | 4 ++++ .../cucumber/features/support/world.js | 10 ++++++++++ 5 files changed, 32 insertions(+), 2 deletions(-) diff --git a/src/js/resources/resourceManager.js b/src/js/resources/resourceManager.js index 80e9221..e07c2f9 100644 --- a/src/js/resources/resourceManager.js +++ b/src/js/resources/resourceManager.js @@ -87,7 +87,7 @@ module.exports = class resourceManager { } if (fileList.length === 0) { - LOGGER.warn("Le dossier " + directory + " est vide"); + LOGGER.warn("Le dossier des resources est vide '" + directory + "'"); return true; } diff --git a/src/js/sources/sourceManager.js b/src/js/sources/sourceManager.js index b3b226a..8b23b6f 100644 --- a/src/js/sources/sourceManager.js +++ b/src/js/sources/sourceManager.js @@ -175,7 +175,7 @@ module.exports = class sourceManager { } if (fileList.length === 0) { - LOGGER.warn("Le dossier " + directory + " est vide"); + LOGGER.warn("Le dossier des sources est vide '" + directory + "'"); return true; } diff --git a/test/functional/configuration/cucumber/features/conf-service.feature b/test/functional/configuration/cucumber/features/conf-service.feature index 82991b1..15db95d 100644 --- a/test/functional/configuration/cucumber/features/conf-service.feature +++ b/test/functional/configuration/cucumber/features/conf-service.feature @@ -396,6 +396,14 @@ Feature: Road2 service configuration Then the configuration analysis should give an exit code 1 Then the server log should contain "Mauvaise configuration: Champ 'application:resources:directories' manquant !" + Scenario: [service.json] (resources.directories sans aucune resource) + Given a valid configuration + And an empty directory "empty_resource" + And with parameter "empty_resource" for attribute "application.resources.directories.[0]" in service configuration + When I test the configuration + Then the configuration analysis should give an exit code 0 + Then the server log should contain "Le dossier des resources est vide" + # TODO # Tester un dossier de ressources dont une des ressources ne peut être lues @@ -467,6 +475,14 @@ Feature: Road2 service configuration Then the configuration analysis should give an exit code 1 Then the server log should contain "Mauvaise configuration: Champ 'application:sources:directories' manquant !" + Scenario: [service.json] (sources.directories sans aucune sources) + Given a valid configuration + And an empty directory "empty_sources" + And with parameter "empty_sources" for attribute "application.sources.directories.[0]" in service configuration + When I test the configuration + Then the configuration analysis should give an exit code 0 + Then the server log should contain "Le dossier des sources est vide" + # TODO # Tester un dossier de ressources dont une des ressources ne peut être lues diff --git a/test/functional/configuration/cucumber/features/support/steps.js b/test/functional/configuration/cucumber/features/support/steps.js index ab6a7f8..9c9ba65 100644 --- a/test/functional/configuration/cucumber/features/support/steps.js +++ b/test/functional/configuration/cucumber/features/support/steps.js @@ -50,6 +50,10 @@ Given("a file {string} non readable", function(relativeFilePath) { this.createFile(relativeFilePath, "", false); }); +Given("an empty directory {string}", function(dirname) { + this.createDir(dirname); +}); + Given("a server configuration non readable", function() { this.nonReadableServerConfiguration(); }); diff --git a/test/functional/configuration/cucumber/features/support/world.js b/test/functional/configuration/cucumber/features/support/world.js index 9fc42bd..d3d7dab 100644 --- a/test/functional/configuration/cucumber/features/support/world.js +++ b/test/functional/configuration/cucumber/features/support/world.js @@ -491,6 +491,16 @@ class road2World { } + // Creation de répertoire + createDir(dirname) { + try { + fs.mkdirSync(path.join(this._tmpDirConf, dirname)); + } catch(error) { + throw "Can't create directory " + dirname + " : " + error; + } + return true + } + createWrongJSONFile(relativeFilePath) { try { From ba13b695ca09280046360861648bbb87379c5740 Mon Sep 17 00:00:00 2001 From: Loic Date: Mon, 13 Mar 2023 15:28:06 +0100 Subject: [PATCH 3/5] [doc] update concepts doc --- documentation/developers/concepts.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/documentation/developers/concepts.md b/documentation/developers/concepts.md index f1db7d5..42da64d 100644 --- a/documentation/developers/concepts.md +++ b/documentation/developers/concepts.md @@ -144,9 +144,11 @@ Ce service est l'objet qui permet de gérer les ressources proposées par l'inst Chaque ressource contient plusieurs sources. Étant donné que plusieurs ressources peuvent pointer vers des sources communes, le service contient un catalogue de sources uniques et un manager de ces sources. -Lorsque l'application est lancée, on commence par lire la configuration de l'application pour être capable d'instancier le logger. Une fois que le logger est chargé, on vérifie complètement la configuration. +Lorsque l'application est lancée, on commence par lire la configuration de l'application pour être capable d'instancier le logger. -Après cela, on charge les ressources et les sources du service indiquées dans la configuration. C'est à ce moment que les fichiers sont lus, stockés en RAM si nécessaire, et que les connexions aux bases de données sont effectuées. +Une fois que le logger est chargé, on vérifie complètement la configuration. Il est possible de configurer un service avec des dossiers de sources et de ressources vides. Ils pourront être remplis plus tard. Cependant, ces dossier doivent être indiqués lors de la configuration du service. + +Après cela, on charge les ressources et les sources du service indiquées dans la configuration s'il y en a. C'est à ce moment que les fichiers sont lus, stockés en RAM si nécessaire, et que les connexions aux bases de données sont effectuées. Enfin, on finit par charger les APIs exposées par le service. C'est là qu'ExpressJS crée le ou les serveurs Node et charge les routes disponibles. From e23189534508eef95c41fed3e4c61ae8b8dbb217 Mon Sep 17 00:00:00 2001 From: jmkerloch Date: Mon, 13 Mar 2023 15:51:58 +0100 Subject: [PATCH 4/5] feat(changelog): update for empty source and resource dir at init --- changelog.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/changelog.md b/changelog.md index 5d1fcbd..b3c87a1 100644 --- a/changelog.md +++ b/changelog.md @@ -7,7 +7,8 @@ ADDED: CHANGED: - La documentation de l'API d'administration a été grandement enrichie. - - La route /health a une réponse plus complète et est vraiment codée pour prendre en compte l'état de chaque service et chaque source disponibles. + - La route /health a une réponse plus complète et est vraiment codée pour prendre en compte l'état de chaque service et chaque source disponibles. + - Les dossiers de sources et de resources des services peuvent maintenant être vide à l'initialisation. ## 2.0.0 From a45d7a5924f93225cdbb99df455b5247fbdca204 Mon Sep 17 00:00:00 2001 From: Loic Date: Tue, 14 Mar 2023 10:29:10 +0100 Subject: [PATCH 5/5] [test] fix exit code function, add tests --- .../cucumber/features/conf-service.feature | 16 +++++++++++++--- .../cucumber/features/support/steps.js | 2 +- .../cucumber/features/support/world.js | 10 +++------- 3 files changed, 17 insertions(+), 11 deletions(-) diff --git a/test/functional/configuration/cucumber/features/conf-service.feature b/test/functional/configuration/cucumber/features/conf-service.feature index 15db95d..e2665eb 100644 --- a/test/functional/configuration/cucumber/features/conf-service.feature +++ b/test/functional/configuration/cucumber/features/conf-service.feature @@ -363,7 +363,7 @@ Feature: Road2 service configuration Given a valid configuration And with parameter "test" for attribute "application.resources.directories.[1]" in service configuration When I test the configuration - Then the configuration analysis should give an exit code 0 + Then the configuration analysis should give an exit code 1 Then the server log should contain "Mauvaise configuration: Le dossier n'existe pas:" Scenario: [service.json] (resources.directories sur deux dossiers qui n'existent pas et en chemins relatifs) @@ -442,7 +442,7 @@ Feature: Road2 service configuration Given a valid configuration And with parameter "test" for attribute "application.sources.directories.[1]" in service configuration When I test the configuration - Then the configuration analysis should give an exit code 0 + Then the configuration analysis should give an exit code 1 Then the server log should contain "Mauvaise configuration: Le dossier n'existe pas:" Scenario: [service.json] (sources.directories sur deux dossiers qui n'existent pas et en chemins relatifs) @@ -480,8 +480,18 @@ Feature: Road2 service configuration And an empty directory "empty_sources" And with parameter "empty_sources" for attribute "application.sources.directories.[0]" in service configuration When I test the configuration - Then the configuration analysis should give an exit code 0 + Then the configuration analysis should give an exit code 1 Then the server log should contain "Le dossier des sources est vide" + Then the server log should contain "La ressource contient une source non disponible" + + Given a valid configuration + And an empty directory "empty_resource" + And with parameter "empty_resource" for attribute "application.resources.directories.[0]" in service configuration + And an empty directory "empty_sources" + And with parameter "empty_sources" for attribute "application.sources.directories.[0]" in service configuration + When I test the configuration + Then the configuration analysis should give an exit code 0 + Then the server log should contain "Le dossier des resources est vide" # TODO # Tester un dossier de ressources dont une des ressources ne peut être lues diff --git a/test/functional/configuration/cucumber/features/support/steps.js b/test/functional/configuration/cucumber/features/support/steps.js index 9c9ba65..b365f04 100644 --- a/test/functional/configuration/cucumber/features/support/steps.js +++ b/test/functional/configuration/cucumber/features/support/steps.js @@ -133,7 +133,7 @@ When("I test the configuration", function(done) { }); Then("the configuration analysis should give an exit code {int}", function(code) { - assert.equal(this.verifyCommandExitCode(code), true); + assert.equal(this.returnCommandExitCode(), code); }); Then("the server log should contain {string}", function(message) { diff --git a/test/functional/configuration/cucumber/features/support/world.js b/test/functional/configuration/cucumber/features/support/world.js index d3d7dab..de29cb9 100644 --- a/test/functional/configuration/cucumber/features/support/world.js +++ b/test/functional/configuration/cucumber/features/support/world.js @@ -641,15 +641,11 @@ class road2World { } - // Analyse du code de retour de la commande - verifyCommandExitCode(code) { + // Retourne le code de la commande + returnCommandExitCode() { - if (code === this._code) { - return true; - } else { return this._code; - } - + } // Analyse des logs