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

Use consistent naming for upload uuids

Browse Source 
Since we have both compose uuids and upload uuids they need to be
clearly named. This updates the upload naming to use 'upload_uuid' in
the inputs, and 'upload_id' in the output (_id instead of _uuid for
consistency with build_id naming in the status responses).

This also adds 'upload_id' to the /upload/log response.
This commit is contained in:
Brian C. Lane 2019-09-06 11:48:28 -07:00
parent ade8945da3
commit 7396c272b2
2 changed files with 43 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

81
src/pylorax/api/v1.py
View File

@ -314,7 +314,7 @@ def v1_compose_start():
return jsonify(status=False, errors=[{"id": BUILD_FAILED, "msg": str(e)}]), 400 return jsonify(status=False, errors=[{"id": BUILD_FAILED, "msg": str(e)}]), 400
if "upload" in compose: if "upload" in compose:
upload_uuid = uuid_schedule_upload( upload_id = uuid_schedule_upload(
api.config["COMPOSER_CFG"], api.config["COMPOSER_CFG"],
build_id, build_id,
provider_name, provider_name,
@ -322,9 +322,9 @@ def v1_compose_start():
settings settings
) )
else: else:
upload_uuid = "" upload_id = ""
return jsonify(status=True, build_id=build_id, upload_id=upload_uuid) return jsonify(status=True, build_id=build_id, upload_id=upload_id)
@v1_api.route("/compose/queue") @v1_api.route("/compose/queue")
def v1_compose_queue(): def v1_compose_queue():
@ -596,7 +596,7 @@ def v1_compose_uploads_schedule(compose_uuid):
{ {
"status": true, "status": true,
"upload_uuid": "572eb0d0-5348-4600-9666-14526ba628bb" "upload_id": "572eb0d0-5348-4600-9666-14526ba628bb"
} }
""" """
if VALID_API_STRING.match(compose_uuid) is None: if VALID_API_STRING.match(compose_uuid) is None:
@ -625,7 +625,7 @@ def v1_compose_uploads_schedule(compose_uuid):
return jsonify(status=False, errors=[{"id": UPLOAD_ERROR, "msg": str(e)}]), 400 return jsonify(status=False, errors=[{"id": UPLOAD_ERROR, "msg": str(e)}]), 400
try: try:
upload_uuid = uuid_schedule_upload( upload_id = uuid_schedule_upload(
api.config["COMPOSER_CFG"], api.config["COMPOSER_CFG"],
compose_uuid, compose_uuid,
provider_name, provider_name,
@ -634,7 +634,7 @@ def v1_compose_uploads_schedule(compose_uuid):
) )
except RuntimeError as e: except RuntimeError as e:
return jsonify(status=False, errors=[{"id": UPLOAD_ERROR, "msg": str(e)}]), 400 return jsonify(status=False, errors=[{"id": UPLOAD_ERROR, "msg": str(e)}]), 400
return jsonify(status=True, upload_uuid=upload_uuid) return jsonify(status=True, upload_id=upload_id)
@v1_api.route("/compose/uploads/delete", defaults={"compose_uuid": "", "upload_uuid": ""}, methods=["DELETE"]) @v1_api.route("/compose/uploads/delete", defaults={"compose_uuid": "", "upload_uuid": ""}, methods=["DELETE"])
@v1_api.route("/compose/uploads/delete/<compose_uuid>/<upload_uuid>", methods=["DELETE"]) @v1_api.route("/compose/uploads/delete/<compose_uuid>/<upload_uuid>", methods=["DELETE"])
@ -648,7 +648,7 @@ def v1_compose_uploads_delete(compose_uuid, upload_uuid):
{ {
"status": true, "status": true,
"upload_uuid": "572eb0d0-5348-4600-9666-14526ba628bb" "upload_id": "572eb0d0-5348-4600-9666-14526ba628bb"
} }
""" """
if None in (VALID_API_STRING.match(compose_uuid), VALID_API_STRING.match(upload_uuid)): if None in (VALID_API_STRING.match(compose_uuid), VALID_API_STRING.match(upload_uuid)):
@ -663,15 +663,15 @@ def v1_compose_uploads_delete(compose_uuid, upload_uuid):
delete_upload(api.config["COMPOSER_CFG"]["upload"], upload_uuid) delete_upload(api.config["COMPOSER_CFG"]["upload"], upload_uuid)
except RuntimeError as error: except RuntimeError as error:
return jsonify(status=False, errors=[{"id": UPLOAD_ERROR, "msg": str(error)}]) return jsonify(status=False, errors=[{"id": UPLOAD_ERROR, "msg": str(error)}])
return jsonify(status=True, upload_uuid=upload_uuid) return jsonify(status=True, upload_id=upload_uuid)
@v1_api.route("/upload/info", defaults={"uuid": ""}) @v1_api.route("/upload/info", defaults={"upload_uuid": ""})
@v1_api.route("/upload/info/<uuid>") @v1_api.route("/upload/info/<upload_uuid>")
@checkparams([("uuid", "", "no UUID given")]) @checkparams([("upload_uuid", "", "no UUID given")])
def v1_upload_info(uuid): def v1_upload_info(upload_uuid):
"""Returns information about a given upload """Returns information about a given upload
**GET /api/v1/upload/info/<uuid>** **GET /api/v1/upload/info/<upload_uuid>**
Example response:: Example response::
@ -697,47 +697,48 @@ def v1_upload_info(uuid):
} }
} }
""" """
if VALID_API_STRING.match(uuid) is None: if VALID_API_STRING.match(upload_uuid) is None:
return jsonify(status=False, errors=[{"id": INVALID_CHARS, "msg": "Invalid characters in API path"}]), 400 return jsonify(status=False, errors=[{"id": INVALID_CHARS, "msg": "Invalid characters in API path"}]), 400
try: try:
upload = get_upload(api.config["COMPOSER_CFG"]["upload"], uuid).summary() upload = get_upload(api.config["COMPOSER_CFG"]["upload"], upload_uuid).summary()
except RuntimeError as error: except RuntimeError as error:
return jsonify(status=False, errors=[{"id": UPLOAD_ERROR, "msg": str(error)}]) return jsonify(status=False, errors=[{"id": UPLOAD_ERROR, "msg": str(error)}])
return jsonify(status=True, upload=upload) return jsonify(status=True, upload=upload)
@v1_api.route("/upload/log", defaults={"uuid": ""}) @v1_api.route("/upload/log", defaults={"upload_uuid": ""})
@v1_api.route("/upload/log/<uuid>") @v1_api.route("/upload/log/<upload_uuid>")
@checkparams([("uuid", "", "no UUID given")]) @checkparams([("upload_uuid", "", "no UUID given")])
def v1_upload_log(uuid): def v1_upload_log(upload_uuid):
"""Returns an upload's log """Returns an upload's log
**GET /api/v1/upload/log/<uuid>** **GET /api/v1/upload/log/<upload_uuid>**
Example response:: Example response::
{ {
"status": true, "status": true,
"upload_id": "b637c411-9d9d-4279-b067-6c8d38e3b211",
"log": "\n __________________\r\n< PLAY [localhost] >..." "log": "\n __________________\r\n< PLAY [localhost] >..."
} }
""" """
if VALID_API_STRING.match(uuid) is None: if VALID_API_STRING.match(upload_uuid) is None:
error = {"id": INVALID_CHARS, "msg": "Invalid characters in API path"} error = {"id": INVALID_CHARS, "msg": "Invalid characters in API path"}
return jsonify(status=False, errors=[error]), 400 return jsonify(status=False, errors=[error]), 400
try: try:
upload = get_upload(api.config["COMPOSER_CFG"]["upload"], uuid) upload = get_upload(api.config["COMPOSER_CFG"]["upload"], upload_uuid)
except RuntimeError as error: except RuntimeError as error:
return jsonify(status=False, errors=[{"id": UPLOAD_ERROR, "msg": str(error)}]) return jsonify(status=False, errors=[{"id": UPLOAD_ERROR, "msg": str(error)}])
return jsonify(status=True, log=upload.upload_log) return jsonify(status=True, upload_id=upload_uuid, log=upload.upload_log)
@v1_api.route("/upload/reset", defaults={"uuid": ""}, methods=["POST"]) @v1_api.route("/upload/reset", defaults={"upload_uuid": ""}, methods=["POST"])
@v1_api.route("/upload/reset/<uuid>", methods=["POST"]) @v1_api.route("/upload/reset/<upload_uuid>", methods=["POST"])
@checkparams([("uuid", "", "no UUID given")]) @checkparams([("upload_uuid", "", "no UUID given")])
def v1_upload_reset(uuid): def v1_upload_reset(upload_uuid):
"""Reset an upload so it can be attempted again """Reset an upload so it can be attempted again
**POST /api/v1/upload/reset/<uuid>** **POST /api/v1/upload/reset/<upload_uuid>**
Optionally pass in a new image name and/or new settings. Optionally pass in a new image name and/or new settings.
@ -761,10 +762,10 @@ def v1_upload_reset(uuid):
{ {
"status": true, "status": true,
"uuid": "c75d5d62-9d26-42fc-a8ef-18bb14679fc7" "upload_id": "c75d5d62-9d26-42fc-a8ef-18bb14679fc7"
} }
""" """
if VALID_API_STRING.match(uuid) is None: if VALID_API_STRING.match(upload_uuid) is None:
error = {"id": INVALID_CHARS, "msg": "Invalid characters in API path"} error = {"id": INVALID_CHARS, "msg": "Invalid characters in API path"}
return jsonify(status=False, errors=[error]), 400 return jsonify(status=False, errors=[error]), 400
@ -773,15 +774,15 @@ def v1_upload_reset(uuid):
settings = parsed.get("settings") if parsed else None settings = parsed.get("settings") if parsed else None
try: try:
reset_upload(api.config["COMPOSER_CFG"]["upload"], uuid, image_name, settings) reset_upload(api.config["COMPOSER_CFG"]["upload"], upload_uuid, image_name, settings)
except RuntimeError as error: except RuntimeError as error:
return jsonify(status=False, errors=[{"id": UPLOAD_ERROR, "msg": str(error)}]) return jsonify(status=False, errors=[{"id": UPLOAD_ERROR, "msg": str(error)}])
return jsonify(status=True, uuid=uuid) return jsonify(status=True, upload_id=upload_uuid)
@v1_api.route("/upload/cancel", defaults={"uuid": ""}, methods=["DELETE"]) @v1_api.route("/upload/cancel", defaults={"upload_uuid": ""}, methods=["DELETE"])
@v1_api.route("/upload/cancel/<uuid>", methods=["DELETE"]) @v1_api.route("/upload/cancel/<upload_uuid>", methods=["DELETE"])
@checkparams([("uuid", "", "no UUID given")]) @checkparams([("upload_uuid", "", "no UUID given")])
def v1_upload_cancel(uuid): def v1_upload_cancel(upload_uuid):
"""Cancel an upload that is either queued or in progress """Cancel an upload that is either queued or in progress
**DELETE /api/v1/uploads/cancel/<upload_uuid>** **DELETE /api/v1/uploads/cancel/<upload_uuid>**
@ -790,18 +791,18 @@ def v1_upload_cancel(uuid):
{ {
"status": true, "status": true,
"uuid": "037a3d56-b421-43e9-9935-c98350c89996" "upload_id": "037a3d56-b421-43e9-9935-c98350c89996"
} }
""" """
if VALID_API_STRING.match(uuid) is None: if VALID_API_STRING.match(upload_uuid) is None:
error = {"id": INVALID_CHARS, "msg": "Invalid characters in API path"} error = {"id": INVALID_CHARS, "msg": "Invalid characters in API path"}
return jsonify(status=False, errors=[error]), 400 return jsonify(status=False, errors=[error]), 400
try: try:
cancel_upload(api.config["COMPOSER_CFG"]["upload"], uuid) cancel_upload(api.config["COMPOSER_CFG"]["upload"], upload_uuid)
except RuntimeError as error: except RuntimeError as error:
return jsonify(status=False, errors=[{"id": UPLOAD_ERROR, "msg": str(error)}]) return jsonify(status=False, errors=[{"id": UPLOAD_ERROR, "msg": str(error)}])
return jsonify(status=True, uuid=uuid) return jsonify(status=True, upload_id=upload_uuid)
@v1_api.route("/upload/providers") @v1_api.route("/upload/providers")
def v1_upload_providers(): def v1_upload_providers():

4
tests/pylorax/test_server.py
View File

@ -3571,7 +3571,7 @@ class ServerAPIV1TestCase(unittest.TestCase):
self.assertNotEqual(data, None) self.assertNotEqual(data, None)
print(data) print(data)
self.assertEqual(data["status"], True) self.assertEqual(data["status"], True)
self.assertEqual(data["uuid"], upload_id) self.assertEqual(data["upload_id"], upload_id)
def test_upload_03_compose_settings(self): def test_upload_03_compose_settings(self):
"""Test starting a compose with upload settings""" """Test starting a compose with upload settings"""
@ -3623,7 +3623,7 @@ class ServerAPIV1TestCase(unittest.TestCase):
self.assertNotEqual(data, None) self.assertNotEqual(data, None)
print(data) print(data)
self.assertEqual(data["status"], True) self.assertEqual(data["status"], True)
self.assertEqual(data["uuid"], upload_id) self.assertEqual(data["upload_id"], upload_id)
def test_upload_04_providers_delete(self): def test_upload_04_providers_delete(self):