Pipeline status badge endpoints for server #158
Merged
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
Some previous status manager refactoring broke the badge end point. I've also changed it from redirecting to the shields.io image, to proxying it.
If no pipeline_id is found, return a badge with 'not found' written in it, rather than returning a 404. Knowing that a pipeline is potentially missing is still useful status.
A status badge at the /badge/collection/<pipeline path> endpoint. This returns a pipeline collection summary badge, e.g. pipelines | 22 succeeded, 14 failed, 2 invalid, 1 running Pipeline path will filter the pipeline ids it is reporting on.
This commit makes application of basic auth (if active) more selective. Instead of forcing basic auth on all endpoints, it is now applied as a decorator for the main dashboard views. This allows us to serve the status badges without basic auth while still being able to protect the dashboard pages.
brew
changed the title
Pull Request Test Coverage Report for Build #88
💛 - Coveralls |
1 similar comment
Pull Request Test Coverage Report for Build #88
💛 - Coveralls |
akariv
approved these changes
Feb 3, 2019
| @@ -220,27 +240,76 @@ def pipeline_api(field, pipeline_id): | |||
| return jsonify(ret) | |||
|
|
|||
|
|
|||
| def _make_badge_response(subject, text, colour): | |||
There was a problem hiding this comment.
Just wondering why not do a redirect here.
There was a problem hiding this comment.
If it redirects away from the site, you can't change the url as easily, to see different results.
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.
The dashboard server included a badge endpoint that was unfortunately broken. This PR fixes up the existing badge endpoint to use the updated status object, and introduces a new
/badge/collectionendpoint to return a summary status of a pipeline collection. Explanation added to the README to illustrate their use:Even simpler pipeline status is available with a status badge, both for individual pipelines, and for pipeline collections. For a single pipeline, add the full pipeline id to the badge endpoint:
Or for a collection of pipelines:
Note that these badge endpoints will always be exposed regardless of
DPP_BASIC_AUTH_PASSWORDandDPP_BASIC_AUTH_USERNAMEsettings.Note, this PR also removes a
refreshendpoint, that I don't think is actively in use, but looked like an unnecessary DoS target.