feat(command): ✨ add Stdin arg (#44)

ghostsquad · web-flow · commit eb1d83ef937a · 2022-03-07T20:49:53.000-08:00
diff --git a/examples/examples_go_test.go b/examples/examples_go_test.go
@@ -25,6 +25,19 @@ func TestRandomGo(t *testing.T) {
 	integration.ProgramTest(t, &test)
 }
 
+func TestStdinGo(t *testing.T) {
+	test := getGoBaseOptions(t).
+		With(integration.ProgramTestOptions{
+			Dir: filepath.Join(getCwd(t), "stdin-go"),
+			ExtraRuntimeValidation: func(t *testing.T, stack integration.RuntimeValidationStackInfo) {
+				out, ok := stack.Outputs["output"].(string)
+				assert.True(t, ok)
+				assert.Equal(t, "the quick brown fox", out)
+			},
+		})
+	integration.ProgramTest(t, &test)
+}
+
 func getGoBaseOptions(t *testing.T) integration.ProgramTestOptions {
 	base := getBaseOptions(t)
 	baseGo := base.With(integration.ProgramTestOptions{
diff --git a/examples/examples_nodejs_test.go b/examples/examples_nodejs_test.go
@@ -31,6 +31,19 @@ func TestRandom(t *testing.T) {
 	integration.ProgramTest(t, &test)
 }
 
+func TestStdin(t *testing.T) {
+	test := getJSBaseOptions(t).
+		With(integration.ProgramTestOptions{
+			Dir: filepath.Join(getCwd(t), "stdin"),
+			ExtraRuntimeValidation: func(t *testing.T, stack integration.RuntimeValidationStackInfo) {
+				out, ok := stack.Outputs["output"].(string)
+				assert.True(t, ok)
+				assert.Equal(t, "the quick brown fox", out)
+			},
+		})
+	integration.ProgramTest(t, &test)
+}
+
 func TestSimple(t *testing.T) {
 	test := getJSBaseOptions(t).
 		With(integration.ProgramTestOptions{
diff --git a/examples/stdin-go/Pulumi.yaml b/examples/stdin-go/Pulumi.yaml
@@ -0,0 +1,3 @@
+name: command-random-go
+runtime: go
+description: A simple command example
diff --git a/examples/stdin-go/go.mod b/examples/stdin-go/go.mod
@@ -0,0 +1,10 @@
+module goaws
+
+go 1.13
+
+require (
+	github.com/pulumi/pulumi-command/sdk v0.0.1
+	github.com/pulumi/pulumi/sdk/v3 v3.20.1-0.20211216225508-8a73104cd690
+)
+
+replace github.com/pulumi/pulumi-command/sdk => ../../sdk
diff --git a/examples/stdin-go/go.sum b/examples/stdin-go/go.sum
diff --git a/examples/stdin-go/main.go b/examples/stdin-go/main.go
@@ -0,0 +1,22 @@
+package main
+
+import (
+	"github.com/pulumi/pulumi-command/sdk/go/command/local"
+	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
+)
+
+func main() {
+	pulumi.Run(func(ctx *pulumi.Context) error {
+
+		random, err := local.NewCommand(ctx, "stdin", &local.CommandArgs{
+			Create: pulumi.String("head -n 1"),
+			Stdin:  pulumi.String("the quick brown fox\njumped over\nthe lazy dog"),
+		})
+		if err != nil {
+			return err
+		}
+
+		ctx.Export("output", random.Stdout)
+		return nil
+	})
+}
diff --git a/examples/stdin/Pulumi.yaml b/examples/stdin/Pulumi.yaml
@@ -0,0 +1,3 @@
+name: command-random
+runtime: nodejs
+description: A simple command example
diff --git a/examples/stdin/index.ts b/examples/stdin/index.ts
@@ -0,0 +1,8 @@
+import { local } from "@pulumi/command";
+
+const random = new local.Command("stdin", {
+    create: "head -n 1",
+    stdin: "the quick brown fox\njumped over\nthe lazy dog"
+});
+
+export const output = random.stdout;
diff --git a/examples/stdin/package.json b/examples/stdin/package.json
@@ -0,0 +1,11 @@
+{
+    "name": "command-random",
+    "version": "0.1.0",
+    "devDependencies": {
+        "@types/node": "latest"
+    },
+    "dependencies": {
+        "@pulumi/pulumi": "latest",
+        "@pulumi/random": "^4.2.0"
+    }
+}
diff --git a/examples/stdin/tsconfig.json b/examples/stdin/tsconfig.json
@@ -0,0 +1,18 @@
+{
+    "compilerOptions": {
+        "strict": true,
+        "outDir": "bin",
+        "target": "es2016",
+        "module": "commonjs",
+        "moduleResolution": "node",
+        "sourceMap": true,
+        "experimentalDecorators": true,
+        "pretty": true,
+        "noFallthroughCasesInSwitch": true,
+        "noImplicitReturns": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.ts"
+    ]
+}
diff --git a/provider/cmd/pulumi-resource-command/schema.json b/provider/cmd/pulumi-resource-command/schema.json
@@ -90,6 +90,10 @@
                 "stderr": {
                     "description": "The standard error of the command's process",
                     "type": "string"
+                },
+                "stdin": {
+                    "description": "Pass a string to the command's process as standard in",
+                    "type": "string"
                 }
             },
             "required": [
@@ -128,6 +132,10 @@
                 "delete": {
                     "type": "string",
                     "description": "The command to run on delete."
+                },
+                "stdin": {
+                    "description": "Pass a string to the command's process as standard in",
+                    "type": "string"
                 }
             },
             "requiredInputs": []
@@ -168,6 +176,10 @@
                 "stderr": {
                     "description": "The standard error of the command's process",
                     "type": "string"
+                },
+                "stdin": {
+                    "description": "Pass a string to the command's process as standard in",
+                    "type": "string"
                 }
             },
             "required": [
@@ -200,6 +212,10 @@
                 "delete": {
                     "description": "The command to run on delete.",
                     "type": "string"
+                },
+                "stdin": {
+                    "description": "Pass a string to the command's process as standard in",
+                    "type": "string"
                 }
             },
             "requiredInputs": [
diff --git a/provider/pkg/provider/command.go b/provider/pkg/provider/command.go
@@ -38,6 +38,7 @@ type command struct {
 	Triggers    *[]interface{}     `pulumi:"triggers,optional"`
 	Create      string             `pulumi:"create"`
 	Delete      *string            `pulumi:"delete,optional"`
+	Stdin       *string            `pulumi:"stdin,optional"`
 
 	// Output
 	Stdout string `pulumi:"stdout"`
@@ -100,6 +101,10 @@ func (c *command) run(ctx context.Context, command string, host *provider.HostCl
 		}
 	}
 
+	if c.Stdin != nil && len(*c.Stdin) > 0 {
+		cmd.Stdin = strings.NewReader(*c.Stdin)
+	}
+
 	var stdoutbuf bytes.Buffer
 	var stderrbuf bytes.Buffer
 
diff --git a/provider/pkg/provider/provider.go b/provider/pkg/provider/provider.go
@@ -137,6 +137,7 @@ func (k *commandProvider) Diff(ctx context.Context, req *pulumirpc.DiffRequest)
 		"interpreter": false,
 		"create":      false,
 		"delete":      false,
+		"stdin":       false,
 		"localPath":   false,
 		"remotePath":  false,
 		"connection":  true,
diff --git a/provider/pkg/provider/remotecommand.go b/provider/pkg/provider/remotecommand.go
@@ -21,6 +21,7 @@ import (
 	"io"
 	"net"
 	"os"
+	"strings"
 	"time"
 
 	"github.com/pulumi/pulumi/sdk/v3/go/common/util/retry"
@@ -98,6 +99,7 @@ type remotecommand struct {
 	Triggers    *[]interface{}     `pulumi:"triggers,optional"`
 	Create      string             `pulumi:"create"`
 	Delete      *string            `pulumi:"delete,optional"`
+	Stdin       *string            `pulumi:"stdin,optional"`
 
 	// Output
 	Stdout string `pulumi:"stdout"`
@@ -145,6 +147,10 @@ func (c *remotecommand) run(ctx context.Context, cmd string, host *provider.Host
 		}
 	}
 
+	if c.Stdin != nil && len(*c.Stdin) > 0 {
+		session.Stdin = strings.NewReader(*c.Stdin)
+	}
+
 	id, err := resource.NewUniqueHex("", 8, 0)
 	if err != nil {
 		return "", "", "", err
diff --git a/sdk/dotnet/Local/Command.cs b/sdk/dotnet/Local/Command.cs
@@ -57,6 +57,12 @@ public partial class Command : Pulumi.CustomResource
         [Output("stderr")]
         public Output<string> Stderr { get; private set; } = null!;
 
+        /// <summary>
+        /// Pass a string to the command's process as standard in
+        /// </summary>
+        [Output("stdin")]
+        public Output<string?> Stdin { get; private set; } = null!;
+
         /// <summary>
         /// The standard output of the command's process
         /// </summary>
@@ -157,6 +163,12 @@ public InputList<string> Interpreter
             set => _interpreter = value;
         }
 
+        /// <summary>
+        /// Pass a string to the command's process as standard in
+        /// </summary>
+        [Input("stdin")]
+        public Input<string>? Stdin { get; set; }
+
         [Input("triggers")]
         private InputList<object>? _triggers;
         public InputList<object> Triggers
diff --git a/sdk/dotnet/Remote/Command.cs b/sdk/dotnet/Remote/Command.cs
@@ -46,6 +46,12 @@ public partial class Command : Pulumi.CustomResource
         [Output("stderr")]
         public Output<string> Stderr { get; private set; } = null!;
 
+        /// <summary>
+        /// Pass a string to the command's process as standard in
+        /// </summary>
+        [Output("stdin")]
+        public Output<string?> Stdin { get; private set; } = null!;
+
         /// <summary>
         /// The standard output of the command's process
         /// </summary>
@@ -133,6 +139,12 @@ public InputMap<string> Environment
             set => _environment = value;
         }
 
+        /// <summary>
+        /// Pass a string to the command's process as standard in
+        /// </summary>
+        [Input("stdin")]
+        public Input<string>? Stdin { get; set; }
+
         [Input("triggers")]
         private InputList<object>? _triggers;
 
diff --git a/sdk/go/command/local/command.go b/sdk/go/command/local/command.go
@@ -32,6 +32,8 @@ type Command struct {
 	Interpreter pulumi.StringArrayOutput `pulumi:"interpreter"`
 	// The standard error of the command's process
 	Stderr pulumi.StringOutput `pulumi:"stderr"`
+	// Pass a string to the command's process as standard in
+	Stdin pulumi.StringPtrOutput `pulumi:"stdin"`
 	// The standard output of the command's process
 	Stdout pulumi.StringOutput `pulumi:"stdout"`
 	// Trigger replacements on changes to this input.
@@ -87,8 +89,10 @@ type commandArgs struct {
 	Environment map[string]string `pulumi:"environment"`
 	// The program and arguments to run the command.
 	// On Linux and macOS, defaults to: `["/bin/sh", "-c"]`. On Windows, defaults to: `["cmd", "/C"]`
-	Interpreter []string      `pulumi:"interpreter"`
-	Triggers    []interface{} `pulumi:"triggers"`
+	Interpreter []string `pulumi:"interpreter"`
+	// Pass a string to the command's process as standard in
+	Stdin    *string       `pulumi:"stdin"`
+	Triggers []interface{} `pulumi:"triggers"`
 }
 
 // The set of arguments for constructing a Command resource.
@@ -104,7 +108,9 @@ type CommandArgs struct {
 	// The program and arguments to run the command.
 	// On Linux and macOS, defaults to: `["/bin/sh", "-c"]`. On Windows, defaults to: `["cmd", "/C"]`
 	Interpreter pulumi.StringArrayInput
-	Triggers    pulumi.ArrayInput
+	// Pass a string to the command's process as standard in
+	Stdin    pulumi.StringPtrInput
+	Triggers pulumi.ArrayInput
 }
 
 func (CommandArgs) ElementType() reflect.Type {
diff --git a/sdk/go/command/remote/command.go b/sdk/go/command/remote/command.go
@@ -26,6 +26,8 @@ type Command struct {
 	Environment pulumi.StringMapOutput `pulumi:"environment"`
 	// The standard error of the command's process
 	Stderr pulumi.StringOutput `pulumi:"stderr"`
+	// Pass a string to the command's process as standard in
+	Stdin pulumi.StringPtrOutput `pulumi:"stdin"`
 	// The standard output of the command's process
 	Stdout pulumi.StringOutput `pulumi:"stdout"`
 	// Trigger replacements on changes to this input.
@@ -84,6 +86,8 @@ type commandArgs struct {
 	Delete *string `pulumi:"delete"`
 	// Additional environment variables available to the command's process.
 	Environment map[string]string `pulumi:"environment"`
+	// Pass a string to the command's process as standard in
+	Stdin *string `pulumi:"stdin"`
 	// Trigger replacements on changes to this input.
 	Triggers []interface{} `pulumi:"triggers"`
 }
@@ -98,6 +102,8 @@ type CommandArgs struct {
 	Delete pulumi.StringPtrInput
 	// Additional environment variables available to the command's process.
 	Environment pulumi.StringMapInput
+	// Pass a string to the command's process as standard in
+	Stdin pulumi.StringPtrInput
 	// Trigger replacements on changes to this input.
 	Triggers pulumi.ArrayInput
 }
diff --git a/sdk/nodejs/local/command.ts b/sdk/nodejs/local/command.ts
@@ -64,6 +64,10 @@ export class Command extends pulumi.CustomResource {
      * The standard error of the command's process
      */
     public /*out*/ readonly stderr!: pulumi.Output<string>;
+    /**
+     * Pass a string to the command's process as standard in
+     */
+    public readonly stdin!: pulumi.Output<string | undefined>;
     /**
      * The standard output of the command's process
      */
@@ -89,6 +93,7 @@ export class Command extends pulumi.CustomResource {
             resourceInputs["dir"] = args ? args.dir : undefined;
             resourceInputs["environment"] = args ? args.environment : undefined;
             resourceInputs["interpreter"] = args ? args.interpreter : undefined;
+            resourceInputs["stdin"] = args ? args.stdin : undefined;
             resourceInputs["triggers"] = args ? args.triggers : undefined;
             resourceInputs["stderr"] = undefined /*out*/;
             resourceInputs["stdout"] = undefined /*out*/;
@@ -99,6 +104,7 @@ export class Command extends pulumi.CustomResource {
             resourceInputs["environment"] = undefined /*out*/;
             resourceInputs["interpreter"] = undefined /*out*/;
             resourceInputs["stderr"] = undefined /*out*/;
+            resourceInputs["stdin"] = undefined /*out*/;
             resourceInputs["stdout"] = undefined /*out*/;
             resourceInputs["triggers"] = undefined /*out*/;
         }
@@ -134,5 +140,9 @@ export interface CommandArgs {
      * On Linux and macOS, defaults to: `["/bin/sh", "-c"]`. On Windows, defaults to: `["cmd", "/C"]`
      */
     interpreter?: pulumi.Input<pulumi.Input<string>[]>;
+    /**
+     * Pass a string to the command's process as standard in
+     */
+    stdin?: pulumi.Input<string>;
     triggers?: pulumi.Input<any[]>;
 }
diff --git a/sdk/nodejs/remote/command.ts b/sdk/nodejs/remote/command.ts
diff --git a/sdk/python/pulumi_command/local/command.py b/sdk/python/pulumi_command/local/command.py
diff --git a/sdk/python/pulumi_command/remote/command.py b/sdk/python/pulumi_command/remote/command.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+name: command-random-go`
	`2`	`+runtime: go`
	`3`	`+description: A simple command example`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+name: command-random`
	`2`	`+runtime: nodejs`
	`3`	`+description: A simple command example`