almalinux/lorax
13
0
Fork 0
Code Issues Pull Requests Releases Activity

Report an error if the blueprint doesn't exist

Browse Source 
composer-cli uses TOML for 'blueprints save' which was returning an
empty 200 response if the blueprint didn't exist. Change this to return
a standard 400 error response if the blueprint doesn't exist.

composer-cli is already setup to handle receiving json when an error is
returned so just the toml API response for `blueprints/save` needed to
be changed.
This commit is contained in:
Brian C. Lane 2018-09-19 11:39:18 -07:00
parent 6a37f80f0f
commit 6da3079349
2 changed files with 19 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/pylorax/api/v0.py
View File

@ -63,15 +63,23 @@ store the new blueprint on the new branch.
"kubernetes" ], "kubernetes" ],
"total": 6 } "total": 6 }
`/api/v0/blueprints/info/<blueprint_names>` `/api/v0/blueprints/info/<blueprint_names>[?format=<json|toml>]`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Return the JSON representation of the blueprint. This includes 3 top level Return the JSON representation of the blueprint. This includes 3 top level
objects. `changes` which lists whether or not the workspace is different from objects. `changes` which lists whether or not the workspace is different from
the most recent commit. `blueprints` which lists the JSON representation of the the most recent commit. `blueprints` which lists the JSON representation of the
blueprint, and `errors` which will list any errors, like non-existant blueprints. blueprint, and `errors` which will list any errors, like non-existant blueprints.
Example:: By default the response is JSON, but if `?format=toml` is included in the URL's
arguments it will return the response as the blueprint's raw TOML content.
*Unless* there is an error which will only return a 400 and a standard error
`Status Response`_.
If there is an error when JSON is requested the successful blueprints and the
errors will both be returned.
Example of json response::
{ {
"changes": [ "changes": [
@ -1103,6 +1111,10 @@ def v0_api(api):
blueprints = sorted(blueprints, key=lambda r: r["name"].lower()) blueprints = sorted(blueprints, key=lambda r: r["name"].lower())
if out_fmt == "toml": if out_fmt == "toml":
if errors:
# If there are errors they need to be reported, use JSON and 400 for this
return jsonify(status=False, errors=errors), 400
else:
# With TOML output we just want to dump the raw blueprint, skipping the rest. # With TOML output we just want to dump the raw blueprint, skipping the rest.
return "\n\n".join([r.toml() for r in blueprints]) return "\n\n".join([r.toml() for r in blueprints])
else: else:

5
tests/cli/test_blueprints_sanity.sh
View File

@ -21,9 +21,8 @@ rlJournalStart
rlAssertGrep "httpd" "example-http-server.toml" rlAssertGrep "httpd" "example-http-server.toml"
# non-existing blueprint # non-existing blueprint
# enable test for https://github.com/weldr/lorax/issues/460 rlRun -t -c "$CLI blueprints save non-existing-bp" 1
# rlRun -t -c "$CLI blueprints save non-existing-bp" 1 rlAssertNotExists "non-existing-bp.toml"
# rlAssertNotExists "non-existing-bp.toml"
rlPhaseEnd rlPhaseEnd
rlPhaseStartTest "blueprints push" rlPhaseStartTest "blueprints push"