strider-git/lib/index.js

Strider provider for git repositories

'use strict';

var debug = require('debug')('strider-git');
var execFile = require('child_process').execFile;
var shellescape = require('shell-escape');

module.exports = {
  gitUrl: gitUrl,
  sshUrl: sshUrl,
  httpUrl: httpUrl,
  gitCmd: gitCmd,
  gitaneCmd: gitaneCmd,
  processBranches: processBranches,
  getBranches: getBranches,
  shellEscape: shellEscape,
};

function gitane(context) {
  if (context && context.runnerId == 'docker') {
    return require('strider-docker-gitane-camo');
  } else {
    return require('gitane');
  }
}

function shellEscape(one) {
  if (!one) {
    throw new Error('trying to escape nothing', one);
  }

  return shellescape([one]);
}

// returns [real, safe] urls
function gitUrl(config) {
  return (config.auth.type === 'ssh' ? sshUrl : httpUrl)(config);
}

/**
 * TODO: validate all git urls. Currently only http(s):// and ssh are
 * supported.
 *
 * List from http://git-scm.com/docs/git-clone#_git_urls_a_id_urls_a
 * ssh://[user@]host.xz[:port]/path/to/repo.git/
 * git://host.xz[:port]/path/to/repo.git/
 * http[s]://host.xz[:port]/path/to/repo.git/
 * ftp[s]://host.xz[:port]/path/to/repo.git/
 * rsync://host.xz/path/to/repo.git/
 */

function sshUrl(config) {
  var base = config.url;

  if (base.indexOf('ssh://') === 0) {
    return [base, base];
  }
  if (base.indexOf('//') !== -1) {
    base = base.split('//')[1];
  }
  if (base.indexOf('@') === -1) {
    base = `git@${base}`;
  }
  if (base.indexOf(':') === -1) {
    base = base.replace('/', ':');
  }

  var url = shellEscape(base);
  return [url, url];
}

function httpUrl(config) {
  var base = config.url;

  if (base.indexOf('//') !== -1) {
    base = base.split('//')[1];
  }

  var url = `${config.auth.type}://${encodeURIComponent(
    config.auth.username
  )}:${config.auth.password}@${base}`;
  var safe = `${config.auth.type}://[username]:[password]@${base}`;

  return [url, safe];
}

function gitCmd(cmd, cwd, auth, context, done) {
  if (auth.type === 'ssh') {
    return gitaneCmd(cmd, cwd, auth.privkey, context, done);
  }

  context.cmd(
    {
      cmd: cmd,
      cwd: cwd,
    },
    done
  );
}

// run a strider command with gitane
function gitaneCmd(cmd, dest, privkey, context, done) {
  var start = new Date();

  context.status('command.start', {
    command: cmd,
    time: start,
    plugin: context.plugin,
  });

  gitane(context).run(
    {
      emitter: {
        emit: context.status,
      },
      cmd: cmd,
      spawn: context.runCmd,
      baseDir: dest,
      privKey: privkey,
      detached: true,
      contextCmd: context.cmd,
    },
    function (err, stdout, stderr, exitCode) {
      var end = new Date();
      var elapsed = end.getTime() - start.getTime();

      if (err) {
        debug(`Gitane error: ${err.stack || err.message || err}`);
      }

      debug(
        `gitane command done ${cmd}; exit code ${exitCode}; duration ${elapsed}`
      );
      context.status('command.done', {
        exitCode: exitCode,
        time: end,
        elapsed: elapsed,
      });

      if (err && exitCode === undefined) {
        return done(500);
      }

      done(exitCode, stdout + stderr);
    }
  );
}

function processBranches(data, done) {
  done(
    null,
    data
      .trim()
      .split(/\n+/)
      .map(function (line) {
        return line.split(/\s+/)[1].split('/').slice(-1)[0];
      })
  );
}

function getBranches(config, privkey, done) {
  if (config.auth.type === 'ssh') {
    gitane().run(
      {
        cmd: `git ls-remote -h ${gitUrl(config)[0]}`,
        baseDir: '/',
        privKey: config.auth.privkey || privkey,
        detached: true,
      },
      function (err, stdout, stderr, exitCode) {
        if (err || exitCode !== 0) {
          return done(err || new Error(stderr));
        }

        processBranches(stdout, done);
      }
    );
  } else {
    execFile('git', ['ls-remote', '-h', httpUrl(config)[0]], function (
      err,
      stdout
    ) {
      if (err) return done(err);
      processBranches(stdout, done);
    });
  }
}