From 8a7d8f7c39ee4f0c95c5c096048082e015dd038a Mon Sep 17 00:00:00 2001 From: Vladimir Domnich Date: Tue, 26 Jul 2022 17:04:00 +0300 Subject: [PATCH] Disable automatic pagination in aws cli client This should prevent output truncation if response contains too many items. Signed-off-by: Vladimir Domnich --- .../lib/python_keywords/aws_cli_client.py | 119 ++++++++++-------- 1 file changed, 66 insertions(+), 53 deletions(-) diff --git a/robot/resources/lib/python_keywords/aws_cli_client.py b/robot/resources/lib/python_keywords/aws_cli_client.py index 4e0e483..090f61a 100644 --- a/robot/resources/lib/python_keywords/aws_cli_client.py +++ b/robot/resources/lib/python_keywords/aws_cli_client.py @@ -10,6 +10,9 @@ logger = logging.getLogger('NeoLogger') class AwsCliClient: + # Flags that we use for all S3 commands: disable SSL verification (as we use self-signed + # certificate in devenv) and disable automatic pagination in CLI output + common_flags = "--no-verify-ssl --no-paginate" def __init__(self, access_key_id: str, secret_access_key: str): self.access_key_id = access_key_id @@ -22,73 +25,74 @@ class AwsCliClient: _configure_aws_cli(cmd, self.access_key_id, self.secret_access_key) def create_bucket(self, Bucket: str): - cmd = f'aws --no-verify-ssl s3api create-bucket --bucket {Bucket} --endpoint-url {S3_GATE}' + cmd = f'aws {self.common_flags} s3api create-bucket --bucket {Bucket} ' \ + f'--endpoint {S3_GATE}' _cmd_run(cmd, timeout=90) def list_buckets(self) -> dict: - cmd = f'aws --no-verify-ssl s3api list-buckets --endpoint {S3_GATE}' + cmd = f'aws {self.common_flags} s3api list-buckets --endpoint {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) def get_bucket_versioning(self, Bucket: str) -> dict: - cmd = f'aws --no-verify-ssl s3api get-bucket-versioning --bucket {Bucket}' \ - f' --endpoint {S3_GATE}' + cmd = f'aws {self.common_flags} s3api get-bucket-versioning --bucket {Bucket} ' \ + f'--endpoint {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) def put_bucket_versioning(self, Bucket: str, VersioningConfiguration: dict) -> dict: - cmd = f'aws --no-verify-ssl s3api put-bucket-versioning --bucket {Bucket} ' \ - f'--versioning-configuration Status={VersioningConfiguration.get("Status")}' \ - f' --endpoint {S3_GATE}' + cmd = f'aws {self.common_flags} s3api put-bucket-versioning --bucket {Bucket} ' \ + f'--versioning-configuration Status={VersioningConfiguration.get("Status")} ' \ + f'--endpoint {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) def list_objects(self, Bucket: str) -> dict: - cmd = f'aws --no-verify-ssl s3api list-objects --bucket {Bucket}' \ - f' --endpoint {S3_GATE}' + cmd = f'aws {self.common_flags} s3api list-objects --bucket {Bucket} ' \ + f'--endpoint {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) def list_objects_v2(self, Bucket: str) -> dict: - cmd = f'aws --no-verify-ssl s3api list-objects-v2 --bucket {Bucket}' \ - f' --endpoint {S3_GATE}' + cmd = f'aws {self.common_flags} s3api list-objects-v2 --bucket {Bucket} ' \ + f'--endpoint {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) def list_object_versions(self, Bucket: str) -> dict: - cmd = f'aws --no-verify-ssl s3api list-object-versions --bucket {Bucket}' \ - f' --endpoint {S3_GATE}' + cmd = f'aws {self.common_flags} s3api list-object-versions --bucket {Bucket} ' \ + f'--endpoint {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) def copy_object(self, Bucket: str, CopySource: str, Key: str) -> dict: - cmd = f'aws --no-verify-ssl s3api copy-object --copy-source {CopySource} --bucket {Bucket} --key {Key}' \ - f' --endpoint {S3_GATE}' + cmd = f'aws {self.common_flags} s3api copy-object --copy-source {CopySource} ' \ + f'--bucket {Bucket} --key {Key} --endpoint {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) def head_bucket(self, Bucket: str) -> dict: - cmd = f'aws --no-verify-ssl s3api head-bucket --bucket {Bucket} --endpoint {S3_GATE}' + cmd = f'aws {self.common_flags} s3api head-bucket --bucket {Bucket} --endpoint {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) def put_object(self, Body: str, Bucket: str, Key: str) -> dict: - cmd = f' aws --no-verify-ssl s3api put-object --bucket {Bucket} --key {Key} --body {Body}' \ - f' --endpoint {S3_GATE}' + cmd = f'aws {self.common_flags} s3api put-object --bucket {Bucket} --key {Key} ' \ + f'--body {Body} --endpoint {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) def head_object(self, Bucket: str, Key: str, VersionId: str = None) -> dict: version = f' --version-id {VersionId}' if VersionId else '' - cmd = f' aws --no-verify-ssl s3api head-object --bucket {Bucket} --key {Key} {version}' \ - f' --endpoint {S3_GATE}' + cmd = f'aws {self.common_flags} s3api head-object --bucket {Bucket} --key {Key} ' \ + f'{version} --endpoint {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) def get_object(self, Bucket: str, Key: str, file_path: str, VersionId: str = None) -> dict: version = f' --version-id {VersionId}' if VersionId else '' - cmd = f' aws --no-verify-ssl s3api get-object --bucket {Bucket} ' \ - f'--key {Key} {version} {file_path} --endpoint {S3_GATE}' + cmd = f'aws {self.common_flags} s3api get-object --bucket {Bucket} --key {Key} ' \ + f'{version} {file_path} --endpoint {S3_GATE}' output = _cmd_run(cmd, timeout=90) return self._to_json(output) @@ -96,16 +100,17 @@ class AwsCliClient: file_path = f"{os.getcwd()}/{ASSETS_DIR}/delete.json" with open(file_path, 'w') as out_file: out_file.write(json.dumps(Delete)) + logger.info(f"Input file for delete-objects: {json.dumps(Delete)}") - cmd = f'aws --no-verify-ssl s3api delete-objects --bucket {Bucket} --delete file://{file_path} ' \ - f'--endpoint {S3_GATE}' + cmd = f'aws {self.common_flags} s3api delete-objects --bucket {Bucket} ' \ + f'--delete file://{file_path} --endpoint {S3_GATE}' output = _cmd_run(cmd, timeout=90) return self._to_json(output) def delete_object(self, Bucket: str, Key: str, VersionId: str = None) -> dict: version = f' --version-id {VersionId}' if VersionId else '' - cmd = f'aws --no-verify-ssl s3api delete-object --bucket {Bucket} --key {Key} {version}' \ - f' --endpoint {S3_GATE}' + cmd = f'aws {self.common_flags} s3api delete-object --bucket {Bucket} ' \ + f'--key {Key} {version} --endpoint {S3_GATE}' output = _cmd_run(cmd, timeout=90) return self._to_json(output) @@ -115,93 +120,101 @@ class AwsCliClient: version = f' --version-id {version_id}' if version_id else '' parts = f'--max-parts {max_parts}' if max_parts else '' part_number = f'--part-number-marker {part_number}' if part_number else '' - cmd = f'aws --no-verify-ssl s3api get-object-attributes --bucket {bucket} --key {key} {version}' \ - f' {parts} {part_number} --object-attributes {attrs} --endpoint {S3_GATE}' + cmd = f'aws {self.common_flags} s3api get-object-attributes --bucket {bucket} ' \ + f'--key {key} {version} {parts} {part_number} --object-attributes {attrs} ' \ + f'--endpoint {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) def delete_bucket(self, Bucket: str) -> dict: - cmd = f'aws --no-verify-ssl s3api delete-bucket --bucket {Bucket} --endpoint {S3_GATE}' + cmd = f'aws {self.common_flags} s3api delete-bucket --bucket {Bucket} --endpoint {S3_GATE}' output = _cmd_run(cmd, timeout=90) return self._to_json(output) def get_bucket_tagging(self, Bucket: str) -> dict: - cmd = f'aws --no-verify-ssl s3api get-bucket-tagging --bucket {Bucket} --endpoint {S3_GATE}' + cmd = f'aws {self.common_flags} s3api get-bucket-tagging --bucket {Bucket} ' \ + f'--endpoint {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) def put_bucket_tagging(self, Bucket: str, Tagging: dict) -> dict: - cmd = f'aws --no-verify-ssl s3api put-bucket-tagging --bucket {Bucket} --tagging \'{json.dumps(Tagging)}\'' \ - f' --endpoint {S3_GATE}' + cmd = f"aws {self.common_flags} s3api put-bucket-tagging --bucket {Bucket} " \ + f"--tagging '{json.dumps(Tagging)}' --endpoint {S3_GATE}" output = _cmd_run(cmd) return self._to_json(output) def delete_bucket_tagging(self, Bucket: str) -> dict: - cmd = f'aws --no-verify-ssl s3api delete-bucket-tagging --bucket {Bucket} --endpoint {S3_GATE}' + cmd = f'aws {self.common_flags} s3api delete-bucket-tagging --bucket {Bucket} ' \ + f'--endpoint {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) def put_object_tagging(self, Bucket: str, Key: str, Tagging: dict) -> dict: - cmd = f'aws --no-verify-ssl s3api put-object-tagging --bucket {Bucket} --key {Key}' \ - f' --tagging \'{json.dumps(Tagging)}\'' \ - f' --endpoint {S3_GATE}' + cmd = f"aws {self.common_flags} s3api put-object-tagging --bucket {Bucket} --key {Key} " \ + f"--tagging '{json.dumps(Tagging)}' --endpoint {S3_GATE}" output = _cmd_run(cmd) return self._to_json(output) def get_object_tagging(self, Bucket: str, Key: str) -> dict: - cmd = f'aws --no-verify-ssl s3api get-object-tagging --bucket {Bucket} --key {Key} --endpoint {S3_GATE}' + cmd = f'aws {self.common_flags} s3api get-object-tagging --bucket {Bucket} --key {Key} ' \ + f'--endpoint {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) def delete_object_tagging(self, Bucket: str, Key: str) -> dict: - cmd = f'aws --no-verify-ssl s3api delete-object-tagging --bucket {Bucket} --key {Key} --endpoint {S3_GATE}' + cmd = f'aws {self.common_flags} s3api delete-object-tagging --bucket {Bucket} ' \ + f'--key {Key} --endpoint {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) @allure.step('Sync directory S3') def sync(self, bucket_name: str, dir_path: str) -> dict: - cmd = f'aws --no-verify-ssl s3 sync {dir_path} s3://{bucket_name} --endpoint-url {S3_GATE}' + cmd = f'aws {self.common_flags} s3 sync {dir_path} s3://{bucket_name} ' \ + f'--endpoint-url {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) def create_multipart_upload(self, Bucket: str, Key: str) -> dict: - cmd = f'aws --no-verify-ssl s3api create-multipart-upload --bucket {Bucket} --key {Key}' \ - f' --endpoint-url {S3_GATE}' + cmd = f'aws {self.common_flags} s3api create-multipart-upload --bucket {Bucket} ' \ + f'--key {Key} --endpoint-url {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) def list_multipart_uploads(self, Bucket: str) -> dict: - cmd = f'aws --no-verify-ssl s3api list-multipart-uploads --bucket {Bucket}' \ - f' --endpoint-url {S3_GATE}' + cmd = f'aws {self.common_flags} s3api list-multipart-uploads --bucket {Bucket} ' \ + f'--endpoint-url {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) def abort_multipart_upload(self, Bucket: str, Key: str, UploadId: str) -> dict: - cmd = f'aws --no-verify-ssl s3api abort-multipart-upload --bucket {Bucket} --key {Key}' \ - f' --upload-id {UploadId} --endpoint-url {S3_GATE}' + cmd = f'aws {self.common_flags} s3api abort-multipart-upload --bucket {Bucket} ' \ + f'--key {Key} --upload-id {UploadId} --endpoint-url {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) def upload_part(self, UploadId: str, Bucket: str, Key: str, PartNumber: int, Body: str) -> dict: - cmd = f'aws --no-verify-ssl s3api upload-part --bucket {Bucket} --key {Key} --upload-id {UploadId} ' \ - f'--part-number {PartNumber} --body {Body} --endpoint-url {S3_GATE}' + cmd = f'aws {self.common_flags} s3api upload-part --bucket {Bucket} --key {Key} ' \ + f'--upload-id {UploadId} --part-number {PartNumber} --body {Body} ' \ + f'--endpoint-url {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) def list_parts(self, UploadId: str, Bucket: str, Key: str) -> dict: - cmd = f'aws --no-verify-ssl s3api list-parts --bucket {Bucket} --key {Key} --upload-id {UploadId} ' \ - f' --endpoint-url {S3_GATE}' + cmd = f'aws {self.common_flags} s3api list-parts --bucket {Bucket} --key {Key} ' \ + f'--upload-id {UploadId} --endpoint-url {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output) - def complete_multipart_upload(self, Bucket: str, Key: str, UploadId: str, MultipartUpload: dict) -> dict: + def complete_multipart_upload(self, Bucket: str, Key: str, UploadId: str, + MultipartUpload: dict) -> dict: file_path = f"{os.getcwd()}/{ASSETS_DIR}/parts.json" with open(file_path, 'w') as out_file: out_file.write(json.dumps(MultipartUpload)) + logger.info(f"Input file for complete-multipart-upload: {json.dumps(MultipartUpload)}") - cmd = f'aws --no-verify-ssl s3api complete-multipart-upload --bucket {Bucket} --key {Key}' \ - f' --upload-id {UploadId} --multipart-upload file://{file_path}' \ - f' --endpoint-url {S3_GATE}' + cmd = f'aws {self.common_flags} s3api complete-multipart-upload --bucket {Bucket} ' \ + f'--key {Key} --upload-id {UploadId} --multipart-upload file://{file_path} ' \ + f'--endpoint-url {S3_GATE}' output = _cmd_run(cmd) return self._to_json(output)