def test_opm_index_add(mock_run_cmd, mock_srt, from_index, bundles, overwrite_csv, container_tool):
build._opm_index_add(
'/tmp/somedir',
bundles,
'binary-image:latest',
from_index,
'user:pass',
overwrite_csv,
container_tool=container_tool,
)
mock_run_cmd.assert_called_once()
opm_args = mock_run_cmd.call_args[0][0]
assert opm_args[0:3] == ['opm', 'index', 'add']
if bundles:
assert ','.join(bundles) in opm_args
else:
assert '""' in opm_args
if from_index:
assert '--from-index' in opm_args
assert from_index in opm_args
else:
assert '--from-index' not in opm_args
if overwrite_csv:
assert '--overwrite-latest' in opm_args
else:
assert '--overwrite-latest' not in opm_args
if container_tool:
assert '--container-tool' in opm_args
assert container_tool in opm_args
else:
assert '--container-tool' not in opm_args
assert "--enable-alpha" in opm_args
mock_srt.assert_called_once_with('user:pass', from_index)
def test_opm_index_add(mock_run_cmd, mock_srt, from_index):
bundles = ['bundle:1.2', 'bundle:1.3']
build._opm_index_add('/tmp/somedir', bundles, 'binary-image:latest',
from_index, 'user:pass')
mock_run_cmd.assert_called_once()
opm_args = mock_run_cmd.call_args[0][0]
assert opm_args[0:3] == ['opm', 'index', 'add']
assert ','.join(bundles) in opm_args
if from_index:
assert '--from-index' in opm_args
assert from_index in opm_args
else:
assert '--from-index' not in opm_args
mock_srt.assert_called_once_with('user:pass', from_index)
def _add_bundles_missing_in_source(
source_index_bundles,
target_index_bundles,
base_dir,
binary_image,
source_from_index,
request_id,
arch,
ocp_version,
overwrite_target_index_token=None,
distribution_scope=None,
):
"""
Rebuild index image with bundles missing from source image but present in target image.
If no bundles are missing in the source index image, the index image is still rebuilt
using the new binary image.
:param list source_index_bundles: bundles present in the source index image.
:param list target_index_bundles: bundles present in the target index image.
:param str base_dir: base directory where operation files will be located.
:param str binary_image: binary image to be used by the new index image.
:param str source_from_index: index image, whose data will be contained in the new index image.
:param int request_id: the ID of the IIB build request.
:param str arch: the architecture to build this image for.
:param str ocp_version: ocp version which will be added as a label to the image.
:param str overwrite_target_index_token: the token used for overwriting the input
``source_from_index`` image. This is required for non-privileged users to use
``overwrite_target_index``. The format of the token must be in the format "user:password".
:return: bundles which were added to the index image.
:rtype: list
"""
set_request_state(request_id, 'in_progress',
'Adding bundles missing in source index image')
log.info(
'Adding bundles from target index image which are missing from source index image'
)
missing_bundles = []
source_bundle_digests = []
source_bundle_csv_names = []
target_bundle_digests = []
for bundle in source_index_bundles:
if '@sha256:' in bundle['bundlePath']:
source_bundle_digests.append(
bundle['bundlePath'].split('@sha256:')[-1])
source_bundle_csv_names.append(bundle['csvName'])
else:
raise IIBError(
f'Bundle {bundle["bundlePath"]} in the source index image is not defined via digest'
)
for bundle in target_index_bundles:
if '@sha256:' in bundle['bundlePath']:
target_bundle_digests.append(
(bundle['bundlePath'].split('@sha256:')[-1], bundle))
else:
raise IIBError(
f'Bundle {bundle["bundlePath"]} in the target index image is not defined via digest'
)
for target_bundle_digest, bundle in target_bundle_digests:
if (target_bundle_digest not in source_bundle_digests
and bundle['csvName'] not in source_bundle_csv_names):
missing_bundles.append(bundle)
missing_bundle_paths = [bundle['bundlePath'] for bundle in missing_bundles]
if missing_bundle_paths:
log.info('%s bundles are missing in the source index image.',
len(missing_bundle_paths))
else:
log.info(
'No bundles are missing in the source index image. However, the index image is '
'still being rebuilt with the new binary image.')
_opm_index_add(
base_dir,
missing_bundle_paths,
binary_image,
source_from_index,
overwrite_target_index_token,
)
_add_label_to_index('com.redhat.index.delivery.version', ocp_version,
base_dir, 'index.Dockerfile')
_add_label_to_index(
'com.redhat.index.delivery.distribution_scope',
distribution_scope,
base_dir,
'index.Dockerfile',
)
_build_image(base_dir, 'index.Dockerfile', request_id, arch)
_push_image(request_id, arch)
_create_and_push_manifest_list(request_id, [arch])
log.info('New index image created')
return missing_bundles
def _add_bundles_missing_in_source(
source_index_bundles,
target_index_bundles,
base_dir,
binary_image,
source_from_index,
request_id,
arch,
ocp_version,
overwrite_target_index_token=None,
distribution_scope=None,
):
"""
Rebuild index image with bundles missing from source image but present in target image.
If no bundles are missing in the source index image, the index image is still rebuilt
using the new binary image.
:param list source_index_bundles: bundles present in the source index image.
:param list target_index_bundles: bundles present in the target index image.
:param str base_dir: base directory where operation files will be located.
:param str binary_image: binary image to be used by the new index image.
:param str source_from_index: index image, whose data will be contained in the new index image.
:param int request_id: the ID of the IIB build request.
:param str arch: the architecture to build this image for.
:param str ocp_version: ocp version which will be added as a label to the image.
:param str overwrite_target_index_token: the token used for overwriting the input
``source_from_index`` image. This is required to use ``overwrite_target_index``.
The format of the token must be in the format "user:password".
:return: tuple where the first value is a list of bundles which were added to the index image
and the second value is a list of bundles in the new index whose ocp_version range does not
satisfy the ocp_version value of the target index.
:rtype: tuple
"""
set_request_state(request_id, 'in_progress',
'Adding bundles missing in source index image')
log.info(
'Adding bundles from target index image which are missing from source index image'
)
missing_bundles = []
missing_bundle_paths = []
# This list stores the bundles whose ocp_version range does not satisfy the ocp_version
# of the target index
invalid_bundles = []
source_bundle_digests = []
source_bundle_csv_names = []
target_bundle_digests = []
for bundle in source_index_bundles:
if '@sha256:' in bundle['bundlePath']:
source_bundle_digests.append(
bundle['bundlePath'].split('@sha256:')[-1])
source_bundle_csv_names.append(bundle['csvName'])
else:
raise IIBError(
f'Bundle {bundle["bundlePath"]} in the source index image is not defined via digest'
)
for bundle in target_index_bundles:
if '@sha256:' in bundle['bundlePath']:
target_bundle_digests.append(
(bundle['bundlePath'].split('@sha256:')[-1], bundle))
else:
raise IIBError(
f'Bundle {bundle["bundlePath"]} in the target index image is not defined via digest'
)
for target_bundle_digest, bundle in target_bundle_digests:
if (target_bundle_digest not in source_bundle_digests
and bundle['csvName'] not in source_bundle_csv_names):
missing_bundles.append(bundle)
missing_bundle_paths.append(bundle['bundlePath'])
for bundle in itertools.chain(missing_bundles, source_index_bundles):
if not is_bundle_version_valid(bundle['bundlePath'], ocp_version):
invalid_bundles.append(bundle)
if invalid_bundles:
log.info(
'%s bundles have invalid version label and will be deprecated.',
len(invalid_bundles))
_opm_index_add(
base_dir,
missing_bundle_paths,
binary_image,
from_index=source_from_index,
overwrite_from_index_token=overwrite_target_index_token,
# Use podman until opm's default mechanism is more resilient:
# https://bugzilla.redhat.com/show_bug.cgi?id=1937097
container_tool='podman',
)
_add_label_to_index('com.redhat.index.delivery.version', ocp_version,
base_dir, 'index.Dockerfile')
_add_label_to_index(
'com.redhat.index.delivery.distribution_scope',
distribution_scope,
base_dir,
'index.Dockerfile',
)
_build_image(base_dir, 'index.Dockerfile', request_id, arch)
_push_image(request_id, arch)
_create_and_push_manifest_list(request_id, [arch])
log.info('New index image created')
return (missing_bundles, invalid_bundles)
