ansys-saf-testing 0.14.0

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 centralizes testing utilities for SAF-SDK development. It 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.

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" }
...

Pytest fixtures from ansys-saf-testing are automatically discovered during test collection. No additional fixture registration or plugin configuration is required.

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.

• hps: if you want to use fixtures and methods for HPS-related testing.

• docker: if you want to use Docker-related fixtures and methods.

• pim: if you want to use fixtures and methods for PIM light server testing.