Export All Test Fixtures#

This example demonstrates how to connect to the Sherlock gRPC service, import a project, and export all test fixtures for a CCA.

Description#

Sherlock’s gRPC API enables users to automate various workflows, including exporting all test fixtures for a CCA. This script demonstrates how to:

  • Connect to the Sherlock service.

  • Import a tutorial project.

  • Export all test fixtures to a CSV file.

import os

from examples.examples_globals import get_sherlock_tutorial_path, get_temp_dir

from ansys.sherlock.core import launcher
from ansys.sherlock.core.errors import (
    SherlockExportAllTestFixtures,
    SherlockImportProjectZipArchiveError,
)

Connect to Sherlock#

Connect to the Sherlock service and ensure proper initialization.

sherlock = launcher.connect(port=9092, timeout=10)

Delete Project#

Delete the project if it already exists.

try:
    sherlock.project.delete_project("Test")
    print("Project deleted successfully.")
except Exception:
    pass

Import Tutorial Project#

Import the tutorial project zip archive provided with the Sherlock installation.

try:
    sherlock.project.import_project_zip_archive(
        project="Test",
        category="Demos",
        archive_file=os.path.join(get_sherlock_tutorial_path(), "Tutorial Project.zip"),
    )
    print("Tutorial project imported successfully.")
except SherlockImportProjectZipArchiveError as e:
    print(f"Error importing project zip archive: {e}")

Export All Test Fixtures#

Export all test fixtures for the “Main Board” to a CSV file.

try:
    test_fixtures_export_path = os.path.join(get_temp_dir(), "TestFixturesExport.csv")
    sherlock.layer.export_all_test_fixtures(
        project="Test",
        cca_name="Main Board",
        export_file=test_fixtures_export_path,
        units="DEFAULT",
    )
    print(f"All test fixtures exported successfully to: {test_fixtures_export_path}")
except SherlockExportAllTestFixtures as e:
    print(f"Error exporting all test fixtures: {e}")