Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(init): no stop of service if source or resource dir is empty #47

Merged
merged 5 commits into from
Mar 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 4 additions & 2 deletions documentation/developers/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions src/js/resources/resourceManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,8 @@ module.exports = class resourceManager {
}

if (fileList.length === 0) {
LOGGER.warn("Le dossier " + directory + " est vide");
return false;
LOGGER.warn("Le dossier des resources est vide '" + directory + "'");
return true;
}

for (let i = 0; i < fileList.length; i++) {
Expand Down
8 changes: 4 additions & 4 deletions src/js/sources/sourceManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -175,8 +175,8 @@ module.exports = class sourceManager {
}

if (fileList.length === 0) {
LOGGER.warn("Le dossier " + directory + " est vide");
return false;
LOGGER.warn("Le dossier des sources est vide '" + directory + "'");
return true;
}

for (let i = 0; i < fileList.length; i++) {
Expand Down Expand Up @@ -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 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -434,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)
Expand Down Expand Up @@ -467,6 +475,24 @@ 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
lgrd marked this conversation as resolved.
Show resolved Hide resolved
When I test the configuration
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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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();
});
Expand Down Expand Up @@ -129,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) {
Expand Down
20 changes: 13 additions & 7 deletions test/functional/configuration/cucumber/features/support/world.js
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down Expand Up @@ -631,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
Expand Down