Quickstart

Installation

athena is available on PyPI and requires Python >= 3.11.

python3 -m pip install haondt-athena

Setup

Start by running init in your project directory.

athena init

This will create an athena directory with some files to get you started.

.
└── athena
    ├── .athena
    ├── .gitignore
    ├── my_module.py
    ├── fixture.py
    ├── variables.yml
    └── secrets.yml

Create a Module

To create a test case, add a python file somewhere inside the athena directory

cd athena
vim hello.py

In order for athena to run the module, there must be a top-level function named run that takes a single argument. athena will call this function, with an Athena instance as the argument. The Athena instance can be used to instantiate a client.

hello.py

from athena.client import Athena

def run(athena: Athena):
    client = athena.client()
    client.get('http://echo.jsontest.com/key/value')

Execute a Module

The responses command can be used to run a module and pretty-print the response data

$ athena responses hello.py
hello •
│ execution
│ │ environment: __default__
│
│ timings
│ │ http://echo...m/key/value    ························ 470ms
│
│ traces
│ │ http://echo.jsontest.com/key/value
│ │ │ │ GET http://echo.jsontest.com/key/value
│ │ │ │ 200 OK 470ms
│ │ │
│ │ │ response
│ │ │ │ headers
│ │ │ │ │ Access-Control-Allow-Origin | *
│ │ │ │ │ Content-Type                | application/json
│ │ │ │ │ X-Cloud-Trace-Context       | 35b9c247eaaa4175c1949b97dd13548a
│ │ │ │ │ Date                        | Fri, 05 Jul 2024 20:33:16 GMT
│ │ │ │ │ Server                      | Google Frontend
│ │ │ │ │ Content-Length              | 17
│ │ │ │
│ │ │ │ body | application/json [json] 17B
│ │ │ │ │ 1 {
│ │ │ │ │ 2   "key": "value"
│ │ │ │ │ 3 }
│ │ │ │ │
│ │ │ │
│ │ │
│ │
│