ansys-saf-testing 0.11.dev0

Collection of test utilities for the Solution Application Framework.

Overview

SAF SDK Testing provides a suite of reusable testing utilities, fixtures, and helper methods designed to standardize and streamline testing across the SAF landscape.

This package serves two primary objectives:

1. Centralizing testing utilities for SAF development: Provides a unified testing infrastructure shared across all SAF-SDK repositories, ensuring consistency and reducing duplication in the development of SAF platform components such as the Desktop Orchestrator, Web Portal, Data Management services, and other core modules.

2. Empowering solution developers: Delivers ready-to-use testing tools for solution developers—consumers of the SAF platform—enabling them to efficiently test their custom solutions built on SAF. This includes utilities for end-to-end solution testing, UI automation, service integration testing, and more.

Core Capabilities

The package is organized into modular components, each addressing specific testing needs:

• Common Utilities: Shared helper functions for general-purpose testing tasks, including network utilities, directory management, and gRPC certificate handling.

• Database Testing: Fixtures and methods for testing against PostgreSQL and SQLite databases, including container-managed database instances.

• Docker Integration: Tools for managing Docker containers and orchestrating containerized test environments.

• Frontend/Selenium: Selenium WebDriver utilities for end-to-end UI testing, including element waiting strategies and browser interaction helpers.

• HPS Integration: Testing support for High Performance Computing Services, including deployment processes and stack management.

• PIM Integration: Utilities for testing Product Instance Management service interactions.

• Pytest Enhancements: Custom pytest fixtures, markers for platform-specific tests, mocking utilities, and test case documentation helpers.

• Solution Testing: End-to-end testing infrastructure for SAF solutions, including GLOW engine integration, execution configurations, and project context management.

• Process Management: Tools for launching and managing external processes during test execution.

Design Principles

This package adheres to strict design principles to ensure reliability and ease of use across the SAF ecosystem:

• Explicit over implicit: No autouse=True fixtures. Developers must explicitly enable fixtures to maintain clarity about test execution.

• Simplicity and transparency: Utilities are designed to be easy to understand, allowing developers to predict behavior when calling them.

• Version-agnostic generality: Utilities are generic and adaptable, avoiding dependencies on specific versions of SAF components.

• Flat architecture: No nested function or fixture calls, maintaining transparency and predictability in test execution.

• Backward compatibility: All changes must be backward compatible. Fixes for one repository should never break others.

Installation

Ensure you have all the necessary prerequisites. Then, refer to the installation guidelines for detailed instructions on how to install the project in your system.

Documentation

The official documentation of SAF SDK Testing contains the following chapters:

• Getting started. This section provides a brief overview and instructions on how to get started with the project. It typically includes information on how to install the project, set up any necessary dependencies, and run a basic example or test to ensure everything is functioning correctly.

• User guide. The user guide section offers detailed documentation and instructions on how to use the project. It provides comprehensive explanations of the project’s features, functionalities, and configuration options. The user guide aims to help users understand the project’s concepts, best practices, and recommended workflows.

• Contribute. This section provides guidelines and instructions on how to contribute to the project. It includes information on how to set up the development environment, run tests, submit pull requests, and follow contribution guidelines.

Troubleshooting

For troubleshooting or reporting issues, open an issue in the project repository.

Follow these steps to report an issue:

• Go to the project repository.

• Click on the Issues tab.

• Click on the New Issue button.

• Provide a clear and detailed description of the issue you are facing.

• Include any relevant error messages, code snippets, or screenshots.

Additionally, you can refer to the official documentation for additional resources and troubleshooting guides.

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.

Changelog

The changelog section provides a summary of notable changes for each version of SAF SDK Testing for Python. It helps you keep track of updates, bug fixes, new features, and improvements made to the project over time.

To view the complete changelog, visit the project repository and navigate to the CHANGELOG file. It provides a comprehensive list of changes categorized by version, along with brief descriptions of each change.

Getting Started

Add to your package’s pyproject.toml:

[tool.poetry.group.tests]
optional = true
[tool.poetry.group.tests.dependencies]
ansys-saf-testing = { version = "^0.1.dev7", source = "solutions-private-pypi", allow-prereleases = true }
...

For methods, just import them when needed. Example:

from ansys.saf.testing.selenium import wait_for_element_to_be_clickable, wait_for_partial_text

Extra groups

• selenium: if you want to use Selenium-related fixtures and methods.

• process: if you want to use Process class for launching external processes.

• solution: if you want to use fixtures and methods to launch a Solution.