sdk/cwl/tests/test_container.py

   1 import arvados_cwl
   2 import logging
   3 import mock
   4 import unittest
   5 import os
   6 import functools
   7 import cwltool.process
   8 from schema_salad.ref_resolver import Loader
   9
  10 from schema_salad.ref_resolver import Loader
  11
  12 if not os.getenv('ARVADOS_DEBUG'):
  13     logging.getLogger('arvados.cwl-runner').setLevel(logging.WARN)
  14     logging.getLogger('arvados.arv-run').setLevel(logging.WARN)
  15
  16
  17 class TestContainer(unittest.TestCase):
  18
  19     # The test passes no builder.resources
  20     # Hence the default resources will apply: {'cores': 1, 'ram': 1024, 'outdirSize': 1024, 'tmpdirSize': 1024}
  21     @mock.patch("arvados.commands.keepdocker.list_images_in_arv")
  22     def test_run(self, keepdocker):
  23         runner = mock.MagicMock()
  24         runner.project_uuid = "zzzzz-8i9sb-zzzzzzzzzzzzzzz"
  25         runner.ignore_docker_for_reuse = False
  26
  27         keepdocker.return_value = [("zzzzz-4zz18-zzzzzzzzzzzzzz3", "")]
  28         runner.api.collections().get().execute.return_value = {
  29             "portable_data_hash": "99999999999999999999999999999993+99"}
  30
  31         document_loader, avsc_names, schema_metadata, metaschema_loader = cwltool.process.get_schema("draft-3")
  32
  33         tool = {
  34             "inputs": [],
  35             "outputs": [],
  36             "baseCommand": "ls",
  37             "arguments": [{"valueFrom": "$(runtime.outdir)"}]
  38         }
  39         make_fs_access=functools.partial(arvados_cwl.CollectionFsAccess, api_client=runner.api)
  40         arvtool = arvados_cwl.ArvadosCommandTool(runner, tool, work_api="containers", avsc_names=avsc_names,
  41                                                  basedir="", make_fs_access=make_fs_access, loader=Loader({}))
  42         arvtool.formatgraph = None
  43         for j in arvtool.job({}, mock.MagicMock(), basedir="", name="test_run",
  44                              make_fs_access=make_fs_access, tmpdir="/tmp"):
  45             j.run()
  46             runner.api.container_requests().create.assert_called_with(
  47                 body={
  48                     'environment': {
  49                         'HOME': '/var/spool/cwl',
  50                         'TMPDIR': '/tmp'
  51                     },
  52                     'name': 'test_run',
  53                     'runtime_constraints': {
  54                         'vcpus': 1,
  55                         'ram': 1073741824
  56                     }, 'priority': 1,
  57                     'mounts': {
  58                         '/var/spool/cwl': {'kind': 'tmp'}
  59                     },
  60                     'state': 'Committed',
  61                     'owner_uuid': 'zzzzz-8i9sb-zzzzzzzzzzzzzzz',
  62                     'output_path': '/var/spool/cwl',
  63                     'container_image': '99999999999999999999999999999993+99',
  64                     'command': ['ls', '/var/spool/cwl'],
  65                     'cwd': '/var/spool/cwl'
  66                 })
  67
  68     # The test passes some fields in builder.resources
  69     # For the remaining fields, the defaults will apply: {'cores': 1, 'ram': 1024, 'outdirSize': 1024, 'tmpdirSize': 1024}
  70     @mock.patch("arvados.commands.keepdocker.list_images_in_arv")
  71     def test_resource_requirements(self, keepdocker):
  72         runner = mock.MagicMock()
  73         runner.project_uuid = "zzzzz-8i9sb-zzzzzzzzzzzzzzz"
  74         runner.ignore_docker_for_reuse = False
  75         document_loader, avsc_names, schema_metadata, metaschema_loader = cwltool.process.get_schema("draft-3")
  76
  77         keepdocker.return_value = [("zzzzz-4zz18-zzzzzzzzzzzzzz3", "")]
  78         runner.api.collections().get().execute.return_value = {
  79             "portable_data_hash": "99999999999999999999999999999993+99"}
  80
  81         tool = {
  82             "inputs": [],
  83             "outputs": [],
  84             "hints": [{
  85                 "class": "ResourceRequirement",
  86                 "coresMin": 3,
  87                 "ramMin": 3000,
  88                 "tmpdirMin": 4000
  89             }, {
  90                 "class": "http://arvados.org/cwl#RuntimeConstraints",
  91                 "keep_cache": 512
  92             }, {
  93                 "class": "http://arvados.org/cwl#APIRequirement",
  94             }],
  95             "baseCommand": "ls"
  96         }
  97         make_fs_access=functools.partial(arvados_cwl.CollectionFsAccess, api_client=runner.api)
  98         arvtool = arvados_cwl.ArvadosCommandTool(runner, tool, work_api="containers",
  99                                                  avsc_names=avsc_names, make_fs_access=make_fs_access,
 100                                                  loader=Loader({}))
 101         arvtool.formatgraph = None
 102         for j in arvtool.job({}, mock.MagicMock(), basedir="", name="test_resource_requirements",
 103                              make_fs_access=make_fs_access, tmpdir="/tmp"):
 104             j.run()
 105
 106         runner.api.container_requests().create.assert_called_with(
 107             body={
 108                 'environment': {
 109                     'HOME': '/var/spool/cwl',
 110                     'TMPDIR': '/tmp'
 111                 },
 112                 'name': 'test_resource_requirements',
 113                 'runtime_constraints': {
 114                     'vcpus': 3,
 115                     'ram': 3145728000,
 116                     'API': True
 117                 }, 'priority': 1,
 118                 'mounts': {
 119                     '/var/spool/cwl': {'kind': 'tmp'}
 120                 },
 121                 'state': 'Committed',
 122                 'owner_uuid': 'zzzzz-8i9sb-zzzzzzzzzzzzzzz',
 123                 'output_path': '/var/spool/cwl',
 124                 'container_image': '99999999999999999999999999999993+99',
 125                 'command': ['ls'],
 126                 'cwd': '/var/spool/cwl'
 127             })
 128
 129     @mock.patch("arvados.collection.Collection")
 130     def test_done(self, col):
 131         api = mock.MagicMock()
 132
 133         runner = mock.MagicMock()
 134         runner.api = api
 135         runner.project_uuid = "zzzzz-8i9sb-zzzzzzzzzzzzzzz"
 136         runner.num_retries = 0
 137         runner.ignore_docker_for_reuse = False
 138
 139         col().open.return_value = []
 140         api.collections().list().execute.side_effect = ({"items": []},
 141                                                         {"items": [{"manifest_text": "XYZ"}]})
 142
 143         arvjob = arvados_cwl.ArvadosContainer(runner)
 144         arvjob.name = "testjob"
 145         arvjob.builder = mock.MagicMock()
 146         arvjob.output_callback = mock.MagicMock()
 147         arvjob.collect_outputs = mock.MagicMock()
 148         arvjob.successCodes = [0]
 149         arvjob.outdir = "/var/spool/cwl"
 150
 151         arvjob.done({
 152             "state": "Complete",
 153             "output": "99999999999999999999999999999993+99",
 154             "log": "99999999999999999999999999999994+99",
 155             "uuid": "zzzzz-8i9sb-zzzzzzzzzzzzzzz",
 156             "exit_code": 0
 157         })
 158
 159         api.collections().list.assert_has_calls([
 160             mock.call(),
 161             mock.call(filters=[['owner_uuid', '=', 'zzzzz-8i9sb-zzzzzzzzzzzzzzz'],
 162                           ['portable_data_hash', '=', '99999999999999999999999999999993+99'],
 163                           ['name', '=', 'Output 9999999 of testjob']]),
 164             mock.call().execute(num_retries=0),
 165             mock.call(limit=1, filters=[['portable_data_hash', '=', '99999999999999999999999999999993+99']],
 166                  select=['manifest_text']),
 167             mock.call().execute(num_retries=0)])
 168
 169         api.collections().create.assert_called_with(
 170             ensure_unique_name=True,
 171             body={'portable_data_hash': '99999999999999999999999999999993+99',
 172                   'manifest_text': 'XYZ',
 173                   'owner_uuid': 'zzzzz-8i9sb-zzzzzzzzzzzzzzz',
 174                   'name': 'Output 9999999 of testjob'})
 175
 176     @mock.patch("arvados.collection.Collection")
 177     def test_done_use_existing_collection(self, col):
 178         api = mock.MagicMock()
 179
 180         runner = mock.MagicMock()
 181         runner.api = api
 182         runner.project_uuid = "zzzzz-8i9sb-zzzzzzzzzzzzzzz"
 183         runner.num_retries = 0
 184
 185         col().open.return_value = []
 186         api.collections().list().execute.side_effect = ({"items": [{"uuid": "zzzzz-4zz18-zzzzzzzzzzzzzz2"}]},)
 187
 188         arvjob = arvados_cwl.ArvadosContainer(runner)
 189         arvjob.name = "testjob"
 190         arvjob.builder = mock.MagicMock()
 191         arvjob.output_callback = mock.MagicMock()
 192         arvjob.collect_outputs = mock.MagicMock()
 193         arvjob.successCodes = [0]
 194         arvjob.outdir = "/var/spool/cwl"
 195
 196         arvjob.done({
 197             "state": "Complete",
 198             "output": "99999999999999999999999999999993+99",
 199             "log": "99999999999999999999999999999994+99",
 200             "uuid": "zzzzz-8i9sb-zzzzzzzzzzzzzzz",
 201             "exit_code": 0
 202         })
 203
 204         api.collections().list.assert_has_calls([
 205             mock.call(),
 206             mock.call(filters=[['owner_uuid', '=', 'zzzzz-8i9sb-zzzzzzzzzzzzzzz'],
 207                                ['portable_data_hash', '=', '99999999999999999999999999999993+99'],
 208                                ['name', '=', 'Output 9999999 of testjob']]),
 209             mock.call().execute(num_retries=0)])
 210
 211         self.assertFalse(api.collections().create.called)