chore: Move Inventory object to pkg/apis/actuation

- Replace custom TypeMeta & ObjectMeta with standard metav1 structs
  to allow Inventory to satisfy the metav1.Object, runtime.Object,
  and client.Object interfaces. This should make the Inventory API
  easier to use and easily convertable to an Unstructured object.

BREAKING CHANGE: Move inventory.Inventory to actuation.Inventory (under pkg/apis/)

LICENSE_TEMPLATE_GO

@@ -0,0 +1,2 @@
+// Copyright YEAR The Kubernetes Authors.
+// SPDX-License-Identifier: Apache-2.0

Makefile

@@ -35,7 +35,13 @@ install-addlicense:
 install-lint:
 	(which $(GOPATH)/bin/golangci-lint || go install github.com/golangci/golangci-lint/cmd/[email protected])
 
-generate: install-stringer
+install-deepcopy-gen:
+	(which $(GOPATH)/bin/deepcopy-gen || go install k8s.io/code-generator/cmd/[email protected])
+
+generate-deepcopy: install-deepcopy-gen
+	hack/run-in-gopath.sh deepcopy-gen --input-dirs ./pkg/apis/... -O zz_generated.deepcopy --go-header-file ./LICENSE_TEMPLATE_GO
+
+generate: install-stringer generate-deepcopy
 	go generate ./...
 
 license: install-addlicense

hack/run-in-gopath.sh

@@ -0,0 +1,43 @@
+#!/usr/bin/env bash
+# Copyright 2021 The Kubernetes Authors.
+# SPDX-License-Identifier: Apache-2.0
+
+set -o errexit -o nounset -o pipefail -o posix
+
+PKG_PATH="sigs.k8s.io/cli-utils"
+
+REPO_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd -P)"
+
+# Make a new temporary GOPATH directory
+export GOPATH=$(mktemp -d -t cli-utils-gopath.XXXXXXXXXX)
+# Clean up on exit (modcache has read-only files, so clean that first)
+trap "go clean -modcache && rm '${GOPATH}/src/${PKG_PATH}' && rm -rf '${GOPATH}'" EXIT
+
+# Make sure we can read, write, and delete
+chmod a+rw "${GOPATH}"
+
+# Use a temporary cache
+export GOCACHE="${GOPATH}/cache"
+
+# Create a symlink for the local repo in the GOPATH
+mkdir -p "${GOPATH}/src/${PKG_PATH}"
+rm -r "${GOPATH}/src/${PKG_PATH}"
+ln -s "${REPO_ROOT}" "${GOPATH}/src/${PKG_PATH}"
+
+# Make sure our own Go binaries are in PATH.
+export PATH="${GOPATH}/bin:${PATH}"
+
+# Set GOROOT so binaries that parse code can work properly.
+export GOROOT=$(go env GOROOT)
+
+# Unset GOBIN in case it already exists in the current session.
+unset GOBIN
+
+# enter the GOPATH before executing the command
+cd "${GOPATH}/src/${PKG_PATH}"
+
+# Run the user-provided command.
+"${@}"
+
+# exit the GOPATH before deleting it
+cd "${REPO_ROOT}"

pkg/apis/actuation/doc.go

@@ -0,0 +1,8 @@
+// Copyright 2021 The Kubernetes Authors.
+// SPDX-License-Identifier: Apache-2.0
+
+// Package actuation contains API Schema definitions for the
+// cli-utils.kubernetes.io API group.
+// +k8s:deepcopy-gen=package
+// +groupName=cli-utils.kubernetes.io
+package actuation // import "sigs.k8s.io/cli-utils/pkg/apis/actuation"

pkg/inventory/types.go → pkg/apis/actuation/types.go

@@ -1,18 +1,19 @@
 // Copyright 2021 The Kubernetes Authors.
 // SPDX-License-Identifier: Apache-2.0
 
-package inventory
+package actuation
 
-import "k8s.io/apimachinery/pkg/types"
+import (
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/types"
+)
 
 // Inventory represents the inventory object in memory.
 // Inventory is currently only used for in-memory storage and not serialized to
 // disk or to the API server.
-// TODO: Replace InventoryInfo with Inventory.TypeMeta & Inventory.ObjectMeta
-// TODO: Replace object.ObjMetadataSet in Storage interface with Inventory.Spec
 type Inventory struct {
-	TypeMeta   `json:",inline"`
-	ObjectMeta `json:"metadata,omitempty"`
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
 
 	Spec   InventorySpec   `json:"spec,omitempty"`
 	Status InventoryStatus `json:"status,omitempty"`
@@ -106,29 +107,3 @@ const (
 	ReconcileFailed                           // Failed
 	ReconcileTimeout                          // Timeout
 )
-
-// TypeMeta describes a REST resource.
-type TypeMeta struct {
-	// Kind is a string value representing the REST resource this object represents.
-	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
-	Kind string `json:"kind,omitempty"`
-
-	// APIVersion defines the versioned schema of this representation of an object.
-	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
-	APIVersion string `json:"apiVersion,omitempty"`
-}
-
-// ObjectMeta describes an individual object instance of a REST resource.
-// TODO: Do we need other fields, like UID, Generation, ResourceVersion, and CreationTimestamp?
-type ObjectMeta struct {
-	// Name identifies an object instance of a REST resource.
-	// More info: http://kubernetes.io/docs/user-guide/identifiers#names
-	Name string `json:"name,omitempty" protobuf:"bytes,1,opt,name=name"`
-
-	// Namespace identifies a group of objects across REST resources.
-	// If namespace is specified, the resource must be namespace-scoped.
-	// If namespace is omitted, the resource must be cluster-scoped.
-	// More info: http://kubernetes.io/docs/user-guide/namespaces
-	// +optional
-	Namespace string `json:"namespace,omitempty" protobuf:"bytes,3,opt,name=namespace"`
-}