bundle validation: check for bundle preset mismatch during setup

[redbeam]

Fixes: Issue #3615

Added a check for bundle type mismatch with preset in function ValidateBundle.

crc/pkg/crc/validation/validation.go

Lines 91 to 107 in 7b04ce5

	func ValidateBundle(bundlePath string, preset crcpreset.Preset) error {
	bundleName := bundle.GetBundleNameFromURI(bundlePath)
	bundleMetadata, err := bundle.Get(bundleName)
	if err != nil {
	if bundlePath == constants.GetDefaultBundlePath(preset) {
	return nil
	}
	return ValidateBundlePath(bundlePath, preset)
	}
	if err = BundleMismatchWithPreset(preset, bundleMetadata); err != nil {
	logging.Fatal(err.Error())
	return err
	}
	bundleMismatchWarning(bundleMetadata.GetBundleName(), preset)
	/* 'bundle' is already unpacked in ~/.crc/cache */
	return nil
	}

The check is performed before checking for custom bundle (and potentially displaying a warning).

Function BundleMismatchWithPreset was moved from machine/start.go to validation/validation.go and is used during start as well.

Testing

1. Download bundle for a preset (i.e. microshift).
2. Change preset to some other value crc config set preset openshift
3. crc setup --bundle <path_to_bundle>
   Output:
   FATA Preset openshift is used but bundle is provided for microshift preset

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign cfergeau for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[redbeam]

Also, I think bundleMismatchWarning function name is kind of ambiguous. It is checking for and displaying a warning if there is a custom bundle being used, so what about renaming it to something like customBundleUsedWarning or userProvidedBundleWarning?

[anjannath]

I'm surprised a custom bundle has a _232 suffix as in your example Anjan, I thought they were suffixed with only _custom

i think this got changed, now they don't contain _custom and are in the form of crc_libvirt_4.16.7_amd64_<unix_timestamp>.crcbundle as per: https://github.com/crc-org/crc/blob/main/pkg/crc/machine/bundle/metadata.go#L227

[cfergeau]

I'm surprised a custom bundle has a _232 suffix as in your example Anjan, I thought they were suffixed with only _custom

i think this got changed, now they don't contain _custom and are in the form of crc_libvirt_4.16.7_amd64_<unix_timestamp>.crcbundle as per: https://github.com/crc-org/crc/blob/main/pkg/crc/machine/bundle/metadata.go#L227

Ah ok, I was tricked by git grep _custom which still returns multiple results.

[redbeam]

Thanks for the suggestion @cfergeau, I modified your regex a bit and it worked really well.

[openshift-ci]

@redbeam: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/integration-crc	353fc52	link	true	/test integration-crc
ci/prow/e2e-crc	353fc52	link	true	/test e2e-crc

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.