zuul-jobs/roles/upload-image-s3/library/upload_image_s3.py
James E. Blair 0c004096c6 Add upload-image-s3 role
This adds a role similar to upload-image-swift to upload dib images
to s3 for use by zuul-launcher.

Change-Id: Ie802a0221717e6d5d5dcaa91771d07f8d0321889
2025-03-25 09:28:28 -07:00

137 lines
3.9 KiB
Python

# Copyright 2014 Rackspace Australia
# Copyright 2018 Red Hat, Inc
# Copyright 2024-2025 Acme Gating, LLC
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import argparse
import datetime
import logging
import os
import sys
import traceback
import boto3
from ansible.module_utils.basic import AnsibleModule
def prune(bucket, delete_after):
# In case the automatic expiration doesn't work, manually prune old uploads
if not delete_after:
return
target = (datetime.datetime.now(datetime.UTC) -
datetime.timedelta(seconds=delete_after))
for obj in bucket.objects.all():
if obj.last_modified < target:
obj.delete()
def run(endpoint, bucket_name, aws_access_key, aws_secret_key,
filename, name, delete_after=None):
endpoint = endpoint or 'https://s3.amazonaws.com/'
s3 = boto3.resource('s3',
endpoint_url=endpoint,
aws_access_key_id=aws_access_key,
aws_secret_access_key=aws_secret_key)
bucket = s3.Bucket(bucket_name)
prune(bucket, delete_after)
bucket.upload_file(filename, name)
url = os.path.join(endpoint, bucket_name, name)
return url
def ansible_main():
module = AnsibleModule(
argument_spec=dict(
endpoint=dict(type='str'),
bucket=dict(required=True, type='str'),
filename=dict(required=True, type='path'),
name=dict(required=True, type='str'),
delete_after=dict(type='int'),
aws_access_key=dict(type='str'),
aws_secret_key=dict(type='str', no_log=True),
)
)
p = module.params
try:
url = run(
p.get('endpoint'),
p.get('bucket'),
p.get('aws_access_key'),
p.get('aws_secret_key'),
p.get('filename'),
p.get('name'),
delete_after=p.get('delete_after'),
)
except Exception:
s = "Error uploading to S3"
s += "\n" + traceback.format_exc()
module.fail_json(
changed=False,
msg=s)
module.exit_json(
changed=True,
url=url,
)
def cli_main():
parser = argparse.ArgumentParser(
description="Upload image to S3"
)
parser.add_argument('--verbose', action='store_true',
help='show debug information')
parser.add_argument('--endpoint',
help='http endpoint of s3 service')
parser.add_argument('bucket',
help='Name of the bucket to use when uploading')
parser.add_argument('filename',
help='the file to upload')
parser.add_argument('name',
help='the object name')
parser.add_argument('--delete-after',
help='Number of seconds to delete object after '
'upload. Default is 3 days (259200 seconds) '
'and if set to 0 X-Delete-After will not be set',
type=int)
args = parser.parse_args()
if args.verbose:
logging.basicConfig(level=logging.DEBUG)
logging.captureWarnings(True)
url = run(
args.endpoint,
args.bucket,
None,
None,
args.filename,
args.name,
delete_after=args.delete_after,
)
print(url)
if __name__ == '__main__':
if not sys.stdin.isatty():
ansible_main()
else:
cli_main()