Refactor qmctl test scripts and improve test utilities

[ArtiomDivak]

• Replace qmctl_cp.sh with qmctl_cp_bidirectional.sh for better test coverage
• Replace qmctl_show.sh with qmctl_show_variants.sh for more comprehensive testing
• Add dedicated qmctl_error_handling.sh and qmctl_json_output.sh test scripts
• Update existing qmctl_exec.sh and qmctl_execin.sh test scripts
• Enhance test utilities in tests/e2e/lib/utils with improved test framework
• Update main test runner test_qmctl.sh to use new script structure

Closes #870

Summary by Sourcery

Refactor and expand end-to-end qmctl test suite to improve coverage and test framework support

New Features:

• Add comprehensive bi-directional copy tests with qmctl_cp_bidirectional.sh
• Add varied show command tests with qmctl_show_variants.sh
• Add dedicated error handling tests with qmctl_error_handling.sh
• Add JSON output validation tests with qmctl_json_output.sh

Enhancements:

• Refactor qmctl_exec.sh and qmctl_execin.sh for container lifecycle management, cleanup, and messaging
• Update test runner (test_qmctl.sh) to orchestrate new script structure
• Enhance shared test utilities in tests/e2e/lib/utils for improved framework support

Tests:

• Replace original qmctl_cp.sh and qmctl_show.sh with expanded variants to cover more scenarios

[sourcery-ai]

Reviewer's Guide

This PR overhauls the qmctl end-to-end test suite by reorganizing and expanding test scripts, standardizing utility functions, and updating the main runner to leverage the new structure. It replaces and introduces dedicated scripts for copy, show, JSON output, and error handling, refactors existing exec/execin tests with robust setup and cleanup, and integrates these into a unified framework.

File-Level Changes

Change	Details	Files
Replaced and added dedicated test scripts for comprehensive coverage	Replaced qmctl_cp.sh with qmctl_cp_bidirectional.sh Replaced qmctl_show.sh with qmctl_show_variants.sh Added qmctl_error_handling.sh and qmctl_json_output.sh Removed deprecated scripts qmctl_cp.sh and qmctl_show.sh	tests/qmctl-test/scripts/qmctl_cp_bidirectional.sh tests/qmctl-test/scripts/qmctl_show_variants.sh tests/qmctl-test/scripts/qmctl_error_handling.sh tests/qmctl-test/scripts/qmctl_json_output.sh tests/qmctl-test/scripts/qmctl_cp.sh (deleted) tests/qmctl-test/scripts/qmctl_show.sh (deleted)
Enhanced existing test scripts with robust container lifecycle management and unified messaging	Parameterized container name and ensured creation, startup, cleanup in qmctl_execin.sh Cleaned up pre-existing containers, added info/fail/pass messaging in qmctl_exec.sh Replaced raw echo statements with info_message/fail_message/pass_message	tests/qmctl-test/scripts/qmctl_execin.sh tests/qmctl-test/scripts/qmctl_exec.sh
Updated main test runner to orchestrate new script structure	Swapped old script calls to new variants in test_qmctl.sh Added invocations for JSON and error-handling tests Standardized failure and success reporting via fail_message and pass_message	tests/qmctl-test/test_qmctl.sh
Improved end-to-end utility library with standardized test functions	Introduced run_test helper for consistent test execution Unified info_message, pass_message, fail_message across scripts Streamlined temp file handling and exit-code assertions	tests/e2e/lib/utils

Possibly linked issues

• CI/CD: create a test for qmctl #870: The PR refactors existing and adds new comprehensive tests for qmctl, directly addressing and closing issue CI/CD: create a test for qmctl #870, which aimed to test qmctl functionality.
• CI/CD: create a test for qmctl #870: The PR refactors and adds new comprehensive tests for qmctl, including copy, JSON output, error handling, and show variants, directly fulfilling the issue's goal of creating tests for qmctl.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @ArtiomDivak - I've reviewed your changes - here's some feedback:

• Consider centralizing the repeated container setup and teardown logic (name, creation, cleanup) into your shared utils to reduce code duplication across exec, execin, and cp test scripts.
• Use dynamically generated container names and temp file paths (e.g. via mktemp) instead of hard-coded “alpine-podman” and /tmp/* to avoid collisions when running tests in parallel.
• Add strict mode flags (set -euo pipefail) at the top of each test script to ensure any unexpected failures or undefined variables cause immediate test failures.

Prompt for AI Agents

Please address the comments from this code review:
## Overall Comments
- Consider centralizing the repeated container setup and teardown logic (name, creation, cleanup) into your shared utils to reduce code duplication across exec, execin, and cp test scripts.
- Use dynamically generated container names and temp file paths (e.g. via mktemp) instead of hard-coded “alpine-podman” and /tmp/* to avoid collisions when running tests in parallel.
- Add strict mode flags (set -euo pipefail) at the top of each test script to ensure any unexpected failures or undefined variables cause immediate test failures.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[dougsland]

we are almost there