Skip to main content

End-to-end test framework for OpenVoiceOS skills

Project description

Ask DeepWiki

OvoScope

OvoScope is an end-to-end testing framework for OVOS skills.

It contains the full core runtime environment using a lightweight in-process ovos-core, allowing skill developers to test the full skill message flow, from utterance to intent handling to final bus responses — without launching a full assistant stack.

image

Like a microscope for your OVOS skills.


Features

  • Simulates OVOS Core messagebus interactions
  • Sends test Message objects and captures responses
  • Verifies message types, data, routing, session handling, and language
  • Automatically flips message direction when configured
  • Designed to integrate cleanly into unittest or pytest workflows

Installation

pip install ovoscope

Usage Example

Testing scenario of complete intent failure (no skills installed)

from ovoscope import End2EndTest
from ovos_bus_client.message import Message
from ovos_bus_client.session import Session


session = Session("123")  # change lang, pipeline, etc. as needed
message = Message("recognizer_loop:utterance",
                  {"utterances": ["hello world"]},
                  {"session": session.serialize(), "source": "A", "destination": "B"})

test = End2EndTest(
    skill_ids=[],
    source_message=message,
    expected_messages=[
        message,
        Message("mycroft.audio.play_sound", {"uri": "snd/error.mp3"}),
        Message("complete_intent_failure", {}),
        Message("ovos.utterance.handled", {}),
    ]
)

test.execute()

Why OvoScope?

  • Lightweight: No need to launch a full messagebus or audio stack
  • Isolated: Use FakeBus and MiniCroft for fast, reliable test environments
  • Flexible: Works with any skill that conforms to OVOS skill loading

License

Apache 2.0


Contributing

PRs are welcome! See CONTRIBUTING.md for guidelines.

Project details


Download files

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

Source Distribution

ovoscope-0.7.2.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

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

ovoscope-0.7.2-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file ovoscope-0.7.2.tar.gz.

File metadata

  • Download URL: ovoscope-0.7.2.tar.gz
  • Upload date:
  • Size: 9.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for ovoscope-0.7.2.tar.gz
Algorithm Hash digest
SHA256 5cff4741be6336a3bb214fa72942cf2e282ff514fc2a7c50fb12ac5664dfa08b
MD5 90d842a74befb9e394de059a9bd0013e
BLAKE2b-256 94ede376a5c34ccfc1dc8e087a9e20ef85fff1ee6fd7cf7062698249ab333b4a

See more details on using hashes here.

File details

Details for the file ovoscope-0.7.2-py3-none-any.whl.

File metadata

  • Download URL: ovoscope-0.7.2-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for ovoscope-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d9dd31d6d3b1429f5ae1a5aab8146e83a766bd94ceebb65f088df054cf13e99c
MD5 f5f0c8fd39df6c0a3c0d5d2342167a15
BLAKE2b-256 b9cfa3db7ebec742f3886e248ec144d33ef8967b38fd29682b5e66d2678cd56c

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