Support editing of packages (#3060)

Author: mortent

porch/api/generated/openapi/zz_generated.openapi.go

@@ -86,6 +86,7 @@ const (
 	TaskTypeInit  TaskType = "init"
 	TaskTypeClone TaskType = "clone"
 	TaskTypePatch TaskType = "patch"
+	TaskTypeEdit  TaskType = "edit"
 	TaskTypeEval  TaskType = "eval"
 )
 
@@ -94,6 +95,7 @@ type Task struct {
 	Init  *PackageInitTaskSpec  `json:"init,omitempty"`
 	Clone *PackageCloneTaskSpec `json:"clone,omitempty"`
 	Patch *PackagePatchTaskSpec `json:"patch,omitempty"`
+	Edit  *PackageEditTaskSpec  `json:"edit,omitempty"`
 	Eval  *FunctionEvalTaskSpec `json:"eval,omitempty"`
 }
 
@@ -153,6 +155,10 @@ type PatchSpec struct {
 	PatchType PatchType `json:"patchType,omitempty"`
 }
 
+type PackageEditTaskSpec struct {
+	Source *PackageRevisionRef `json:"sourceRef,omitempty"`
+}
+
 type RepositoryType string
 
 const (

porch/api/porch/types_packagerevisions.go

@@ -94,6 +94,7 @@ const (
 	TaskTypeInit  TaskType = "init"
 	TaskTypeClone TaskType = "clone"
 	TaskTypePatch TaskType = "patch"
+	TaskTypeEdit  TaskType = "edit"
 	TaskTypeEval  TaskType = "eval"
 )
 
@@ -102,6 +103,7 @@ type Task struct {
 	Init  *PackageInitTaskSpec  `json:"init,omitempty"`
 	Clone *PackageCloneTaskSpec `json:"clone,omitempty"`
 	Patch *PackagePatchTaskSpec `json:"patch,omitempty"`
+	Edit  *PackageEditTaskSpec  `json:"edit,omitempty"`
 	Eval  *FunctionEvalTaskSpec `json:"eval,omitempty"`
 }
 
@@ -161,6 +163,10 @@ type PatchSpec struct {
 	PatchType PatchType `json:"patchType,omitempty"`
 }
 
+type PackageEditTaskSpec struct {
+	Source *PackageRevisionRef `json:"sourceRef,omitempty"`
+}
+
 type RepositoryType string
 
 const (

porch/api/porch/v1alpha1/types_packagerevisions.go

@@ -74,36 +74,14 @@ func (m *clonePackageMutation) Apply(ctx context.Context, resources repository.P
 func (m *clonePackageMutation) cloneFromRegisteredRepository(ctx context.Context, ref *api.PackageRevisionRef) (repository.PackageResources, error) {
 	if ref.Name == "" {
 		return repository.PackageResources{}, fmt.Errorf("upstreamRef.name is required")
-
-	}
-	repositoryName, err := parseUpstreamRepository(ref.Name)
-	if err != nil {
-		return repository.PackageResources{}, err
-	}
-	var resolved configapi.Repository
-	if err := m.referenceResolver.ResolveReference(ctx, m.namespace, repositoryName, &resolved); err != nil {
-		return repository.PackageResources{}, fmt.Errorf("cannot find repository %s/%s: %w", m.namespace, repositoryName, err)
 	}
 
-	open, err := m.cad.OpenRepository(ctx, &resolved)
+	revision, err := (&PackageFetcher{
+		cad:               m.cad,
+		referenceResolver: m.referenceResolver,
+	}).FetchRevision(ctx, ref, m.namespace)
 	if err != nil {
-		return repository.PackageResources{}, err
-	}
-
-	revisions, err := open.ListPackageRevisions(ctx, repository.ListPackageRevisionFilter{KubeObjectName: ref.Name})
-	if err != nil {
-		return repository.PackageResources{}, err
-	}
-
-	var revision repository.PackageRevision
-	for _, rev := range revisions {
-		if rev.KubeObjectName() == ref.Name {
-			revision = rev
-			break
-		}
-	}
-	if revision == nil {
-		return repository.PackageResources{}, fmt.Errorf("cannot find package revision %q", ref.Name)
+		return repository.PackageResources{}, fmt.Errorf("failed to fetch package revision %q: %w", ref.Name, err)
 	}
 
 	resources, err := revision.GetResources(ctx)

porch/api/porch/v1alpha1/zz_generated.conversion.go

@@ -0,0 +1,59 @@
+// Copyright 2022 Google LLC
+//
+// 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 engine
+
+import (
+	"context"
+	"fmt"
+
+	api "github.com/GoogleContainerTools/kpt/porch/api/porch/v1alpha1"
+	"github.com/GoogleContainerTools/kpt/porch/engine/pkg/kpt"
+	"github.com/GoogleContainerTools/kpt/porch/repository/pkg/repository"
+	"go.opentelemetry.io/otel/trace"
+)
+
+type editPackageMutation struct {
+	task              *api.Task
+	name              string
+	namespace         string
+	cad               CaDEngine
+	referenceResolver ReferenceResolver
+}
+
+var _ mutation = &editPackageMutation{}
+
+func (m *editPackageMutation) Apply(ctx context.Context, resources repository.PackageResources) (repository.PackageResources, *api.Task, error) {
+	ctx, span := tracer.Start(ctx, "editPackageMutation::Apply", trace.WithAttributes())
+	defer span.End()
+
+	sourceRef := m.task.Edit.Source
+
+	sourceResources, err := (&PackageFetcher{
+		cad:               m.cad,
+		referenceResolver: m.referenceResolver,
+	}).FetchResources(ctx, sourceRef, m.namespace)
+	if err != nil {
+		return repository.PackageResources{}, nil, fmt.Errorf("failed to fetch resources for package %q: %w", sourceRef.Name, err)
+	}
+
+	// Update Kptfile
+	if err := kpt.UpdateKptfileName(m.name, sourceResources.Spec.Resources); err != nil {
+		return repository.PackageResources{}, nil, fmt.Errorf("failed to update package name %q: %w", sourceRef.Name, err)
+	}
+
+	return repository.PackageResources{
+		Contents: sourceResources.Spec.Resources,
+	}, &api.Task{}, nil
+}

porch/api/porch/v1alpha1/zz_generated.deepcopy.go

@@ -183,6 +183,18 @@ func (cad *cadEngine) mapTaskToMutation(ctx context.Context, obj *api.PackageRev
 	case api.TaskTypePatch:
 		return buildPatchMutation(ctx, task)
 
+	case api.TaskTypeEdit:
+		if task.Edit == nil {
+			return nil, fmt.Errorf("edit not set for task of type %q", task.Type)
+		}
+		return &editPackageMutation{
+			task:              task,
+			namespace:         obj.Namespace,
+			name:              obj.Spec.PackageName,
+			cad:               cad,
+			referenceResolver: cad.referenceResolver,
+		}, nil
+
 	case api.TaskTypeEval:
 		if task.Eval == nil {
 			return nil, fmt.Errorf("eval not set for task of type %q", task.Type)