Add option for docker image in nightly regression testing

[EmbeddedDevops1]

PR Type

Enhancement, Documentation

---

Description

• Added --docker-image option to the integration test scripts.
• Modified logic to handle both --dockerfile and --docker-image options in test_with_docker.sh.
• Ensured either --dockerfile or --docker-image is provided in test_with_docker.sh.
• Updated test_all.sh to use the new --docker-image option.
• Improved formatting in multiple README files across different templated test projects.

---

Changes walkthrough 📝

	Relevant files
Enhancement	2 files test_all.sh Update Docker option in test script                                            tests_integration/test_all.sh Changed --dockerfile option to --docker-image in the test script. +1/-1      test_with_docker.sh Add and handle `--docker-image` option in test script        tests_integration/test_with_docker.sh Added --docker-image option. Modified logic to handle both --dockerfile and --docker-image. Added checks to ensure either --dockerfile or --docker-image is provided. +19/-5
Documentation	8 files README.md Improve formatting in README                                                          templated_tests/cpp_cli/README.md - Minor formatting improvements. +0/-4      README.md Improve formatting in README                                                          templated_tests/csharp_webservice/README.md - Minor formatting improvements. +2/-6      README.md Improve formatting in README                                                          templated_tests/go_webservice/README.md - Minor formatting improvements. +0/-7      README.md Improve formatting in README                                                          templated_tests/java_gradle/README.md - Minor formatting improvements. +1/-1      README.md Improve formatting in README                                                          templated_tests/js_vanilla/README.md - Minor formatting improvements. +0/-3      README.md Improve formatting in README                                                          templated_tests/python_fastapi/README.md - Minor formatting improvements. +1/-1      README.md Improve formatting in README                                                          templated_tests/react_calculator/README.md - Minor formatting improvements. +0/-8      README.md Improve formatting in README                                                          templated_tests/ruby_sinatra/README.md - Minor formatting improvements. +0/-17

---

💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[pr-agent-pro-staging[bot]]

PR Reviewer Guide 🔍

(Review updated until commit https://github.com/Codium-ai/cover-agent/commit/f89cbb16b4f68ab8e4bbb4be355c3e9fa8e4ae07)

⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Key issues to review Logic Redundancy The script checks for the presence of either `DOCKERFILE` or `DOCKER_IMAGE` but does not handle the case where both might be provided, which could lead to unexpected behavior or Docker image conflicts. Error Handling The script exits with a generic error code `1` for different types of errors without any specific error differentiation. This could make debugging more difficult when integrating with other systems or scripts that rely on specific exit codes for different error types.

[codiumai-pr-agent-pro[bot]]

Persistent review updated to latest commit https://github.com/Codium-ai/cover-agent/commit/f89cbb16b4f68ab8e4bbb4be355c3e9fa8e4ae07

[pr-agent-pro-staging[bot]]

PR Code Suggestions ✨

Latest suggestions up to f89cbb1

Category	Suggestion	Score
Possible issue	Add a check to prevent simultaneous provision of both DOCKERFILE and DOCKER_IMAGE ___ **Add a check to ensure that both DOCKERFILE and DOCKER_IMAGE are not provided simultaneously, as this could lead to ambiguous behavior on whether to build or pull an image.** [tests_integration/test_with_docker.sh [59-61]](https://github.com/Codium-ai/cover-agent/pull/139/files#diff-22b862bfac27a48d3f8fc102221e4d610b8db0f15f416cdf1e507753eab1208dR59-R61) ```diff if [ -z "$DOCKERFILE" ] && [ -z "$DOCKER_IMAGE" ]; then echo "Missing required parameters: either --dockerfile or --docker-image must be provided" exit 1 +elif [ -n "$DOCKERFILE" ] && [ -n "$DOCKER_IMAGE" ]; then + echo "Conflicting parameters: both --dockerfile and --docker-image cannot be provided simultaneously" + exit 1 fi ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 10 Why: This suggestion addresses a potential conflict that could lead to ambiguous behavior, ensuring that only one of the parameters is provided, which is crucial for the correct functioning of the script.	10
	Add a directory existence check before building the Docker image to prevent build failures ___ **Ensure that the docker build command includes error handling for cases where the Dockerfile directory might not exist, preventing unclear errors.** [tests_integration/test_with_docker.sh [67]](https://github.com/Codium-ai/cover-agent/pull/139/files#diff-22b862bfac27a48d3f8fc102221e4d610b8db0f15f416cdf1e507753eab1208dR67-R67) ```diff -docker build -t cover-agent-image -f "$DOCKERFILE" "$(dirname "$DOCKERFILE")" +DOCKERFILE_DIR="$(dirname "$DOCKERFILE")" +if [ ! -d "$DOCKERFILE_DIR" ]; then + echo "Dockerfile directory does not exist: $DOCKERFILE_DIR" + exit 1 +fi +docker build -t cover-agent-image -f "$DOCKERFILE" "$DOCKERFILE_DIR" ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 8 Why: Checking for the existence of the Dockerfile directory before attempting to build prevents unclear errors and improves the reliability of the script.	8
Best practice	Implement error handling for Docker operations to ensure robust script execution ___ **Add error handling for Docker commands to manage build or pull failures gracefully.** [tests_integration/test_with_docker.sh [67-71]](https://github.com/Codium-ai/cover-agent/pull/139/files#diff-22b862bfac27a48d3f8fc102221e4d610b8db0f15f416cdf1e507753eab1208dR67-R71) ```diff -docker build -t cover-agent-image -f "$DOCKERFILE" "$(dirname "$DOCKERFILE")" -docker pull "$DOCKER_IMAGE" -docker tag "$DOCKER_IMAGE" cover-agent-image +if ! docker build -t cover-agent-image -f "$DOCKERFILE" "$(dirname "$DOCKERFILE")"; then + echo "Docker build failed" + exit 1 +fi +if ! docker pull "$DOCKER_IMAGE"; then + echo "Docker pull failed" + exit 1 +fi +if ! docker tag "$DOCKER_IMAGE" cover-agent-image; then + echo "Docker tag operation failed" + exit 1 +fi ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 9 Why: Adding error handling for Docker commands is a best practice that enhances the robustness of the script, ensuring that failures are managed gracefully.	9
Enhancement	Use a variable for Docker image tags to enhance flexibility and prevent conflicts ___ **Replace the hardcoded Docker image tag 'cover-agent-image' with a variable to allow dynamic naming and avoid potential conflicts or overwrites in Docker image tagging.** [tests_integration/test_with_docker.sh [67-71]](https://github.com/Codium-ai/cover-agent/pull/139/files#diff-22b862bfac27a48d3f8fc102221e4d610b8db0f15f416cdf1e507753eab1208dR67-R71) ```diff -docker build -t cover-agent-image -f "$DOCKERFILE" "$(dirname "$DOCKERFILE")" -docker tag "$DOCKER_IMAGE" cover-agent-image +IMAGE_TAG="custom-image-tag" # Define your desired tag +docker build -t "$IMAGE_TAG" -f "$DOCKERFILE" "$(dirname "$DOCKERFILE")" +docker tag "$DOCKER_IMAGE" "$IMAGE_TAG" ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 7 Why: Using a variable for Docker image tags improves flexibility and maintainability, but it is not as critical as preventing simultaneous provision of conflicting parameters.	7

---

Previous suggestions

Suggestions up to commit f89cbb1

Category	Suggestion	Score
Possible issue	Add error handling for Docker commands to enhance script robustness ___ **To enhance the script's robustness, add a check to ensure that the Docker commands succeed before proceeding. This can prevent cascading failures in the script.** [tests_integration/test_with_docker.sh [67-71]](https://github.com/Codium-ai/cover-agent/pull/139/files#diff-22b862bfac27a48d3f8fc102221e4d610b8db0f15f416cdf1e507753eab1208dR67-R71) ```diff -docker build -t cover-agent-image -f "$DOCKERFILE" "$(dirname "$DOCKERFILE")" -docker pull "$DOCKER_IMAGE" -docker tag "$DOCKER_IMAGE" cover-agent-image +if ! docker build -t cover-agent-image -f "$DOCKERFILE" "$(dirname "$DOCKERFILE")"; then + echo "Docker build failed" + exit 1 +fi +if ! docker pull "$DOCKER_IMAGE"; then + echo "Docker pull failed" + exit 1 +fi +if ! docker tag "$DOCKER_IMAGE" cover-agent-image; then + echo "Docker tag failed" + exit 1 +fi ``` Suggestion importance[1-10]: 10 Why: Adding error handling for Docker commands is crucial for preventing cascading failures and ensuring the script fails gracefully, which significantly enhances robustness.	10
	Add a check for conflicting parameters when both DOCKERFILE and DOCKER_IMAGE are provided ___ **To ensure robustness in the script, it's recommended to check if both DOCKERFILE and DOCKER_IMAGE are provided and print a specific error message. This helps in avoiding confusion when both parameters are mistakenly supplied.** [tests_integration/test_with_docker.sh [59-61]](https://github.com/Codium-ai/cover-agent/pull/139/files#diff-22b862bfac27a48d3f8fc102221e4d610b8db0f15f416cdf1e507753eab1208dR59-R61) ```diff if [ -z "$DOCKERFILE" ] && [ -z "$DOCKER_IMAGE" ]; then echo "Missing required parameters: either --dockerfile or --docker-image must be provided" exit 1 +elif [ -n "$DOCKERFILE" ] && [ -n "$DOCKER_IMAGE" ]; then + echo "Conflicting parameters: both --dockerfile and --docker-image cannot be provided simultaneously" + exit 1 fi ``` Suggestion importance[1-10]: 9 Why: This suggestion addresses a potential issue where both parameters might be provided simultaneously, which could lead to confusion or unexpected behavior. Adding this check improves the robustness of the script.	9
Enhancement	Use a variable for the Docker image name to increase flexibility ___ **Instead of hardcoding the image name 'cover-agent-image' during the Docker build and pull commands, consider using a variable to allow for more flexibility and configurability.** [tests_integration/test_with_docker.sh [67-71]](https://github.com/Codium-ai/cover-agent/pull/139/files#diff-22b862bfac27a48d3f8fc102221e4d610b8db0f15f416cdf1e507753eab1208dR67-R71) ```diff -docker build -t cover-agent-image -f "$DOCKERFILE" "$(dirname "$DOCKERFILE")" -docker tag "$DOCKER_IMAGE" cover-agent-image +IMAGE_NAME="cover-agent-image" +docker build -t "$IMAGE_NAME" -f "$DOCKERFILE" "$(dirname "$DOCKERFILE")" +docker tag "$DOCKER_IMAGE" "$IMAGE_NAME" ``` Suggestion importance[1-10]: 7 Why: Using a variable for the Docker image name enhances flexibility and configurability, making the script more adaptable to different contexts.	7
Maintainability	Improve variable names for better clarity and maintainability ___ **To improve the clarity and maintainability of the script, consider using more descriptive variable names than DOCKERFILE and DOCKER_IMAGE. This change will make the script easier to understand and maintain.** [tests_integration/test_with_docker.sh [10-11]](https://github.com/Codium-ai/cover-agent/pull/139/files#diff-22b862bfac27a48d3f8fc102221e4d610b8db0f15f416cdf1e507753eab1208dR10-R11) ```diff -DOCKERFILE="" -DOCKER_IMAGE="" +DOCKER_FILE_PATH="" +DOCKER_IMAGE_URL="" ``` Suggestion importance[1-10]: 6 Why: More descriptive variable names improve the readability and maintainability of the script, although the current names are not incorrect.	6

[EmbeddedDevops1]

ℹ️ No functional code has been touched in this PR.