DM-10261: Create dispatch_verify.py CLI for uploading a verification job #10
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This code is adapted from https://github.com/lsst-sqre/post-qa The idea is to provide a client library to support HTTP GET, POST, etc. requests against the SQUASH API. This handles getting endpoints, handling API version headers, logging, etc. Data objects can use this API to implement data upload and download methods. The idea is that the squash.py method itself will remain data agnostic. Adds `requests` as an EUPS dependency. responses (https://github.com/getsentry/responses) is an optional dependency to support unittests. Tests will skip is responses cannot be imported. Eventually we shall try to ensure responses is systematically available in the CI environment.
Job.dispatch() uploads the job to the SQUASH database via its HTTP API. This API doesn't exist yet, so this method should be considered a proof-of-concept. Metrics and specifications should be uploaded separately since they're not changing per-job, and can be considered separate resources.
The new lsst.verify.metadata sub-package will host tools for gathering metadata from environments. metadata/eupsmanifest.py is the first one, which parses the manifest.txt file found in lsstsw builds. A sample manifest.txt is included in tests/data/lsstsw/build (emulates the directory structure of lsstsw).
Port from https://github.com/lsst-sqre/post-qa. LsstswRepos provides an interface to repos.yaml and git repository metadata in lsstsw. This includes the Git origin url of packages and the currently-checked out Git branch. Note I tried to mock the GitPython package to properly test the LsstswRepo.get_package_branch() method, but couldn't get it to work yet.
get_jenkins_env() gather job metadata from the Jenkins CI execution environment.
MetricSet, SpecificationSet and MeasurementSet gain __iadd__() and update() methods. This provides a simple API for merging sets. Also add Job.__iadd__ to merge Jobs This provides a convenient API for merging Jobs, which comes up when collecting several Jobs output from individual tasks for upload to SQUASH.
These are a convenience APIs for inserting Metric instances from a MetricSet into the Measurement.metric attribute of a measurement. Job.reload_metrics_package adds metrics to Measurement instances, as well as augmenting Job.metrics and Job.specs. Adding metrics to measurement instances is useful because it helps us normalize the units of measurements when serialized. Add Job.reload_metrics_package
dispatch_verify.py is responsible for gathering Job JSON files, enriching them with environment metadata, and either printing, writing, or HTTP POSTing those Job documents to SQUASH.
jonathansick
force-pushed
the
tickets/DM-10261
branch
from
88d11b4
to
795ae0f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
dispatch_verify.pyacts as an upload client to send verification job JSON fields to SQUASH.Some features:
dispatch_verify.pycan also save the merged JSON document for later processing or archival. It can also print it out to standard output.--env=jenkinsflag, Jenkins environment information is added to the Job metadata.--lsstswflag, lsstsw package information is added to the Job metadata.