Display resources selected for function run (#2537)

* Display resources selected for function run

* Update test

* Update test

Author: phanimarupaka

e2e/testdata/fn-eval/selectors/basicpipeline/.expected/config.yaml

@@ -0,0 +1,3 @@
+stdErr: |
+  [RUNNING] "gcr.io/kpt-fn/set-namespace:v0.1.3" on 1 resource(s)
+  [PASS] "gcr.io/kpt-fn/set-namespace:v0.1.3" in 0s

e2e/testdata/fn-eval/selectors/out-of-place-fnchain-unwrap/.expected/config.yaml

@@ -13,9 +13,9 @@
 # limitations under the License.
 
 stdErr: |
-  [RUNNING] "gcr.io/kpt-fn/set-namespace:v0.1.3"
+  [RUNNING] "gcr.io/kpt-fn/set-namespace:v0.1.3" on 1 resource(s)
   [PASS] "gcr.io/kpt-fn/set-namespace:v0.1.3" in 0s
-  [RUNNING] "gcr.io/kpt-fn/set-annotations:v0.1.3"
+  [RUNNING] "gcr.io/kpt-fn/set-annotations:v0.1.3" on 1 resource(s)
   [PASS] "gcr.io/kpt-fn/set-annotations:v0.1.3" in 0s
   [RUNNING] "gcr.io/kpt-fn/set-labels:v0.1.3"
   [PASS] "gcr.io/kpt-fn/set-labels:v0.1.3" in 0s

e2e/testdata/fn-render/selectors/basicpipeline/.expected/config.yaml

@@ -0,0 +1,8 @@
+stdErr: |
+  Package "basicpipeline": 
+  [RUNNING] "gcr.io/kpt-fn/set-namespace:v0.1.3" on 1 resource(s)
+  [PASS] "gcr.io/kpt-fn/set-namespace:v0.1.3" in 0s
+  [RUNNING] "gcr.io/kpt-fn/set-labels:v0.1.4"
+  [PASS] "gcr.io/kpt-fn/set-labels:v0.1.4" in 0s
+
+  Successfully executed 2 function(s) in 1 package(s).

e2e/testdata/fn-render/selectors/generator/.expected/config.yaml

@@ -0,0 +1,16 @@
+stdErr: |
+  Package "generator/db": 
+  [RUNNING] "gcr.io/kpt-fn/starlark:v0.2.1"
+  [PASS] "gcr.io/kpt-fn/starlark:v0.2.1" in 0s
+  [RUNNING] "gcr.io/kpt-fn/set-namespace:v0.1.3" on 1 resource(s)
+  [PASS] "gcr.io/kpt-fn/set-namespace:v0.1.3" in 0s
+  [RUNNING] "gcr.io/kpt-fn/set-labels:v0.1.4" on 1 resource(s)
+  [PASS] "gcr.io/kpt-fn/set-labels:v0.1.4" in 0s
+
+  Package "generator": 
+  [RUNNING] "gcr.io/kpt-fn/set-namespace:v0.1.3" on 1 resource(s)
+  [PASS] "gcr.io/kpt-fn/set-namespace:v0.1.3" in 0s
+  [RUNNING] "gcr.io/kpt-fn/set-labels:v0.1.4" on 1 resource(s)
+  [PASS] "gcr.io/kpt-fn/set-labels:v0.1.4" in 0s
+
+  Successfully executed 5 function(s) in 2 package(s).

internal/cmdrender/executor.go

@@ -363,7 +363,6 @@ func (pn *pkgNode) runMutators(ctx context.Context, hctx *hydrationContext, inpu
 				return nil, err
 			}
 		}
-
 		// select the resources on which function should be applied
 		selectedInput, err := fnruntime.SelectInput(input, selectors, &fnruntime.SelectionContext{RootPackagePath: hctx.root.pkg.UniquePath})
 		if err != nil {
@@ -415,16 +414,20 @@ func (pn *pkgNode) runValidators(ctx context.Context, hctx *hydrationContext, in
 
 	for i := range pl.Validators {
 		fn := pl.Validators[i]
-		validator, err := fnruntime.NewContainerRunner(ctx, &fn, pn.pkg.UniquePath, hctx.fnResults, hctx.imagePullPolicy)
-		if err != nil {
-			return err
-		}
 		// validators are run on a copy of mutated resources to ensure
 		// resources are not mutated.
 		selectedResources, err := fnruntime.SelectInput(input, fn.Selectors, &fnruntime.SelectionContext{RootPackagePath: hctx.root.pkg.UniquePath})
 		if err != nil {
 			return err
 		}
+		displayResourceCount := false
+		if len(fn.Selectors) > 0 {
+			displayResourceCount = true
+		}
+		validator, err := fnruntime.NewContainerRunner(ctx, &fn, pn.pkg.UniquePath, hctx.fnResults, hctx.imagePullPolicy, displayResourceCount)
+		if err != nil {
+			return err
+		}
 		if _, err = validator.Filter(cloneResources(selectedResources)); err != nil {
 			return err
 		}
@@ -515,7 +518,11 @@ func fnChain(ctx context.Context, hctx *hydrationContext, pkgPath types.UniquePa
 	for i := range fns {
 		fn := fns[i]
 		fn.Image = fnruntime.AddDefaultImagePathPrefix(fn.Image)
-		r, err := fnruntime.NewContainerRunner(ctx, &fn, pkgPath, hctx.fnResults, hctx.imagePullPolicy)
+		displayResourceCount := false
+		if len(fn.Selectors) > 0 {
+			displayResourceCount = true
+		}
+		r, err := fnruntime.NewContainerRunner(ctx, &fn, pkgPath, hctx.fnResults, hctx.imagePullPolicy, displayResourceCount)
 		if err != nil {
 			return nil, err
 		}

internal/fnruntime/runner.go

@@ -43,7 +43,7 @@ import (
 func NewContainerRunner(
 	ctx context.Context, f *kptfilev1.Function,
 	pkgPath types.UniquePath, fnResults *fnresult.ResultList,
-	imagePullPolicy ImagePullPolicy) (kio.Filter, error) {
+	imagePullPolicy ImagePullPolicy, displayResourceCount bool) (kio.Filter, error) {
 	config, err := newFnConfig(f, pkgPath)
 	if err != nil {
 		return nil, err
@@ -66,7 +66,7 @@ func NewContainerRunner(
 		Run:            cfn.Run,
 		FunctionConfig: config,
 	}
-	return NewFunctionRunner(ctx, fltr, pkgPath, fnResult, fnResults, true)
+	return NewFunctionRunner(ctx, fltr, pkgPath, fnResult, fnResults, true, displayResourceCount)
 }
 
 // NewFunctionRunner returns a kio.Filter given a specification of a function
@@ -76,7 +76,8 @@ func NewFunctionRunner(ctx context.Context,
 	pkgPath types.UniquePath,
 	fnResult *fnresult.Result,
 	fnResults *fnresult.ResultList,
-	setPkgPathAnnotation bool) (kio.Filter, error) {
+	setPkgPathAnnotation bool,
+	displayResourceCount bool) (kio.Filter, error) {
 	name := fnResult.Image
 	if name == "" {
 		name = fnResult.ExecPath
@@ -89,6 +90,7 @@ func NewFunctionRunner(ctx context.Context,
 		fnResult:             fnResult,
 		fnResults:            fnResults,
 		setPkgPathAnnotation: setPkgPathAnnotation,
+		displayResourceCount: displayResourceCount,
 	}, nil
 }
 
@@ -105,12 +107,17 @@ type FunctionRunner struct {
 	// on resources that do not have it set. The resources generated by
 	// functions do not have this annotation set.
 	setPkgPathAnnotation bool
+	displayResourceCount bool
 }
 
 func (fr *FunctionRunner) Filter(input []*yaml.RNode) (output []*yaml.RNode, err error) {
 	pr := printer.FromContextOrDie(fr.ctx)
 	if !fr.disableCLIOutput {
-		pr.Printf("[RUNNING] %q\n", fr.name)
+		pr.Printf("[RUNNING] %q", fr.name)
+		if fr.displayResourceCount {
+			pr.Printf(" on %d resource(s)", len(input))
+		}
+		pr.Printf("\n")
 	}
 	t0 := time.Now()
 	output, err = fr.do(input)

thirdparty/kyaml/runfn/runfn.go

@@ -396,7 +396,11 @@ func (r *RunFns) defaultFnFilterProvider(spec runtimeutil.FunctionSpec, fnConfig
 			DeferFailure:   spec.DeferFailure,
 		}
 		fnResult.ExecPath = r.OriginalExec
+	}
 
+	displayResourceCount := false
+	if !r.Selector.IsEmpty() {
+		displayResourceCount = true
 	}
-	return fnruntime.NewFunctionRunner(r.Ctx, fltr, "", fnResult, r.fnResults, false)
+	return fnruntime.NewFunctionRunner(r.Ctx, fltr, "", fnResult, r.fnResults, false, displayResourceCount)
 }