Updates TektonConfig Conditions and cleanup

This updates the tektonconfig conditions and removes unnecessary code. Signed-off-by: Shivam Mukhade <[email protected]>
tektoncd · Sep 24, 2021 · fbfcf17 · fbfcf17
1 parent 0ffff66
commit fbfcf17
Show file tree

Hide file tree

Showing 11 changed files with 183 additions and 323 deletions.
diff --git a/pkg/apis/operator/v1alpha1/tektonaddon_types.go b/pkg/apis/operator/v1alpha1/tektonaddon_types.go
@@ -17,8 +17,6 @@ limitations under the License.
 package v1alpha1
 
 import (
-	"reflect"
-
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	duckv1 "knative.dev/pkg/apis/duck/v1"
 )
@@ -75,7 +73,7 @@ type Addon struct {
 }
 
 func (a Addon) IsEmpty() bool {
-	return reflect.DeepEqual(a, Addon{})
+	return len(a.Params) == 0
 }
 
 // TektonAddonsList contains a list of TektonAddon

diff --git a/pkg/apis/operator/v1alpha1/tektonconfig_lifecycle.go b/pkg/apis/operator/v1alpha1/tektonconfig_lifecycle.go
@@ -21,107 +21,130 @@ import (
 	"knative.dev/pkg/apis"
 )
 
-var (
-	_ TektonComponentStatus = (*TektonConfigStatus)(nil)
+const (
+	PreInstall      apis.ConditionType = "PreInstall"
+	ComponentsReady apis.ConditionType = "ComponentsReady"
+	PostInstall     apis.ConditionType = "PostInstall"
+)
 
+var (
 	configCondSet = apis.NewLivingConditionSet(
-		DependenciesInstalled,
-		DeploymentsAvailable,
-		InstallSucceeded,
+		PreInstall,
+		ComponentsReady,
+		PostInstall,
 	)
 )
 
-// GroupVersionKind returns SchemeGroupVersion of a TektonConfig
-func (tp *TektonConfig) GroupVersionKind() schema.GroupVersionKind {
+func (tc *TektonConfig) GroupVersionKind() schema.GroupVersionKind {
 	return SchemeGroupVersion.WithKind(KindTektonConfig)
 }
 
-// GetCondition returns the current condition of a given condition type
-func (tps *TektonConfigStatus) GetCondition(t apis.ConditionType) *apis.Condition {
-	return configCondSet.Manage(tps).GetCondition(t)
+func (tc *TektonConfig) GetGroupVersionKind() schema.GroupVersionKind {
+	return SchemeGroupVersion.WithKind(KindTektonConfig)
 }
 
-// InitializeConditions initializes conditions of an TektonConfigStatus
-func (tps *TektonConfigStatus) InitializeConditions() {
-	configCondSet.Manage(tps).InitializeConditions()
+func (tcs *TektonConfigStatus) GetCondition(t apis.ConditionType) *apis.Condition {
+	return configCondSet.Manage(tcs).GetCondition(t)
 }
 
-// IsReady looks at the conditions returns true if they are all true.
-func (tps *TektonConfigStatus) IsReady() bool {
-	return configCondSet.Manage(tps).IsHappy()
+func (tcs *TektonConfigStatus) InitializeConditions() {
+	configCondSet.Manage(tcs).InitializeConditions()
 }
 
-// MarkInstallSucceeded marks the InstallationSucceeded status as true.
-func (tps *TektonConfigStatus) MarkInstallSucceeded() {
-	configCondSet.Manage(tps).MarkTrue(InstallSucceeded)
-	if tps.GetCondition(DependenciesInstalled).IsUnknown() {
-		// Assume deps are installed if we're not sure
-		tps.MarkDependenciesInstalled()
-	}
+func (tcs *TektonConfigStatus) IsReady() bool {
+	return configCondSet.Manage(tcs).IsHappy()
 }
 
-// MarkInstallFailed marks the InstallationSucceeded status as false with the given
-// message.
-func (tps *TektonConfigStatus) MarkInstallFailed(msg string) {
-	configCondSet.Manage(tps).MarkFalse(
-		InstallSucceeded,
-		"Error",
-		"Install failed with message: %s", msg)
+func (tcs *TektonConfigStatus) MarkPreInstallComplete() {
+	configCondSet.Manage(tcs).MarkTrue(PreInstall)
 }
 
-// MarkDeploymentsAvailable marks the DeploymentsAvailable status as true.
-func (tps *TektonConfigStatus) MarkDeploymentsAvailable() {
-	configCondSet.Manage(tps).MarkTrue(DeploymentsAvailable)
+func (tcs *TektonConfigStatus) MarkComponentsReady() {
+	configCondSet.Manage(tcs).MarkTrue(ComponentsReady)
 }
 
-// MarkDeploymentsNotReady marks the DeploymentsAvailable status as false and calls out
-// it's waiting for deployments.
-func (tps *TektonConfigStatus) MarkDeploymentsNotReady() {
-	configCondSet.Manage(tps).MarkFalse(
-		DeploymentsAvailable,
-		"NotReady",
-		"Waiting on deployments")
+func (tcs *TektonConfigStatus) MarkPostInstallComplete() {
+	configCondSet.Manage(tcs).MarkTrue(PostInstall)
 }
 
-// MarkDependenciesInstalled marks the DependenciesInstalled status as true.
-func (tps *TektonConfigStatus) MarkDependenciesInstalled() {
-	configCondSet.Manage(tps).MarkTrue(DependenciesInstalled)
+func (tcs *TektonConfigStatus) MarkNotReady(msg string) {
+	configCondSet.Manage(tcs).MarkFalse(
+		apis.ConditionReady,
+		"Error",
+		"Ready: %s", msg)
 }
 
-// MarkDependencyInstalling marks the DependenciesInstalled status as false with the
-// given message.
-func (tps *TektonConfigStatus) MarkDependencyInstalling(msg string) {
-	configCondSet.Manage(tps).MarkFalse(
-		DependenciesInstalled,
-		"Installing",
-		"Dependency installing: %s", msg)
+func (tcs *TektonConfigStatus) MarkPreInstallFailed(msg string) {
+	tcs.MarkNotReady("PreReconciliation failed")
+	configCondSet.Manage(tcs).MarkFalse(
+		PreInstall,
+		"Error",
+		"PreReconciliation failed with message: %s", msg)
 }
 
-// MarkDependencyMissing marks the DependenciesInstalled status as false with the
-// given message.
-func (tps *TektonConfigStatus) MarkDependencyMissing(msg string) {
-	configCondSet.Manage(tps).MarkFalse(
-		DependenciesInstalled,
+func (tcs *TektonConfigStatus) MarkComponentNotReady(msg string) {
+	tcs.MarkNotReady("Components not ready")
+	configCondSet.Manage(tcs).MarkFalse(
+		ComponentsReady,
 		"Error",
-		"Dependency missing: %s", msg)
+		"Components not in ready state: %s", msg)
+}
+
+func (tcs *TektonConfigStatus) MarkPostInstallFailed(msg string) {
+	tcs.MarkNotReady("PostReconciliation failed")
+	configCondSet.Manage(tcs).MarkFalse(
+		PostInstall,
+		"Error",
+		"PostReconciliation failed with message: %s", msg)
 }
 
 // GetVersion gets the currently installed version of the component.
-func (tps *TektonConfigStatus) GetVersion() string {
-	return tps.Version
+func (tcs *TektonConfigStatus) GetVersion() string {
+	return tcs.Version
 }
 
 // SetVersion sets the currently installed version of the component.
-func (tps *TektonConfigStatus) SetVersion(version string) {
-	tps.Version = version
+func (tcs *TektonConfigStatus) SetVersion(version string) {
+	tcs.Version = version
 }
 
+// TODO: below methods are not required for TektonConfig
+// but as extension implements TektonComponent we need to defined them
+// this will be removed
+
 // GetManifests gets the url links of the manifests.
-func (tps *TektonConfigStatus) GetManifests() []string {
-	return tps.Manifests
+func (tcs *TektonConfigStatus) GetManifests() []string {
+	return []string{}
 }
 
 // SetVersion sets the url links of the manifests.
-func (tps *TektonConfigStatus) SetManifests(manifests []string) {
-	tps.Manifests = manifests
+func (tcs *TektonConfigStatus) SetManifests(manifests []string) {
+}
+
+func (tcs *TektonConfigStatus) MarkInstallSucceeded() {
+	panic("implement me")
+}
+
+func (tcs *TektonConfigStatus) MarkInstallFailed(msg string) {
+	panic("implement me")
+}
+
+func (tcs *TektonConfigStatus) MarkDeploymentsAvailable() {
+	panic("implement me")
+}
+
+func (tcs *TektonConfigStatus) MarkDeploymentsNotReady() {
+	panic("implement me")
+}
+
+func (tcs *TektonConfigStatus) MarkDependenciesInstalled() {
+	panic("implement me")
+}
+
+func (tcs *TektonConfigStatus) MarkDependencyInstalling(msg string) {
+	panic("implement me")
+}
+
+func (tcs *TektonConfigStatus) MarkDependencyMissing(msg string) {
+	panic("implement me")
 }
diff --git a/pkg/apis/operator/v1alpha1/tektonconfig_lifecycle_test.go b/pkg/apis/operator/v1alpha1/tektonconfig_lifecycle_test.go
@@ -30,109 +30,69 @@ func TestTektonConfigGroupVersionKind(t *testing.T) {
 		Version: SchemaVersion,
 		Kind:    KindTektonConfig,
 	}
-	if got := r.GroupVersionKind(); got != want {
+	if got := r.GetGroupVersionKind(); got != want {
 		t.Errorf("got: %v, want: %v", got, want)
 	}
 }
 
 func TestTektonConfigHappyPath(t *testing.T) {
-	tp := &TektonConfigStatus{}
-	tp.InitializeConditions()
-
-	apistest.CheckConditionOngoing(tp, DependenciesInstalled, t)
-	apistest.CheckConditionOngoing(tp, DeploymentsAvailable, t)
-	apistest.CheckConditionOngoing(tp, InstallSucceeded, t)
-
-	// Install succeeds.
-	tp.MarkInstallSucceeded()
-	// Dependencies are assumed successful too.
-	apistest.CheckConditionSucceeded(tp, DependenciesInstalled, t)
-	apistest.CheckConditionOngoing(tp, DeploymentsAvailable, t)
-	apistest.CheckConditionSucceeded(tp, InstallSucceeded, t)
-
-	// Deployments are not available at first.
-	tp.MarkDeploymentsNotReady()
-	apistest.CheckConditionSucceeded(tp, DependenciesInstalled, t)
-	apistest.CheckConditionFailed(tp, DeploymentsAvailable, t)
-	apistest.CheckConditionSucceeded(tp, InstallSucceeded, t)
-	if ready := tp.IsReady(); ready {
-		t.Errorf("tp.IsReady() = %v, want false", ready)
-	}
+	tc := &TektonConfigStatus{}
+	tc.InitializeConditions()
+
+	apistest.CheckConditionOngoing(tc, PreInstall, t)
+	apistest.CheckConditionOngoing(tc, ComponentsReady, t)
+	apistest.CheckConditionOngoing(tc, PostInstall, t)
+
+	// Pre install completes execution
+	tc.MarkPreInstallComplete()
+	apistest.CheckConditionSucceeded(tc, PreInstall, t)
+
+	// Components and then PostInstall completes and we're good.
+	tc.MarkComponentsReady()
+	apistest.CheckConditionSucceeded(tc, ComponentsReady, t)
 
-	// Deployments become ready and we're good.
-	tp.MarkDeploymentsAvailable()
-	apistest.CheckConditionSucceeded(tp, DependenciesInstalled, t)
-	apistest.CheckConditionSucceeded(tp, DeploymentsAvailable, t)
-	apistest.CheckConditionSucceeded(tp, InstallSucceeded, t)
-	if ready := tp.IsReady(); !ready {
-		t.Errorf("tp.IsReady() = %v, want true", ready)
+	tc.MarkPostInstallComplete()
+	apistest.CheckConditionSucceeded(tc, PostInstall, t)
+
+	if ready := tc.IsReady(); !ready {
+		t.Errorf("tc.IsReady() = %v, want true", ready)
 	}
+
 }
 
 func TestTektonConfigErrorPath(t *testing.T) {
-	tp := &TektonConfigStatus{}
-	tp.InitializeConditions()
-
-	apistest.CheckConditionOngoing(tp, DependenciesInstalled, t)
-	apistest.CheckConditionOngoing(tp, DeploymentsAvailable, t)
-	apistest.CheckConditionOngoing(tp, InstallSucceeded, t)
-
-	// Install fails.
-	tp.MarkInstallFailed("test")
-	apistest.CheckConditionOngoing(tp, DependenciesInstalled, t)
-	apistest.CheckConditionOngoing(tp, DeploymentsAvailable, t)
-	apistest.CheckConditionFailed(tp, InstallSucceeded, t)
-
-	// Dependencies are installing.
-	tp.MarkDependencyInstalling("testing")
-	apistest.CheckConditionFailed(tp, DependenciesInstalled, t)
-	apistest.CheckConditionOngoing(tp, DeploymentsAvailable, t)
-	apistest.CheckConditionFailed(tp, InstallSucceeded, t)
-
-	// Install now succeeds.
-	tp.MarkInstallSucceeded()
-	apistest.CheckConditionFailed(tp, DependenciesInstalled, t)
-	apistest.CheckConditionOngoing(tp, DeploymentsAvailable, t)
-	apistest.CheckConditionSucceeded(tp, InstallSucceeded, t)
-	if ready := tp.IsReady(); ready {
-		t.Errorf("tp.IsReady() = %v, want false", ready)
-	}
+	tc := &TektonConfigStatus{}
+	tc.InitializeConditions()
 
-	// Deployments become ready
-	tp.MarkDeploymentsAvailable()
-	apistest.CheckConditionFailed(tp, DependenciesInstalled, t)
-	apistest.CheckConditionSucceeded(tp, DeploymentsAvailable, t)
-	apistest.CheckConditionSucceeded(tp, InstallSucceeded, t)
-	if ready := tp.IsReady(); ready {
-		t.Errorf("tp.IsReady() = %v, want false", ready)
-	}
+	apistest.CheckConditionOngoing(tc, PreInstall, t)
+	apistest.CheckConditionOngoing(tc, ComponentsReady, t)
+	apistest.CheckConditionOngoing(tc, PostInstall, t)
 
-	// Finally, dependencies become available.
-	tp.MarkDependenciesInstalled()
-	apistest.CheckConditionSucceeded(tp, DependenciesInstalled, t)
-	apistest.CheckConditionSucceeded(tp, DeploymentsAvailable, t)
-	apistest.CheckConditionSucceeded(tp, InstallSucceeded, t)
-	if ready := tp.IsReady(); !ready {
-		t.Errorf("tp.IsReady() = %v, want true", ready)
-	}
-}
+	// Pre install completes execution
+	tc.MarkPreInstallComplete()
+	apistest.CheckConditionSucceeded(tc, PreInstall, t)
 
-func TestTektonConfigExternalDependency(t *testing.T) {
-	tp := &TektonConfigStatus{}
-	tp.InitializeConditions()
+	// ComponentsReady is not ready when components are not in ready state
+	tc.MarkComponentNotReady("waiting for component")
+	apistest.CheckConditionFailed(tc, ComponentsReady, t)
 
-	// External marks dependency as failed.
-	tp.MarkDependencyMissing("test")
+	// ComponentsReady and then PostInstall become ready and we're good.
+	tc.MarkComponentsReady()
+	apistest.CheckConditionSucceeded(tc, ComponentsReady, t)
 
-	// Install succeeds.
-	tp.MarkInstallSucceeded()
-	apistest.CheckConditionFailed(tp, DependenciesInstalled, t)
-	apistest.CheckConditionOngoing(tp, DeploymentsAvailable, t)
-	apistest.CheckConditionSucceeded(tp, InstallSucceeded, t)
+	tc.MarkPostInstallComplete()
+	apistest.CheckConditionSucceeded(tc, PostInstall, t)
+
+	if ready := tc.IsReady(); !ready {
+		t.Errorf("tc.IsReady() = %v, want true", ready)
+	}
+
+	// In further reconciliation component might fail
+
+	tc.MarkComponentNotReady("pipeline not ready")
+	apistest.CheckConditionFailed(tc, ComponentsReady, t)
+	if ready := tc.IsReady(); ready {
+		t.Errorf("tc.IsReady() = %v, want false", ready)
+	}
 
-	// Dependencies are now ready.
-	tp.MarkDependenciesInstalled()
-	apistest.CheckConditionSucceeded(tp, DependenciesInstalled, t)
-	apistest.CheckConditionOngoing(tp, DeploymentsAvailable, t)
-	apistest.CheckConditionSucceeded(tp, InstallSucceeded, t)
 }