/*
Copyright 2023 The Tekton Authors

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

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package workspace_test

import (
	"context"
	"testing"

	"github.com/google/go-cmp/cmp"
	"github.com/tektoncd/pipeline/pkg/apis/config"
	v1 "github.com/tektoncd/pipeline/pkg/apis/pipeline/v1"
	"github.com/tektoncd/pipeline/pkg/workspace"
	"github.com/tektoncd/pipeline/test/diff"
	"github.com/tektoncd/pipeline/test/names"
	corev1 "k8s.io/api/core/v1"
	"k8s.io/apimachinery/pkg/util/sets"
)

func TestCreateVolumes(t *testing.T) {
	names.TestingSeed()
	for _, tc := range []struct {
		name            string
		workspaces      []v1.WorkspaceBinding
		expectedVolumes map[string]corev1.Volume
	}{{
		name: "binding a single workspace with a PVC",
		workspaces: []v1.WorkspaceBinding{{
			Name: "custom",
			PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
				ClaimName: "mypvc",
			},
			SubPath: "/foo/bar/baz",
		}},
		expectedVolumes: map[string]corev1.Volume{
			"custom": {
				Name: "ws-20573",
				VolumeSource: corev1.VolumeSource{
					PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
						ClaimName: "mypvc",
					},
				},
			},
		},
	}, {
		name: "binding a single workspace with emptyDir",
		workspaces: []v1.WorkspaceBinding{{
			Name: "custom",
			EmptyDir: &corev1.EmptyDirVolumeSource{
				Medium: corev1.StorageMediumMemory,
			},
			SubPath: "/foo/bar/baz",
		}},
		expectedVolumes: map[string]corev1.Volume{
			"custom": {
				Name: "ws-20573",
				VolumeSource: corev1.VolumeSource{
					EmptyDir: &corev1.EmptyDirVolumeSource{
						Medium: corev1.StorageMediumMemory,
					},
				},
			},
		},
	}, {
		name: "binding a single workspace with configMap",
		workspaces: []v1.WorkspaceBinding{{
			Name: "custom",
			ConfigMap: &corev1.ConfigMapVolumeSource{
				LocalObjectReference: corev1.LocalObjectReference{
					Name: "foobarconfigmap",
				},
				Items: []corev1.KeyToPath{{
					Key:  "foobar",
					Path: "foobar.txt",
				}},
			},
			SubPath: "/foo/bar/baz",
		}},
		expectedVolumes: map[string]corev1.Volume{
			"custom": {
				Name: "ws-20573",
				VolumeSource: corev1.VolumeSource{
					ConfigMap: &corev1.ConfigMapVolumeSource{
						LocalObjectReference: corev1.LocalObjectReference{
							Name: "foobarconfigmap",
						},
						Items: []corev1.KeyToPath{{
							Key:  "foobar",
							Path: "foobar.txt",
						}},
					},
				},
			},
		},
	}, {
		name: "binding a single workspace with secret",
		workspaces: []v1.WorkspaceBinding{{
			Name: "custom",
			Secret: &corev1.SecretVolumeSource{
				SecretName: "foobarsecret",
				Items: []corev1.KeyToPath{{
					Key:  "foobar",
					Path: "foobar.txt",
				}},
			},
			SubPath: "/foo/bar/baz",
		}},
		expectedVolumes: map[string]corev1.Volume{
			"custom": {
				Name: "ws-20573",
				VolumeSource: corev1.VolumeSource{
					Secret: &corev1.SecretVolumeSource{
						SecretName: "foobarsecret",
						Items: []corev1.KeyToPath{{
							Key:  "foobar",
							Path: "foobar.txt",
						}},
					},
				},
			},
		},
	}, {
		name: "binding a single workspace with projected",
		workspaces: []v1.WorkspaceBinding{{
			Name: "custom",
			Projected: &corev1.ProjectedVolumeSource{
				Sources: []corev1.VolumeProjection{{
					ConfigMap: &corev1.ConfigMapProjection{
						LocalObjectReference: corev1.LocalObjectReference{
							Name: "foobarconfigmap",
						},
						Items: []corev1.KeyToPath{{
							Key:  "foobar",
							Path: "foobar.txt",
						}},
					},
				}, {
					Secret: &corev1.SecretProjection{
						LocalObjectReference: corev1.LocalObjectReference{
							Name: "foobarsecret",
						},
						Items: []corev1.KeyToPath{{
							Key:  "foobar",
							Path: "foobar.txt",
						}},
					},
				}},
			},
			SubPath: "/foo/bar/baz",
		}},
		expectedVolumes: map[string]corev1.Volume{
			"custom": {
				Name: "ws-20573",
				VolumeSource: corev1.VolumeSource{
					Projected: &corev1.ProjectedVolumeSource{
						Sources: []corev1.VolumeProjection{{
							ConfigMap: &corev1.ConfigMapProjection{
								LocalObjectReference: corev1.LocalObjectReference{
									Name: "foobarconfigmap",
								},
								Items: []corev1.KeyToPath{{
									Key:  "foobar",
									Path: "foobar.txt",
								}},
							},
						}, {
							Secret: &corev1.SecretProjection{
								LocalObjectReference: corev1.LocalObjectReference{
									Name: "foobarsecret",
								},
								Items: []corev1.KeyToPath{{
									Key:  "foobar",
									Path: "foobar.txt",
								}},
							},
						}},
					},
				},
			},
		},
	}, {
		name:            "0 workspace bindings",
		workspaces:      []v1.WorkspaceBinding{},
		expectedVolumes: map[string]corev1.Volume{},
	}, {
		name: "binding multiple workspaces",
		workspaces: []v1.WorkspaceBinding{{
			Name: "custom",
			PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
				ClaimName: "mypvc",
			},
			SubPath: "/foo/bar/baz",
		}, {
			Name: "even-more-custom",
			PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
				ClaimName: "myotherpvc",
			},
		}},
		expectedVolumes: map[string]corev1.Volume{
			"custom": {
				Name: "ws-20573",
				VolumeSource: corev1.VolumeSource{
					PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
						ClaimName: "mypvc",
					},
				},
			},
			"even-more-custom": {
				Name: "ws-338c2",
				VolumeSource: corev1.VolumeSource{
					PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
						ClaimName: "myotherpvc",
					},
				},
			},
		},
	}, {
		name: "multiple workspaces binding to the same volume with diff subpaths doesnt duplicate",
		workspaces: []v1.WorkspaceBinding{{
			Name: "custom",
			PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
				ClaimName: "mypvc",
			},
			SubPath: "/foo/bar/baz",
		}, {
			Name: "custom2",
			PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
				ClaimName: "mypvc",
			},
			SubPath: "/very/professional/work/space",
		}},
		expectedVolumes: map[string]corev1.Volume{
			"custom": {
				Name: "ws-20573",
				VolumeSource: corev1.VolumeSource{
					PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
						ClaimName: "mypvc",
					},
				},
			},
			"custom2": {
				// Since it is the same PVC source, it can't be added twice with two different names
				Name: "ws-20573",
				VolumeSource: corev1.VolumeSource{
					PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
						ClaimName: "mypvc",
					},
				},
			},
		},
	}, {
		name: "consistent hashed name for different inputs",
		workspaces: []v1.WorkspaceBinding{{
			Name:     "test-01097628",
			EmptyDir: &corev1.EmptyDirVolumeSource{},
		}, {
			Name:     "test-01617609",
			EmptyDir: &corev1.EmptyDirVolumeSource{},
		}, {
			Name:     "test-01675975",
			EmptyDir: &corev1.EmptyDirVolumeSource{},
		}, {
			Name:     "test-01809743",
			EmptyDir: &corev1.EmptyDirVolumeSource{},
		}},
		expectedVolumes: map[string]corev1.Volume{
			"test-01097628": {
				Name: "ws-f32ff",
				VolumeSource: corev1.VolumeSource{
					EmptyDir: &corev1.EmptyDirVolumeSource{},
				},
			},
			"test-01617609": {
				Name: "ws-a0814",
				VolumeSource: corev1.VolumeSource{
					EmptyDir: &corev1.EmptyDirVolumeSource{},
				},
			},
			"test-01675975": {
				Name: "ws-b2d09",
				VolumeSource: corev1.VolumeSource{
					EmptyDir: &corev1.EmptyDirVolumeSource{},
				},
			},
			"test-01809743": {
				Name: "ws-60320",
				VolumeSource: corev1.VolumeSource{
					EmptyDir: &corev1.EmptyDirVolumeSource{},
				},
			},
		},
	}} {
		t.Run(tc.name, func(t *testing.T) {
			v := workspace.CreateVolumes(tc.workspaces)
			if d := cmp.Diff(tc.expectedVolumes, v); d != "" {
				t.Errorf("Didn't get expected volumes from bindings %s", diff.PrintWantGot(d))
			}
		})
	}
}

func TestApply(t *testing.T) {
	names.TestingSeed()
	for _, tc := range []struct {
		name             string
		ts               v1.TaskSpec
		workspaces       []v1.WorkspaceBinding
		expectedTaskSpec v1.TaskSpec
	}{{
		name: "binding a single workspace with a PVC",
		ts: v1.TaskSpec{
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "custom",
			}},
		},
		workspaces: []v1.WorkspaceBinding{{
			Name: "custom",
			PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
				ClaimName: "mypvc",
			},
			SubPath: "/foo/bar/baz",
		}},
		expectedTaskSpec: v1.TaskSpec{
			StepTemplate: &v1.StepTemplate{
				VolumeMounts: []corev1.VolumeMount{{
					Name:      "ws-20573",
					MountPath: "/workspace/custom",
					SubPath:   "/foo/bar/baz",
				}},
			},
			Volumes: []corev1.Volume{{
				Name: "ws-20573",
				VolumeSource: corev1.VolumeSource{
					PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
						ClaimName: "mypvc",
					},
				},
			}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "custom",
			}},
		},
	}, {
		name: "binding a single workspace with emptyDir",
		ts: v1.TaskSpec{
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "custom",
			},
			}},
		workspaces: []v1.WorkspaceBinding{{
			Name: "custom",
			EmptyDir: &corev1.EmptyDirVolumeSource{
				Medium: corev1.StorageMediumMemory,
			},
			SubPath: "/foo/bar/baz",
		}},
		expectedTaskSpec: v1.TaskSpec{
			StepTemplate: &v1.StepTemplate{
				VolumeMounts: []corev1.VolumeMount{{
					Name:      "ws-20573",
					MountPath: "/workspace/custom",
					SubPath:   "/foo/bar/baz", // TODO: what happens when you use subPath with emptyDir
				}},
			},
			Volumes: []corev1.Volume{{
				Name: "ws-20573",
				VolumeSource: corev1.VolumeSource{
					EmptyDir: &corev1.EmptyDirVolumeSource{
						Medium: corev1.StorageMediumMemory,
					},
				},
			}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "custom",
			}},
		},
	}, {
		name: "binding a single workspace with projected",
		ts: v1.TaskSpec{
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "custom",
			},
			}},
		workspaces: []v1.WorkspaceBinding{{
			Name: "custom",
			Projected: &corev1.ProjectedVolumeSource{
				Sources: []corev1.VolumeProjection{{
					ConfigMap: &corev1.ConfigMapProjection{
						LocalObjectReference: corev1.LocalObjectReference{
							Name: "foobarconfigmap",
						},
						Items: []corev1.KeyToPath{{
							Key:  "foobar",
							Path: "foobar.txt",
						}},
					},
				}, {
					Secret: &corev1.SecretProjection{
						LocalObjectReference: corev1.LocalObjectReference{
							Name: "foobarsecret",
						},
						Items: []corev1.KeyToPath{{
							Key:  "foobar",
							Path: "foobar.txt",
						}},
					},
				}},
			},
			SubPath: "/foo/bar/baz",
		}},
		expectedTaskSpec: v1.TaskSpec{
			StepTemplate: &v1.StepTemplate{
				VolumeMounts: []corev1.VolumeMount{{
					Name:      "ws-20573",
					MountPath: "/workspace/custom",
					SubPath:   "/foo/bar/baz", // TODO: what happens when you use subPath with emptyDir
				}},
			},
			Volumes: []corev1.Volume{{
				Name: "ws-20573",
				VolumeSource: corev1.VolumeSource{
					Projected: &corev1.ProjectedVolumeSource{
						Sources: []corev1.VolumeProjection{{
							ConfigMap: &corev1.ConfigMapProjection{
								LocalObjectReference: corev1.LocalObjectReference{
									Name: "foobarconfigmap",
								},
								Items: []corev1.KeyToPath{{
									Key:  "foobar",
									Path: "foobar.txt",
								}},
							},
						}, {
							Secret: &corev1.SecretProjection{
								LocalObjectReference: corev1.LocalObjectReference{
									Name: "foobarsecret",
								},
								Items: []corev1.KeyToPath{{
									Key:  "foobar",
									Path: "foobar.txt",
								}},
							},
						}},
					},
				},
			}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "custom",
			}},
		},
	}, {
		name: "task spec already has volumes and stepTemplate",
		ts: v1.TaskSpec{
			StepTemplate: &v1.StepTemplate{
				VolumeMounts: []corev1.VolumeMount{{
					Name:      "awesome-volume",
					MountPath: "/",
				}},
			},
			Volumes: []corev1.Volume{{
				Name: "awesome-volume",
				VolumeSource: corev1.VolumeSource{
					EmptyDir: &corev1.EmptyDirVolumeSource{},
				},
			}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "custom",
			}},
		},
		workspaces: []v1.WorkspaceBinding{{
			Name: "custom",
			EmptyDir: &corev1.EmptyDirVolumeSource{
				Medium: corev1.StorageMediumMemory,
			},
			SubPath: "/foo/bar/baz",
		}},
		expectedTaskSpec: v1.TaskSpec{
			StepTemplate: &v1.StepTemplate{
				VolumeMounts: []corev1.VolumeMount{{
					Name:      "awesome-volume",
					MountPath: "/",
				}, {
					Name:      "ws-20573",
					MountPath: "/workspace/custom",
					SubPath:   "/foo/bar/baz", // TODO: what happens when you use subPath with emptyDir
				}},
			},
			Volumes: []corev1.Volume{{
				Name: "awesome-volume",
				VolumeSource: corev1.VolumeSource{
					EmptyDir: &corev1.EmptyDirVolumeSource{},
				},
			}, {
				Name: "ws-20573",
				VolumeSource: corev1.VolumeSource{
					EmptyDir: &corev1.EmptyDirVolumeSource{
						Medium: corev1.StorageMediumMemory,
					},
				},
			}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "custom",
			}},
		},
	}, {
		name: "0 workspace bindings",
		ts: v1.TaskSpec{
			Steps: []v1.Step{{
				Name: "foo",
			}},
		},
		workspaces: []v1.WorkspaceBinding{},
		expectedTaskSpec: v1.TaskSpec{
			Steps: []v1.Step{{
				Name: "foo",
			}},
		},
	}, {
		name: "binding multiple workspaces",
		ts: v1.TaskSpec{
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "custom",
			}, {
				Name: "even-more-custom",
			}},
		},
		workspaces: []v1.WorkspaceBinding{{
			Name: "custom",
			PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
				ClaimName: "mypvc",
			},
			SubPath: "/foo/bar/baz",
		}, {
			Name: "even-more-custom",
			PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
				ClaimName: "myotherpvc",
			},
		}},
		expectedTaskSpec: v1.TaskSpec{
			StepTemplate: &v1.StepTemplate{
				VolumeMounts: []corev1.VolumeMount{{
					Name:      "ws-20573",
					MountPath: "/workspace/custom",
					SubPath:   "/foo/bar/baz",
				}, {
					Name:      "ws-338c2",
					MountPath: "/workspace/even-more-custom",
					SubPath:   "",
				}},
			},
			Volumes: []corev1.Volume{{
				Name: "ws-20573",
				VolumeSource: corev1.VolumeSource{
					PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
						ClaimName: "mypvc",
					},
				},
			}, {
				Name: "ws-338c2",
				VolumeSource: corev1.VolumeSource{
					PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
						ClaimName: "myotherpvc",
					},
				},
			}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "custom"}, {
				Name: "even-more-custom",
			}},
		},
	}, {
		name: "multiple workspaces binding to the same volume with diff subpaths doesnt duplicate",
		ts: v1.TaskSpec{
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "custom",
			}, {
				Name: "custom2",
			}},
		},
		workspaces: []v1.WorkspaceBinding{{
			Name: "custom",
			PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
				ClaimName: "mypvc",
			},
			SubPath: "/foo/bar/baz",
		}, {
			Name: "custom2",
			PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
				ClaimName: "mypvc",
			},
			SubPath: "/very/professional/work/space",
		}},
		expectedTaskSpec: v1.TaskSpec{
			StepTemplate: &v1.StepTemplate{
				VolumeMounts: []corev1.VolumeMount{{
					Name:      "ws-20573",
					MountPath: "/workspace/custom",
					SubPath:   "/foo/bar/baz",
				}, {
					Name:      "ws-20573",
					MountPath: "/workspace/custom2",
					SubPath:   "/very/professional/work/space",
				}},
			},
			Volumes: []corev1.Volume{{
				Name: "ws-20573",
				VolumeSource: corev1.VolumeSource{
					PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
						ClaimName: "mypvc",
					},
				},
			}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "custom",
			}, {
				Name: "custom2",
			}},
		},
	}, {
		name: "non default mount path",
		ts: v1.TaskSpec{
			Workspaces: []v1.WorkspaceDeclaration{{
				Name:      "custom",
				MountPath: "/my/fancy/mount/path",
			}},
		},
		workspaces: []v1.WorkspaceBinding{{
			Name: "custom",
			PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
				ClaimName: "mypvc",
			},
		}},
		expectedTaskSpec: v1.TaskSpec{
			StepTemplate: &v1.StepTemplate{
				VolumeMounts: []corev1.VolumeMount{{
					Name:      "ws-20573",
					MountPath: "/my/fancy/mount/path",
				}},
			},
			Volumes: []corev1.Volume{{
				Name: "ws-20573",
				VolumeSource: corev1.VolumeSource{
					PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
						ClaimName: "mypvc",
					},
				},
			}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name:      "custom",
				MountPath: "/my/fancy/mount/path",
			}},
		},
	}, {
		name: "readOnly true marks volume mount readOnly",
		ts: v1.TaskSpec{
			Workspaces: []v1.WorkspaceDeclaration{{
				Name:      "custom",
				MountPath: "/my/fancy/mount/path",
				ReadOnly:  true,
			}},
		},
		workspaces: []v1.WorkspaceBinding{{
			Name: "custom",
			PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
				ClaimName: "mypvc",
			},
		}},
		expectedTaskSpec: v1.TaskSpec{
			StepTemplate: &v1.StepTemplate{
				VolumeMounts: []corev1.VolumeMount{{
					Name:      "ws-20573",
					MountPath: "/my/fancy/mount/path",
					ReadOnly:  true,
				}},
			},
			Volumes: []corev1.Volume{{
				Name: "ws-20573",
				VolumeSource: corev1.VolumeSource{
					PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
						ClaimName: "mypvc",
					},
				},
			}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name:      "custom",
				MountPath: "/my/fancy/mount/path",
				ReadOnly:  true,
			}},
		},
	}, {
		name: "binding a single workspace with CSI",
		ts: v1.TaskSpec{
			Workspaces: []v1.WorkspaceDeclaration{{
				Name:      "custom",
				MountPath: "/workspace/csi",
				ReadOnly:  true,
			}},
		},
		workspaces: []v1.WorkspaceBinding{{
			Name: "custom",
			CSI: &corev1.CSIVolumeSource{
				Driver: "secrets-store.csi.k8s.io",
			},
			SubPath: "/foo/bar/baz",
		}},
		expectedTaskSpec: v1.TaskSpec{
			StepTemplate: &v1.StepTemplate{
				VolumeMounts: []corev1.VolumeMount{{
					Name:      "ws-20573",
					MountPath: "/workspace/csi",
					SubPath:   "/foo/bar/baz",
					ReadOnly:  true,
				}},
			},
			Volumes: []corev1.Volume{{
				Name: "ws-20573",
				VolumeSource: corev1.VolumeSource{
					CSI: &corev1.CSIVolumeSource{
						Driver: "secrets-store.csi.k8s.io",
					},
				},
			}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name:      "custom",
				MountPath: "/workspace/csi",
				ReadOnly:  true,
			}},
		},
	}} {
		t.Run(tc.name, func(t *testing.T) {
			vols := workspace.CreateVolumes(tc.workspaces)
			ts, err := workspace.Apply(context.Background(), tc.ts, tc.workspaces, vols)
			if err != nil {
				t.Fatalf("Did not expect error but got %v", err)
			}
			if d := cmp.Diff(tc.expectedTaskSpec, *ts); d != "" {
				t.Errorf("Didn't get expected TaskSpec modifications %s", diff.PrintWantGot(d))
			}
		})
	}
}

func TestApply_PropagatedWorkspacesFromWorkspaceBindingToDeclarations(t *testing.T) {
	names.TestingSeed()
	for _, tc := range []struct {
		name             string
		ts               v1.TaskSpec
		workspaces       []v1.WorkspaceBinding
		expectedTaskSpec v1.TaskSpec
		apiField         string
	}{{
		name: "propagate workspaces",
		ts: v1.TaskSpec{
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "workspace1",
			}},
		},
		workspaces: []v1.WorkspaceBinding{{
			Name: "workspace2",
			PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
				ClaimName: "mypvc",
			},
		}},
		expectedTaskSpec: v1.TaskSpec{
			Volumes: []corev1.Volume{{
				Name: "ws-c88ff",
				VolumeSource: corev1.VolumeSource{
					PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
						ClaimName: "mypvc",
					},
				},
			}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name:      "workspace1",
				MountPath: "",
				ReadOnly:  false,
			}, {
				Name:      "workspace2",
				MountPath: "",
				ReadOnly:  false,
			}},
			StepTemplate: &v1.StepTemplate{
				VolumeMounts: []corev1.VolumeMount{{Name: "ws-c88ff", MountPath: "/workspace/workspace2"}},
			},
		},
	}} {
		t.Run(tc.name, func(t *testing.T) {
			vols := workspace.CreateVolumes(tc.workspaces)
			ts, err := workspace.Apply(context.Background(), tc.ts, tc.workspaces, vols)
			if err != nil {
				t.Fatalf("Did not expect error but got %v", err)
			}
			if d := cmp.Diff(tc.expectedTaskSpec, *ts); d != "" {
				t.Errorf("Didn't get expected TaskSpec modifications %s", diff.PrintWantGot(d))
			}
		})
	}
}

func TestApply_IsolatedWorkspaces(t *testing.T) {
	names.TestingSeed()
	for _, tc := range []struct {
		name             string
		ts               v1.TaskSpec
		workspaces       []v1.WorkspaceBinding
		expectedTaskSpec v1.TaskSpec
	}{{
		name: "workspace isolated to step does not appear in step template or sidecars",
		ts: v1.TaskSpec{
			Steps: []v1.Step{{
				Workspaces: []v1.WorkspaceUsage{{
					Name: "source",
				}},
			}},
			Sidecars: []v1.Sidecar{{Name: "foo"}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "source",
			}},
		},
		workspaces: []v1.WorkspaceBinding{{
			Name: "source",
			PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
				ClaimName: "testpvc",
			},
		}},
		expectedTaskSpec: v1.TaskSpec{
			StepTemplate: &v1.StepTemplate{},
			Volumes: []corev1.Volume{{
				Name: "ws-1bcf2",
				VolumeSource: corev1.VolumeSource{
					PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
						ClaimName: "testpvc",
					},
				},
			}},
			Steps: []v1.Step{{
				VolumeMounts: []corev1.VolumeMount{{
					Name:      "ws-1bcf2",
					MountPath: "/workspace/source",
				}},
				Workspaces: []v1.WorkspaceUsage{{
					Name: "source",
				}},
			}},
			Sidecars: []v1.Sidecar{{Name: "foo"}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "source",
			}},
		},
	}, {
		name: "workspace isolated to sidecar does not appear in steps",
		ts: v1.TaskSpec{
			Steps: []v1.Step{{
				Name: "step1",
			}},
			Sidecars: []v1.Sidecar{{
				Workspaces: []v1.WorkspaceUsage{{
					Name: "source",
				}},
			}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "source",
			}},
		},
		workspaces: []v1.WorkspaceBinding{{
			Name: "source",
			PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
				ClaimName: "testpvc",
			},
		}},
		expectedTaskSpec: v1.TaskSpec{
			StepTemplate: &v1.StepTemplate{},
			Volumes: []corev1.Volume{{
				Name: "ws-1bcf2",
				VolumeSource: corev1.VolumeSource{
					PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
						ClaimName: "testpvc",
					},
				},
			}},
			Steps: []v1.Step{{
				Name: "step1",
			}},
			Sidecars: []v1.Sidecar{{
				VolumeMounts: []corev1.VolumeMount{{
					Name:      "ws-1bcf2",
					MountPath: "/workspace/source",
				}},
				Workspaces: []v1.WorkspaceUsage{{
					Name: "source",
				}},
			}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "source",
			}},
		},
	}, {
		name: "workspace isolated to one step and one sidecar does not appear in step template",
		ts: v1.TaskSpec{
			Steps: []v1.Step{{
				Workspaces: []v1.WorkspaceUsage{{
					Name: "source",
				}},
			}, {
				Name: "step2",
			}},
			Sidecars: []v1.Sidecar{{
				Workspaces: []v1.WorkspaceUsage{{
					Name: "source",
				}},
			}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "source",
			}},
		},
		workspaces: []v1.WorkspaceBinding{{
			Name: "source",
			PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
				ClaimName: "testpvc",
			},
		}},
		expectedTaskSpec: v1.TaskSpec{
			StepTemplate: &v1.StepTemplate{},
			Volumes: []corev1.Volume{{
				Name: "ws-1bcf2",
				VolumeSource: corev1.VolumeSource{
					PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
						ClaimName: "testpvc",
					},
				},
			}},
			Steps: []v1.Step{{
				VolumeMounts: []corev1.VolumeMount{{
					Name:      "ws-1bcf2",
					MountPath: "/workspace/source",
				}},
				Workspaces: []v1.WorkspaceUsage{{
					Name: "source",
				}},
			}, {
				Name: "step2",
			}},
			Sidecars: []v1.Sidecar{{
				VolumeMounts: []corev1.VolumeMount{{
					Name:      "ws-1bcf2",
					MountPath: "/workspace/source",
				}},
				Workspaces: []v1.WorkspaceUsage{{
					Name: "source",
				}},
			}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "source",
			}},
		},
	}, {
		name: "workspaces are mounted to sidecars by default",
		ts: v1.TaskSpec{
			Steps:    []v1.Step{{}},
			Sidecars: []v1.Sidecar{{}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "source",
			}},
		},
		workspaces: []v1.WorkspaceBinding{{
			Name: "source",
			PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
				ClaimName: "testpvc",
			},
		}},
		expectedTaskSpec: v1.TaskSpec{
			StepTemplate: &v1.StepTemplate{
				VolumeMounts: []corev1.VolumeMount{{
					Name: "ws-1bcf2", MountPath: "/workspace/source",
				}},
			},
			Volumes: []corev1.Volume{{
				Name: "ws-1bcf2",
				VolumeSource: corev1.VolumeSource{
					PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
						ClaimName: "testpvc",
					},
				},
			}},
			Steps: []v1.Step{{}},
			Sidecars: []v1.Sidecar{{
				VolumeMounts: []corev1.VolumeMount{{
					Name:      "ws-1bcf2",
					MountPath: "/workspace/source",
				}},
			}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "source",
			}},
		},
	}, {
		name: "isolated workspaces custom mountpaths appear in volumemounts",
		ts: v1.TaskSpec{
			Steps: []v1.Step{{
				Workspaces: []v1.WorkspaceUsage{{
					Name:      "source",
					MountPath: "/foo",
				}},
			}},
			Sidecars: []v1.Sidecar{{
				Workspaces: []v1.WorkspaceUsage{{
					Name:      "source",
					MountPath: "/bar",
				}},
			}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "source",
			}},
		},
		workspaces: []v1.WorkspaceBinding{{
			Name: "source",
			PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
				ClaimName: "testpvc",
			},
		}},
		expectedTaskSpec: v1.TaskSpec{
			StepTemplate: &v1.StepTemplate{},
			Volumes: []corev1.Volume{{
				Name: "ws-1bcf2",
				VolumeSource: corev1.VolumeSource{
					PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
						ClaimName: "testpvc",
					},
				},
			}},
			Steps: []v1.Step{{
				Workspaces: []v1.WorkspaceUsage{{
					Name:      "source",
					MountPath: "/foo",
				}},
				VolumeMounts: []corev1.VolumeMount{{
					Name:      "ws-1bcf2",
					MountPath: "/foo",
				}},
			}},
			Sidecars: []v1.Sidecar{{
				Workspaces: []v1.WorkspaceUsage{{
					Name:      "source",
					MountPath: "/bar",
				}},
				VolumeMounts: []corev1.VolumeMount{{
					Name:      "ws-1bcf2",
					MountPath: "/bar",
				}},
			}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name: "source",
			}},
		},
	}, {
		name: "existing sidecar volumeMounts are not displaced by workspace binding",
		ts: v1.TaskSpec{
			Workspaces: []v1.WorkspaceDeclaration{{
				Name:      "custom",
				MountPath: "/my/fancy/mount/path",
				ReadOnly:  true,
			}},
			Sidecars: []v1.Sidecar{{
				Name: "conflicting volume mount sidecar",
				VolumeMounts: []corev1.VolumeMount{{
					Name:      "mount-path-conflicts",
					MountPath: "/my/fancy/mount/path",
				}},
			}},
		},
		workspaces: []v1.WorkspaceBinding{{
			Name: "custom",
			PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
				ClaimName: "mypvc",
			},
		}},
		expectedTaskSpec: v1.TaskSpec{
			StepTemplate: &v1.StepTemplate{
				VolumeMounts: []corev1.VolumeMount{{
					Name:      "ws-20573",
					MountPath: "/my/fancy/mount/path",
					ReadOnly:  true,
				}},
			},
			Sidecars: []v1.Sidecar{{
				Name: "conflicting volume mount sidecar",
				VolumeMounts: []corev1.VolumeMount{{
					Name:      "mount-path-conflicts",
					MountPath: "/my/fancy/mount/path",
				}},
			}},
			Volumes: []corev1.Volume{{
				Name: "ws-20573",
				VolumeSource: corev1.VolumeSource{
					PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
						ClaimName: "mypvc",
					},
				},
			}},
			Workspaces: []v1.WorkspaceDeclaration{{
				Name:      "custom",
				MountPath: "/my/fancy/mount/path",
				ReadOnly:  true,
			}},
		},
	}} {
		t.Run(tc.name, func(t *testing.T) {
			ctx := config.ToContext(context.Background(), &config.Config{
				FeatureFlags: &config.FeatureFlags{
					EnableAPIFields: "alpha",
				},
			})
			vols := workspace.CreateVolumes(tc.workspaces)
			ts, err := workspace.Apply(ctx, tc.ts, tc.workspaces, vols)
			if err != nil {
				t.Fatalf("Did not expect error but got %v", err)
			}
			if d := cmp.Diff(tc.expectedTaskSpec, *ts); d != "" {
				t.Errorf("Didn't get expected TaskSpec modifications %s", diff.PrintWantGot(d))
			}
		})
	}
}

func TestApplyWithMissingWorkspaceDeclaration(t *testing.T) {
	names.TestingSeed()
	ts := v1.TaskSpec{
		Steps:      []v1.Step{{}},
		Sidecars:   []v1.Sidecar{{}},
		Workspaces: []v1.WorkspaceDeclaration{}, // Intentionally missing workspace declaration
	}
	bindings := []v1.WorkspaceBinding{{
		Name: "source",
		PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
			ClaimName: "testpvc",
		},
	}}
	vols := workspace.CreateVolumes(bindings)
	if _, err := workspace.Apply(context.Background(), ts, bindings, vols); err != nil {
		t.Errorf("Did not expect error because of workspace propagation but got %v", err)
	}
}

// TestAddSidecarVolumeMount tests that sidecars dont receive a volume mount if
// it has a mount that already shares the same MountPath.
func TestAddSidecarVolumeMount(t *testing.T) {
	for _, tc := range []struct {
		sidecarMounts   []corev1.VolumeMount
		volumeMount     corev1.VolumeMount
		expectedSidecar v1.Sidecar
	}{{
		sidecarMounts: nil,
		volumeMount: corev1.VolumeMount{
			Name:      "foo",
			MountPath: "/workspace/foo",
		},
		expectedSidecar: v1.Sidecar{
			VolumeMounts: []corev1.VolumeMount{{
				Name:      "foo",
				MountPath: "/workspace/foo",
			}},
		},
	}, {
		sidecarMounts: []corev1.VolumeMount{},
		volumeMount: corev1.VolumeMount{
			Name:      "foo",
			MountPath: "/workspace/foo",
		},
		expectedSidecar: v1.Sidecar{
			VolumeMounts: []corev1.VolumeMount{{
				Name:      "foo",
				MountPath: "/workspace/foo",
			}},
		},
	}, {
		sidecarMounts: []corev1.VolumeMount{{
			Name:      "bar",
			MountPath: "/workspace/bar",
		}},
		volumeMount: corev1.VolumeMount{
			Name:      "workspace1",
			MountPath: "/workspace/bar",
		},
		expectedSidecar: v1.Sidecar{
			VolumeMounts: []corev1.VolumeMount{{
				Name:      "bar",
				MountPath: "/workspace/bar",
			}},
		},
	}, {
		sidecarMounts: []corev1.VolumeMount{{
			Name:      "bar",
			MountPath: "/workspace/bar",
		}},
		volumeMount: corev1.VolumeMount{
			Name:      "foo",
			MountPath: "/workspace/foo",
		},
		expectedSidecar: v1.Sidecar{
			VolumeMounts: []corev1.VolumeMount{{
				Name:      "bar",
				MountPath: "/workspace/bar",
			}, {
				Name:      "foo",
				MountPath: "/workspace/foo",
			}},
		},
	}} {
		sidecar := v1.Sidecar{}
		sidecar.VolumeMounts = tc.sidecarMounts
		workspace.AddSidecarVolumeMount(&sidecar, tc.volumeMount)
		if d := cmp.Diff(tc.expectedSidecar, sidecar); d != "" {
			t.Error(diff.PrintWantGot(d))
		}
	}
}

func TestFindWorkspacesUsedByTask(t *testing.T) {
	tests := []struct {
		name string
		ts   *v1.TaskSpec
		want sets.String
	}{{
		name: "completespec",
		ts: &v1.TaskSpec{
			Steps: []v1.Step{{
				Name:    "step-name",
				Image:   "step-image",
				Script:  "$(workspaces.step-script.path)",
				Command: []string{"$(workspaces.step-command.path)"},
				Args:    []string{"$(workspaces.step-args.path)"},
			}},
			Sidecars: []v1.Sidecar{{
				Name:    "sidecar-name",
				Image:   "sidecar-image",
				Script:  "$(workspaces.sidecar-script.path)",
				Command: []string{"$(workspaces.sidecar-command.path)"},
				Args:    []string{"$(workspaces.sidecar-args.path)"},
			}},
			StepTemplate: &v1.StepTemplate{
				Image:   "steptemplate-image",
				Command: []string{"$(workspaces.steptemplate-command.path)"},
				Args:    []string{"$(workspaces.steptemplate-args.path)"},
			},
		},
		want: sets.NewString(
			"step-script",
			"step-args",
			"step-command",
			"sidecar-script",
			"sidecar-args",
			"sidecar-command",
			"steptemplate-args",
			"steptemplate-command",
		),
	}, {
		name: "workspace used in step env",
		ts: &v1.TaskSpec{
			Steps: []v1.Step{{
				Name:  "step-name",
				Image: "step-image",
				Env: []corev1.EnvVar{{
					Name:  "path",
					Value: "$(workspaces.env-ws.path)",
				}},
				Command: []string{"ls"},
			}},
		},
		want: sets.NewString(
			"env-ws",
		),
	}, {
		name: "workspace used in step workingDir",
		ts: &v1.TaskSpec{
			Steps: []v1.Step{{
				Name:       "step-name",
				Image:      "step-image",
				WorkingDir: "$(workspaces.shared.path)",
				Command:    []string{"ls"},
			}},
		},
		want: sets.NewString(
			"shared",
		),
	}, {
		name: "workspace used in step Params for stepactions",
		ts: &v1.TaskSpec{
			Steps: []v1.Step{{
				Name: "step-name",
				Params: []v1.Param{{
					Name:  "path",
					Value: *v1.NewStructuredValues("$(workspaces.shared.path)"),
				}},
				Ref: &v1.Ref{
					Name: "step-action",
				},
			}},
		},
		want: sets.NewString(
			"shared",
		),
	}, {
		name: "workspace used in sidecar env",
		ts: &v1.TaskSpec{
			Sidecars: []v1.Sidecar{{
				Name:  "step-name",
				Image: "step-image",
				Env: []corev1.EnvVar{{
					Name:  "path",
					Value: "$(workspaces.env-ws.path)",
				}},
				Command: []string{"ls"},
			}},
		},
		want: sets.NewString(
			"env-ws",
		),
	}, {
		name: "workspace used in sidecar workingDir",
		ts: &v1.TaskSpec{
			Sidecars: []v1.Sidecar{{
				Name:       "step-name",
				Image:      "step-image",
				WorkingDir: "$(workspaces.shared.path)",
				Command:    []string{"ls"},
			}},
		},
		want: sets.NewString(
			"shared",
		),
	}, {
		name: "workspace used in stepTemplate env",
		ts: &v1.TaskSpec{
			StepTemplate: &v1.StepTemplate{
				Env: []corev1.EnvVar{{
					Name:  "path",
					Value: "$(workspaces.env-ws.path)",
				}},
			},
		},
		want: sets.NewString(
			"env-ws",
		),
	}, {
		name: "workspace used in stepTemplate workingDir",
		ts: &v1.TaskSpec{
			StepTemplate: &v1.StepTemplate{
				WorkingDir: "$(workspaces.shared.path)",
			},
		},
		want: sets.NewString(
			"shared",
		),
	}}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			got, err := workspace.FindWorkspacesUsedByTask(*tt.ts)
			if err != nil {
				t.Fatalf("Could not find workspaces: %v", err)
			}
			if d := cmp.Diff(tt.want, got); d != "" {
				t.Error(diff.PrintWantGot(d))
			}
		})
	}
}

func TestReplaceWorkspaceBindingsVars(t *testing.T) {
	testCases := []struct {
		name              string
		workspaceBindings []v1.WorkspaceBinding
		replacements      map[string]string
		expected          []v1.WorkspaceBinding
	}{
		{
			name:         "No replacements",
			replacements: nil,
			workspaceBindings: []v1.WorkspaceBinding{
				{SubPath: "$(params.to-replace)"},
			},
			expected: []v1.WorkspaceBinding{
				{SubPath: "$(params.to-replace)"},
			},
		},
		{
			name: "Replace SubPath",
			replacements: map[string]string{
				"params.to-replace": "replaced",
			},
			workspaceBindings: []v1.WorkspaceBinding{
				{SubPath: "$(params.to-replace)"},
			},
			expected: []v1.WorkspaceBinding{
				{SubPath: "replaced"},
			},
		},
		{
			name: "Replace PersistentVolumeClaim",
			replacements: map[string]string{
				"params.to-replace": "replaced",
			},
			workspaceBindings: []v1.WorkspaceBinding{
				{
					PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
						ClaimName: "$(params.to-replace)",
					},
				},
			},
			expected: []v1.WorkspaceBinding{
				{
					PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
						ClaimName: "replaced",
					},
				},
			},
		},
		{
			name: "Replace ConfigMap",
			replacements: map[string]string{
				"params.to-replace": "replaced",
			},
			workspaceBindings: []v1.WorkspaceBinding{
				{
					ConfigMap: &corev1.ConfigMapVolumeSource{
						LocalObjectReference: corev1.LocalObjectReference{
							Name: "$(params.to-replace)",
						},
						Items: []corev1.KeyToPath{{
							Key:  "$(params.to-replace)",
							Path: "$(params.to-replace)",
						}},
					},
				},
			},
			expected: []v1.WorkspaceBinding{
				{
					ConfigMap: &corev1.ConfigMapVolumeSource{
						LocalObjectReference: corev1.LocalObjectReference{
							Name: "replaced",
						},
						Items: []corev1.KeyToPath{{
							Key:  "replaced",
							Path: "replaced",
						}},
					},
				},
			},
		},
		{
			name: "Replace Secret",
			replacements: map[string]string{
				"params.to-replace": "replaced",
			},
			workspaceBindings: []v1.WorkspaceBinding{
				{
					Secret: &corev1.SecretVolumeSource{
						SecretName: "$(params.to-replace)",
						Items: []corev1.KeyToPath{{
							Key:  "$(params.to-replace)",
							Path: "$(params.to-replace)",
						}},
					},
				},
			},
			expected: []v1.WorkspaceBinding{
				{
					Secret: &corev1.SecretVolumeSource{
						SecretName: "replaced",
						Items: []corev1.KeyToPath{{
							Key:  "replaced",
							Path: "replaced",
						}},
					},
				},
			},
		},
		{
			name: "Replace Projected",
			replacements: map[string]string{
				"params.to-replace": "replaced",
			},
			workspaceBindings: []v1.WorkspaceBinding{
				{
					Projected: &corev1.ProjectedVolumeSource{
						Sources: []corev1.VolumeProjection{{
							ConfigMap: &corev1.ConfigMapProjection{
								LocalObjectReference: corev1.LocalObjectReference{
									Name: "$(params.to-replace)",
								},
								Items: []corev1.KeyToPath{{
									Key:  "$(params.to-replace)",
									Path: "$(params.to-replace)",
								}},
							},
						}, {
							Secret: &corev1.SecretProjection{
								LocalObjectReference: corev1.LocalObjectReference{
									Name: "$(params.to-replace)",
								},
								Items: []corev1.KeyToPath{{
									Key:  "$(params.to-replace)",
									Path: "$(params.to-replace)",
								}},
							},
						}},
					},
				},
			},
			expected: []v1.WorkspaceBinding{
				{
					Projected: &corev1.ProjectedVolumeSource{
						Sources: []corev1.VolumeProjection{{
							ConfigMap: &corev1.ConfigMapProjection{
								LocalObjectReference: corev1.LocalObjectReference{
									Name: "replaced",
								},
								Items: []corev1.KeyToPath{{
									Key:  "replaced",
									Path: "replaced",
								}},
							},
						}, {
							Secret: &corev1.SecretProjection{
								LocalObjectReference: corev1.LocalObjectReference{
									Name: "replaced",
								},
								Items: []corev1.KeyToPath{{
									Key:  "replaced",
									Path: "replaced",
								}},
							},
						}},
					},
				},
			},
		},
		{
			name: "Replace CSI",
			replacements: map[string]string{
				"params.to-replace": "replaced",
			},
			workspaceBindings: []v1.WorkspaceBinding{
				{
					CSI: &corev1.CSIVolumeSource{
						Driver: "$(params.to-replace)",
						NodePublishSecretRef: &corev1.LocalObjectReference{
							Name: "$(params.to-replace)",
						},
					},
				},
			},
			expected: []v1.WorkspaceBinding{
				{
					CSI: &corev1.CSIVolumeSource{
						Driver: "replaced",
						NodePublishSecretRef: &corev1.LocalObjectReference{
							Name: "replaced",
						},
					},
				},
			},
		},
	}

	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			result := workspace.ReplaceWorkspaceBindingsVars(tc.workspaceBindings, tc.replacements)
			if d := cmp.Diff(tc.expected, result); d != "" {
				t.Errorf("Test case %q, diff: %s", tc.name, diff.PrintWantGot(d))
			}
		})
	}
}
