Move several packages into internal

This commit moves several packages in pkg/ into pkg/internal.
This reduces the Pipelines API surface by ensuring these packages can't be imported
and relied on by clients, as we only intend for pkg/apis and pkg/client to be imported
outside of Pipelines. Other packages that contain exported functions used outside
of pkg/ will be refactored in a later commit.

cmd/entrypoint/runner.go

@@ -8,7 +8,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-    http://www.apache.org/licenses/LICENSE-2.0
+	http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
@@ -30,8 +30,8 @@ import (
 	"sync"
 	"syscall"
 
+	"github.com/tektoncd/pipeline/pkg/apis/config"
 	"github.com/tektoncd/pipeline/pkg/entrypoint"
-	"github.com/tektoncd/pipeline/pkg/pod"
 )
 
 // TODO(jasonhall): Test that original exit code is propagated and that
@@ -112,7 +112,7 @@ func (rr *realRunner) Run(ctx context.Context, args ...string) error {
 	// main process and all children
 	cmd.SysProcAttr = &syscall.SysProcAttr{Setpgid: true}
 
-	if os.Getenv("TEKTON_RESOURCE_NAME") == "" && os.Getenv(pod.TektonHermeticEnvVar) == "1" {
+	if os.Getenv("TEKTON_RESOURCE_NAME") == "" && os.Getenv(config.TektonHermeticEnvVar) == "1" {
 		dropNetworking(cmd)
 	}
 

pkg/apis/config/pod.go

@@ -0,0 +1,8 @@
+package config
+
+const (
+	// TektonHermeticEnvVar is the env var we set in containers to indicate they should be run hermetically
+	TektonHermeticEnvVar = "TEKTON_HERMETIC"
+	// ReleaseAnnotation is the annotation set on TaskRun pods specifying the version of Pipelines
+	ReleaseAnnotation = "pipeline.tekton.dev/release"
+)

pkg/apis/pipeline/v1/param_types.go

@@ -24,7 +24,7 @@ import (
 	"strings"
 
 	resource "github.com/tektoncd/pipeline/pkg/apis/resource/v1alpha1"
-	"github.com/tektoncd/pipeline/pkg/substitution"
+	"github.com/tektoncd/pipeline/pkg/internal/substitution"
 	"k8s.io/apimachinery/pkg/util/sets"
 	"knative.dev/pkg/apis"
 )

pkg/apis/pipeline/v1/pipeline_validation.go

@@ -23,8 +23,8 @@ import (
 
 	"github.com/tektoncd/pipeline/pkg/apis/config"
 	"github.com/tektoncd/pipeline/pkg/apis/validate"
+	"github.com/tektoncd/pipeline/pkg/internal/substitution"
 	"github.com/tektoncd/pipeline/pkg/reconciler/pipeline/dag"
-	"github.com/tektoncd/pipeline/pkg/substitution"
 	admissionregistrationv1 "k8s.io/api/admissionregistration/v1"
 	"k8s.io/apimachinery/pkg/api/equality"
 	"k8s.io/apimachinery/pkg/util/sets"

pkg/apis/pipeline/v1/task_validation.go

@@ -27,7 +27,7 @@ import (
 	"github.com/tektoncd/pipeline/pkg/apis/config"
 	"github.com/tektoncd/pipeline/pkg/apis/validate"
 	"github.com/tektoncd/pipeline/pkg/apis/version"
-	"github.com/tektoncd/pipeline/pkg/substitution"
+	"github.com/tektoncd/pipeline/pkg/internal/substitution"
 	admissionregistrationv1 "k8s.io/api/admissionregistration/v1"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/util/sets"

pkg/apis/pipeline/v1/taskref_types.go

@@ -39,4 +39,7 @@ type TaskKind string
 const (
 	// NamespacedTaskKind indicates that the task type has a namespaced scope.
 	NamespacedTaskKind TaskKind = "Task"
+	// ReasonCouldntGetTask indicates that the reason for the failure status is that the
+	// Task couldn't be found
+	ReasonCouldntGetTask = "CouldntGetTask"
 )

pkg/apis/pipeline/v1/when_types.go

@@ -19,7 +19,7 @@ package v1
 import (
 	"fmt"
 
-	"github.com/tektoncd/pipeline/pkg/substitution"
+	"github.com/tektoncd/pipeline/pkg/internal/substitution"
 	"k8s.io/apimachinery/pkg/selection"
 )
 

pkg/apis/pipeline/v1beta1/param_types.go

@@ -23,7 +23,7 @@ import (
 	"strings"
 
 	resource "github.com/tektoncd/pipeline/pkg/apis/resource/v1alpha1"
-	"github.com/tektoncd/pipeline/pkg/substitution"
+	"github.com/tektoncd/pipeline/pkg/internal/substitution"
 	"k8s.io/apimachinery/pkg/util/sets"
 	"knative.dev/pkg/apis"
 )

pkg/apis/pipeline/v1beta1/pipeline_validation.go

@@ -23,9 +23,9 @@ import (
 
 	"github.com/tektoncd/pipeline/pkg/apis/config"
 	"github.com/tektoncd/pipeline/pkg/apis/validate"
-	"github.com/tektoncd/pipeline/pkg/list"
+	"github.com/tektoncd/pipeline/pkg/internal/list"
+	"github.com/tektoncd/pipeline/pkg/internal/substitution"
 	"github.com/tektoncd/pipeline/pkg/reconciler/pipeline/dag"
-	"github.com/tektoncd/pipeline/pkg/substitution"
 	admissionregistrationv1 "k8s.io/api/admissionregistration/v1"
 	"k8s.io/apimachinery/pkg/api/equality"
 	"k8s.io/apimachinery/pkg/util/sets"

pkg/apis/pipeline/v1beta1/task_validation.go

@@ -27,7 +27,7 @@ import (
 	"github.com/tektoncd/pipeline/pkg/apis/config"
 	"github.com/tektoncd/pipeline/pkg/apis/validate"
 	"github.com/tektoncd/pipeline/pkg/apis/version"
-	"github.com/tektoncd/pipeline/pkg/substitution"
+	"github.com/tektoncd/pipeline/pkg/internal/substitution"
 	admissionregistrationv1 "k8s.io/api/admissionregistration/v1"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/util/sets"

pkg/apis/pipeline/v1beta1/taskref_types.go

@@ -47,4 +47,7 @@ const (
 	NamespacedTaskKind TaskKind = "Task"
 	// ClusterTaskKind indicates that task type has a cluster scope.
 	ClusterTaskKind TaskKind = "ClusterTask"
+	// ReasonCouldntGetTask indicates that the reason for the failure status is that the
+	// Task couldn't be found
+	ReasonCouldntGetTask = "CouldntGetTask"
 )

pkg/apis/pipeline/v1beta1/when_types.go

@@ -19,7 +19,7 @@ package v1beta1
 import (
 	"fmt"
 
-	"github.com/tektoncd/pipeline/pkg/substitution"
+	"github.com/tektoncd/pipeline/pkg/internal/substitution"
 	"k8s.io/apimachinery/pkg/selection"
 )
 

pkg/artifacts/artifacts.go

@@ -0,0 +1,12 @@
+package artifacts
+
+import "fmt"
+
+// GetPVCName returns the name that should be used for the PVC for a PipelineRun
+func GetPVCName(n named) string {
+	return fmt.Sprintf("%s-pvc", n.GetName())
+}
+
+type named interface {
+	GetName() string
+}

pkg/internal/affinityassistant/transformer.go

@@ -19,8 +19,8 @@ package affinityassistant
 import (
 	"context"
 
-	"github.com/tektoncd/pipeline/pkg/pod"
-	"github.com/tektoncd/pipeline/pkg/workspace"
+	"github.com/tektoncd/pipeline/pkg/internal/pod"
+	"github.com/tektoncd/pipeline/pkg/internal/workspace"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )

pkg/internal/affinityassistant/transformer_test.go

@@ -5,7 +5,7 @@ Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at
 
-    http://www.apache.org/licenses/LICENSE-2.0
+	http://www.apache.org/licenses/LICENSE-2.0
 
 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
@@ -21,7 +21,7 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/tektoncd/pipeline/pkg/internal/affinityassistant"
-	"github.com/tektoncd/pipeline/pkg/workspace"
+	"github.com/tektoncd/pipeline/pkg/internal/workspace"
 	"github.com/tektoncd/pipeline/test/diff"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"

pkg/artifacts/artifact_storage_test.go → pkg/internal/artifacts/artifact_storage_test.go

@@ -27,6 +27,7 @@ import (
 	"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
 	resourcev1alpha1 "github.com/tektoncd/pipeline/pkg/apis/resource/v1alpha1"
 	"github.com/tektoncd/pipeline/pkg/apis/resource/v1alpha1/storage"
+	"github.com/tektoncd/pipeline/pkg/artifacts"
 	"github.com/tektoncd/pipeline/test/diff"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/errors"
@@ -295,9 +296,9 @@ func TestInitializeArtifactStorage(t *testing.T) {
 			}
 			// If the expected storage type is PVC, make sure we're actually creating that PVC.
 			if c.storagetype == "pvc" {
-				_, err := fakekubeclient.CoreV1().PersistentVolumeClaims(pipelinerun.Namespace).Get(ctx, GetPVCName(pipelinerun), metav1.GetOptions{})
+				_, err := fakekubeclient.CoreV1().PersistentVolumeClaims(pipelinerun.Namespace).Get(ctx, artifacts.GetPVCName(pipelinerun), metav1.GetOptions{})
 				if err != nil {
-					t.Fatalf("Error getting expected PVC %s for PipelineRun %s: %s", GetPVCName(pipelinerun), pipelinerun.Name, err)
+					t.Fatalf("Error getting expected PVC %s for PipelineRun %s: %s", artifacts.GetPVCName(pipelinerun), pipelinerun.Name, err)
 				}
 			}
 			// Make sure we don't get any errors running CleanupArtifactStorage against the resulting storage, whether it's
@@ -455,18 +456,18 @@ func TestCleanupArtifactStorage(t *testing.T) {
 				ArtifactBucket: ab,
 			}
 			ctx := config.ToContext(context.Background(), &configs)
-			_, err = fakekubeclient.CoreV1().PersistentVolumeClaims(pipelinerun.Namespace).Get(ctx, GetPVCName(pipelinerun), metav1.GetOptions{})
+			_, err = fakekubeclient.CoreV1().PersistentVolumeClaims(pipelinerun.Namespace).Get(ctx, artifacts.GetPVCName(pipelinerun), metav1.GetOptions{})
 			if err != nil {
-				t.Fatalf("Error getting expected PVC %s for PipelineRun %s: %s", GetPVCName(pipelinerun), pipelinerun.Name, err)
+				t.Fatalf("Error getting expected PVC %s for PipelineRun %s: %s", artifacts.GetPVCName(pipelinerun), pipelinerun.Name, err)
 			}
 			if err := CleanupArtifactStorage(ctx, pipelinerun, fakekubeclient); err != nil {
 				t.Fatalf("Error cleaning up artifact storage: %s", err)
 			}
-			_, err = fakekubeclient.CoreV1().PersistentVolumeClaims(pipelinerun.Namespace).Get(ctx, GetPVCName(pipelinerun), metav1.GetOptions{})
+			_, err = fakekubeclient.CoreV1().PersistentVolumeClaims(pipelinerun.Namespace).Get(ctx, artifacts.GetPVCName(pipelinerun), metav1.GetOptions{})
 			if err == nil {
-				t.Fatalf("Found PVC %s for PipelineRun %s after it should have been cleaned up", GetPVCName(pipelinerun), pipelinerun.Name)
+				t.Fatalf("Found PVC %s for PipelineRun %s after it should have been cleaned up", artifacts.GetPVCName(pipelinerun), pipelinerun.Name)
 			} else if !errors.IsNotFound(err) {
-				t.Fatalf("Error checking if PVC %s for PipelineRun %s has been cleaned up: %s", GetPVCName(pipelinerun), pipelinerun.Name, err)
+				t.Fatalf("Error checking if PVC %s for PipelineRun %s has been cleaned up: %s", artifacts.GetPVCName(pipelinerun), pipelinerun.Name, err)
 			}
 		})
 	}

pkg/artifacts/artifacts_storage.go → pkg/internal/artifacts/artifacts_storage.go

@@ -21,6 +21,8 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/tektoncd/pipeline/pkg/artifacts"
+
 	"github.com/tektoncd/pipeline/pkg/apis/config"
 	"github.com/tektoncd/pipeline/pkg/apis/pipeline"
 	"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
@@ -172,7 +174,7 @@ func newArtifactBucketFromConfig(ctx context.Context, images pipeline.Images) *s
 }
 
 func createPVC(ctx context.Context, pr *v1beta1.PipelineRun, c kubernetes.Interface) (*corev1.PersistentVolumeClaim, error) {
-	if _, err := c.CoreV1().PersistentVolumeClaims(pr.Namespace).Get(ctx, GetPVCName(pr), metav1.GetOptions{}); err != nil {
+	if _, err := c.CoreV1().PersistentVolumeClaims(pr.Namespace).Get(ctx, artifacts.GetPVCName(pr), metav1.GetOptions{}); err != nil {
 		if errors.IsNotFound(err) {
 			pvcConfig := config.FromContextOrDefaults(ctx).ArtifactPVC
 			pvcSize, err := resource.ParseQuantity(pvcConfig.Size)
@@ -205,11 +207,11 @@ func createPVC(ctx context.Context, pr *v1beta1.PipelineRun, c kubernetes.Interf
 }
 
 func deletePVC(ctx context.Context, pr *v1beta1.PipelineRun, c kubernetes.Interface) error {
-	if _, err := c.CoreV1().PersistentVolumeClaims(pr.Namespace).Get(ctx, GetPVCName(pr), metav1.GetOptions{}); err != nil {
+	if _, err := c.CoreV1().PersistentVolumeClaims(pr.Namespace).Get(ctx, artifacts.GetPVCName(pr), metav1.GetOptions{}); err != nil {
 		if !errors.IsNotFound(err) {
-			return fmt.Errorf("failed to get Persistent Volume %q due to error: %w", GetPVCName(pr), err)
+			return fmt.Errorf("failed to get Persistent Volume %q due to error: %w", artifacts.GetPVCName(pr), err)
 		}
-	} else if err := c.CoreV1().PersistentVolumeClaims(pr.Namespace).Delete(ctx, GetPVCName(pr), metav1.DeleteOptions{}); err != nil {
+	} else if err := c.CoreV1().PersistentVolumeClaims(pr.Namespace).Delete(ctx, artifacts.GetPVCName(pr), metav1.DeleteOptions{}); err != nil {
 		return fmt.Errorf("failed to delete Persistent Volume %q due to error: %w", pr.Name, err)
 	}
 	return nil
@@ -220,7 +222,7 @@ func getPVCSpec(pr *v1beta1.PipelineRun, pvcSize resource.Quantity, storageClass
 	return &corev1.PersistentVolumeClaim{
 		ObjectMeta: metav1.ObjectMeta{
 			Namespace:       pr.Namespace,
-			Name:            GetPVCName(pr),
+			Name:            artifacts.GetPVCName(pr),
 			OwnerReferences: []metav1.OwnerReference{*kmeta.NewControllerRef(pr)},
 		},
 		Spec: corev1.PersistentVolumeClaimSpec{
@@ -234,12 +236,3 @@ func getPVCSpec(pr *v1beta1.PipelineRun, pvcSize resource.Quantity, storageClass
 		},
 	}
 }
-
-// GetPVCName returns the name that should be used for the PVC for a PipelineRun
-func GetPVCName(n named) string {
-	return fmt.Sprintf("%s-pvc", n.GetName())
-}
-
-type named interface {
-	GetName() string
-}

pkg/internal/computeresources/transformer.go

@@ -21,7 +21,7 @@ import (
 
 	"github.com/tektoncd/pipeline/pkg/internal/computeresources/compare"
 	"github.com/tektoncd/pipeline/pkg/internal/computeresources/limitrange"
-	"github.com/tektoncd/pipeline/pkg/pod"
+	"github.com/tektoncd/pipeline/pkg/internal/pod"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/api/resource"
 	corev1listers "k8s.io/client-go/listers/core/v1"

pkg/container/container_replacements.go → pkg/internal/container/container_replacements.go

@@ -18,7 +18,7 @@ package container
 
 import (
 	"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
-	"github.com/tektoncd/pipeline/pkg/substitution"
+	"github.com/tektoncd/pipeline/pkg/internal/substitution"
 	corev1 "k8s.io/api/core/v1"
 )
 

pkg/container/sidecar_replacements.go → pkg/internal/container/sidecar_replacements.go

@@ -18,7 +18,7 @@ package container
 
 import (
 	"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
-	"github.com/tektoncd/pipeline/pkg/substitution"
+	"github.com/tektoncd/pipeline/pkg/internal/substitution"
 )
 
 // ApplySidecarReplacements applies variable interpolation on a Sidecar.

pkg/container/sidecar_replacements_test.go → pkg/internal/container/sidecar_replacements_test.go

@@ -21,7 +21,7 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
-	"github.com/tektoncd/pipeline/pkg/container"
+	"github.com/tektoncd/pipeline/pkg/internal/container"
 	corev1 "k8s.io/api/core/v1"
 )
 

pkg/container/step_replacements.go → pkg/internal/container/step_replacements.go

@@ -18,7 +18,7 @@ package container
 
 import (
 	"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
-	"github.com/tektoncd/pipeline/pkg/substitution"
+	"github.com/tektoncd/pipeline/pkg/internal/substitution"
 )
 
 // ApplyStepReplacements applies variable interpolation on a Step.

pkg/container/step_replacements_test.go → pkg/internal/container/step_replacements_test.go

@@ -21,7 +21,7 @@ import (
 
 	"github.com/google/go-cmp/cmp"
 	"github.com/tektoncd/pipeline/pkg/apis/pipeline/v1beta1"
-	"github.com/tektoncd/pipeline/pkg/container"
+	"github.com/tektoncd/pipeline/pkg/internal/container"
 	corev1 "k8s.io/api/core/v1"
 )
 

pkg/pod/pod.go → pkg/internal/pod/pod.go

@@ -39,9 +39,6 @@ import (
 )
 
 const (
-	// TektonHermeticEnvVar is the env var we set in containers to indicate they should be run hermetically
-	TektonHermeticEnvVar = "TEKTON_HERMETIC"
-
 	// ExecutionModeAnnotation is an experimental optional annotation to set the execution mode on a TaskRun
 	ExecutionModeAnnotation = "experimental.tekton.dev/execution-mode"
 
@@ -55,8 +52,6 @@ const (
 
 // These are effectively const, but Go doesn't have such an annotation.
 var (
-	ReleaseAnnotation = "pipeline.tekton.dev/release"
-
 	groupVersionKind = schema.GroupVersionKind{
 		Group:   v1beta1.SchemeGroupVersion.Group,
 		Version: v1beta1.SchemeGroupVersion.Version,
@@ -218,7 +213,7 @@ func (b *Builder) Build(ctx context.Context, taskRun *v1beta1.TaskRun, taskSpec
 	if taskRun.Annotations[ExecutionModeAnnotation] == ExecutionModeHermetic && alphaAPIEnabled {
 		for i, s := range stepContainers {
 			// Add it at the end so it overrides
-			env := append(s.Env, corev1.EnvVar{Name: TektonHermeticEnvVar, Value: "1"}) //nolint
+			env := append(s.Env, corev1.EnvVar{Name: config.TektonHermeticEnvVar, Value: "1"}) //nolint
 			stepContainers[i].Env = env
 		}
 	}
@@ -294,7 +289,7 @@ func (b *Builder) Build(ctx context.Context, taskRun *v1beta1.TaskRun, taskSpec
 	}
 
 	podAnnotations := kmeta.CopyMap(taskRun.Annotations)
-	podAnnotations[ReleaseAnnotation] = changeset.Get()
+	podAnnotations[config.ReleaseAnnotation] = changeset.Get()
 
 	if readyImmediately {
 		podAnnotations[readyAnnotation] = readyAnnotationValue

pkg/pod/pod_test.go → pkg/internal/pod/pod_test.go

@@ -54,7 +54,7 @@ var (
 	}
 
 	ignoreReleaseAnnotation = func(k string, v string) bool {
-		return k == ReleaseAnnotation
+		return k == config.ReleaseAnnotation
 	}
 	featureInjectedSidecar                   = "running-in-environment-with-injected-sidecars"
 	featureAwaitSidecarReadiness             = "await-sidecar-readiness"
@@ -1823,11 +1823,11 @@ _EOF_
 			var trAnnotations map[string]string
 			if c.trAnnotation == nil {
 				trAnnotations = map[string]string{
-					ReleaseAnnotation: fakeVersion,
+					config.ReleaseAnnotation: fakeVersion,
 				}
 			} else {
 				trAnnotations = c.trAnnotation
-				trAnnotations[ReleaseAnnotation] = fakeVersion
+				trAnnotations[config.ReleaseAnnotation] = fakeVersion
 			}
 			testTaskRunName := taskRunName
 			if c.trName != "" {
@@ -2032,11 +2032,11 @@ debug-fail-continue-heredoc-randomly-generated-mz4c7
 			var trAnnotations map[string]string
 			if c.trAnnotation == nil {
 				trAnnotations = map[string]string{
-					ReleaseAnnotation: fakeVersion,
+					config.ReleaseAnnotation: fakeVersion,
 				}
 			} else {
 				trAnnotations = c.trAnnotation
-				trAnnotations[ReleaseAnnotation] = fakeVersion
+				trAnnotations[config.ReleaseAnnotation] = fakeVersion
 			}
 			tr := &v1beta1.TaskRun{
 				ObjectMeta: metav1.ObjectMeta{