Skip to main content

noqa runner

Project description

noqa-runner

AI-powered mobile test execution runner for iOS applications.

Installation

pip install noqa-runner

Quick Start

CLI

# Run on physical device with local IPA build
python -m noqa_runner run \
  --noqa-api-token $NOQA_API_TOKEN \
  --case-input-json '[
    {
      "case_instructions": "Open app and login with valid credentials"
    }
  ]' \
  --device-id "00008110-001234567890001E" \
  --apple-developer-team-id TEAM123456 \
  --app-bundle-id com.example.app \
  --build-path /path/to/app.ipa

# Run on iOS Simulator with .app build
python -m noqa_runner run \
  --noqa-api-token $NOQA_API_TOKEN \
  --case-input-json '[
    {
      "case_instructions": "Open app and login with valid credentials"
    }
  ]' \
  --simulator-id "SIMULATOR-UDID" \
  --app-bundle-id com.example.app \
  --build-path /path/to/MyApp.app

# Run on device with TestFlight installation
python -m noqa_runner run \
  --noqa-api-token $NOQA_API_TOKEN \
  --case-input-json '[
    {
      "case_instructions": "Open app and verify features"
    }
  ]' \
  --device-id "00008110-001234567890001E" \
  --apple-developer-team-id TEAM123456 \
  --app-bundle-id com.example.app \
  --app-store-id 123456789

Required Options:

--noqa-api-token TEXT         noqa API authentication token [required]
--case-input-json TEXT        JSON with test cases: [{case_instructions, test_id?, case_name?}] [required]
--app-bundle-id TEXT          App bundle ID (auto-extracted from build if not provided) [recommended]

Target Options (choose one):

--device-id TEXT              Device UDID for physical device testing
--simulator-id TEXT           Simulator UDID for simulator testing

**Device-Only Options:**

--apple-developer-team-id TEXT Apple Developer Team ID for code signing [required for devices] --app-store-id TEXT App Store ID for TestFlight installation (device only)


**Installation Options (choose one):**

--build-path TEXT Path to local IPA build file --app-store-id TEXT App Store ID for TestFlight installation


**Other Options:**

--app-context TEXT Application context information [optional] --agent-api-url TEXT Agent API base URL [optional, default: https://agent.noqa.ai] --log-level TEXT Logging level [optional, default: INFO]


### Python API

```python
from noqa_runner import RunnerSession, RunnerTestInfo

# Create session
session = RunnerSession()

# Run on physical device with local IPA build
results = await session.run(
    noqa_api_token="your-token",
    tests=[
        RunnerTestInfo(
            case_instructions="Open app and verify home screen",
        )
    ],
    device_id="00008110-001234567890001E",
    apple_developer_team_id="TEAM123456",
    app_bundle_id="com.example.app",
    app_build_path="/path/to/app.ipa",
)

# Run on iOS Simulator with .app build
results = await session.run(
    noqa_api_token="your-token",
    tests=[
        RunnerTestInfo(
            case_instructions="Open app and verify home screen",
        )
    ],
    simulator_id="SIMULATOR-UDID",
    app_bundle_id="com.example.app",
    app_build_path="/path/to/MyApp.app",
)

# Run with TestFlight installation
results = session.run(
    noqa_api_token="your-token",
    tests=[
        RunnerTestInfo(
            case_instructions="Open app and verify features",
        )
    ],
    device_id="00008110-001234567890001E",
    apple_developer_team_id="TEAM123456",
    app_bundle_id="com.example.app",
    app_store_id="123456789",
)

Test Results

The CLI returns test results as JSON with detailed information about each test execution:

[
  {
    "case_instructions": "Complete onboarding, check that paywall has products",
    "status": "passed",
    "message": "Test completed",
    "test_conditions": [
      {
        "condition": "Onboarding process was completed successfully",
        "is_verified": true,
        "evidence": "User progressed through multiple onboarding screens, ending with 'Get started' button",
        "step_number": 4,
        "confidence": 100
      },
      ...
    ],
    "steps": [...]
  }
]

Support

For issues and questions https://noqa.ai/

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

noqa_runner-0.5.5.tar.gz (36.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

noqa_runner-0.5.5-py3-none-any.whl (55.9 kB view details)

Uploaded Python 3

File details

Details for the file noqa_runner-0.5.5.tar.gz.

File metadata

  • Download URL: noqa_runner-0.5.5.tar.gz
  • Upload date:
  • Size: 36.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for noqa_runner-0.5.5.tar.gz
Algorithm Hash digest
SHA256 ae2f7644f59664331fb612fb81f67e997de27e09a806bcfe7ba25f9908ce819a
MD5 cad4fc80c2dc6be14e5aba58f70b0944
BLAKE2b-256 a6c898209c386fe55cb350236fc643c30363bbbf18a367c7bdac766485167a7c

See more details on using hashes here.

File details

Details for the file noqa_runner-0.5.5-py3-none-any.whl.

File metadata

  • Download URL: noqa_runner-0.5.5-py3-none-any.whl
  • Upload date:
  • Size: 55.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for noqa_runner-0.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 7d48bea3d5b5da8330fd3d738add98a78b025c6c95c61bddb1592c975d6e1a66
MD5 c25a999628d0a3e491a5d39e7cb3cb63
BLAKE2b-256 b6901a381c1bec7434c1865067435bae30524e4e691256b03f2788d147a9761f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page