Add DialErrorLimit as parameter for remote command (#180)

adrianriobo · web-flow · commit e0d039d1c343 · 2023-02-17T19:31:48.000-05:00
Previously there was a hardcoded value of 10 attempts on dialing the remote host. If all 10 attempts returned an error then command execution would fail. This change enables to adjust the number of attempts when getting an error while dialing, or even to remove the limit to keep retrying until timeout.
diff --git a/examples/ec2_remote/index.ts b/examples/ec2_remote/index.ts
@@ -41,6 +41,13 @@ const connection: types.input.remote.ConnectionArgs = {
     privateKey: privateKey,
 };
 
+const connectionNoDialRetry: types.input.remote.ConnectionArgs = {
+    host: server.publicIp,
+    user: "ec2-user",
+    privateKey: privateKey,
+    dialErrorLimit: -1,
+};
+
 const hostname = new remote.Command("hostname", {
     connection,
     create: "hostname",
@@ -55,6 +62,12 @@ new remote.Command("remotePrivateIP", {
     delete: `rm private_ip.txt`,
 }, { deleteBeforeReplace: true });
 
+new remote.Command("remoteWithNoDialRetryPrivateIP", {
+    connection: connectionNoDialRetry,
+    create: interpolate`echo ${server.privateIp} > private_ip_on_no_dial_retry.txt`,
+    delete: `rm private_ip_on_no_dial_retry.txt`,
+}, { deleteBeforeReplace: true });
+
 new local.Command("localPrivateIP", {
     create: interpolate`echo ${server.privateIp} > private_ip.txt`,
     delete: `rm private_ip.txt`,
diff --git a/provider/cmd/pulumi-resource-command/schema.json b/provider/cmd/pulumi-resource-command/schema.json
@@ -471,6 +471,11 @@
                     "description": "SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.",
                     "type": "string"
                 },
+                "dialErrorLimit": {
+                    "default": 10,
+                    "description": "Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10",
+                    "type": "integer"
+                },
                 "host": {
                     "description": "The address of the resource to connect to.",
                     "type": "string"
diff --git a/provider/pkg/provider/remote/connection.go b/provider/pkg/provider/remote/connection.go
@@ -29,6 +29,8 @@ import (
 
 const (
 	sshAgentSocketEnvVar = "SSH_AUTH_SOCK"
+	DialErrorDefault     = 10
+	DialErrorUnlimited   = -1
 )
 
 type Connection struct {
@@ -39,6 +41,7 @@ type Connection struct {
 	PrivateKey         *string  `pulumi:"privateKey,optional"`
 	PrivateKeyPassword *string  `pulumi:"privateKeyPassword,optional"`
 	AgentSocketPath    *string  `pulumi:"agentSocketPath,optional"`
+	DialErrorLimit     *int     `pulumi:"dialErrorLimit,optional"`
 }
 
 func (c *Connection) Annotate(a infer.Annotator) {
@@ -52,6 +55,8 @@ func (c *Connection) Annotate(a infer.Annotator) {
 	a.Describe(&c.PrivateKey, "The contents of an SSH key to use for the connection. This takes preference over the password if provided.")
 	a.Describe(&c.PrivateKeyPassword, "The password to use in case the private key is encrypted.")
 	a.Describe(&c.AgentSocketPath, "SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.")
+	a.Describe(&c.DialErrorLimit, "Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10")
+	a.SetDefault(&c.DialErrorLimit, DialErrorDefault)
 }
 
 func (con *Connection) SShConfig() (*ssh.ClientConfig, error) {
@@ -109,7 +114,9 @@ func (con *Connection) Dial(ctx p.Context, config *ssh.ClientConfig) (*ssh.Clien
 				net.JoinHostPort(*con.Host, fmt.Sprintf("%.0f", *con.Port)),
 				config)
 			if err != nil {
-				if try > 10 {
+				// on each try we already made a dial
+				dials := try + 1
+				if *con.DialErrorLimit > DialErrorUnlimited && dials > *con.DialErrorLimit {
 					return true, nil, err
 				}
 				return false, nil, nil
diff --git a/sdk/dotnet/Remote/Inputs/ConnectionArgs.cs b/sdk/dotnet/Remote/Inputs/ConnectionArgs.cs
@@ -21,6 +21,12 @@ public sealed class ConnectionArgs : global::Pulumi.ResourceArgs
         [Input("agentSocketPath")]
         public Input<string>? AgentSocketPath { get; set; }
 
+        /// <summary>
+        /// Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10
+        /// </summary>
+        [Input("dialErrorLimit")]
+        public Input<int>? DialErrorLimit { get; set; }
+
         /// <summary>
         /// The address of the resource to connect to.
         /// </summary>
@@ -59,6 +65,7 @@ public sealed class ConnectionArgs : global::Pulumi.ResourceArgs
 
         public ConnectionArgs()
         {
+            DialErrorLimit = 10;
             Port = 22;
             User = "root";
         }
diff --git a/sdk/dotnet/Remote/Outputs/Connection.cs b/sdk/dotnet/Remote/Outputs/Connection.cs
@@ -21,6 +21,10 @@ public sealed class Connection
         /// </summary>
         public readonly string? AgentSocketPath;
         /// <summary>
+        /// Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10
+        /// </summary>
+        public readonly int? DialErrorLimit;
+        /// <summary>
         /// The address of the resource to connect to.
         /// </summary>
         public readonly string Host;
@@ -49,6 +53,8 @@ public sealed class Connection
         private Connection(
             string? agentSocketPath,
 
+            int? dialErrorLimit,
+
             string host,
 
             string? password,
@@ -62,6 +68,7 @@ private Connection(
             string? user)
         {
             AgentSocketPath = agentSocketPath;
+            DialErrorLimit = dialErrorLimit;
             Host = host;
             Password = password;
             Port = port;
diff --git a/sdk/go/command/remote/pulumiTypes.go b/sdk/go/command/remote/pulumiTypes.go
diff --git a/sdk/java/src/main/java/com/pulumi/command/remote/inputs/ConnectionArgs.java b/sdk/java/src/main/java/com/pulumi/command/remote/inputs/ConnectionArgs.java
@@ -7,6 +7,7 @@
 import com.pulumi.core.annotations.Import;
 import com.pulumi.core.internal.Codegen;
 import java.lang.Double;
+import java.lang.Integer;
 import java.lang.String;
 import java.util.Objects;
 import java.util.Optional;
@@ -36,6 +37,21 @@ public Optional<Output<String>> agentSocketPath() {
         return Optional.ofNullable(this.agentSocketPath);
     }
 
+    /**
+     * Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10
+     * 
+     */
+    @Import(name="dialErrorLimit")
+    private @Nullable Output<Integer> dialErrorLimit;
+
+    /**
+     * @return Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10
+     * 
+     */
+    public Optional<Output<Integer>> dialErrorLimit() {
+        return Optional.ofNullable(this.dialErrorLimit);
+    }
+
     /**
      * The address of the resource to connect to.
      * 
@@ -130,6 +146,7 @@ private ConnectionArgs() {}
 
     private ConnectionArgs(ConnectionArgs $) {
         this.agentSocketPath = $.agentSocketPath;
+        this.dialErrorLimit = $.dialErrorLimit;
         this.host = $.host;
         this.password = $.password;
         this.port = $.port;
@@ -177,6 +194,27 @@ public Builder agentSocketPath(String agentSocketPath) {
             return agentSocketPath(Output.of(agentSocketPath));
         }
 
+        /**
+         * @param dialErrorLimit Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10
+         * 
+         * @return builder
+         * 
+         */
+        public Builder dialErrorLimit(@Nullable Output<Integer> dialErrorLimit) {
+            $.dialErrorLimit = dialErrorLimit;
+            return this;
+        }
+
+        /**
+         * @param dialErrorLimit Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10
+         * 
+         * @return builder
+         * 
+         */
+        public Builder dialErrorLimit(Integer dialErrorLimit) {
+            return dialErrorLimit(Output.of(dialErrorLimit));
+        }
+
         /**
          * @param host The address of the resource to connect to.
          * 
@@ -304,6 +342,7 @@ public Builder user(String user) {
         }
 
         public ConnectionArgs build() {
+            $.dialErrorLimit = Codegen.integerProp("dialErrorLimit").output().arg($.dialErrorLimit).def(10).getNullable();
             $.host = Objects.requireNonNull($.host, "expected parameter 'host' to be non-null");
             $.port = Codegen.doubleProp("port").output().arg($.port).def(2.2e+01).getNullable();
             $.user = Codegen.stringProp("user").output().arg($.user).def("root").getNullable();
diff --git a/sdk/java/src/main/java/com/pulumi/command/remote/outputs/Connection.java b/sdk/java/src/main/java/com/pulumi/command/remote/outputs/Connection.java
@@ -5,6 +5,7 @@
 
 import com.pulumi.core.annotations.CustomType;
 import java.lang.Double;
+import java.lang.Integer;
 import java.lang.String;
 import java.util.Objects;
 import java.util.Optional;
@@ -17,6 +18,11 @@ public final class Connection {
      * 
      */
     private @Nullable String agentSocketPath;
+    /**
+     * @return Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10
+     * 
+     */
+    private @Nullable Integer dialErrorLimit;
     /**
      * @return The address of the resource to connect to.
      * 
@@ -56,6 +62,13 @@ private Connection() {}
     public Optional<String> agentSocketPath() {
         return Optional.ofNullable(this.agentSocketPath);
     }
+    /**
+     * @return Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10
+     * 
+     */
+    public Optional<Integer> dialErrorLimit() {
+        return Optional.ofNullable(this.dialErrorLimit);
+    }
     /**
      * @return The address of the resource to connect to.
      * 
@@ -109,6 +122,7 @@ public static Builder builder(Connection defaults) {
     @CustomType.Builder
     public static final class Builder {
         private @Nullable String agentSocketPath;
+        private @Nullable Integer dialErrorLimit;
         private String host;
         private @Nullable String password;
         private @Nullable Double port;
@@ -119,6 +133,7 @@ public Builder() {}
         public Builder(Connection defaults) {
     	      Objects.requireNonNull(defaults);
     	      this.agentSocketPath = defaults.agentSocketPath;
+    	      this.dialErrorLimit = defaults.dialErrorLimit;
     	      this.host = defaults.host;
     	      this.password = defaults.password;
     	      this.port = defaults.port;
@@ -133,6 +148,11 @@ public Builder agentSocketPath(@Nullable String agentSocketPath) {
             return this;
         }
         @CustomType.Setter
+        public Builder dialErrorLimit(@Nullable Integer dialErrorLimit) {
+            this.dialErrorLimit = dialErrorLimit;
+            return this;
+        }
+        @CustomType.Setter
         public Builder host(String host) {
             this.host = Objects.requireNonNull(host);
             return this;
@@ -165,6 +185,7 @@ public Builder user(@Nullable String user) {
         public Connection build() {
             final var o = new Connection();
             o.agentSocketPath = agentSocketPath;
+            o.dialErrorLimit = dialErrorLimit;
             o.host = host;
             o.password = password;
             o.port = port;
diff --git a/sdk/nodejs/types/input.ts b/sdk/nodejs/types/input.ts
@@ -16,6 +16,10 @@ export namespace remote {
          * SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
          */
         agentSocketPath?: pulumi.Input<string>;
+        /**
+         * Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10
+         */
+        dialErrorLimit?: pulumi.Input<number>;
         /**
          * The address of the resource to connect to.
          */
@@ -47,6 +51,7 @@ export namespace remote {
     export function connectionArgsProvideDefaults(val: ConnectionArgs): ConnectionArgs {
         return {
             ...val,
+            dialErrorLimit: (val.dialErrorLimit) ?? 10,
             port: (val.port) ?? 22,
             user: (val.user) ?? "root",
         };
diff --git a/sdk/nodejs/types/output.ts b/sdk/nodejs/types/output.ts
@@ -16,6 +16,10 @@ export namespace remote {
          * SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
          */
         agentSocketPath?: string;
+        /**
+         * Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10
+         */
+        dialErrorLimit?: number;
         /**
          * The address of the resource to connect to.
          */
@@ -47,6 +51,7 @@ export namespace remote {
     export function connectionProvideDefaults(val: Connection): Connection {
         return {
             ...val,
+            dialErrorLimit: (val.dialErrorLimit) ?? 10,
             port: (val.port) ?? 22,
             user: (val.user) ?? "root",
         };
diff --git a/sdk/python/pulumi_command/remote/_inputs.py b/sdk/python/pulumi_command/remote/_inputs.py
diff --git a/sdk/python/pulumi_command/remote/outputs.py b/sdk/python/pulumi_command/remote/outputs.py
