Skip to content

Reporting

Warning

This code is meant for testing and not to be enabled in a production setting.

Can be enabled by setting enable_reporting to True.

cattle_grid.reporter

Made as a tool to create reports from test runs done using behave. Basically, a scenario is run, and a markdown file is created.

Currently recorded are the step, the scenario, messages received on the incoming.# and outgoing.# routing keys of the cattle_grid exchange.

Finally, fetch results from gateway are reported.

fetch_result_reporting(msg, routing_key=Context('message.raw_message.routing_key')) async

Records the result of performed fetch requests

Source code in cattle_grid/reporter.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
@router.subscriber(
    RabbitQueue("reporting_fetch_result", routing_key="receive.#"),
    device_exchange,
)
async def fetch_result_reporting(
    msg: dict,
    routing_key=Context("message.raw_message.routing_key"),
):
    """Records the result of performed fetch requests"""
    if not current_file:
        return
    if msg.get("action") != "fetch_result":
        return {}

    async with current_file_handler() as fp:
        fp.writelines(
            [
                f"""

```json title="{routing_key}"
""",
                json.dumps(msg, indent=2),
                "\n```\n\n",
            ]
        )

    return {}

reporting_incoming_outgoing(msg, routing_key=Context('message.raw_message.routing_key')) async

Records incoming and outgoing messages

Source code in cattle_grid/reporter.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
@router.subscriber(
    RabbitQueue("processing_reporting_in", routing_key="incoming.#"),
    cattle_grid_exchange,
)
@router.subscriber(
    RabbitQueue("processing_reporting_out", routing_key="outgoing.#"),
    cattle_grid_exchange,
)
async def reporting_incoming_outgoing(
    msg: dict,
    routing_key=Context("message.raw_message.routing_key"),
):
    """Records incoming and outgoing messages"""
    if not current_file:
        return
    async with current_file_handler() as fp:
        fp.writelines(
            [
                f"""

```json title="{routing_key}"
""",
                json.dumps(msg, indent=2),
                "\n```\n\n",
            ]
        )

    return {}

reporting_scenario(msg) async

Reports the scenario.

Note every scenario is written to its own file in the reports directory.

Source code in cattle_grid/reporter.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
@router.subscriber(RabbitQueue("scenario_queue", routing_key="scenario"), exchange)
async def reporting_scenario(msg):
    """Reports the scenario.

    Note every scenario is written to its own file in the `reports` directory."""
    scenario = msg.get("name")
    async with lock:
        global current_file
        scenario_alpha = "".join([x for x in scenario if x.isalpha()])
        current_file = f"reports/{scenario_alpha}.md"

    async with current_file_handler(mode="w") as fp:
        fp.writelines([f"#{scenario}\n\n"])

reporting_step(msg) async

Reports the current step

Source code in cattle_grid/reporter.py 
38
39
40
41
42
43
44
45
@router.subscriber(RabbitQueue("step_queue", routing_key="step"), exchange)
async def reporting_step(msg):
    """Reports the current step"""
    if not current_file:
        return

    async with current_file_handler() as fp:
        fp.writelines(["## " + msg.get("type") + ": " + msg.get("name") + "\n\n"])