tsparams

Documentation

Index

• Constants
• Variables
• type ArgoCdGitDetails

Constants

const (
	// LabelSuite is the label for all the tests in this suite.
	LabelSuite = "gitopsztp"
	// LabelArgoCdAcmCrsTestCases is the label for the ACM CRs test cases.
	LabelArgoCdAcmCrsTestCases = "ztp-argocd-acm-crs"
	// LabelArgoCdClustersAppTestCases is the label for the Argo CD clusters app test cases.
	LabelArgoCdClustersAppTestCases = "ztp-argocd-clusters"
	// LabelArgoCdHubTemplatingTestCases is the label for a particular set of test cases.
	LabelArgoCdHubTemplatingTestCases = "ztp-argocd-hub-templating"
	// LabelArgoCdNodeDeletionTestCases is the label for a particular set of test cases.
	LabelArgoCdNodeDeletionTestCases = "ztp-argocd-node-delete"
	// LabelArgoCdPoliciesAppTestCases is the label for a particular set of test cases.
	LabelArgoCdPoliciesAppTestCases = "ztp-argocd-policies"
	// LabelGeneratorTestCases is the label for a particular set of test cases.
	LabelGeneratorTestCases = "ztp-generator"
	// LabelMachineConfigTestCases is the label for a particular set of test cases.
	LabelMachineConfigTestCases = "ztp-machine-config"
	// LabelSpokeCheckerTests is the label for a particular set of test cases.
	LabelSpokeCheckerTests = "ztp-spoke-checker"
	// LabelClusterInstanceDeleteTestCases is the label for the siteconfig operator's cluster instance delete test cases.
	LabelClusterInstanceDeleteTestCases = "ztp-cluster-instance-delete"
	// LabelSiteconfigFailoverTestCases is the label for the siteconfig operator's failover test cases.
	LabelSiteconfigFailoverTestCases = "ztp-siteconfig-failover"
	// LabelSiteconfigNegativeTestCases is the label for the siteconfig operator's negative test cases.
	LabelSiteconfigNegativeTestCases = "ztp-siteconfig-negative"
	// LabelSiteconfigDayTwoConfigTestCase is the label for the siteconfig operator's day 2 configuration test.
	LabelSiteconfigDayTwoConfigTestCase = "ztp-siteconfig-day-two"

	// LabelBiosDayZeroTests is the label for a particuarl set of test cases.
	LabelBiosDayZeroTests = "ztp-bios-day-zero"

	// MultiClusterHubOperator is the name of the multi cluster hub operator.
	MultiClusterHubOperator = "multiclusterhub-operator"
	// AcmPolicyGeneratorName is the name of the ACM policy generator container.
	AcmPolicyGeneratorName = "acm-policy-generator"
	// TalmHubPodName is the name of the TALM pod on the hub cluster.
	TalmHubPodName = "cluster-group-upgrades-controller-manager"
	// ImageRegistryName is the name of the image registry config.
	ImageRegistryName = "cluster"
	// ImageRegistryNamespace is the namespace for the image registry and where its PVC is.
	ImageRegistryNamespace = "openshift-image-registry"
	// NetworkDiagnosticsNamespace is the namespace for network diagnostics.
	NetworkDiagnosticsNamespace = "openshift-network-diagnostics"
	// ConsoleNamespace is the namespace for the openshift console.
	ConsoleNamespace = "openshift-console"

	// ArgoCdPoliciesAppName is the name of the policies app in Argo CD.
	ArgoCdPoliciesAppName = "policies"
	// ArgoCdClustersAppName is the name of the clusters app in Argo CD.
	ArgoCdClustersAppName = "clusters"

	// ArgoCdChangeInterval is the interval to use for polling for changes to Argo CD.
	ArgoCdChangeInterval = 10 * time.Second
	// ArgoCdChangeTimeout is the time to use for polling for changes to Argo CD.
	ArgoCdChangeTimeout = 10 * time.Minute

	// ZtpTestPathAcmCrs is the git path for the ACM CRs test.
	ZtpTestPathAcmCrs = "ztp-test/acm-crs"
	// ZtpTestPathClustersApp is the git path for the clusters app test.
	ZtpTestPathClustersApp = "ztp-test/klusterlet-addon"
	// ZtpTestPathRemoveNmState is the git path for the remove nm state test.
	ZtpTestPathRemoveNmState = "ztp-test/remove-nmstate"
	// ZtpTestPathTemplatingAutoIndent is the git path for the templating auto indent test.
	ZtpTestPathTemplatingAutoIndent = "ztp-test/hub-templating-autoindent"
	// ZtpTestPathTemplatingValid is the git path for the templating valid test.
	ZtpTestPathTemplatingValid = "ztp-test/hub-templating-valid"
	// ZtpTestPathTemplatingValid416 is the git path for the templating valid test starting from TALM 4.16.
	ZtpTestPathTemplatingValid416 = "ztp-test/hub-templating-valid-4.16"
	// ZtpTestPathNodeDeleteAddAnnotation is the git path for the node deletion add annotation test.
	ZtpTestPathNodeDeleteAddAnnotation = "ztp-test/node-delete/add-annotation"
	// ZtpTestPathNodeDeleteAddSuppression is the git path for the node deletion add suppression test.
	ZtpTestPathNodeDeleteAddSuppression = "ztp-test/node-delete/add-suppression"
	// ZtpTestPathCustomInterval is the git path for the policies app custom interval test.
	ZtpTestPathCustomInterval = "ztp-test/custom-interval"
	// ZtpTestPathInvalidInterval is the git path for the policies app invalid interval test.
	ZtpTestPathInvalidInterval = "ztp-test/invalid-interval"
	// ZtpTestPathImageRegistry is the git path for the policies app image registry test.
	ZtpTestPathImageRegistry = "ztp-test/image-registry"
	// ZtpTestPathCustomSourceNewCr is the git path for the policies app custome source new cr test.
	ZtpTestPathCustomSourceNewCr = "ztp-test/custom-source-crs/new-cr"
	// ZtpTestPathCustomSourceReplaceExisting is the path for the policies app custom source replace existing test.
	ZtpTestPathCustomSourceReplaceExisting = "ztp-test/custom-source-crs/replace-existing"
	// ZtpTestPathCustomSourceNoCrFile is the git path for the policies app custome source no cr file test.
	ZtpTestPathCustomSourceNoCrFile = "ztp-test/custom-source-crs/no-cr-file"
	// ZtpTestPathCustomSourceSearchPath is the git path for the policies app custome source search path test.
	ZtpTestPathCustomSourceSearchPath = "ztp-test/custom-source-crs/search-path"
	// ZtpTestPathDetachAIMNO is the git path for the siteconfig operator detach AI MNO cluster instance test.
	ZtpTestPathDetachAIMNO = "ztp-test/siteconfig-operator/detach-ai-mno"
	// ZtpTestPathDetachAISNO is the git path for the siteconfig operator detach AI SNO cluster instance test.
	ZtpTestPathDetachAISNO = "ztp-test/siteconfig-operator/detach-ai-sno"
	// ZtpTestPathNoClusterTemplateCm is the git path for the siteconfig operator non-existent cluster template cm test.
	ZtpTestPathNoClusterTemplateCm = "ztp-test/siteconfig-operator/non-existent-cluster-template-cm"
	// ZtpTestPathNoExtraManifestsCm is the git path for the siteconfig operator non-existent extra manifests cm test.
	ZtpTestPathNoExtraManifestsCm = "ztp-test/siteconfig-operator/non-existent-extra-manifests-cm"
	// ZtpTestPathInvalidTemplateRef is the git path for the siteconfig operator invalid template reference test.
	ZtpTestPathInvalidTemplateRef = "ztp-test/siteconfig-operator/invalid-template-ref"
	// ZtpTestPathValidTemplateRef is the git path for the siteconfig operator valid template reference test.
	ZtpTestPathValidTemplateRef = "ztp-test/siteconfig-operator/valid-template-ref"
	// ZtpTestPathUniqueClusterName is the git path for the siteconfig operator unique cluster name test.
	ZtpTestPathUniqueClusterName = "ztp-test/siteconfig-operator/unique-cluster-name"
	// ZtpTestPathDuplicateClusterName is the git path for the siteconfig operator duplicate cluster name test.
	ZtpTestPathDuplicateClusterName = "ztp-test/siteconfig-operator/duplicate-cluster-name"
	// ZtpTestPathNewClusterLabel is the git path for the siteconfig operator new cluster label test.
	ZtpTestPathNewClusterLabel = "ztp-test/siteconfig-operator/new-cluster-label"
	// ZtpKustomizationPath is the path to the kustomization file in the ztp test.
	ZtpKustomizationPath = "/kustomization.yaml"

	// TestNamespace is the namespace used for ZTP tests.
	TestNamespace = "ztp-test"
	// AcmCrsPolicyName is the name of the policy for ACM CRs.
	AcmCrsPolicyName = "acm-crs-policy"
	// HubTemplatingPolicyName is the name used for the hub templating policy.
	HubTemplatingPolicyName = "hub-templating-policy-sriov-config"
	// HubTemplatingCguName is the name used for the hub templating CGU.
	HubTemplatingCguName = "hub-templating"
	// HubTemplatingCguNamespace is the namespace used by the hub templating CGU. It should be different than the
	// policy namespace.
	HubTemplatingCguNamespace = "default"
	// HubTemplatingSecretName is the name of the secret used by the hub templating valid test.
	HubTemplatingSecretName = "sriovsecret"
	// NodeDeletionCrAnnotation is the annotation applied in the node deletion tests.
	NodeDeletionCrAnnotation = "bmac.agent-install.openshift.io/remove-agent-and-node-on-delete"
	// ZtpGeneratedAnnotation is the annotation applied to ztp generated resources.
	ZtpGeneratedAnnotation = "ran.openshift.io/ztp-gitops-generated"
	// CustomIntervalDefaultPolicyName is the name of the default policy created in the custom interval test.
	CustomIntervalDefaultPolicyName = "custom-interval-policy-default"
	// CustomIntervalOverridePolicyName is the name of the override policy created in the custom interval test.
	CustomIntervalOverridePolicyName = "custom-interval-policy-override"
	// CustomSourceCrPolicyName is the name of the policy for the custom source CR.
	CustomSourceCrPolicyName = "custom-source-cr-policy-config"
	// CustomSourceCrName is the name of the custom source CR itself.
	CustomSourceCrName = "custom-source-cr"
	// CustomSourceTestNamespace is the test namespace for the custom source test.
	CustomSourceTestNamespace = "default"
	// CustomSourceStorageClass is the storage class used in the custom source test.
	CustomSourceStorageClass = "example-storage-class"
	// ImageRegistrySC is the storage class created by the policies app image registry tests.
	ImageRegistrySC = "image-registry-sc"
	// ImageRegistryPV is the persistent volume created by the policies app image registry tests.
	ImageRegistryPV = "image-registry-pv-filesystem"
	// ImageRegistryPVC is the persistent volume claim created by the policies app image registry tests.
	ImageRegistryPVC = "image-registry-pvc"
	// ImageRegistryPath is the path to where the image registry PV will be.
	ImageRegistryPath = "/var/imageregistry"
	// DefaultAIClusterTemplatesConfigMapName is the name of default AI cluster templates config map.
	DefaultAIClusterTemplatesConfigMapName = "ai-cluster-templates-v1"
	// DefaultAINodeTemplatesConfigMapName is the name of default AI node templates config map.
	DefaultAINodeTemplatesConfigMapName = "ai-node-templates-v1"
	// SiteconfigOperatorPodLabel is the name of siteconfig operator pod label selector.
	SiteconfigOperatorPodLabel = "app.kubernetes.io/name=siteconfig-controller"
	// CIExtraLabelsKey is the key name of 'extraLabels:' field in ClusterInstance CR.
	CIExtraLabelsKey = "ManagedCluster"
	// TestLabelKey represents day-2 cluster label key in ClusterInstance CR.
	TestLabelKey = "custom-test"

	// ClusterInstanceValidatedType is one of the type of ClusterInstance condition types.
	ClusterInstanceValidatedType = "ClusterInstanceValidated"
	// ProvisionedType is one of the type of ClusterInstance condition types.
	ProvisionedType = "Provisioned"
	// RenderedTemplatesValidatedType is one of the type of ClusterInstance condition types.
	RenderedTemplatesValidatedType = "RenderedTemplatesValidated"
	// ClusterInstanceFailReason is the reason for a failure of all ClusterInstance condition types.
	ClusterInstanceFailReason = "Failed"
	// ClusterInstanceInProgressReason is the reason for in-progress cluster provisioning.
	ClusterInstanceInProgressReason = "InProgress"
	// NonExistentExtraManifestConfigMapFailMessage is the message for ClusterInstanceValidated condition type.
	NonExistentExtraManifestConfigMapFailMessage = "Validation failed: failed to retrieve ExtraManifest"
	// NonExistentClusterTemplateConfigMapFailMessage is the message for ClusterInstanceValidated condition type.
	NonExistentClusterTemplateConfigMapFailMessage = "Validation failed: failed to validate cluster-level TemplateRef"
	// InvalidTemplateRefFailMessage is the message for invalid template reference condition.
	InvalidTemplateRefFailMessage = "Validation failed: failed to validate node-level TemplateRef"
	// ValidTemplateRefSuccessMessage is the message for valid template reference condition.
	ValidTemplateRefSuccessMessage = "Provisioning cluster"
	// RenderedManifestsFailMessage is the message for rendered manifests dry-run validation failure.
	RenderedManifestsFailMessage = "Rendered manifests failed dry-run validation"
	// SiteconfigOperatorDefaultReconcileTime is the default time for siteconfig controller to reconcile.
	SiteconfigOperatorDefaultReconcileTime = 5 * time.Minute

	// LogLevel is the verbosity of glog statements in this test suite.
	LogLevel glog.Level = 90
)

Variables

var (
	// Labels represents the range of labels that can be used for test cases selection.
	Labels = append(ranparam.Labels, LabelSuite)

	// ReporterHubNamespacesToDump tells to the reporter which namespaces on the hub to collect pod logs from.
	ReporterHubNamespacesToDump = map[string]string{
		TestNamespace:                       "",
		ranparam.OpenshiftOperatorNamespace: "",
	}

	// ReporterSpokeNamespacesToDump tells the reporter which namespaces on the spokes to collect pod logs from.
	ReporterSpokeNamespacesToDump = map[string]string{
		TestNamespace: "",
	}

	// ReporterHubCRsToDump is the CRs the reporter should dump on the hub.
	ReporterHubCRsToDump = []k8sreporter.CRData{
		{Cr: &corev1.NamespaceList{}},
		{Cr: &corev1.PodList{}},
		{Cr: &policiesv1.PolicyList{}},
		{Cr: &placementrulev1.PlacementRuleList{}, Namespace: ptr.To(TestNamespace)},
		{Cr: &cguv1alpha1.ClusterGroupUpgradeList{}},
		{Cr: &corev1.ConfigMapList{}, Namespace: ptr.To(TestNamespace)},
		{Cr: &corev1.SecretList{}, Namespace: ptr.To(TestNamespace)},
		{Cr: &argocdoperator.ArgoCDList{}},
		{Cr: &v1alpha1.ApplicationList{}},
	}

	// ReporterSpokeCRsToDump is the CRs the reporter should dump on the spokes.
	ReporterSpokeCRsToDump = []k8sreporter.CRData{
		{Cr: &corev1.NamespaceList{}},
		{Cr: &corev1.PodList{}},
		{Cr: &policiesv1.PolicyList{}},
		{Cr: &corev1.PersistentVolumeList{}},
		{Cr: &corev1.PersistentVolumeClaimList{}, Namespace: ptr.To(ImageRegistryNamespace)},
		{Cr: &storagev1.StorageClassList{}},
		{Cr: &corev1.ServiceAccountList{}, Namespace: ptr.To(CustomSourceTestNamespace)},
		{Cr: &sriovv1.SriovNetworkList{}, Namespace: ptr.To(RANConfig.SriovOperatorNamespace)},
		{Cr: &sriovv1.SriovNetworkList{}, Namespace: ptr.To(TestNamespace)},
		{Cr: &imageregistryv1.ConfigList{}},
		{Cr: &certificatesv1.CertificateSigningRequestList{}},
	}

	// ArgoCdApps is the slice of the Argo CD app names defined in this package.
	ArgoCdApps = []string{
		ArgoCdClustersAppName,
		ArgoCdPoliciesAppName,
	}
	// ArgoCdAppDetails contains more details for each of the ArgoCdApps.
	ArgoCdAppDetails = map[string]ArgoCdGitDetails{}

	// ImageRegistryPolicies is a slice of all the policies the image registry test creates.
	ImageRegistryPolicies = []string{
		"image-registry-policy-sc",
		"image-registry-policy-pvc",
		"image-registry-policy-pv",
		"image-registry-policy-config",
	}

	// CINonExistentExtraManifestConfigMapCondition is the condition when referencing non-existent.
	// extra-manifest config map in ClusterInstance CR.
	CINonExistentExtraManifestConfigMapCondition = metav1.Condition{
		Type:    ClusterInstanceValidatedType,
		Status:  metav1.ConditionFalse,
		Message: NonExistentExtraManifestConfigMapFailMessage,
		Reason:  ClusterInstanceFailReason,
	}

	// CINonExistentClusterTemplateConfigMapCondition is the condition when referencing non-existent.
	// cluster templates config map in ClusterInstance CR.
	CINonExistentClusterTemplateConfigMapCondition = metav1.Condition{
		Type:    ClusterInstanceValidatedType,
		Status:  metav1.ConditionFalse,
		Message: NonExistentClusterTemplateConfigMapFailMessage,
		Reason:  ClusterInstanceFailReason,
	}

	// CIInvalidTemplateRefCondition is the condition when referencing invalid.
	// node level template in ClusterInstance CR.
	CIInvalidTemplateRefCondition = metav1.Condition{
		Type:    ClusterInstanceValidatedType,
		Status:  metav1.ConditionFalse,
		Message: InvalidTemplateRefFailMessage,
		Reason:  ClusterInstanceFailReason,
	}

	// CIValidTemplateRefCondition is the condition when referencing valid.
	// cluster & node level template in ClusterInstance CR.
	CIValidTemplateRefCondition = metav1.Condition{
		Type:    ProvisionedType,
		Status:  metav1.ConditionFalse,
		Message: ValidTemplateRefSuccessMessage,
		Reason:  ClusterInstanceInProgressReason,
	}

	// CIDuplicateClusterNameCondition is the condition when referencing duplicate.
	// cluster name in ClusterInstance CR.
	CIDuplicateClusterNameCondition = metav1.Condition{
		Type:    RenderedTemplatesValidatedType,
		Status:  metav1.ConditionFalse,
		Message: RenderedManifestsFailMessage,
		Reason:  ClusterInstanceFailReason,
	}
)

Types

type ArgoCdGitDetails

type ArgoCdGitDetails struct {
	Repo   string
	Branch string
	Path   string
}

ArgoCdGitDetails is the details for a single app in ArgoCD.