contrib: add helper to graph current configuration

[liambeguin]

Description

Add a sub-command to sync-places to generate a graphviz graph of the resources and places in a given environment.

A visual representation can help make sense of a large amount of information quickly.
This tried to put all relevant information in one place without being overly complicated.

I also tired to use a color blind friendly palette, not sure how that turned out..

I'm very open to modifying this based on feedback and recommendations.

I also tried to put this into a separate tool using fastapi to have the graph rendered in a browser directly, but ran into trouble. If that approach is preferred I can also push that instead, and maybe with a bit of support we can get it to work consistently.

Testing

$ ./labgrid/contrib/sync-places.py graph | dot -Tsvg -o labgrid-graph.svg

By default the command will just output a dot graph to stdout, piping that to dot we can generate images.

As noted in the docstring, this will generate a graph with:

• all resources, grouped by groupname and exporter.
• all places, with a list of tags (a darker shade of blue, if the place is acquired)
• solid edges between places and acquired resources
• dotted edges between places and unacquired resources
• edges between resources and places carry the match name if any.

here's a simple example of what the output looks like:

Checklist

• Documentation for the feature (documented in the docstring)
• Tests for the feature
• PR has been tested

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (2d6f93c) 62.7% compared to head (f99c44b) 62.7%.
Report is 2 commits behind head on master.

Additional details and impacted files

@@          Coverage Diff           @@
##           master   #1303   +/-   ##
======================================
  Coverage    62.7%   62.7%           
======================================
  Files         163     163           
  Lines       12001   12001           
======================================
  Hits         7532    7532           
  Misses       4469    4469           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Bastian-Krause]

Does this actually use anything from sync-places.py? Maybe it would be better to have this as a separate script in crontrib/ ?

[liambeguin]

Does this actually use anything from sync-places.py?

Not much apart from the "setup". I thought it kind of made sense to group, but I'm happy to separate it. I'll update the PR

[liambeguin]

I ended up finding a solution to share the event loop between fastapi and labgrid so I also updated the script to serve the graph in a browser.

[liambeguin]

I just rebased this MR on the latest master. If there are no other comments I think this would be ready to merge.