Skip to main content

Automated Testing Overview

In the fast-paced world of software development, automated testing has become an essential component of maintaining high-quality, reliable applications. QA Sphere recognizes this need and provides robust tools to integrate your automated testing processes seamlessly into your overall quality assurance workflow.

The Power of Integration​

QA Sphere offers two primary methods for integrating your automated testing efforts with our platform:

  1. REST API: For developers and teams looking for maximum flexibility and customization.
  2. QA Sphere CLI Tool: For quick, easy integration, especially suited for CI/CD pipelines.

Both of these methods allow you to automate the process of uploading test results, linking them to existing test cases, and maintaining a comprehensive view of your testing efforts.

REST API: Flexibility and Control​

Our REST API provides a programmatic interface to QA Sphere, allowing you to:

  • Upload test results
  • Create and manage test cases
  • Update test run statuses
  • Retrieve detailed testing information

This level of access enables you to build custom integrations tailored to your specific workflow and tooling, making QA Sphere a central hub for all your testing data.

QA Sphere CLI Tool: Simplicity and Efficiency​

For teams looking for a more straightforward approach, our Command Line Interface (CLI) tool offers a user-friendly way to integrate automated test results. The CLI is language- and framework-agnostic — it works with any testing tool that produces JUnit XML reports, as well as Playwright JSON reports natively. Key features include:

  • Easy installation and setup
  • Upload of JUnit XML and Playwright JSON results
  • Automatic matching of test cases with support for multiple marker formats (hyphenated, underscore, CamelCase)
  • Automatic test case creation for unmatched results
  • Custom run naming with date/time and environment variable templates
  • Support for attachments and flexible error handling

Whether your team uses Playwright, Cypress, pytest, Go, Java, Rust, .NET, Ruby, or any other test framework — as long as it can produce a JUnit XML report, the QAS CLI can upload the results to QA Sphere.

The CLI tool is particularly useful for quickly integrating with CI/CD pipelines, allowing you to automate result reporting as part of your build and deployment processes.

The CLI is open source and available on GitHub: github.com/hypersequent/qas-cli. You can track development progress, report issues, and contribute to the project.

Quick Start​

QA Sphere seamlessly integrates with any test automation tool, language, and framework. The integration process is straightforward:

  1. Run your tests and generate a JUnit XML or Playwright JSON report
  2. Install the QAS CLI: npm install -g qas-cli (or use npx qas-cli)
  3. Configure credentials in a .qaspherecli file or environment variables
  4. Upload results: npx qas-cli junit-upload ./path/to/results.xml

The CLI automatically matches tests to QA Sphere test cases, creates test runs, and uploads results — no manual mapping required.

For detailed setup instructions, see the framework-specific integration guides:

Best Practices​

  1. Consistent Naming: Include QA Sphere test case markers in your test names. The CLI supports multiple formats to accommodate different languages:
    • Hyphenated (all languages): PRJ-002: Login test
    • Underscore (pytest, Go, Rust): test_prj002_login_test
    • CamelCase (Go, Java): TestPrj002LoginTest
  2. CI/CD Integration: Integrate result submission into your CI/CD pipeline for real-time test result updates.
  3. Error Handling: Use the --force option to continue uploads even when encountering non-critical errors, or --ignore-unmatched to suppress individual unmatched test messages during gradual test case linking.