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.0a1.tar.gz (7.3 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.0a1-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ovoscope-0.7.0a1.tar.gz
  • Upload date:
  • Size: 7.3 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.0a1.tar.gz
Algorithm Hash digest
SHA256 163fed025b0bc900732bcf3d098921417162d716b4acd760fa3d912e978b802d
MD5 871f2de2f3ca942eb503919dba3651e3
BLAKE2b-256 ad14fb07dfbcdd2ff3e14868b880dd31a63e628440e2f150ee203a438c085627

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ovoscope-0.7.0a1-py3-none-any.whl
  • Upload date:
  • Size: 7.0 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.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 9305bf496889b7a42f66809acffe8c69446f9df603255f6d43625b9f7df4395d
MD5 0e0dec9fa116dc9899333ac72efa01a0
BLAKE2b-256 30f508fbccdc37b2b20d60411f97b5c0912da1617d08496bf05d89825f5c1946

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