add option to skip dependency installation

apt-get is not available on certain distributions so it's better to have
the option to leave it out so we can still have the ability to run this
action without having to be on ubuntu.

Signed-off-by: Eli Uriegas <[email protected]>

Author: seemethere

action.yml

@@ -11,6 +11,10 @@ inputs:
     description: 'If apt should be executed with sudo or without'
     required: false
     default: 'true'
+  install_dependencies:
+    description: 'Whether or not to install dependencies for tmate on linux (openssh-client, xz-utils)'
+    required: false
+    default: 'true'
   limit-access-to-actor:
     description: 'If only the public SSH keys of the user triggering the workflow should be authorized'
     required: false
@@ -30,4 +34,4 @@ inputs:
   tmate-server-ed25519-fingerprint:
     description: 'The ed25519 fingerprint for your tmate server'
     required: false
-    default: ''
+    default: ''

lib/index.js

@@ -10317,6 +10317,11 @@ const TMATE_ARCH_MAP = {
 /** @param {number} ms */
 const sleep = (ms) => new Promise(resolve => setTimeout(resolve, ms));
 
+async function installDependenciesLinux(optionalSudoPrefix='sudo') {
+  await execShellCommand(optionalSudoPrefix + 'apt-get update');
+  await execShellCommand(optionalSudoPrefix + 'apt-get install -y openssh-client xz-utils');
+}
+
 async function run() {
   const optionalSudoPrefix = core.getInput('sudo') === "true" ? "sudo " : "";
   try {
@@ -10328,8 +10333,9 @@ async function run() {
       await execShellCommand('pacman -Sy --noconfirm tmate');
       tmateExecutable = 'CHERE_INVOKING=1 tmate'
     } else {
-      await execShellCommand(optionalSudoPrefix + 'apt-get update');
-      await execShellCommand(optionalSudoPrefix + 'apt-get install -y openssh-client xz-utils');
+      if (core.getInput('install_dependencies') === "true") {
+        await installDependenciesLinux(optionalSudoPrefix);
+      }
 
       const tmateArch = TMATE_ARCH_MAP[external_os_default().arch()];
       if (!tmateArch) {

src/index.js

@@ -24,6 +24,11 @@ const TMATE_ARCH_MAP = {
 /** @param {number} ms */
 const sleep = (ms) => new Promise(resolve => setTimeout(resolve, ms));
 
+export async function installDependenciesLinux(optionalSudoPrefix='sudo') {
+  await execShellCommand(optionalSudoPrefix + 'apt-get update');
+  await execShellCommand(optionalSudoPrefix + 'apt-get install -y openssh-client xz-utils');
+}
+
 export async function run() {
   const optionalSudoPrefix = core.getInput('sudo') === "true" ? "sudo " : "";
   try {
@@ -35,8 +40,9 @@ export async function run() {
       await execShellCommand('pacman -Sy --noconfirm tmate');
       tmateExecutable = 'CHERE_INVOKING=1 tmate'
     } else {
-      await execShellCommand(optionalSudoPrefix + 'apt-get update');
-      await execShellCommand(optionalSudoPrefix + 'apt-get install -y openssh-client xz-utils');
+      if (core.getInput('install_dependencies') === "true") {
+        await installDependenciesLinux(optionalSudoPrefix);
+      }
 
       const tmateArch = TMATE_ARCH_MAP[os.arch()];
       if (!tmateArch) {

src/index.test.js

@@ -41,7 +41,7 @@ describe('Tmate GitHub integration', () => {
     Object.defineProperty(process, "platform", {
       value: "linux"
     })
-    core.getInput.mockReturnValueOnce("true").mockReturnValue("false")
+    core.getInput.mockReturnValueOnce("true").mockReturnValueOnce("true").mockReturnValue("false")
     const customConnectionString = "foobar"
     execShellCommand.mockReturnValue(Promise.resolve(customConnectionString))
     await run()
@@ -54,7 +54,7 @@ describe('Tmate GitHub integration', () => {
     Object.defineProperty(process, "platform", {
       value: "linux"
     })
-    core.getInput.mockReturnValue("false")
+    core.getInput.mockReturnValueOnce("false").mockReturnValueOnce("true").mockReturnValue("false")
     const customConnectionString = "foobar"
     execShellCommand.mockReturnValue(Promise.resolve(customConnectionString))
     await run()
@@ -63,6 +63,19 @@ describe('Tmate GitHub integration', () => {
     expect(core.info).toHaveBeenNthCalledWith(2, `SSH: ${customConnectionString}`);
     expect(core.info).toHaveBeenNthCalledWith(3, "Exiting debugging session because the continue file was created");
   });
+  it('should be handle the main loop for linux without installing dependencies', async () => {
+    Object.defineProperty(process, "platform", {
+      value: "linux"
+    })
+    core.getInput.mockReturnValue("false")
+    const customConnectionString = "foobar"
+    execShellCommand.mockReturnValue(Promise.resolve(customConnectionString))
+    await run()
+    expect(execShellCommand).not.toHaveBeenNthCalledWith(1, "apt-get update")
+    expect(core.info).toHaveBeenNthCalledWith(1, `Web shell: ${customConnectionString}`);
+    expect(core.info).toHaveBeenNthCalledWith(2, `SSH: ${customConnectionString}`);
+    expect(core.info).toHaveBeenNthCalledWith(3, "Exiting debugging session because the continue file was created");
+  });
   it('should install tmate via brew for darwin', async () => {
     Object.defineProperty(process, "platform", {
       value: "darwin"