option for origin data as annotation

api/resource/origin.go

@@ -0,0 +1,60 @@
+// Copyright 2019 The Kubernetes Authors.
+// SPDX-License-Identifier: Apache-2.0
+
+package resource
+
+import (
+	"path/filepath"
+	"strings"
+
+	"sigs.k8s.io/kustomize/api/internal/git"
+)
+
+// Origin retains information about where resources in the output
+// of `kustomize build` originated from
+type Origin struct {
+	// Path is the path to the resource, rooted from the directory upon
+	// which `kustomize build` was invoked
+	Path string
+
+	// Repo is the remote repository that the resource originated from if it is
+	// not from a local file
+	Repo string
+
+	// Ref is the ref of the remote repository that the resource originated from
+	// if it is not from a local file
+	Ref string
+}
+
+// Copy returns a copy of origin
+func (origin *Origin) Copy() Origin {
+	return *origin
+}
+
+// Append returns a copy of origin with a path appended to it
+func (origin *Origin) Append(path string) *Origin {
+	originCopy := origin.Copy()
+	repoSpec, err := git.NewRepoSpecFromUrl(path)
+	if err == nil {
+		originCopy.Repo = repoSpec.Host + repoSpec.OrgRepo
+		absPath := repoSpec.AbsPath()
+		path = absPath[strings.Index(absPath[1:], "/")+1:][1:]
+		originCopy.Path = ""
+		originCopy.Ref = repoSpec.Ref
+	}
+	originCopy.Path = filepath.Join(originCopy.Path, path)
+	return &originCopy
+}
+
+// String returns a string version of origin
+func (origin *Origin) String() string {
+	var anno string
+	anno = anno + "path: " + origin.Path + "\n"
+	if origin.Repo != "" {
+		anno = anno + "repo: " + origin.Repo + "\n"
+	}
+	if origin.Ref != "" {
+		anno = anno + "ref: " + origin.Ref + "\n"
+	}
+	return anno
+}

api/resource/origin_test.go

@@ -0,0 +1,83 @@
+// Copyright 2019 The Kubernetes Authors.
+// SPDX-License-Identifier: Apache-2.0
+
+package resource_test
+
+import (
+	"testing"
+
+	. "sigs.k8s.io/kustomize/api/resource"
+)
+
+func TestOriginAppend(t *testing.T) {
+	tests := []struct {
+		in       *Origin
+		path     string
+		expected string
+	}{
+		{
+			in: &Origin{
+				Path: "prod",
+			},
+			path: "service.yaml",
+			expected: `path: prod/service.yaml
+`,
+		},
+		{
+			in: &Origin{
+				Path: "overlay/prod",
+			},
+			path: "github.com/kubernetes-sigs/kustomize/examples/multibases/dev/",
+			expected: `path: examples/multibases/dev
+repo: https://github.com/kubernetes-sigs/kustomize
+`,
+		},
+	}
+	for _, test := range tests {
+		actual := test.in.Append(test.path).String()
+		if actual != test.expected {
+			t.Fatalf("Expected %v, but got %v\n", test.expected, actual)
+		}
+	}
+}
+
+func TestOriginString(t *testing.T) {
+	tests := []struct {
+		in       *Origin
+		expected string
+	}{
+		{
+			in: &Origin{
+				Path: "prod/service.yaml",
+				Repo: "github.com/kubernetes-sigs/kustomize/examples/multibases/dev/",
+				Ref:  "v1.0.6",
+			},
+			expected: `path: prod/service.yaml
+repo: github.com/kubernetes-sigs/kustomize/examples/multibases/dev/
+ref: v1.0.6
+`,
+		},
+		{
+			in: &Origin{
+				Path: "prod/service.yaml",
+				Repo: "github.com/kubernetes-sigs/kustomize/examples/multibases/dev/",
+			},
+			expected: `path: prod/service.yaml
+repo: github.com/kubernetes-sigs/kustomize/examples/multibases/dev/
+`,
+		},
+		{
+			in: &Origin{
+				Path: "prod/service.yaml",
+			},
+			expected: `path: prod/service.yaml
+`,
+		},
+	}
+
+	for _, test := range tests {
+		if test.in.String() != test.expected {
+			t.Fatalf("Expected %v, but got %v\n", test.expected, test.in.String())
+		}
+	}
+}