diff --git a/swh/deposit/client/__init__.py b/swh/deposit/client/__init__.py new file mode 100755 index 00000000..e69de29b diff --git a/bin/swh-deposit b/swh/deposit/client/cli.py similarity index 99% rename from bin/swh-deposit rename to swh/deposit/client/cli.py index 78d4aeed..29419b47 100755 --- a/bin/swh-deposit +++ b/swh/deposit/client/cli.py @@ -1,242 +1,240 @@ -#!/usr/bin/env python3 - # Copyright (C) 2018 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information """Script to demonstrate software deposit scenario to https://deposit.sofwareheritage.org. Use: ./swh-deposit --help """ import os import click import logging import uuid from swh.deposit.loader.client import DepositClient class InputError(ValueError): """Input script error """ pass def generate_slug(prefix='swh-sample'): """Generate a slug (sample purposes). """ return '%s-%s' % (prefix, uuid.uuid4()) def parse_cli_options(archive, username, password, metadata, binary_deposit, metadata_deposit, collection, slug, partial, deposit_id, url): """Parse the cli options and make sure the combination is acceptable. If not, an InputError exception is raised explaining the issue. Raises: InputError explaining the issue Returns: dict with the following keys: 'archive': the software archive to deposit 'username': username 'password': associated password 'metadata': the metadata file to deposit 'collection': the username's associated client 'slug': the slug or external id identifying the deposit to make 'partial': if the deposit is partial or not 'client': instantiated class 'url': deposit's server main entry point 'deposit_type': deposit's type (binary, multipart, metadata) """ if binary_deposit and metadata_deposit: # too many flags use, remove redundant ones (-> multipart deposit) binary_deposit = False metadata_deposit = False if not os.path.exists(archive): raise InputError('Software Archive %s must exist!' % archive) if not metadata: metadata = '%s.metadata.xml' % archive if not binary_deposit and not os.path.exists(metadata): raise InputError('Software Archive metadata %s must exist!' % metadata) client = DepositClient({ 'url': url, 'auth': { 'username': username, 'password': password }, }) if collection: # transpose to the right collection path collection = '/%s/' % collection if not collection: # retrieve user's collection sd_content = client.service_document() if 'error' in sd_content: raise InputError(sd_content['error']) collection = sd_content['collection'] if not slug: # generate slug slug = generate_slug() if binary_deposit: deposit_type = 'binary' elif metadata_deposit: deposit_type = 'metadata' else: deposit_type = 'multipart' return { 'archive': archive, 'username': username, 'password': password, 'metadata': metadata, 'collection': collection, 'slug': slug, 'partial': partial, 'client': client, 'url': url, 'deposit_type': deposit_type, } def do_binary_deposit(config, dry_run, log): """Execute the binary deposit. """ log.debug('Binary deposit') deposit_url = config['collection'] filepath = config['archive'] slug = config['slug'] client = config['client'] in_progress = config['partial'] if not dry_run: return client.deposit_binary(deposit_url, filepath, slug, in_progress) return {} def do_metadata_deposit(config, dry_run, log): log.debug('Metadata deposit') deposit_url = config['collection'] filepath = config['metadata'] slug = config['slug'] client = config['client'] in_progress = config['partial'] if not dry_run: r = client.deposit_metadata(deposit_url, filepath, slug, in_progress) return r return {} def do_multipart_deposit(config, dry_run, log): log.debug('Multipart deposit') client = config['client'] deposit_url = config['collection'] archive_path = config['archive'] metadata_path = config['metadata'] slug = config['slug'] client = config['client'] in_progress = config['partial'] if not dry_run: r = client.deposit_multipart(deposit_url, archive_path, metadata_path, slug, in_progress) return r return {} @click.command(help='Software Heritage Deposit client') @click.argument('archive', required=1) @click.option('--username', required=1, help="Mandatory user's name") @click.option('--password', required=1, help="Mandatory user's associated password") @click.option('--metadata', help="""Optional path to an xml metadata file. If not provided, this will use a file named .metadata.xml""") @click.option('--binary-deposit/--no-binary-deposit', default=False, help='Software archive only deposit') @click.option('--metadata-deposit/--no-metadata-deposit', default=False, help='Metadata only deposit') @click.option('--collection', help="""Optional user's collection. If not provided, this will be retrieved.""") @click.option('--slug', help="""External system information identifier. If not provided, it will be generated""") @click.option('--partial/--no-partial', default=False, help='The deposit will be partial (as in not finished)') @click.option('--deposit-id', type=click.INT, help='Update an existing partial deposit with its identifier') @click.option('--url', default='http://localhost:5006/1') @click.option('--dry-run/--no-dry-run', default=False) @click.option('--verbose/--no-verbose', default=False) def main(archive, username, password, metadata=None, binary_deposit=False, metadata_deposit=False, collection=None, slug=None, partial=False, deposit_id=None, url='http://localhost:5006/1', dry_run=True, verbose=False): log = logging.getLogger('swh-deposit') log.addHandler(logging.StreamHandler()) _loglevel = logging.DEBUG if verbose else logging.INFO log.setLevel(_loglevel) if dry_run: log.info("**DRY RUN**") config = {} try: log.debug('Parsing cli options') config = parse_cli_options( archive, username, password, metadata, binary_deposit, metadata_deposit, collection, slug, partial, deposit_id, url) except InputError as e: log.error('Problem during parsing options: %s' % e) return 1 if verbose: log.info("Parsed configuration: %s" % ( config, )) deposit_fn = { 'binary': lambda config, dry_run=dry_run, log=log: do_binary_deposit( config, dry_run, log), 'metadata': lambda config, dry_run=dry_run, log=log: do_metadata_deposit( config, dry_run, log), 'multipart': lambda config, dry_run=dry_run, log=log: do_multipart_deposit( config, dry_run, log), } deposit_type = config['deposit_type'] r = deposit_fn[deposit_type](config) if r: log.info(r) if __name__ == '__main__': main()