Bitbucket runner support (#798)

* Bitbucket runner support

* docker

* remove docker.sh

* remove redundant

* DUMMY

* restore register

* fix test

* revert package-lock

* revert correctly package-lock

* gentle poll

* warn workdir and verbose docker command

* single

* Add `bitbucket` to `cml runner --driver` values

Co-authored-by: Helio Machado <[email protected]>

Author: DavidGOrtega

bin/cml/runner.js

@@ -229,6 +229,10 @@ const runLocal = async (opts) => {
       RUNNER_JOBS_RUNNING = RUNNER_JOBS_RUNNING.filter(
         (job) => job.id !== jobId
       );
+
+      if (single && cml.driver === 'bitbucket') {
+        await shutdown({ ...opts, reason: 'single job' });
+      }
     }
   };
 
@@ -396,7 +400,10 @@ const run = async (opts) => {
   try {
     winston.info(`Preparing workdir ${workdir}...`);
     await fs.mkdir(workdir, { recursive: true });
-  } catch (err) {}
+    await fs.chmod(workdir, '766');
+  } catch (err) {
+    winston.warn(err.message);
+  }
 
   if (cloud) await runCloud(opts);
   else await runLocal(opts);
@@ -470,7 +477,7 @@ exports.builder = (yargs) =>
       },
       driver: {
         type: 'string',
-        choices: ['github', 'gitlab'],
+        choices: ['github', 'gitlab', 'bitbucket'],
         description:
           'Platform where the repository is hosted. If not specified, it will be inferred from the environment'
       },

bin/cml/runner.test.js

@@ -87,7 +87,7 @@ describe('CML e2e', () => {
         --driver                                  Platform where the repository is
                                                   hosted. If not specified, it will be
                                                   inferred from the environment
-                                                [string] [choices: \\"github\\", \\"gitlab\\"]
+                                   [string] [choices: \\"github\\", \\"gitlab\\", \\"bitbucket\\"]
         --repo                                    Repository to be used for
                                                   registering the runner. If not
                                                   specified, it will be inferred from

src/cml.js

@@ -281,7 +281,6 @@ class CML {
           log.job = id;
           log.status = 'job_ended';
           log.success = data.includes('Succeeded');
-          log.level = log.success ? 'info' : 'error';
         } else if (data.includes('Listening for Jobs')) {
           log.status = 'ready';
         }
@@ -299,12 +298,30 @@ class CML {
         } else if (duration) {
           log.status = 'job_ended';
           log.success = msg.includes('Job succeeded');
-          log.level = log.success ? 'info' : 'error';
         } else if (msg.includes('Starting runner for')) {
           log.status = 'ready';
         }
         return log;
       }
+
+      if (this.driver === BB) {
+        const id = 'bb';
+        if (data.includes('Getting step StepId{accountUuid={')) {
+          log.job = id;
+          log.status = 'job_started';
+        } else if (
+          data.includes('Completing step with result Result{status=')
+        ) {
+          log.job = id;
+          log.status = 'job_ended';
+          log.success = data.includes('status=PASSED');
+        } else if (data.includes('Updating runner status to "ONLINE"')) {
+          log.status = 'ready';
+        }
+
+        log.level = log.success ? 'info' : 'error';
+        return log.status ? log : null;
+      }
     } catch (err) {
       winston.warn(`Failed parsing log: ${err.message}`);
       winston.warn(

src/drivers/bitbucket_cloud.js

@@ -2,10 +2,11 @@ const crypto = require('crypto');
 const fetch = require('node-fetch');
 const winston = require('winston');
 const { URL } = require('url');
+const { spawn } = require('child_process');
 const FormData = require('form-data');
 const ProxyAgent = require('proxy-agent');
 
-const { fetchUploadData } = require('../utils');
+const { fetchUploadData, exec, gpuPresent, sleep } = require('../utils');
 
 const { BITBUCKET_COMMIT, BITBUCKET_BRANCH, BITBUCKET_PIPELINE_UUID } =
   process.env;
@@ -118,19 +119,112 @@ class BitbucketCloud {
   }
 
   async runnerToken() {
-    throw new Error('Bitbucket Cloud does not support runnerToken!');
+    return 'DUMMY';
+  }
+
+  async startRunner(opts) {
+    const { projectPath } = this;
+    const { workdir, name, labels } = opts;
+
+    winston.warn(
+      `Bitbucket runner is working under /tmp folder and not under ${workdir} as expected`
+    );
+
+    try {
+      const { uuid: accountId } = await this.request({ endpoint: `/user` });
+      const { uuid: repoId } = await this.request({
+        endpoint: `/repositories/${projectPath}`
+      });
+      const {
+        uuid,
+        oauth_client: { id, secret }
+      } = await this.registerRunner({ name, labels });
+
+      const gpu = await gpuPresent();
+      const command = `docker container run -t -a stderr -a stdout --rm \
+      -v /var/run/docker.sock:/var/run/docker.sock \
+      -v /var/lib/docker/containers:/var/lib/docker/containers:ro \
+      -v /tmp:/tmp \
+      -e ACCOUNT_UUID=${accountId} \
+      -e REPOSITORY_UUID=${repoId} \
+      -e RUNNER_UUID=${uuid} \
+      -e OAUTH_CLIENT_ID=${id} \
+      -e OAUTH_CLIENT_SECRET=${secret} \
+      -e WORKING_DIRECTORY=/tmp \
+      --name ${name} \
+      ${gpu ? '--runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=all' : ''} \
+      docker-public.packages.atlassian.com/sox/atlassian/bitbucket-pipelines-runner:1`;
+
+      return spawn(command, { shell: true });
+    } catch (err) {
+      throw new Error(`Failed preparing runner: ${err.message}`);
+    }
   }
 
   async registerRunner(opts = {}) {
-    throw new Error('Bitbucket Cloud does not support registerRunner!');
+    const { projectPath } = this;
+    const { name, labels } = opts;
+
+    const endpoint = `/repositories/${projectPath}/pipelines-config/runners`;
+
+    const request = await this.request({
+      api: 'https://api.bitbucket.org/internal',
+      endpoint,
+      method: 'POST',
+      body: JSON.stringify({
+        labels: ['self.hosted'].concat(labels.split(',')),
+        name
+      })
+    });
+
+    let registered = false;
+    while (!registered) {
+      await sleep(1);
+      const runner = (await this.runners()).find(
+        (runner) => runner.name === name
+      );
+      if (runner) registered = true;
+    }
+
+    return request;
   }
 
   async unregisterRunner(opts = {}) {
-    throw new Error('Bitbucket Cloud does not support unregisterRunner!');
+    const { projectPath } = this;
+    const { runnerId, name } = opts;
+    const endpoint = `/repositories/${projectPath}/pipelines-config/runners/${runnerId}`;
+
+    try {
+      await this.request({
+        api: 'https://api.bitbucket.org/internal',
+        endpoint,
+        method: 'DELETE'
+      });
+    } catch (err) {
+      if (!err.message.includes('invalid json response body')) {
+        throw err;
+      }
+    } finally {
+      await exec(`docker stop ${name}`);
+    }
   }
 
   async runners(opts = {}) {
-    throw new Error('Bitbucket Cloud does not support runners!');
+    const { projectPath } = this;
+
+    const endpoint = `/repositories/${projectPath}/pipelines-config/runners`;
+    const runners = await this.paginatedRequest({
+      api: 'https://api.bitbucket.org/internal',
+      endpoint
+    });
+
+    return runners.map(({ uuid: id, name, labels, state: { status } }) => ({
+      id,
+      name,
+      labels,
+      online: status === 'ONLINE',
+      busy: status === 'ONLINE'
+    }));
   }
 
   async runnerById(opts = {}) {
@@ -269,6 +363,16 @@ class BitbucketCloud {
     }
   }
 
+  async pipelineRestart(opts = {}) {
+    winston.warn('BitBucket Cloud does not support workflowRestart yet!');
+  }
+
+  async pipelineJobs(opts = {}) {
+    winston.warn('BitBucket Cloud does not support pipelineJobs yet!');
+
+    return [];
+  }
+
   async pipelineRerun(opts = {}) {
     const { projectPath } = this;
     const { id = BITBUCKET_PIPELINE_UUID } = opts;
@@ -290,14 +394,6 @@ class BitbucketCloud {
     });
   }
 
-  async pipelineRestart(opts = {}) {
-    throw new Error('BitBucket Cloud does not support workflowRestart!');
-  }
-
-  async pipelineJobs(opts = {}) {
-    throw new Error('Not implemented');
-  }
-
   async updateGitConfig({ userName, userEmail } = {}) {
     const [user, password] = Buffer.from(this.token, 'base64')
       .toString('utf-8')
@@ -351,8 +447,8 @@ class BitbucketCloud {
   }
 
   async request(opts = {}) {
-    const { token, api } = this;
-    const { url, endpoint, method = 'GET', body } = opts;
+    const { token } = this;
+    const { url, endpoint, method = 'GET', body, api = this.api } = opts;
 
     if (!(url || endpoint))
       throw new Error('Bitbucket Cloud API endpoint not found');
@@ -362,8 +458,6 @@ class BitbucketCloud {
       headers['Content-Type'] = 'application/json';
 
     const requestUrl = url || `${api}${endpoint}`;
-    winston.debug(`${method} ${requestUrl}`);
-
     const response = await fetch(requestUrl, {
       method,
       headers,

src/drivers/bitbucket_cloud.test.js

@@ -35,9 +35,8 @@ describe('Non Enviromental tests', () => {
   });
 
   test('Runner token', async () => {
-    await expect(client.runnerToken()).rejects.toThrow(
-      'Bitbucket Cloud does not support runnerToken!'
-    );
+    const token = await client.runnerToken();
+    await expect(token).toBe('DUMMY');
   });
 
   test('updateGitConfig', async () => {

src/drivers/github.js

@@ -263,7 +263,6 @@ class Github {
         )}.tar.gz`;
         await download({ url, path: destination });
         await tar.extract({ file: destination, cwd: workdir });
-        await exec(`chmod -R 777 ${workdir}`);
       }
 
       await exec(

src/drivers/gitlab.js

@@ -9,7 +9,7 @@ const ProxyAgent = require('proxy-agent');
 const { backOff } = require('exponential-backoff');
 const winston = require('winston');
 
-const { fetchUploadData, download, exec } = require('../utils');
+const { fetchUploadData, download, gpuPresent } = require('../utils');
 
 const { IN_DOCKER, CI_PIPELINE_ID } = process.env;
 const API_VER = 'v4';
@@ -173,16 +173,7 @@ class Gitlab {
       dockerVolumes = []
     } = opts;
 
-    let gpu = true;
-    try {
-      await exec('nvidia-smi');
-    } catch (err) {
-      try {
-        await exec('cuda-smi');
-      } catch (err) {
-        gpu = false;
-      }
-    }
+    const gpu = await gpuPresent();
 
     try {
       const bin = resolve(workdir, 'gitlab-runner');

src/utils.js

@@ -164,6 +164,21 @@ const sshConnection = async (opts) => {
   return ssh;
 };
 
+const gpuPresent = async () => {
+  let gpu = true;
+  try {
+    await exec('nvidia-smi');
+  } catch (err) {
+    try {
+      await exec('cuda-smi');
+    } catch (err) {
+      gpu = false;
+    }
+  }
+
+  return gpu;
+};
+
 exports.exec = exec;
 exports.fetchUploadData = fetchUploadData;
 exports.upload = upload;
@@ -173,3 +188,4 @@ exports.isProcRunning = isProcRunning;
 exports.watermarkUri = watermarkUri;
 exports.download = download;
 exports.sshConnection = sshConnection;
+exports.gpuPresent = gpuPresent;