11789: Merge branch 'master' into 11789-arvput-exclude-flag

[arvados.git] / sdk / python / tests / test_arv_keepdocker.py

diff --git a/sdk/python/tests/test_arv_keepdocker.py b/sdk/python/tests/test_arv_keepdocker.py
index bb94db560f631333a9945f8c3388ebc66a69266c..36b4954e515bda07b272b1d33e7fe9df4c3c17aa 100644 (file)
--- a/sdk/python/tests/test_arv_keepdocker.py
+++ b/sdk/python/tests/test_arv_keepdocker.py
@@ -1,30 +1,116 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
+# Copyright (C) The Arvados Authors. All rights reserved.
+#
+# SPDX-License-Identifier: Apache-2.0
 
-import io
+from __future__ import absolute_import
+import arvados
+import hashlib
+import mock
 import os
+import subprocess
 import sys
 import tempfile
 import unittest
+import logging
 
 import arvados.commands.keepdocker as arv_keepdocker
-import arvados_testutil as tutil
+from . import arvados_testutil as tutil
+from . import run_test_server
 
 
-class ArvKeepdockerTestCase(unittest.TestCase):
-    def run_arv_keepdocker(self, args):
+class StopTest(Exception):
+    pass
+
+
+class ArvKeepdockerTestCase(unittest.TestCase, tutil.VersionChecker):
+    def run_arv_keepdocker(self, args, err):
         sys.argv = ['arv-keepdocker'] + args
-        return arv_keepdocker.main()
+        log_handler = logging.StreamHandler(err)
+        arv_keepdocker.logger.addHandler(log_handler)
+        try:
+            return arv_keepdocker.main()
+        finally:
+            arv_keepdocker.logger.removeHandler(log_handler)
 
     def test_unsupported_arg(self):
         with self.assertRaises(SystemExit):
-            self.run_arv_keepdocker(['-x=unknown'])
+            self.run_arv_keepdocker(['-x=unknown'], sys.stderr)
 
     def test_version_argument(self):
-        err = io.BytesIO()
-        out = io.BytesIO()
-        with tutil.redirected_streams(stdout=out, stderr=err):
+        with tutil.redirected_streams(
+                stdout=tutil.StringIO, stderr=tutil.StringIO) as (out, err):
             with self.assertRaises(SystemExit):
-                self.run_arv_keepdocker(['--version'])
-        self.assertEqual(out.getvalue(), '')
-        self.assertRegexpMatches(err.getvalue(), "[0-9]+\.[0-9]+\.[0-9]+")
+                self.run_arv_keepdocker(['--version'], sys.stderr)
+        self.assertVersionOutput(out, err)
+
+    @mock.patch('arvados.commands.keepdocker.find_image_hashes',
+                return_value=['abc123'])
+    @mock.patch('arvados.commands.keepdocker.find_one_image_hash',
+                return_value='abc123')
+    def test_image_format_compatibility(self, _1, _2):
+        old_id = hashlib.sha256(b'old').hexdigest()
+        new_id = 'sha256:'+hashlib.sha256(b'new').hexdigest()
+        for supported, img_id, expect_ok in [
+                (['v1'], old_id, True),
+                (['v1'], new_id, False),
+                (None, old_id, False),
+                ([], old_id, False),
+                ([], new_id, False),
+                (['v1', 'v2'], new_id, True),
+                (['v1'], new_id, False),
+                (['v2'], new_id, True)]:
+
+            fakeDD = arvados.api('v1')._rootDesc
+            if supported is None:
+                del fakeDD['dockerImageFormats']
+            else:
+                fakeDD['dockerImageFormats'] = supported
+
+            err = tutil.StringIO()
+            out = tutil.StringIO()
+
+            with tutil.redirected_streams(stdout=out), \
+                 mock.patch('arvados.api') as api, \
+                 mock.patch('arvados.commands.keepdocker.popen_docker',
+                            return_value=subprocess.Popen(
+                                ['echo', img_id],
+                                stdout=subprocess.PIPE)), \
+                 mock.patch('arvados.commands.keepdocker.prep_image_file',
+                            side_effect=StopTest), \
+                 self.assertRaises(StopTest if expect_ok else SystemExit):
+
+                api()._rootDesc = fakeDD
+                self.run_arv_keepdocker(['--force', 'testimage'], err)
+
+            self.assertEqual(out.getvalue(), '')
+            if expect_ok:
+                self.assertNotRegex(
+                    err.getvalue(), "refusing to store",
+                    msg=repr((supported, img_id)))
+            else:
+                self.assertRegex(
+                    err.getvalue(), "refusing to store",
+                    msg=repr((supported, img_id)))
+            if not supported:
+                self.assertRegex(
+                    err.getvalue(),
+                    "server does not specify supported image formats",
+                    msg=repr((supported, img_id)))
+
+        fakeDD = arvados.api('v1')._rootDesc
+        fakeDD['dockerImageFormats'] = ['v1']
+        err = tutil.StringIO()
+        out = tutil.StringIO()
+        with tutil.redirected_streams(stdout=out), \
+             mock.patch('arvados.api') as api, \
+             mock.patch('arvados.commands.keepdocker.popen_docker',
+                        return_value=subprocess.Popen(
+                            ['echo', new_id],
+                            stdout=subprocess.PIPE)), \
+             mock.patch('arvados.commands.keepdocker.prep_image_file',
+                        side_effect=StopTest), \
+             self.assertRaises(StopTest):
+            api()._rootDesc = fakeDD
+            self.run_arv_keepdocker(
+                ['--force', '--force-image-format', 'testimage'], err)
+        self.assertRegex(err.getvalue(), "forcing incompatible image")