CLOUDDST-24254 : Merge index image failing with FBC operator present in source

This commit fix this bug by ignoring deprecation operators which are not available in database.

Author: Ashwini Kumar

iib/workers/tasks/build_merge_index_image.py

@@ -39,6 +39,7 @@
 from iib.workers.tasks.utils import (
     add_max_ocp_version_property,
     chmod_recursively,
+    filter_operators_present_in_db,
     get_bundles_from_deprecation_list,
     request_logger,
     set_registry_token,
@@ -326,6 +327,15 @@ def handle_merge_request(
             bundle['bundlePath'] for bundle in invalid_version_bundles
         ]
 
+        index_db_file = os.path.join(temp_dir, get_worker_config()['temp_index_db_path'])
+
+        # Operator passed in deprecation list should be available in operator database,
+        # filter_operators_present_in_db removes operaors which are passed in
+        # deprecation list and does not exists in database.
+        deprecation_bundles = filter_operators_present_in_db(
+            deprecation_bundles, index_db_file, temp_dir
+        )
+
         if deprecation_bundles:
             intermediate_image_name = _get_external_arch_pull_spec(
                 request_id, arch, include_transport=False

iib/workers/tasks/utils.py

@@ -1265,3 +1265,29 @@ def get_bundle_metadata(
         for pullspec in operator_csv.get_pullspecs():
             bundle_metadata['found_pullspecs'].add(pullspec)
     return bundle_metadata
+
+
+def filter_operators_present_in_db(
+    deprecation_bundles: List[str],
+    index_db_file: str,
+    temp_dir: str,
+) -> List[str]:
+    """
+    Check if operator marked for deprecation is available, if not drop them.
+
+    :param List[str] deprecation_bundles: List of bundles to be depricated
+    :param str index_db_file: Path of operator database
+    :param str temp_dir: temp directory where opm will be executed
+
+    :return:rtype: list(str) A List of operator bundle to be deprecated
+    """
+    bundles_list = get_list_bundles(index_db_file, temp_dir)
+
+    deprecation_bundles = [
+        bundle["bundlePath"]
+        for bundle in bundles_list
+        if bundle["bundlePath"] in deprecation_bundles
+    ]
+
+    log.info("Deprecation bundle after filter is : %s", deprecation_bundles)
+    return deprecation_bundles

tests/test_workers/test_tasks/test_build_merge_index_image.py

@@ -29,6 +29,7 @@
 @mock.patch('iib.workers.tasks.build_merge_index_image._push_image')
 @mock.patch('iib.workers.tasks.build_merge_index_image._build_image')
 @mock.patch('iib.workers.tasks.build_merge_index_image.deprecate_bundles_fbc')
+@mock.patch('iib.workers.tasks.build_merge_index_image.filter_operators_present_in_db')
 @mock.patch('iib.workers.tasks.build_merge_index_image.deprecate_bundles')
 @mock.patch('iib.workers.tasks.build_merge_index_image._get_external_arch_pull_spec')
 @mock.patch('iib.workers.tasks.build_merge_index_image.get_bundles_from_deprecation_list')
@@ -63,6 +64,7 @@ def test_handle_merge_request(
     mock_gbfdl,
     mock_geaps,
     mock_dep_b,
+    mock_f_dep_b,
     mock_dep_b_fbc,
     mock_bi,
     mock_pi,
@@ -118,6 +120,7 @@ def side_effect(*args, base_dir, **kwargs):
 
     mock_dep_b.side_effect = side_effect
     mock_dep_b_fbc.side_effect = side_effect
+    mock_f_dep_b.return_value = mock_dep_b
 
     mock_gidp.return_value = '/tmp'
     mock_run_cmd.return_value = json.dumps(
@@ -203,6 +206,7 @@ def side_effect(*args, base_dir, **kwargs):
     return_value=[[{'bundlePath': 'some_bundle'}], []],
 )
 @mock.patch('iib.workers.tasks.utils.set_request_state')
+@mock.patch('iib.workers.tasks.utils.get_list_bundles')
 @mock.patch('iib.workers.tasks.build_merge_index_image.set_request_state')
 @mock.patch('iib.workers.tasks.build_merge_index_image._update_index_image_build_state')
 @mock.patch('iib.workers.tasks.build_merge_index_image.prepare_request_for_build')
@@ -218,6 +222,7 @@ def test_handle_merge_request_no_deprecate(
     mock_prfb,
     mock_uiibs,
     mock_srs,
+    mock_get_bundles,
     mock_srs2,
     mock_gpb,
     mock_abmis,
@@ -261,7 +266,14 @@ def test_handle_merge_request_no_deprecate(
     mock_abmis.return_value = ([], invalid_bundles)
     mock_gid.return_value = 'database/index.db'
     mock_om.return_value = 'catalog', 'cache'
-
+    mock_get_bundles.return_value = [
+        {
+            'bundlePath': 'invalid_bundle:1.0',
+            'csvName': 'invalid_bundle:1.0',
+            'packageName': 'invalid_bundle',
+            'version': '1.0',
+        },
+    ]
     mock_run_cmd.return_value = json.dumps(
         {
             "schema": "olm.bundle",
@@ -309,6 +321,7 @@ def test_handle_merge_request_no_deprecate(
                 binary_image='binary-image:1.0',
                 from_index=mock.ANY,
             )
+            mock_get_bundles.assert_called_once()
             assert mock_bi.call_count == 2
             assert mock_pi.call_count == 2
         else:

tests/test_workers/test_tasks/test_utils.py

@@ -1,6 +1,7 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 import logging
 import os
+
 import stat
 import textwrap
 from unittest import mock
@@ -1264,3 +1265,61 @@ def test_add_max_ocp_version_property_empty_index(mock_apti, mock_glb, mock_gbj,
 
     mock_gbj.assert_not_called()
     mock_apti.assert_not_called()
+
+
+@mock.patch('iib.workers.tasks.utils.get_list_bundles')
+def filter_operators_present_in_db(mock_bundle_list):
+
+    mock_bundle_list.return_value = [
+        {
+            'bundlePath': 'op1@sha',
+            'csvName': 'op1.v0.1.489-1',
+            'packageName': 'op1',
+            'version': '0.1.489-1',
+        },
+        {
+            'bundlePath': 'op2@sha',
+            'csvName': 'op2.v0.1.501-1',
+            'packageName': 'op2',
+            'version': '0.1.501-1',
+        },
+    ]
+
+    deprecation_bundles = [
+        "op1@sha",
+    ]
+
+    operator_after_deprication = utils.filter_operators_present_in_db(
+        deprecation_bundles, "index/db/file", "temp_dir"
+    )
+
+    assert operator_after_deprication == ["op1@sha"]
+
+
+@mock.patch('iib.workers.tasks.utils.get_list_bundles')
+def test_no_matching_filter_operators_present_in_db(mock_bundle_list):
+
+    mock_bundle_list.return_value = [
+        {
+            'bundlePath': 'op1@sha',
+            'csvName': 'op1.v0.1.489-1',
+            'packageName': 'op1',
+            'version': '0.1.489-1',
+        },
+        {
+            'bundlePath': 'op2@sha',
+            'csvName': 'op2.v0.1.501-1',
+            'packageName': 'op2',
+            'version': '0.1.501-1',
+        },
+    ]
+
+    deprecation_bundles = [
+        "op3@sha",
+    ]
+
+    operator_after_deprication = utils.filter_operators_present_in_db(
+        deprecation_bundles, "index/db/file", "temp_dir"
+    )
+
+    assert operator_after_deprication == []