Feature/docker container (#3)

Allow the script to run in containers.

Author: jonpugh

.github/workflows/demo.yml

@@ -0,0 +1,17 @@
+name: Demo
+on:
+  push:
+    branches: [ "feature/docker-container" ]
+  workflow_dispatch:
+
+jobs:
+  demo:
+    name: Demonstrate runner
+    runs-on: runner@localhost.runner
+    steps:
+      - name: Debug
+        run: |
+          echo "Who am I: $(whoami)"
+          echo "Hostname: $(hostname -f)"
+          echo "Environment:"
+          env

Dockerfile

@@ -0,0 +1,23 @@
+# This is for testing and development only.
+# SSHD must be installed before running the playbook.
+FROM geerlingguy/docker-${MOLECULE_DISTRO:-rockylinux8}-ansible:latest
+
+RUN useradd runner
+RUN yum install -y \
+    git \
+    jq
+
+# This codebase. The runner wrapper script.
+COPY ./ /github-runner
+WORKDIR /github-runner
+RUN chown runner:runner . -R
+
+# GitHub Runner code.
+# Install runner to a path that won't ever be in a volume.
+ENV RUNNER_PATH /usr/share/github-runner
+# We are installing as root then switching back because we need to use the install-dependencies script.
+RUN ./github-runner --no-run --no-config --runner-path=${RUNNER_PATH}
+RUN ${RUNNER_PATH}/bin/installdependencies.sh
+RUN chown runner:runner ${RUNNER_PATH} -R
+
+USER runner

docker-compose.yml

@@ -0,0 +1,15 @@
+# For testing and development.
+
+---
+services:
+  runner:
+#    image: geerlingguy/docker-${MOLECULE_DISTRO:-rockylinux8}-ansible:latest
+    image: jonpugh/github-runner
+    hostname: ${DOCKER_HOSTNAME:-localhost.runner}
+    volumes:
+      - ./:/github-runner
+    environment:
+      GITHUB_TOKEN: ${GITHUB_TOKEN}
+      GITHUB_REPOSITORY: jonpugh/github-runner
+    entrypoint: /github-runner/github-runner
+    build: ./

github-runner

@@ -22,15 +22,21 @@ start() {
     say Launching runner with run.sh ...
     line
     cd $RUNNER_FOLDER
-    ./run.sh
+
+    # Run.sh in a new process.
+    ./run.sh &
+    RUNNER_PID=$!
+    say "Run.sh PID: $RUNNER_PID"
+    wait $RUNNER_PID
+
   else
     say Launching runner with run.sh ... SKIPPED.
     say Exiting github-runner.
   fi
 
 }
 welcome() {
-  say "GitHub Runner | ${RUNNER_SCRIPT_PATH}"
+  say "GitHub Runner"
   say Welcome! This script will:
   say 1. Install Runner
   say 2. Configure Runner
@@ -67,11 +73,17 @@ verify() {
     RUNNER_SCRIPT_ENV_FILE_STATUS="(Not found)"
   fi
 
-  # Detect composer usage.
+  # Detect path to this script.
+  # @TODO: Rename RUNNER_SCRIPT_ to reduce confusion with github runner CLI
   if [[ -z "$COMPOSER_RUNTIME_BIN_DIR" ]]; then
-    RUNNER_SCRIPT_PATH="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+    RUNNER_SCRIPT_PATH="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )/github-runner"
   else
-    RUNNER_SCRIPT_PATH="$COMPOSER_RUNTIME_BIN_DIR"
+    RUNNER_SCRIPT_PATH="$COMPOSER_RUNTIME_BIN_DIR/github-runner"
+  fi
+  if [[ ! -f "${RUNNER_SCRIPT_PATH}" ]]; then
+     say "Path detection failed."
+     say "No file found at ${RUNNER_SCRIPT_PATH}"
+     exit 1
   fi
   RUNNER_SCRIPT_DIR=$(dirname $RUNNER_SCRIPT_PATH)
 
@@ -140,27 +152,35 @@ verify() {
   line
   welcome
 
-  if [[ -z "${GITHUB_REPOSITORY}" ]]; then
-    line
-    say GITHUB_REPOSITORY is required. Use --repo or set the environment variable.
-    exit 1
-  fi
-
-  # Add name to labels.
-  RUNNER_CONFIG_LABELS="${RUNNER_CONFIG_LABELS},${RUNNER_CONFIG_NAME}"
-
-  # Gather API token to create runners.
-  if [[ -z "${GITHUB_TOKEN}" ]]; then
-    line
-    say GITHUB_TOKEN is required. Use --token or set the environment variable.
-    say Create a 'Personal Access Token' owned by the organization, with 'admin:write' access on this repository
-    say https://github.com/settings/personal-access-tokens/new
-    line
-    exit 1
+  if [[ -n "${RUNNER_CONFIG}" ]]; then
+    if [[ -z "${GITHUB_REPOSITORY}" ]]; then
+      line
+      say GITHUB_REPOSITORY is required. Use --repo or set the environment variable.
+      exit 1
+    fi
+
+    # Add name to labels.
+    RUNNER_CONFIG_LABELS="${RUNNER_CONFIG_LABELS},${RUNNER_CONFIG_NAME}"
+
+    # Gather API token to create runners.
+    if [[ -z "${GITHUB_TOKEN}" ]]; then
+      line
+      say GITHUB_TOKEN is required. Use --token or set the environment variable.
+      say Create a 'Personal Access Token' owned by the organization, with 'admin:write' access on this repository
+      say https://github.com/settings/personal-access-tokens/new
+      line
+      exit 1
+    fi
   fi
 
   # Prepare runner dir.
   line
+  say "User: $(whoami)"
+  say "Host: $(hostname -f)"
+  say "Current directory: $(pwd)"
+  say "Runner download path: $RUNNER_PATH"
+  line
+
   if [[ ! -d $RUNNER_PATH ]]; then
     mkdir -p $RUNNER_PATH
     RUNNER_FOLDER=$(realpath $RUNNER_PATH)
@@ -170,6 +190,9 @@ verify() {
     say Found folder: $RUNNER_FOLDER
   fi
 
+  line
+  info
+
   # getNewToken.
   line
   RESPONSE=$(curl -L \
@@ -248,13 +271,15 @@ configure() {
 }
 
 stop() {
-  say "Stopped."
+  say "Stopped. Run.sh PID: $RUNNER_PID"
+  kill $RUNNER_PID
   ./config.sh remove --token ${RUNNER_CONFIG_TOKEN} || say "config remove didn't work."
 
   exit 0
 }
 cancel() {
-  echo
+  say "Cancelled. Run.sh PID: $RUNNER_PID"
+  kill $RUNNER_PID
   if [[ "${RUNNER_CLEANUP}" == "yes" ]]; then
     say "Cancelled. Removing $RUNNER_FOLDER..."
     rm -rf $RUNNER_FOLDER