sdk/cwl/arvados_cwl/arvdocker.py

   1 # Copyright (C) The Arvados Authors. All rights reserved.
   2 #
   3 # SPDX-License-Identifier: Apache-2.0
   4
   5 import logging
   6 import sys
   7 import threading
   8 import copy
   9 import re
  10 import subprocess
  11
  12 from schema_salad.sourceline import SourceLine
  13
  14 import cwltool.docker
  15 from cwltool.errors import WorkflowException
  16 import arvados.commands.keepdocker
  17
  18 logger = logging.getLogger('arvados.cwl-runner')
  19
  20 cached_lookups = {}
  21 cached_lookups_lock = threading.Lock()
  22
  23 def determine_image_id(dockerImageId):
  24     for line in (
  25         subprocess.check_output(  # nosec
  26             ["docker", "images", "--no-trunc", "--all"]
  27         )
  28         .decode("utf-8")
  29         .splitlines()
  30     ):
  31         try:
  32             match = re.match(r"^([^ ]+)\s+([^ ]+)\s+([^ ]+)", line)
  33             split = dockerImageId.split(":")
  34             if len(split) == 1:
  35                 split.append("latest")
  36             elif len(split) == 2:
  37                 #  if split[1] doesn't  match valid tag names, it is a part of repository
  38                 if not re.match(r"[\w][\w.-]{0,127}", split[1]):
  39                     split[0] = split[0] + ":" + split[1]
  40                     split[1] = "latest"
  41             elif len(split) == 3:
  42                 if re.match(r"[\w][\w.-]{0,127}", split[2]):
  43                     split[0] = split[0] + ":" + split[1]
  44                     split[1] = split[2]
  45                     del split[2]
  46
  47             # check for repository:tag match or image id match
  48             if match and (
  49                 (split[0] == match.group(1) and split[1] == match.group(2))
  50                 or dockerImageId == match.group(3)
  51             ):
  52                 return match.group(3)
  53         except ValueError:
  54             pass
  55
  56     return None
  57
  58
  59 def arv_docker_get_image(api_client, dockerRequirement, pull_image, project_uuid,
  60                          force_pull, tmp_outdir_prefix, match_local_docker, copy_deps):
  61     """Check if a Docker image is available in Keep, if not, upload it using arv-keepdocker."""
  62
  63     if "http://arvados.org/cwl#dockerCollectionPDH" in dockerRequirement:
  64         return dockerRequirement["http://arvados.org/cwl#dockerCollectionPDH"]
  65
  66     if "dockerImageId" not in dockerRequirement and "dockerPull" in dockerRequirement:
  67         dockerRequirement = copy.deepcopy(dockerRequirement)
  68         dockerRequirement["dockerImageId"] = dockerRequirement["dockerPull"]
  69         if hasattr(dockerRequirement, 'lc'):
  70             dockerRequirement.lc.data["dockerImageId"] = dockerRequirement.lc.data["dockerPull"]
  71
  72     global cached_lookups
  73     global cached_lookups_lock
  74     with cached_lookups_lock:
  75         if dockerRequirement["dockerImageId"] in cached_lookups:
  76             return cached_lookups[dockerRequirement["dockerImageId"]]
  77
  78     with SourceLine(dockerRequirement, "dockerImageId", WorkflowException, logger.isEnabledFor(logging.DEBUG)):
  79         sp = dockerRequirement["dockerImageId"].split(":")
  80         image_name = sp[0]
  81         image_tag = sp[1] if len(sp) > 1 else "latest"
  82
  83         out_of_project_images = arvados.commands.keepdocker.list_images_in_arv(api_client, 3,
  84                                                                 image_name=image_name,
  85                                                                 image_tag=image_tag,
  86                                                                 project_uuid=None)
  87
  88         if copy_deps:
  89             # Only images that are available in the destination project
  90             images = arvados.commands.keepdocker.list_images_in_arv(api_client, 3,
  91                                                                     image_name=image_name,
  92                                                                     image_tag=image_tag,
  93                                                                     project_uuid=project_uuid)
  94         else:
  95             images = out_of_project_images
  96
  97         if match_local_docker:
  98             local_image_id = determine_image_id(dockerRequirement["dockerImageId"])
  99             if local_image_id:
 100                 # find it in the list
 101                 found = False
 102                 for i in images:
 103                     if i[1]["dockerhash"] == local_image_id:
 104                         found = True
 105                         images = [i]
 106                         break
 107                 if not found:
 108                     # force re-upload.
 109                     images = []
 110
 111                 for i in out_of_project_images:
 112                     if i[1]["dockerhash"] == local_image_id:
 113                         found = True
 114                         out_of_project_images = [i]
 115                         break
 116                 if not found:
 117                     # force re-upload.
 118                     out_of_project_images = []
 119
 120         if not images:
 121             if not out_of_project_images:
 122                 # Fetch Docker image if necessary.
 123                 try:
 124                     result = cwltool.docker.DockerCommandLineJob.get_image(dockerRequirement, pull_image,
 125                                                                   force_pull, tmp_outdir_prefix)
 126                     if not result:
 127                         raise WorkflowException("Docker image '%s' not available" % dockerRequirement["dockerImageId"])
 128                 except OSError as e:
 129                     raise WorkflowException("While trying to get Docker image '%s', failed to execute 'docker': %s" % (dockerRequirement["dockerImageId"], e))
 130
 131             # Upload image to Arvados
 132             args = []
 133             if project_uuid:
 134                 args.append("--project-uuid="+project_uuid)
 135             args.append(image_name)
 136             args.append(image_tag)
 137             logger.info("Uploading Docker image %s:%s", image_name, image_tag)
 138             try:
 139                 arvados.commands.put.api_client = api_client
 140                 arvados.commands.keepdocker.main(args, stdout=sys.stderr, install_sig_handlers=False, api=api_client)
 141             except SystemExit as e:
 142                 # If e.code is None or zero, then keepdocker exited normally and we can continue
 143                 if e.code:
 144                     raise WorkflowException("keepdocker exited with code %s" % e.code)
 145
 146             images = arvados.commands.keepdocker.list_images_in_arv(api_client, 3,
 147                                                                     image_name=image_name,
 148                                                                     image_tag=image_tag,
 149                                                                     project_uuid=project_uuid)
 150
 151         if not images:
 152             raise WorkflowException("Could not find Docker image %s:%s" % (image_name, image_tag))
 153
 154         pdh = api_client.collections().get(uuid=images[0][0]).execute()["portable_data_hash"]
 155
 156         with cached_lookups_lock:
 157             cached_lookups[dockerRequirement["dockerImageId"]] = pdh
 158
 159     return pdh
 160
 161 def arv_docker_clear_cache():
 162     global cached_lookups
 163     global cached_lookups_lock
 164     with cached_lookups_lock:
 165         cached_lookups = {}