cleanup context

Author: yuwenma

go/fn/context.go

@@ -16,27 +16,11 @@ package fn
 
 import (
 	"context"
-	"time"
 )
 
 var _ context.Context = &Context{}
 
 // TODO: Have Context implement `context.Context`.
 type Context struct {
-	ctx context.Context
-}
-
-func (c *Context) Deadline() (deadline time.Time, ok bool) {
-	return c.ctx.Deadline()
-}
-
-func (c *Context) Done() <-chan struct{} {
-	return c.ctx.Done()
-}
-func (c *Context) Err() error {
-	return c.ctx.Err()
-}
-
-func (c *Context) Value(key any) any {
-	return c.ctx.Value(key)
+	context.Context
 }

go/fn/examples/example_asmain_runner_test.go

@@ -4,7 +4,7 @@
 // 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
+//      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,
@@ -14,31 +14,30 @@
 package example
 
 import (
-    "os"
+	"os"
 
-    "github.com/GoogleContainerTools/kpt-functions-sdk/go/fn"
+	"github.com/GoogleContainerTools/kpt-functions-sdk/go/fn"
 )
 
 var _ fn.Runner = &SetLabels{}
 
 type SetLabels struct {
-    Labels map[string]string `json:"labels,omitempty"`
+	Labels map[string]string `json:"labels,omitempty"`
 }
 
 // Run is the main function logic.
 // `ctx` provides easy methods to add info, error or warning result to `ResourceList.Results`.
 // `items` is parsed from the STDIN "ResourceList.Items".
 // `functionConfig` is from the STDIN "ResourceList.FunctionConfig". The value has been assigned to the r.Labels
-//
-//    the functionConfig is validated to have kind "SetLabels" and apiVersion "fn.kpt.dev/v1alpha1"
-func (r *SetLabels) Run(_ *fn.Context, _ *fn.KubeObject, items fn.KubeObjects, results *fn.Results) bool {
-    for _, o := range items {
-    for k, newLabel := range r.Labels {
-    o.SetLabel(k, newLabel)
-    }
-    }
-    results.Infof("updated labels")
-    return true
+//  the functionConfig is validated to have kind "SetLabels" and apiVersion "fn.kpt.dev/v1alpha1"
+func (r *SetLabels) Run(ctx *fn.Context, functionConfig *fn.KubeObject, items fn.KubeObjects, results *fn.Results) bool {
+	for _, o := range items {
+		for k, newLabel := range r.Labels {
+			o.SetLabel(k, newLabel)
+		}
+	}
+	results.Infof("updated labels", nil)
+	return true
 }
 
 // This example uses a SetLabels object, which implements `Runner.Run` methods.
@@ -51,34 +50,33 @@ func (r *SetLabels) Run(_ *fn.Context, _ *fn.KubeObject, items fn.KubeObjects, r
 //     kind: Service
 //     metadata:
 //       name: example
-//
 // functionConfig:
-//    apiVersion: fn.kpt.dev/v1alpha1
-//    kind: SetLabels
-//    metadata:
-//      name: setlabel-fn-config
+//   apiVersion: fn.kpt.dev/v1alpha1
+//   kind: SetLabels
+//   metadata:
+//     name: setlabel-fn-config
 func Example_asMain() {
-    file, _ := os.Open("./data/setlabels-resourcelist.yaml")
-    defer file.Close()
-    os.Stdin = file
+	file, _ := os.Open("./data/setlabels-resourcelist.yaml")
+	defer file.Close()
+	os.Stdin = file
 
-    if err := fn.AsMain(&SetLabels{}); err != nil {
-    os.Exit(1)
-    }
-    // Output:
-    // apiVersion: config.kubernetes.io/v1
-    // kind: ResourceList
-    // items:
-    // - apiVersion: v1
-    //   kind: Service
-    //   metadata:
-    //     name: example
-    // functionConfig:
-    //   apiVersion: fn.kpt.dev/v1alpha1
-    //   kind: SetLabels
-    //   metadata:
-    //     name: setlabel-fn-config
-    // results:
-    // - message: updated labels
-    //   severity: info
+	if err := fn.AsMain(&SetLabels{}); err != nil {
+		os.Exit(1)
+	}
+	// Output:
+	// apiVersion: config.kubernetes.io/v1
+	// kind: ResourceList
+	// items:
+	// - apiVersion: v1
+	//   kind: Service
+	//   metadata:
+	//     name: example
+	// functionConfig:
+	//   apiVersion: fn.kpt.dev/v1alpha1
+	//   kind: SetLabels
+	//   metadata:
+	//     name: setlabel-fn-config
+	// results:
+	// - message: updated labels
+	//   severity: info
 }

go/fn/functionrunner.go

@@ -15,10 +15,11 @@
 package fn
 
 type Runner interface {
-	// Run passes the `functionConfig` and `items` from input ResourceList to allow you to do operations.
+	// Run provides the entrypoint to allow you make changes to input `resourcelist.Items`
 	// Args:
-	//    items: We intentionally do not allow you to add or delete KubeObject from "items", you can only modify
-	// the items, because we expect you to use Runner only for transformer or validator functions.
+	//    items: The KRM resources in the form of a slice of KubeObject.
+	//       Note: You can only modify the existing items but not add or delete items.
+	//       We intentionally design the method this way to make the Runner be used as a Transformer or Validator, but not a Generator.
 	//    results: You can use `ErrorE` `Errorf` `Infof` `Warningf` `WarningE` to add user message to `Results`.
 	// Returns:
 	//    return a boolean to tell whether the execution should be considered as PASS or FAIL. CLI like kpt will

go/fn/result.go

@@ -130,7 +130,7 @@ type Field struct {
 
 type Results []*Result
 
-// ErrorE writes an Error level `result` to the results slice. It accepts arguments according to a format specifier.
+// Errorf writes an Error level `result` to the results slice. It accepts arguments according to a format specifier.
 // e.g.
 // results.Errorf("bad kind %v", "invalid")
 func (r *Results) Errorf(format string, a ...any) {
@@ -140,7 +140,6 @@ func (r *Results) Errorf(format string, a ...any) {
 
 // ErrorE writes the `error` as an Error level `result` to the results slice.
 // e.g.
-//
 //	err := error.New("test)
 //	results.ErrorE(err)
 func (r *Results) ErrorE(err error) {
@@ -150,7 +149,6 @@ func (r *Results) ErrorE(err error) {
 
 // Infof writes an Info level `result` to the results slice. It accepts arguments according to a format specifier.
 // e.g.
-//
 //	results.Infof("update %v %q ", "ConfigMap", "kptfile.kpt.dev")
 func (r *Results) Infof(format string, a ...any) {
 	infoResult := &Result{Severity: Info, Message: fmt.Sprintf(format, a...)}
@@ -159,7 +157,6 @@ func (r *Results) Infof(format string, a ...any) {
 
 // Warningf writes a Warning level `result` to the results slice. It accepts arguments according to a format specifier.
 // e.g.
-//
 //	results.Warningf("bad kind %q", "invalid")
 func (r *Results) Warningf(format string, a ...any) {
 	warnResult := &Result{Severity: Warning, Message: fmt.Sprintf(format, a...)}