Merge pull request #51 from yc-actions/feature/ssh

add params to enable ssh login to the runner

Author: nikolaymatrosov

__tests__/__snapshots__/main.test.ts.snap

@@ -0,0 +1,73 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`cloud-init default 1`] = `
+[
+  "#!/bin/bash",
+  "mkdir actions-runner && cd actions-runner",
+  "case $(uname -m) in aarch64) ARCH="arm64" ;; amd64|x86_64) ARCH="x64" ;; esac && export RUNNER_ARCH=\${ARCH}",
+  "curl -O -L https://github.com/actions/runner/releases/download/v2.299.1/actions-runner-linux-\${RUNNER_ARCH}-2.299.1.tar.gz",
+  "tar xzf ./actions-runner-linux-\${RUNNER_ARCH}-2.299.1.tar.gz",
+  "export RUNNER_ALLOW_RUNASROOT=1",
+  "./config.sh --url https://github.com/owner/repo --token githubRegistrationToken --labels label",
+  "./run.sh",
+]
+`;
+
+exports[`cloud-init with home dir 1`] = `
+[
+  "#!/bin/bash",
+  "cd "foo"",
+  "export RUNNER_ALLOW_RUNASROOT=1",
+  "./config.sh --url https://github.com/owner/repo --token githubRegistrationToken --labels label",
+  "./run.sh",
+]
+`;
+
+exports[`cloud-init with home dir and user and ssh key 1`] = `
+[
+  "#cloud-config",
+  "ssh_pwauth: 'no'",
+  "users:",
+  "  - name: user",
+  "    sudo: ALL=(ALL) NOPASSWD:ALL",
+  "    shell: /bin/bash",
+  "    ssh_authorized_keys:",
+  "      - key",
+  "runcmd:",
+  "  - cd "foo"",
+  "  - export RUNNER_ALLOW_RUNASROOT=1",
+  "  - >-",
+  "    ./config.sh --url https://github.com/owner/repo --token",
+  "    githubRegistrationToken --labels label",
+  "  - ./run.sh",
+  "",
+]
+`;
+
+exports[`cloud-init with user and ssh key 1`] = `
+[
+  "#cloud-config",
+  "ssh_pwauth: 'no'",
+  "users:",
+  "  - name: user",
+  "    sudo: ALL=(ALL) NOPASSWD:ALL",
+  "    shell: /bin/bash",
+  "    ssh_authorized_keys:",
+  "      - key",
+  "runcmd:",
+  "  - mkdir actions-runner && cd actions-runner",
+  "  - >-",
+  "    case $(uname -m) in aarch64) ARCH="arm64" ;; amd64|x86_64) ARCH="x64" ;;",
+  "    esac && export RUNNER_ARCH=\${ARCH}",
+  "  - >-",
+  "    curl -O -L",
+  "    https://github.com/actions/runner/releases/download/v2.299.1/actions-runner-linux-\${RUNNER_ARCH}-2.299.1.tar.gz",
+  "  - tar xzf ./actions-runner-linux-\${RUNNER_ARCH}-2.299.1.tar.gz",
+  "  - export RUNNER_ALLOW_RUNASROOT=1",
+  "  - >-",
+  "    ./config.sh --url https://github.com/owner/repo --token",
+  "    githubRegistrationToken --labels label",
+  "  - ./run.sh",
+  "",
+]
+`;

__tests__/config.test.ts

@@ -21,6 +21,8 @@ test('basic Config ', () => {
       secondDiskImageId: '',
       secondDiskType: '',
       secondDiskSize: 0,
+      user: '',
+      sshPublicKey: '',
       resourcesSpec: {
         cores: 1,
         memory: 10 * 1024 ** 3,
@@ -49,6 +51,8 @@ test('add secondary disk', () => {
       secondDiskImageId: 'secondDiskImageId',
       secondDiskType: 'secondDiskType',
       secondDiskSize: parseMemory('30Gb'),
+      user: '',
+      sshPublicKey: '',
       resourcesSpec: {
         cores: 1,
         memory: parseMemory('8Gb'),
@@ -77,6 +81,8 @@ test('add secondary disk without image-id throw error', () => {
       secondDiskImageId: '',
       secondDiskType: 'secondDiskType',
       secondDiskSize: parseMemory('30Gb'),
+      user: 'user',
+      sshPublicKey: 'sshPublicKey',
       resourcesSpec: {
         cores: 1,
         memory: parseMemory('8Gb'),

__tests__/main.test.ts

@@ -1,7 +1,8 @@
+import {describe, test, expect} from '@jest/globals';
 import * as cp from 'child_process';
 import * as path from 'path';
 import * as process from 'process';
-import {test} from '@jest/globals';
+import {buildUserDataScript} from '../src/main';
 
 // This test will run only in fully configured env and creates real VM
 // in the Yandex Cloud, so it will be disabled in CI/CD. You can enable it to test locally.
@@ -22,3 +23,65 @@ test.skip('test runs', () => {
   }
   console.log(res?.toString());
 });
+
+describe('cloud-init', () => {
+  test('default', () => {
+    const actual = buildUserDataScript({
+      githubRegistrationToken: 'githubRegistrationToken',
+      label: 'label',
+      owner: 'owner',
+      repo: 'repo',
+      runnerHomeDir: '',
+      user: '',
+      sshPublicKey: '',
+    });
+    expect(actual.length).toBe(8);
+    expect(actual).toMatchSnapshot();
+    expect(actual[0]).toBe('#!/bin/bash');
+  });
+
+  test('with home dir', () => {
+    const actual = buildUserDataScript({
+      githubRegistrationToken: 'githubRegistrationToken',
+      label: 'label',
+      owner: 'owner',
+      repo: 'repo',
+      runnerHomeDir: 'foo',
+      user: '',
+      sshPublicKey: '',
+    });
+    expect(actual.length).toBe(5);
+    expect(actual).toMatchSnapshot();
+    expect(actual[0]).toBe('#!/bin/bash');
+  });
+
+  test('with user and ssh key', () => {
+    const actual = buildUserDataScript({
+      githubRegistrationToken: 'githubRegistrationToken',
+      label: 'label',
+      owner: 'owner',
+      repo: 'repo',
+      runnerHomeDir: '',
+      user: 'user',
+      sshPublicKey: 'key',
+    });
+    expect(actual.length).toBe(23);
+    expect(actual).toMatchSnapshot();
+    expect(actual[0]).toBe('#cloud-config');
+  });
+
+  test('with home dir and user and ssh key', () => {
+    const actual = buildUserDataScript({
+      githubRegistrationToken: 'githubRegistrationToken',
+      label: 'label',
+      owner: 'owner',
+      repo: 'repo',
+      runnerHomeDir: 'foo',
+      user: 'user',
+      sshPublicKey: 'key',
+    });
+    expect(actual.length).toBe(16);
+    expect(actual).toMatchSnapshot();
+    expect(actual[0]).toBe('#cloud-config');
+  });
+});

action.yml

@@ -83,6 +83,13 @@ inputs:
     required: false
     description: 'Compute platform Id'
     default: 'standard-v3'
+
+  user:
+    required: false
+    description: 'User name to login with via ssh'
+  ssh-public-key:
+    required: false
+    description: 'Public SSH key to login with'
 outputs:
   label:
     description: >-