mirror of
https://github.com/jlengrand/bugsink.git
synced 2026-03-09 23:51:20 +00:00
354af7ea0a
Nothing worrying, but good to have checked this regardless and important to have a green pipeline. Fix #175
75 lines
3.2 KiB
Python
75 lines
3.2 KiB
Python
import json
|
|
import requests
|
|
import fastjsonschema
|
|
|
|
# no_bandit_expl: subprocess.run is used to call black in an interal utility script; it's just fine.
|
|
from subprocess import run, PIPE # nosec B404
|
|
|
|
from django.conf import settings
|
|
|
|
from django.core.management.base import BaseCommand
|
|
|
|
|
|
def alter_schema(schema):
|
|
# alter the schema to make it fit what the actual documentation says; see issues/utils.py' get_values() for details
|
|
|
|
for key in ['exception', 'threads', 'breadcrumbs']:
|
|
# no idea why that anyOf[0] is there (since there's no anyOf[1]), but it's there.
|
|
definition = schema['anyOf'][0]['properties'][key]
|
|
schema['anyOf'][0]['properties'][key] = {
|
|
"anyOf": [
|
|
definition,
|
|
definition['properties']['values'],
|
|
]
|
|
}
|
|
|
|
|
|
class Command(BaseCommand):
|
|
help = "Fetches the event schema JSON from the API and saves it to disk. Used during development."
|
|
|
|
def handle(self, *args, **options):
|
|
# Fetch the event schema JSON from the API and save it to disk
|
|
json_result = requests.get(
|
|
"https://raw.githubusercontent.com/getsentry/sentry-data-schemas/main/relay/event.schema.json",
|
|
timeout=10)
|
|
json_result.raise_for_status()
|
|
|
|
with open(settings.BASE_DIR / "api/event.schema.json", "w") as f:
|
|
f.write(json_result.text)
|
|
|
|
# Fetch the license from GitHub and save it to disk (with annotation about the source)
|
|
license_url = "https://raw.githubusercontent.com/getsentry/sentry-data-schemas/main/LICENSE"
|
|
license_result = requests.get(license_url, timeout=10)
|
|
license_result.raise_for_status()
|
|
|
|
with open(settings.BASE_DIR / "api/LICENSE", "w") as f:
|
|
f.write("""This licence applies to the files: event.schema.json (and its derivatives)
|
|
The source of this file is: %s
|
|
|
|
""" % license_url)
|
|
f.write(license_result.text)
|
|
|
|
# Generate fastjsonschema code from the schema and save it to disk
|
|
schema = json.loads(json_result.text)
|
|
|
|
alter_schema(schema)
|
|
with open(settings.BASE_DIR / "api/event.schema.altered.json", "w") as f:
|
|
json.dump(schema, f, indent=2)
|
|
|
|
# use_formats=False for "uint64", see https://github.com/horejsek/python-fastjsonschema/issues/108
|
|
# use_default=False to avoid fastjsonschema adding default values to the data it validates (bwegh)
|
|
code = fastjsonschema.compile_to_code(schema, use_formats=False, use_default=False, detailed_exceptions=False)
|
|
|
|
with open(settings.BASE_DIR / "bugsink/event_schema.py", "w") as f:
|
|
f.write("""# This file is generated by fetch_event_schema_json.py
|
|
# it is based on api/event.schema.altered.json
|
|
# the following license applies:
|
|
""")
|
|
f.write("\n".join("# " + line for line in license_result.text.splitlines()) + "\n\n")
|
|
f.write(code)
|
|
|
|
# put it through 'black' to make it fit on screen at least, and perhaps to get useable diffs too.
|
|
# (we don't bother putting it in requirements.txt, since it's used so rarely)
|
|
# no_bandit_expl: subprocess.run is used to call black in an interal utility script; it's just fine.
|
|
run(["black", settings.BASE_DIR / "bugsink/event_schema.py"], stdout=PIPE, stderr=PIPE) # nosec
|