Cli Usability: Cleanup fn commands and make dir optional (kptdev#1710)

* Make Dir Optional For Fn Commands

* Clean -<STDIN> to -

commands/fncmd.go

@@ -17,8 +17,8 @@ package commands
 import (
 	"github.com/GoogleContainerTools/kpt/internal/cmdexport"
 	"github.com/GoogleContainerTools/kpt/internal/cmdfndoc"
+	"github.com/GoogleContainerTools/kpt/internal/cmdrender"
 	"github.com/GoogleContainerTools/kpt/internal/docs/generated/fndocs"
-	"github.com/GoogleContainerTools/kpt/internal/pipeline"
 	"github.com/GoogleContainerTools/kpt/thirdparty/cmdconfig/commands/cmdeval"
 	"github.com/GoogleContainerTools/kpt/thirdparty/cmdconfig/commands/cmdsink"
 	"github.com/GoogleContainerTools/kpt/thirdparty/cmdconfig/commands/cmdsource"
@@ -49,7 +49,7 @@ func GetFnCommand(name string) *cobra.Command {
 	eval.Long = fndocs.RunShort + "\n" + fndocs.RunLong
 	eval.Example = fndocs.RunExamples
 
-	render := pipeline.NewCommand(name)
+	render := cmdrender.NewCommand(name)
 
 	doc := cmdfndoc.NewCommand(name)
 	doc.Short = fndocs.DocShort

internal/cmdexport/cmdexport.go

@@ -37,7 +37,7 @@ func ExportCommand() *cobra.Command {
 func GetExportRunner() *ExportRunner {
 	r := &ExportRunner{PipelineConfig: &types.PipelineConfig{}}
 	c := &cobra.Command{
-		Use:     "export DIR/",
+		Use:     "export [DIR]",
 		Short:   fndocs.ExportShort,
 		Long:    fndocs.ExportLong,
 		Example: fndocs.ExportExamples,
@@ -77,7 +77,11 @@ type ExportRunner struct {
 }
 
 func (r *ExportRunner) preRunE(cmd *cobra.Command, args []string) (err error) {
-	r.Dir = args[0]
+	// default to current working directory
+	r.Dir = "."
+	if len(args) > 0 {
+		r.Dir = args[0]
+	}
 
 	if len(r.WorkflowOrchestrator) == 0 {
 		return fmt.Errorf(
@@ -109,7 +113,7 @@ func (r *ExportRunner) preRunE(cmd *cobra.Command, args []string) (err error) {
 }
 
 // runE generates the pipeline and writes it into a file or stdout.
-func (r *ExportRunner) runE(c *cobra.Command, args []string) error {
+func (r *ExportRunner) runE(c *cobra.Command, _ []string) error {
 	pipeline, e := r.Pipeline.Init(r.PipelineConfig).Generate()
 
 	if e != nil {

internal/cmdfndoc/cmdfndoc.go

@@ -31,7 +31,7 @@ func NewRunner(parent string) *Runner {
 	r := &Runner{}
 	c := &cobra.Command{
 		Use:     "doc --image=IMAGE",
-		Args:    cobra.MaximumNArgs(1),
+		Args:    cobra.MaximumNArgs(0),
 		Short:   fndocs.DocShort,
 		Long:    fndocs.DocShort + "\n" + fndocs.DocLong,
 		Example: fndocs.DocExamples,
@@ -52,7 +52,7 @@ type Runner struct {
 	Command *cobra.Command
 }
 
-func (r *Runner) runE(c *cobra.Command, args []string) error {
+func (r *Runner) runE(c *cobra.Command, _ []string) error {
 	if r.Image == "" {
 		return errors.New("image must be specified")
 	}

internal/pipeline/cmd.go → internal/cmdrender/cmd.go

@@ -13,7 +13,7 @@
 // limitations under the License.
 
 // Package cmdget contains the get command
-package pipeline
+package cmdrender
 
 import (
 	"fmt"
@@ -64,7 +64,7 @@ func (r *Runner) preRunE(c *cobra.Command, args []string) error {
 	return nil
 }
 
-func (r *Runner) runE(c *cobra.Command, args []string) error {
+func (r *Runner) runE(c *cobra.Command, _ []string) error {
 	err := cmdutil.DockerCmdAvailable()
 	if err != nil {
 		return err

internal/pipeline/executor.go → internal/cmdrender/executor.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package pipeline
+package cmdrender
 
 import (
 	"fmt"

internal/pipeline/pipeline_function.go → internal/cmdrender/pipeline_function.go

@@ -14,15 +14,15 @@
 
 // Package pipeline provides struct definitions for Pipeline and utility
 // methods to read and write a pipeline resource.
-package pipeline
+package cmdrender
 
 import (
 	"fmt"
 	"io/ioutil"
 	"os"
 	"path"
 
-	"github.com/GoogleContainerTools/kpt/internal/pipeline/runtime"
+	"github.com/GoogleContainerTools/kpt/internal/cmdrender/runtime"
 	"github.com/GoogleContainerTools/kpt/internal/types"
 	kptfilev1alpha2 "github.com/GoogleContainerTools/kpt/pkg/api/kptfile/v1alpha2"
 	"sigs.k8s.io/kustomize/kyaml/fn/runtime/runtimeutil"

internal/pipeline/pipeline_function_test.go → internal/cmdrender/pipeline_function_test.go

@@ -26,7 +26,7 @@
 
 // Package pipeline provides struct definitions for Pipeline and utility
 // methods to read and write a pipeline resource.
-package pipeline
+package cmdrender
 
 import (
 	"io/ioutil"

internal/pipeline/runtime/container_test.go → internal/cmdrender/runtime/container_test.go

@@ -20,7 +20,7 @@ import (
 	"bytes"
 	"testing"
 
-	"github.com/GoogleContainerTools/kpt/internal/pipeline/runtime"
+	"github.com/GoogleContainerTools/kpt/internal/cmdrender/runtime"
 	"github.com/stretchr/testify/assert"
 )
 

site/reference/pkg/tree/README.md

@@ -97,7 +97,7 @@ kubectl get all -o yaml | kpt pkg tree \
 ### Synopsis
 <!--mdtogo:Long-->
 ```
-kpt pkg tree [DIR | -<STDIN>] [flags]
+kpt pkg tree [DIR | -] [flags]
 ```
 
 #### Args

thirdparty/cmdconfig/commands/cmdeval/fnevalcmd.go → thirdparty/cmdconfig/commands/cmdeval/cmdeval.go

@@ -21,7 +21,7 @@ import (
 func GetEvalFnRunner(name string) *EvalFnRunner {
 	r := &EvalFnRunner{}
 	c := &cobra.Command{
-		Use:     "eval [DIR]",
+		Use:     "eval [DIR | -]",
 		RunE:    r.runE,
 		PreRunE: r.preRunE,
 	}
@@ -83,7 +83,7 @@ type EvalFnRunner struct {
 	IncludeMetaResources bool
 }
 
-func (r *EvalFnRunner) runE(c *cobra.Command, args []string) error {
+func (r *EvalFnRunner) runE(c *cobra.Command, _ []string) error {
 	return runner.HandleError(c, r.RunFns.Execute())
 }
 
@@ -224,12 +224,15 @@ func (r *EvalFnRunner) preRunE(c *cobra.Command, args []string) error {
 	if r.Image == "" && r.ExecPath == "" {
 		return errors.Errorf("must specify --image or --exec-path")
 	}
-
 	var dataItems []string
 	if c.ArgsLenAtDash() >= 0 {
-		dataItems = args[c.ArgsLenAtDash():]
+		dataItems = append(dataItems, args[c.ArgsLenAtDash():]...)
 		args = args[:c.ArgsLenAtDash()]
 	}
+	if len(args) == 0 {
+		// default to current working directory
+		args = append(args, ".")
+	}
 	if len(args) > 1 {
 		return errors.Errorf("0 or 1 arguments supported, function arguments go after '--'")
 	}
@@ -245,9 +248,11 @@ func (r *EvalFnRunner) preRunE(c *cobra.Command, args []string) error {
 	// set the output to stdout if in dry-run mode or no arguments are specified
 	var output io.Writer
 	var input io.Reader
-	if len(args) == 0 {
+	if args[0] == "-" {
 		output = c.OutOrStdout()
 		input = c.InOrStdin()
+		// clear args as it indicates stdin and not path
+		args = []string{}
 	} else if r.DryRun {
 		output = c.OutOrStdout()
 	}

thirdparty/cmdconfig/commands/cmdeval/fnevalcmd_test.go → thirdparty/cmdconfig/commands/cmdeval/cmdeval_test.go

@@ -47,7 +47,7 @@ apiVersion: v1
 		},
 		{
 			name:   "config map stdin / stdout",
-			args:   []string{"eval", "--image", "foo:bar", "--", "a=b", "c=d", "e=f"},
+			args:   []string{"eval", "-", "--image", "foo:bar", "--", "a=b", "c=d", "e=f"},
 			input:  os.Stdin,
 			output: os.Stdout,
 			expected: `

thirdparty/cmdconfig/commands/cmdsink/cmdsink.go

@@ -8,19 +8,18 @@ import (
 	"github.com/GoogleContainerTools/kpt/thirdparty/cmdconfig/commands/runner"
 	"github.com/spf13/cobra"
 	"sigs.k8s.io/kustomize/kyaml/kio"
-	"sigs.k8s.io/kustomize/kyaml/kio/kioutil"
 )
 
 // GetSinkRunner returns a command for Sink.
 func GetSinkRunner(name string) *SinkRunner {
 	r := &SinkRunner{}
 	c := &cobra.Command{
-		Use:     "sink DIR",
+		Use:     "sink [DIR]",
 		Short:   fndocs.SinkShort,
 		Long:    fndocs.SinkLong,
 		Example: fndocs.SinkExamples,
 		RunE:    r.runE,
-		Args:    cobra.MaximumNArgs(1),
+		Args:    cobra.MinimumNArgs(1),
 	}
 	r.Command = c
 	return r
@@ -36,15 +35,7 @@ type SinkRunner struct {
 }
 
 func (r *SinkRunner) runE(c *cobra.Command, args []string) error {
-	var outputs []kio.Writer
-	if len(args) == 1 {
-		outputs = []kio.Writer{&kio.LocalPackageWriter{PackagePath: args[0]}}
-	} else {
-		outputs = []kio.Writer{&kio.ByteWriter{
-			Writer:           c.OutOrStdout(),
-			ClearAnnotations: []string{kioutil.PathAnnotation}},
-		}
-	}
+	outputs := []kio.Writer{&kio.LocalPackageWriter{PackagePath: args[0]}}
 
 	err := kio.Pipeline{
 		Inputs:  []kio.Reader{&kio.ByteReader{Reader: c.InOrStdin()}},