chore: Update controller finalizer name to include explicit part

*   The finalizer name used by the controller was updated.
*   A new constant `FinalizerName` was introduced for the explicit part of the
name.
*   The finalizer name was updated to combine the group name and the new
constant.
*   This change aligns the finalizer naming with common Kubernetes conventions.

Fixes openshift-pipelines#1763

Signed-off-by: Chmouel Boudjnah <[email protected]>

Author: chmouel

pkg/action/patch_test.go

@@ -1,7 +1,7 @@
 package action
 
 import (
-	"path/filepath"
+	"path"
 	"testing"
 
 	apipac "github.com/openshift-pipelines/pipelines-as-code/pkg/apis/pipelinesascode"
@@ -40,7 +40,7 @@ func TestPatchPipelineRun(t *testing.T) {
 
 	patchedPR, err := PatchPipelineRun(ctx, logger, "log URL", fakeClients.Tekton, testPR, getLogURLMergePatch(fakeClients, testPR))
 	assert.NilError(t, err)
-	assert.Equal(t, patchedPR.Annotations[filepath.Join(apipac.GroupName, "log-url")], "https://localhost.console/#/namespaces/namespace/pipelineruns/force-me")
+	assert.Equal(t, patchedPR.Annotations[path.Join(apipac.GroupName, "log-url")], "https://localhost.console/#/namespaces/namespace/pipelineruns/force-me")
 }
 
 func getLogURLMergePatch(clients clients.Clients, pr *pipelinev1.PipelineRun) map[string]any {

pkg/apis/pipelinesascode/register.go

@@ -21,4 +21,5 @@ const (
 	GroupName       = "pipelinesascode.tekton.dev"
 	RepositoryKind  = "Repository"
 	V1alpha1Version = "v1alpha1"
+	FinalizerName   = "finalizer"
 )

pkg/pipelineascode/pipelineascode_test.go

@@ -8,7 +8,7 @@ import (
 	"fmt"
 	"io"
 	"net/http"
-	"path/filepath"
+	"path"
 	"regexp"
 	"strings"
 	"sync"
@@ -667,7 +667,7 @@ func TestRun(t *testing.T) {
 					if pr.GetName() == "force-me" {
 						continue
 					}
-					logURL, ok := pr.Annotations[filepath.Join(apipac.GroupName, "log-url")]
+					logURL, ok := pr.Annotations[path.Join(apipac.GroupName, "log-url")]
 					assert.Assert(t, ok, "failed to find log-url label on pipelinerun: %s/%s", pr.GetNamespace(), pr.GetGenerateName())
 					assert.Equal(t, logURL, cs.Clients.ConsoleUI().DetailURL(&pr))
 
@@ -700,5 +700,5 @@ func TestGetLogURLMergePatch(t *testing.T) {
 	assert.Assert(t, ok)
 	a, ok := m["annotations"].(map[string]string)
 	assert.Assert(t, ok)
-	assert.Equal(t, a[filepath.Join(apipac.GroupName, "log-url")], con.URL())
+	assert.Equal(t, a[path.Join(apipac.GroupName, "log-url")], con.URL())
 }

pkg/provider/gitlab/gitlab.go

@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"net/http"
 	"net/url"
+	"path"
 	"path/filepath"
 	"regexp"
 	"strings"
@@ -212,7 +213,7 @@ func (v *Provider) SetClient(_ context.Context, run *params.Run, runevent *info.
 	// if we don't have sourceProjectID (ie: incoming-webhook) then try to set
 	// it ASAP if we can.
 	if v.sourceProjectID == 0 && runevent.Organization != "" && runevent.Repository != "" {
-		projectSlug := filepath.Join(runevent.Organization, runevent.Repository)
+		projectSlug := path.Join(runevent.Organization, runevent.Repository)
 		projectinfo, _, err := v.Client().Projects.GetProject(projectSlug, &gitlab.GetProjectOptions{})
 		if err != nil {
 			return err

pkg/reconciler/controller.go

@@ -2,6 +2,7 @@ package reconciler
 
 import (
 	"context"
+	"path"
 
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/apis/pipelinesascode"
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/apis/pipelinesascode/keys"
@@ -88,7 +89,7 @@ func checkStateAndEnqueue(impl *controller.Impl) func(obj any) {
 func ctrlOpts() func(impl *controller.Impl) controller.Options {
 	return func(_ *controller.Impl) controller.Options {
 		return controller.Options{
-			FinalizerName: pipelinesascode.GroupName,
+			FinalizerName: path.Join(pipelinesascode.GroupName, pipelinesascode.FinalizerName),
 			PromoteFilterFunc: func(obj any) bool {
 				_, exist := obj.(*tektonv1.PipelineRun).GetAnnotations()[keys.State]
 				return exist

pkg/reconciler/controller_test.go

@@ -2,6 +2,7 @@ package reconciler
 
 import (
 	"context"
+	"path"
 	"testing"
 
 	"github.com/openshift-pipelines/pipelines-as-code/pkg/apis/pipelinesascode"
@@ -63,7 +64,7 @@ func TestCtrlOpts(t *testing.T) {
 	opts := ctrlOpts()(impl)
 
 	// Assert that the finalizer name is set correctly.
-	assert.Equal(t, pipelinesascode.GroupName, opts.FinalizerName)
+	assert.Equal(t, path.Join(pipelinesascode.GroupName, pipelinesascode.FinalizerName), opts.FinalizerName)
 
 	// Create a new PipelineRun object with the "started" state label.
 	pr := &pipelinev1.PipelineRun{