Running API Tests from the Command Line: Transforming Your Automation Framework for CI/CD

Problem statement

Automation framework must be runnable from a single command without IDE dependence to be integrated into CI/CD pipelines.

Why command‑line

CI/CD tools execute predefined commands on clean servers; frameworks that require IDE clicks cannot be integrated. Command‑line provides scriptability, environment independence, and standardized input/output.

Core transformation steps

Unified entry point Create a single executable (e.g., run_tests.py or main.go ) that parses arguments, manages test suites, and generates reports.

Add CLI support of the test framework Examples:

Python + pytest: pytest tests/ -v --html=report.html Java + TestNG/JUnit: mvn test or gradle test after configuring pom.xml or build.gradle.

JavaScript + Jest/Mocha: add "test": "jest" to scripts in package.json, then run npm test.

Parameterize key configuration Externalize mutable values such as base URL, credentials, and feature switches. Pass them via CLI, e.g.:

# Example
pytest tests/ --base-url=http://test-env.com --username=api_user --password=secret

In Python, use argparse and pytest’s pytest_addoption hook to consume the arguments.

Standardize test report output Write reports to a designated directory (e.g., ./reports ) in HTML (human‑readable, e.g., pytest‑html, Allure) and XML (machine‑readable, e.g., JUnit XML) formats.

Concrete Python example

Directory layout:

api_auto_framework/
├── run_tests.py        # unified entry
├── config/
│   └── config.py      # configuration file
├── tests/
│   └── test_demo.py   # test case
├── requirements.txt    # dependencies
└── reports/            # report output directory

Sample run_tests.py implementation:

import argparse
import pytest
import os
from datetime import datetime

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description='API Test Runner')
    parser.add_argument('--env', default='test', help='Test environment: test/staging/prod')
    parser.add_argument('--browser', default='chrome', help='Browser type (if UI actions)')
    args = parser.parse_args()

    os.environ['TEST_ENV'] = args.env

    now = datetime.now().strftime('%Y-%m-%d_%H-%M-%S')
    html_report_path = f'reports/report_{now}.html'
    xml_report_path = f'reports/junit_{now}.xml'

    pytest_args = [
        '-v',
        f'--html={html_report_path}',
        f'--junit-xml={xml_report_path}',
        'tests/'
    ]

    exit_code = pytest.main(pytest_args)
    exit(exit_code)

Run the tests from the terminal:

python run_tests.py --env=staging

Conclusion

Command‑line transformation is the essential first step for making an automation framework CI/CD‑ready, enabling scheduling and execution in continuous‑integration environments.