Teach the integration tests how to check nested bundles

Signed-off-by: Hunor Csomortáni <csomh@redhat.com>

tests/integration/push_nvr/push_nvr_test.py

@@ -7,7 +7,7 @@
 import requests
 import pytest
 from operatorcourier import api as courier
-from tests.integration.utils import test_env, Bundle
+from tests.integration.utils import test_env, make_bundle
 
 
 def test_invalid_zip(omps):
@@ -86,11 +86,11 @@ def test_valid_zip_default_version(omps, quay, koji, tmp_path):
                             test_env['test_package'], '1.0.0',
                             authorization=None)
 
-    quay_bundle = Bundle(quay.get_bundle(test_env['test_namespace'],
-                                         test_env['test_package'], '1.0.0',
-                                         authorization=None))
+    quay_bundle = make_bundle(quay.get_bundle(test_env['test_namespace'],
+                              test_env['test_package'], '1.0.0',
+                              authorization=None))
     koji.download_manifest(nvr, tmp_path)
-    koji_bundle = Bundle(
+    koji_bundle = make_bundle(
         courier.build_and_verify(source_dir=tmp_path.as_posix()).bundle)
 
     # Note: this only confirms that OMPS used the right data from Koji,
@@ -162,13 +162,12 @@ def test_nested_manifest(omps, quay, koji, tmp_path):
                             test_env['test_package'], '1.0.0',
                             authorization=None)
 
-    quay_bundle = Bundle(quay.get_bundle(test_env['test_namespace'],
-                                         test_env['test_package'], '1.0.0',
-                                         authorization=None))
+    quay_bundle = make_bundle(quay.get_bundle(test_env['test_namespace'],
+                              test_env['test_package'], '1.0.0',
+                              authorization=None))
 
     koji.download_manifest(nvr, tmp_path)
-    koji_bundle = Bundle(
-        courier.build_and_verify(source_dir=tmp_path.as_posix()).bundle)
+    koji_bundle = make_bundle(tmp_path.as_posix())
 
     # Note: this only confirms that OMPS used the right data from Koji,
     #       but tells nothing about the correctness of that data.

tests/integration/replace_registry/replace_registry_test.py

@@ -8,7 +8,7 @@
 import pytest
 from distutils import dir_util
 from itertools import cycle
-from tests.integration.utils import test_env, Bundle
+from tests.integration.utils import test_env, make_bundle
 
 
 def is_yaml_file(path):
@@ -72,7 +72,7 @@ def koji_registries(replace_conf, path):
     )
     response.raise_for_status()
 
-    quay_bundle = Bundle(
+    quay_bundle = make_bundle(
         quay.get_bundle(
             test_env["test_namespace"],
             test_env["test_package"],
@@ -149,7 +149,7 @@ def test_replace_during_archive_push(omps, quay, tmp_path_factory, manifest_path
     )
     response.raise_for_status()
 
-    quay_bundle = Bundle(
+    quay_bundle = make_bundle(
         quay.get_bundle(
             test_env["test_namespace"],
             test_env["test_package"],

tests/integration/utils.py

@@ -23,17 +23,41 @@ def load_test_env():
 test_env = load_test_env()
 
 
-class Bundle:
-    """Wrapper to ease working with bundles.
+def make_bundle(bundle):
+    """Make a bundle to be used by the tests.
+
+    Args:
+        bundle: either a bundle as a dictionary OR
+                a nested bundle as concatenated files OR
+                a path to a directory of a nested bundle.
+    Returns:
+        A FlatBundle or a string, which has the files of a nested bundle
+        concatenated.
+
+    Raises:
+        AssertionError if the argument is of a type that is not handled.
+    """
+    if isinstance(bundle, dict):
+        return FlatBundle(bundle)
+    elif isinstance(bundle, str):
+        b = bundle
+        if os.path.isdir(bundle):
+            b = concatenated_files(bundle)
+        return b
+    else:
+        assert False
+
+
+class FlatBundle():
+    """Wrapper to ease working with flat-bundles.
     """
-
     FIELDS = ('clusterServiceVersions', 'customResourceDefinitions', 'packages')
 
     def __init__(self, bundle_dict):
         self.bundle_dict = bundle_dict
 
     def __eq__(self, other):
-        for field in Bundle.FIELDS:
+        for field in FlatBundle.FIELDS:
             sd = yaml.safe_load(self.bundle_dict['data'][field])
             od = yaml.safe_load(other.bundle_dict['data'][field])
 
@@ -47,7 +71,7 @@ def __eq__(self, other):
         return True
 
     def __contains__(self, text):
-        for field in Bundle.FIELDS:
+        for field in FlatBundle.FIELDS:
             if text in self.bundle_dict['data'][field]:
                 return True
 
@@ -293,9 +317,15 @@ def get_bundle(self, namespace, package, release, authorization=True):
             with tarfile.open(archive, 'r:gz') as tar:
                 tar.extractall(path=tempdir)
 
-            bundle_file = '{tempdir}/bundle.yaml'.format(tempdir=tempdir)
-            with open(bundle_file, 'r') as f:
-                bundle = yaml.safe_load(f)
+            os.remove(archive)
+            bundle_file = f"{tempdir}/bundle.yaml"
+            if os.path.isfile(bundle_file):
+                with open(bundle_file, 'r') as f:
+                    bundle = yaml.safe_load(f)
+            else:
+                # Assume that this is a nested bundle. Concatenate the sorted
+                # files in a single string.
+                bundle = concatenated_files(tempdir)
 
         return bundle
 
@@ -442,3 +472,26 @@ def download_manifest(self, nvr, tmpdir):
             z.extractall(tmpdir)
 
         os.remove(archive)
+
+
+def concatenated_files(directory):
+    """Takes a directory and recursively concatenates all the files in it.
+
+    Files are sorted before concatenation.
+
+    Args:
+        directory: path to the directory to be parsed
+
+    Returns:
+        String with the content of all the files found, concatenated.
+    """
+    ret = ''
+    files = []
+    for dirpath, dirnames, filenames in os.walk(directory):
+        for filename in filenames:
+            files.append(os.path.join(dirpath, filename))
+    files.sort()
+    for file in files:
+        with open(file, 'r') as fp:
+            ret += fp.read()
+    return ret