Add backwards-compatibility with sshAuthAgent option

Since d2f92b2, callers may be passing this option in and expect it to be used as the `agent` option for ssh2.
apocas · Apr 22, 2020 · bde24db · bde24db
1 parent 779cdc1
commit bde24db
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/lib/modem.js b/lib/modem.js
@@ -90,6 +90,11 @@ var Modem = function (options) {
   this.headers = opts.headers || {};
   this.sshOptions = Object.assign({}, options ? options.sshOptions : {}, optDefaults.sshOptions);
 
+  // Support sshAuthAgent for backwards-compatibility with d2f92b22cf284d537a57cc255ba11b4c4c5d7b61
+  if (options && options.sshAuthAgent) {
+    this.sshOptions.agent = options.sshAuthAgent;
+  }
+
   if (this.key && this.cert && this.ca) {
     this.protocol = 'https';
   }

diff --git a/test/modem_test.js b/test/modem_test.js
@@ -169,4 +169,14 @@ describe('Modem', function() {
     assert.strictEqual(modem.sshOptions.agent, '/var/lib/sock');
     assert.strictEqual(modem.sshOptions.foo, 'bar');
   });
+
+  it('supports custom sshAuthAgent for backwards-compatibility', function() {
+    process.env.DOCKER_HOST = 'ssh://[email protected]:5555';
+    process.env.SSH_AUTH_SOCK = '/var/lib/sock';
+
+    var modem = new Modem({
+      sshAuthAgent: '/var/lib/custom_agent',
+    });
+    assert.strictEqual(modem.sshOptions.agent, '/var/lib/custom_agent');
+  });
 });