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.2a1.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.2a1-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ovoscope-0.7.2a1.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.2a1.tar.gz
Algorithm Hash digest
SHA256 bec9d72f1d6346fd3917d5c4d210efeeece9fef2fd9d8cd6363436fbdb22e5e0
MD5 923bacdf2f4c3ef85403a768d01f0921
BLAKE2b-256 ea038037be966a7be1ce64d34ed569876ff6a57f769672278c3252936401a6ff

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ovoscope-0.7.2a1-py3-none-any.whl
  • Upload date:
  • Size: 7.8 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.2a1-py3-none-any.whl
Algorithm Hash digest
SHA256 7ec1510b9cbed7c482ce0c06465f9231793af0440fa1d9891de7854862673438
MD5 ddbf73c9ccc62b7105628a3dccbaa0d1
BLAKE2b-256 e38666a2c841ce954879c54d4a6defb20526d695b6ff00e308d184bee7ac31e9

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