172 lines
6.2 KiB
Python
172 lines
6.2 KiB
Python
# -*- coding: utf-8 -*- #
|
|
# Copyright 2023 Google LLC. All Rights Reserved.
|
|
#
|
|
# 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.
|
|
"""Implements the command to download generic artifacts from a repository."""
|
|
|
|
from __future__ import absolute_import
|
|
from __future__ import division
|
|
from __future__ import unicode_literals
|
|
|
|
import os
|
|
|
|
from googlecloudsdk.api_lib.artifacts import exceptions as ar_exceptions
|
|
from googlecloudsdk.calliope import base
|
|
from googlecloudsdk.command_lib.artifacts import download_util
|
|
from googlecloudsdk.command_lib.artifacts import file_util
|
|
from googlecloudsdk.command_lib.artifacts import flags
|
|
from googlecloudsdk.core import log
|
|
|
|
|
|
@base.DefaultUniverseOnly
|
|
@base.ReleaseTracks(
|
|
base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA, base.ReleaseTrack.GA
|
|
)
|
|
class Download(base.Command):
|
|
"""Download a generic artifact from a generic artifact repository."""
|
|
|
|
detailed_help = {
|
|
'DESCRIPTION': '{description}',
|
|
'EXAMPLES': """\
|
|
To download version v0.1.0 of myfile.txt located in a repository in "us-central1" to /path/to/destination/:
|
|
|
|
$ {command} --location=us-central1 --project=myproject --repository=myrepo \
|
|
--package=mypackage --version=v0.1.0 --destination=/path/to/destination/ \
|
|
--name=myfile.txt
|
|
|
|
To download version v0.1.0 of myfile.txt located in a repository in "us-central1" to /path/to/destination/ using parallel multipart download with 4 threads:
|
|
|
|
$ {command} --location=us-central1 --project=myproject --repository=myrepo \
|
|
--package=mypackage --version=v0.1.0 --destination=/path/to/destination/ \
|
|
--name=myfile.txt --parallelism=4
|
|
|
|
To download version v0.1.0 of myfile.txt in 8000 byte chunks located in a repository in "us-central1" to /path/to/destination/:
|
|
|
|
$ {command} --location=us-central1 --project=myproject --repository=myrepo \
|
|
--package=mypackage --version=v0.1.0 --destination=/path/to/destination/ \
|
|
--name=myfile.txt --chunk-size=8000
|
|
|
|
To download all files of version v0.1.0 and package mypackage located in a repository in "us-central1" to /path/to/destination/
|
|
while maintaining the folder hierarchy:
|
|
|
|
$ {command} --location=us-central1 --project=myproject --repository=myrepo \
|
|
--package=mypackage --version=v0.1.0 --destination=/path/to/destination/
|
|
""",
|
|
}
|
|
|
|
@staticmethod
|
|
def Args(parser):
|
|
"""Set up arguments for this command.
|
|
|
|
Args:
|
|
parser: An argparse.ArgumentParser.
|
|
"""
|
|
flags.GetRequiredRepoFlag().AddToParser(parser)
|
|
flags.GetChunkSize().AddToParser(parser)
|
|
|
|
parser.add_argument(
|
|
'--destination',
|
|
metavar='DESTINATION',
|
|
required=True,
|
|
help='The path where you want to save the downloaded file.',
|
|
)
|
|
parser.add_argument(
|
|
'--package',
|
|
metavar='ARTIFACT',
|
|
required=True,
|
|
help='The artifact to download.',
|
|
)
|
|
parser.add_argument(
|
|
'--version',
|
|
metavar='VERSION',
|
|
required=True,
|
|
help='The version of the artifact to download.',
|
|
)
|
|
parser.add_argument(
|
|
'--name',
|
|
metavar='NAME',
|
|
help='If specified, the file name within the artifact to download.'
|
|
)
|
|
parser.add_argument(
|
|
'--parallelism',
|
|
metavar='PARALLELISM',
|
|
help=(
|
|
'Specifies the number of threads to use for downloading the file in'
|
|
' parallel.'
|
|
),
|
|
)
|
|
|
|
def Run(self, args):
|
|
"""Run the generic artifact download command."""
|
|
|
|
repo_ref = args.CONCEPTS.repository.Parse()
|
|
args.destination = os.path.expanduser(args.destination)
|
|
if not os.path.exists(args.destination):
|
|
raise ar_exceptions.DirectoryNotExistError(
|
|
'Destination directory does not exist: ' + args.destination
|
|
)
|
|
if not os.path.isdir(args.destination):
|
|
raise ar_exceptions.PathNotDirectoryError(
|
|
'Destination is not a directory: ' + args.destination
|
|
)
|
|
# Get the file name when given a file path
|
|
if args.name:
|
|
file_name = os.path.basename(args.name)
|
|
file_id = '{}:{}:{}'.format(args.package, args.version, args.name)
|
|
self.downloadGenericArtifact(args, repo_ref, file_id, file_name)
|
|
else:
|
|
# file name was not specified, download all files in the given version.
|
|
list_files = file_util.ListGenericFiles(args)
|
|
if not list_files:
|
|
raise ar_exceptions.ArtifactRegistryError(
|
|
'No files found for package: {} version: {}'.format(
|
|
args.package, args.version
|
|
)
|
|
)
|
|
self.batchDownloadFiles(args, repo_ref, list_files)
|
|
|
|
def downloadGenericArtifact(self, args, repo_ref, file_id, file_name):
|
|
final_path = os.path.join(args.destination, file_name)
|
|
file_escaped = file_util.EscapeFileNameFromIDs(
|
|
repo_ref.projectsId,
|
|
repo_ref.locationsId,
|
|
repo_ref.repositoriesId,
|
|
file_id,
|
|
)
|
|
default_chunk_size = 3 * 1024 * 1024
|
|
chunk_size = args.chunk_size or default_chunk_size
|
|
parallelism = args.parallelism or 1
|
|
|
|
download_util.Download(
|
|
final_path,
|
|
file_escaped.RelativeName(),
|
|
file_name,
|
|
False,
|
|
int(chunk_size),
|
|
int(parallelism),
|
|
)
|
|
log.status.Print(
|
|
'Successfully downloaded the file to {}'.format(args.destination)
|
|
)
|
|
|
|
def batchDownloadFiles(self, args, repo_ref, list_files):
|
|
for files in list_files:
|
|
# Extract just the file id.
|
|
file_id = os.path.basename(files.name)
|
|
file_name = file_id.rsplit(':', 1)[1].replace('%2F', '/')
|
|
# Create the directory structure.
|
|
if '/' in file_name:
|
|
d = os.path.dirname(file_name)
|
|
os.makedirs(os.path.join(args.destination, d), exist_ok=True)
|
|
self.downloadGenericArtifact(args, repo_ref, file_id, file_name)
|