Declarative test runner using YAML and jinja2.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for crdoconnor from gravatar.com crdoconnor

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU Affero General Public License v3 or later (AGPLv3+) (AGPL)
  • Author: Colm O'Connor
  • Tags hitch, testing, framework, bdd, tdd, declarative, tests, testing, jinja2, yaml
Classifiers
Report project as malware

Project description

HitchTest

HitchTest is a part of the hitch testing framework which compiles and runs YAML (and optionally jinja2) tests like this:

{% extends "base.yml" %}
{% block test %}
- engine: engine.py:DjangoReminderTestExecutionEngine
  name: Sign up, create reminder and wait for email reminder to arrive in python {{ python_version }}
  preconditions:
    python_version: "{{ python_version }}"
  scenario:
    - Load website
    - Click: register
    - Fill form:
        id_username: django
        id_email: django@reinhardt.com
        id_password1: jazzguitar
        id_password2: jazzguitar
    - Click submit
    - Click: create
    - Fill form:
        id_description: Remind me about upcoming gig.
        id_when: 30 days
    - Click: create
    - Wait for email:
        Containing: Confirm E-mail Address
    - Confirm emails sent: 1
    - Time travel:
        Days: 30
    - Wait for email:
        Containing: Remind me about upcoming gig.
{% endblock %}

There is no magic here. Each of these steps calls a python method, defined by you in the specified execution engine class, like so:

def click(self, on):
    """Click on HTML id."""
    self.driver.find_element_by_id(on).click()

Features

  • Integrates with IPython.

  • Pretty stacktraces and test results.

  • Quiet mode.

  • Integrated and easily overriden test settings.

Why YAML + Jinja2?

This is to more easily maintain separation of concerns. Enforcing the use of YAML keeps the test scripts declarative, and all of the execution code is kept centralized in the engine.

This also makes reading, writing, adding metadata to and and parsing test cases much easier.

Combining YAML with jinja2 gives you the power to deduplicate test case code while still maintaining comprehensibility and simplicity.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page