kustomize/api/resource/origin.go

// Copyright 2019 The Kubernetes Authors.
// SPDX-License-Identifier: Apache-2.0

package resource

import (
	"path/filepath"
	"strings"

	"sigs.k8s.io/kustomize/api/internal/git"
	kyaml "sigs.k8s.io/kustomize/kyaml/yaml"
)

// 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 `json:"path,omitempty" yaml:"path,omitempty"`

	// Repo is the remote repository that the resource originated from if it is
	// not from a local file
	Repo string `json:"repo,omitempty" yaml:"repo,omitempty"`

	// Ref is the ref of the remote repository that the resource originated from
	// if it is not from a local file
	Ref string `json:"ref,omitempty" yaml:"ref,omitempty"`
}

// Copy returns a copy of origin
func (origin *Origin) Copy() Origin {
	if origin == nil {
		return 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, error) {
	anno, err := kyaml.Marshal(origin)
	return string(anno), err
}