Skip to main content

End-to-end test framework for OpenVoiceOS skills

Project description

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.

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("test123")
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("recognizer_loop:utterance", {"utterances": ["hello world"]}, {"session": session.serialize()}),
        Message("complete_intent_failure", {}, {"session": session.serialize()}),
        Message("ovos.utterance.handled", {}, {"session": session.serialize()}),
    ]
)

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.0.1.tar.gz (4.4 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.0.1-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ovoscope-0.0.1.tar.gz
Algorithm Hash digest
SHA256 9850913dd20fdc6a2373eb01c66966b0c181f865479f284fba33b2a4b6192f7d
MD5 8cebd443b8ce8f251303d1f438ee0822
BLAKE2b-256 6be19fd027064f79f0d5ca596438b065ffe98b0d13cbe58ef2b54bb86e82aeb1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: ovoscope-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 4.3 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.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6fd52998d18ad9b6d36696644a35d204c5024480635e3813c0d49c52b835b118
MD5 9af8830774345eb94b79be0cea660aa4
BLAKE2b-256 44fa785ab50b8665192c1c32696cf8a17bf23f0b5dac90e176df1c20c295fb5c

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