Integration of the toolbox.sh script and associated unit tests to install the SonarQube development environment

[christopherlouet]

• Add toolbox.sh utility script for SonarQube development environment installation
• Add utils.sh script to launch toolbox commands
• Addition of the pytest framework for unit testing bash scripts

[dedece35]

error during execution of toolbox.sh

   ~/git_ecocode/ecoCode-java   PR_62 ✔  ./toolbox.sh                                                                                                                            
./toolbox.sh: line 14: declare: -A: invalid option
declare: usage: declare [-afFirtx] [-p] [name[=value] ...]
Usage toolbox.sh [OPTIONS] COMMAND
Commands:
init                Initialize and creating containers
start               Starting Docker containers
stop                Stopping Docker containers
clean               Stop and remove containers, networks and volumes
build               Build the ecoCode plugin
compile             Compile the ecoCode plugin
build-docker        Build Docker services
release             Create a new release
release-push        Push the new release
Options:
-l, --logs          Display Docker container logs
-p, --push          Push the new release
-f, --force         To delete the target folder or recompile the source code
--token=<TOKEN>     Creating containers with previously created token
-h, --help          Display help
-v, --verbose       Make the command more talkative

[dedece35]

error after checking the result => no plugin deployed

[christopherlouet]

The “declare: -A: invalid option” error is linked to the use of bash on macOS, which is not recent (3.2?). The shebang line “#!/usr/bin/env bash” should have used the most recent version of bash (4.0 or higher) located in /usr/local/bin/bash.
As a precaution, a correction will be made to make the array compatible with bash v3.
The documentation for this script will be updated in the README and the ecoCode-common project today.

[dedece35]

ok for correction ... but the main problem is the JAR deployment to correct

[christopherlouet]

As a first step, I propose to update the script documentation directly in the README, as these new utilities are currently only used in the ecoCode-java project.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[dedece35]

put a comment for these 2 options, please

[christopherlouet]

Following on from the last point, here are the changes to be made in the future:

• add a patch to correctly copy the jar file to the target folder
• update documentation on environment variables in .default.docker.env file
• display in the console the port used by the SonarQube web interface
• don't use mkdocs to view API documutation, the markdown file will suffice for now
• include a patch in the toolbox.Dockerfile for macOS compatibility
• externalize tooling in ecoCode-common so that the toolbox can be used in other ecoCode projects
• create a toolbox-wrapper script to retrieve the toolbox from the ecoCode-Common project
• include architecture documentation in the ecoCode-common project to explain how the toolbox works

[github-actions]

This PR has been automatically marked as stale because it has no activity for 30 days.
Please add a comment if you want to keep the issue open. Thank you for your contributions!