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.6.tar.gz (36.5 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.6-py3-none-any.whl (55.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: noqa_runner-0.5.6.tar.gz
  • Upload date:
  • Size: 36.5 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.6.tar.gz
Algorithm Hash digest
SHA256 836e4da3eca3ac6b7be7d64bd407ae8409368ad979346dff45e9b0ad6875bb69
MD5 3a2be976640d5c22fd69391bc5e2d1e3
BLAKE2b-256 83b69a5891fa9cd5710a01c2528e85064b2347a8112158967733e4c5094190b5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: noqa_runner-0.5.6-py3-none-any.whl
  • Upload date:
  • Size: 55.8 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 d3c6069bde12ae9663e45f9c488d288f336a398c146a5b8bd1f848c36efa019b
MD5 e45850bea51fe81094782c5cfb5ce6c6
BLAKE2b-256 9b53ae6a1561daefd9a635890173b6fa51ec6deb16dd6e785ddf7ebd2d17ddcf

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