Add labels support #11

Author: npalm

.ci/Dockerfile

@@ -0,0 +1,13 @@
+FROM node:12
+
+WORKDIR /lambda
+
+COPY . /lambda
+
+RUN apt-get update \
+    && apt-get install -y zip \
+    && rm -rf /var/lib/apt/lists/*
+
+RUN yarn install \
+    && yarn run dist
+

.ci/build.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+lambaSrcDirs=("modules/runner-binaries-syncer/lambdas/runner-binaries-syncer" "modules/runners/lambdas/scale-runners" "modules/webhook/lambdas/webhook")
+repoRoot=$(dirname "${BASH_SOURCE[0]}")/..
+
+for lambdaDir in ${lambaSrcDirs[@]}; do
+    cd $repoRoot/${lambdaDir}
+    docker build -t lambda -f ../../../../.ci/Dockerfile .
+    docker create --name lambda lambda
+    zipName=$(basename "$PWD")
+    docker cp lambda:/lambda/${zipName}.zip ${zipName}.zip
+    docker rm lambda
+done

examples/default/main.tf

@@ -29,6 +29,7 @@ module "runners" {
   }
 
   enable_organization_runners = false
+  runner_extra_labels         = "default,example"
 }
 
 

main.tf

@@ -46,10 +46,12 @@ module "runners" {
   s3_bucket_runner_binaries   = module.runner_binaries.bucket
   s3_location_runner_binaries = local.s3_action_runner_url
 
-  sqs                            = aws_sqs_queue.queued_builds
-  github_app                     = var.github_app
-  enable_organization_runners    = var.enable_organization_runners
-  scale_down_schedule_expression = var.scale_down_schedule_expression
+  sqs                             = aws_sqs_queue.queued_builds
+  github_app                      = var.github_app
+  enable_organization_runners     = var.enable_organization_runners
+  scale_down_schedule_expression  = var.scale_down_schedule_expression
+  minimum_running_time_in_minutes = var.minimum_running_time_in_minutes
+  runner_extra_labels             = var.runner_extra_labels
 }
 
 module "runner_binaries" {

modules/runners/lambdas/scale-runners/src/scale-runners/runners.ts

@@ -72,7 +72,7 @@ export async function createRunner(runnerParameters: RunnerInputParameters): Pro
 
   const subnets = (process.env.SUBNET_IDS as string).split(',');
   const randomSubnet = subnets[Math.floor(Math.random() * subnets.length)];
-
+  console.debug('Runner configuration: ' + JSON.stringify(runnerParameters));
   const ec2 = new EC2();
   const runInstancesResponse = await ec2
     .runInstances({

modules/runners/lambdas/scale-runners/src/scale-runners/scale-up.test.ts

@@ -38,6 +38,7 @@ describe('scaleUp', () => {
     process.env.GITHUB_APP_CLIENT_SECRET = 'TEST_CLIENT_SECRET';
     process.env.RUNNERS_MAXIMUM_COUNT = '3';
     process.env.ENVIRONMENT = 'unit-test-environment';
+
     jest.clearAllMocks();
     mockOctokit.actions.listRepoWorkflowRuns.mockImplementation(() => ({
       data: {
@@ -115,7 +116,7 @@ describe('scaleUp', () => {
       await scaleUp('aws:sqs', TEST_DATA);
       expect(createRunner).toBeCalledWith({
         environment: 'unit-test-environment',
-        runnerConfig: `--url https://github.com/${TEST_DATA.repositoryOwner} --token 1234abcd`,
+        runnerConfig: `--url https://github.com/${TEST_DATA.repositoryOwner} --token 1234abcd `,
         orgName: TEST_DATA.repositoryOwner,
         repoName: undefined,
       });
@@ -149,11 +150,12 @@ describe('scaleUp', () => {
       });
     });
 
-    it('creates a runner with correct config', async () => {
+    it('creates a runner with correct config and labels', async () => {
+      process.env.RUNNER_EXTRA_LABELS = 'label1,label2';
       await scaleUp('aws:sqs', TEST_DATA);
       expect(createRunner).toBeCalledWith({
         environment: 'unit-test-environment',
-        runnerConfig: `--url https://github.com/${TEST_DATA.repositoryOwner}/${TEST_DATA.repositoryName} --token 1234abcd`,
+        runnerConfig: `--url https://github.com/${TEST_DATA.repositoryOwner}/${TEST_DATA.repositoryName} --token 1234abcd --labels label1,label2`,
         orgName: undefined,
         repoName: `${TEST_DATA.repositoryOwner}/${TEST_DATA.repositoryName}`,
       });

modules/runners/lambdas/scale-runners/src/scale-runners/scale-up.ts

@@ -36,6 +36,7 @@ export const scaleUp = async (eventSource: string, payload: ActionRequestMessage
   if (eventSource !== 'aws:sqs') throw Error('Cannot handle non-SQS events!');
   const enableOrgLevel = yn(process.env.ENABLE_ORGANIZATION_RUNNERS, { default: true });
   const maximumRunners = parseInt(process.env.RUNNERS_MAXIMUM_COUNT || '3');
+  const runnerExtraLabels = process.env.RUNNER_EXTRA_LABELS;
   const environment = process.env.ENVIRONMENT as string;
   const githubAppAuth = createGithubAppAuth(payload.installationId);
   const githubInstallationClient = await createInstallationClient(githubAppAuth);
@@ -72,11 +73,12 @@ export const scaleUp = async (eventSource: string, payload: ActionRequestMessage
           });
       const token = registrationToken.data.token;
 
+      const labelsArgument = runnerExtraLabels !== undefined ? `--labels ${runnerExtraLabels}` : '';
       await createRunner({
         environment: environment,
         runnerConfig: enableOrgLevel
-          ? `--url https://github.com/${payload.repositoryOwner} --token ${token}`
-          : `--url https://github.com/${payload.repositoryOwner}/${payload.repositoryName} --token ${token}`,
+          ? `--url https://github.com/${payload.repositoryOwner} --token ${token} ${labelsArgument}`
+          : `--url https://github.com/${payload.repositoryOwner}/${payload.repositoryName} --token ${token} ${labelsArgument}`,
         orgName: enableOrgLevel ? payload.repositoryOwner : undefined,
         repoName: enableOrgLevel ? undefined : `${payload.repositoryOwner}/${payload.repositoryName}`,
       });

modules/runners/scale-up.tf

@@ -10,6 +10,7 @@ resource "aws_lambda_function" "scale_up" {
   environment {
     variables = {
       ENABLE_ORGANIZATION_RUNNERS = var.enable_organization_runners
+      RUNNER_EXTRA_LABELS         = var.runner_extra_labels
       GITHUB_APP_KEY_BASE64       = var.github_app.key_base64
       GITHUB_APP_ID               = var.github_app.id
       GITHUB_APP_CLIENT_ID        = var.github_app.client_id

modules/runners/variables.tf

@@ -120,3 +120,9 @@ variable "minimum_running_time_in_minutes" {
   type        = number
   default     = 5
 }
+
+variable "runner_extra_labels" {
+  description = "Extra labels for the runners (GitHub). Separate each label by a comma"
+  type        = string
+  default     = ""
+}

variables.tf

@@ -51,3 +51,9 @@ variable "minimum_running_time_in_minutes" {
   type        = number
   default     = 5
 }
+
+variable "runner_extra_labels" {
+  description = "Extra labels for the runners (GitHub). Separate each label by a comma"
+  type        = string
+  default     = ""
+}