Merge pull request #5 from bredondev/onevar

Sub-commands (inline variable setting)

Author: quangkhoa

CHANGELOG.md

@@ -6,7 +6,13 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 ## Unreleased
 
-Nil.
+### Changed
+
+- Introduce sub-commands to add the possibility to set a variable on the fly, without a `gitlab.env.yml`.
+- The `token` can be retrieved from env variable.
+- New commands are :
+    - `glci sv <options>` to set one variable.
+    - `glci sav <options>` to set all variables in `gitlab.env.yml`.
 
 ## [v1.1.2] - 2017-09-06
 

README.md

@@ -4,7 +4,7 @@
 [![Travis CI](https://img.shields.io/travis/temando/gitlab-ci-variables-cli.svg)](https://travis-ci.org/temando/gitlab-ci-variables-cli)
 [![MIT License](https://img.shields.io/github/license/temando/gitlab-ci-variables-cli.svg)](https://en.wikipedia.org/wiki/MIT_License)
 
-CLI tool to allow setting multiple pipeline variables on Gitlab CI, instead of going through Gitlab UI and adding individual variables.
+CLI tool to allow setting pipeline variables on Gitlab CI, instead of going through Gitlab UI and adding individual variables.
 
 Supports Gitlab API v4, available since Gitlab 9.0.
 
@@ -18,6 +18,23 @@ $ npm install -g gitlab-ci-variables-setter-cli
 
 ## Usage
 
+### One variable (`glci sv`)
+
+Run the following command, where:
+
+- `gitlab-token` is your Gitlab personal access token
+- `gitlab-project-url` is your project url on gitlab, e.g. https://gitlab.com/gitlab-org/gitlab-ce
+- `key` is the variable you want to set
+- `value` is the value of the variable you want to set
+
+```sh
+$ glci sv --token <gitlab-token> --url <gitlab-project-url> --key <key> --value <value>
+Set <key> = <value> for gitlab-org/gitlab-ce.
+Completed setting variable on Gitlab CI.
+```
+
+### Several variables (`glci sav`)
+
 Put all required variable key/values on a properties file named `gitlab.env.yml`, e.g:
 
 ```yml
@@ -36,33 +53,40 @@ Run the following command from the directory that contains the properties file,
 - `gitlab-project-url` is your project url on gitlab, e.g. https://gitlab.com/gitlab-org/gitlab-ce
 
 ```sh
-$ setAllVars --token <gitlab-token> --url <gitlab-project-url>
+$ glci sav --token <gitlab-token> --url <gitlab-project-url>
 Set AWS_CREDENTIALS = <value> for gitlab-org/gitlab-ce.
 Set NPM_INSTALL_TOKEN = <value> for gitlab-org/gitlab-ce.
 Completed setting variables on Gitlab CI.
 ```
 
-By default, all existing variables on Gitlab CI will be overridden. If you wish to ignore existing variables, add a `--do-not-force` option, e.g:
+#### For all usages
+
+##### `--do-not-force`
+
+By default, existing variables on Gitlab CI will be overridden. If you wish to ignore existing variables, add a `--do-not-force` option, e.g:
 
 ```sh
-$ setAllVars --token <gitlab-token> --url <gitlab-project-url> --do-not-force
+$ glci sav --token <gitlab-token> --url <gitlab-project-url> --do-not-force
 Skipping AWS_CREDENTIALS, already set for gitlab-org/gitlab-ce.
 Skipping NPM_INSTALL_TOKEN, already set for gitlab-org/gitlab-ce.
 Completed setting variables on Gitlab CI.
 ```
 
-If your working directory is a git repostory of your project, the `--url` option can be omitted, e.g:
+##### `--url`
+
+If your working directory is a git repository of your project, the `--url` option can be omitted, e.g:
 
 ```sh
-$ setAllVars --token <gitlab-token>
+$ glci sv --token <gitlab-token> --key <key> --value <value>
 No URL specified, using git remote `origin`.
-Set AWS_CREDENTIALS = <value> for gitlab-org/gitlab-ce.
-Set NPM_INSTALL_TOKEN = <value> for gitlab-org/gitlab-ce.
-Completed setting variables on Gitlab CI.
+Set <key> = <value> for gitlab-org/gitlab-ce.
+Completed setting variable on Gitlab CI.
 ```
 
 > Omitting `--url` will derive the URL from the remote named `origin`.
 
+##### `--token`
+
 This project supports `.gitlabrc` files using [rc](https://www.npmjs.com/package/rc).
 If `--token` is not specified, this project can use a `.gitlabrc`, e.g:
 
@@ -71,20 +95,40 @@ token = this-is-my-gitlab-token
 ```
 
 ```sh
-$ setAllVars --url <gitlab-project-url>
+$ glci sav --url <gitlab-project-url>
 Using token from .gitlabrc.
 Set AWS_CREDENTIALS = <value> for gitlab-org/gitlab-ce.
 Set NPM_INSTALL_TOKEN = <value> for gitlab-org/gitlab-ce.
 Completed setting variables on Gitlab CI.
 ```
 
-Essentially, if your project is a git repository, and you have `.gitlabrc` file,
-no options are required and this tool can be invoked simply as:
+Alternatively, you can also set a GITLAB_TOKEN environment variable:
+
+```sh
+$ export GITLAB_TOKEN=this-is-my-gitlab-token
+$ glci sv --url <gitlab-project-url> --key <key> --value <value>
+Using token from environment variable GITLAB_TOKEN.
+Set <key> = <value> for gitlab-org/gitlab-ce.
+Completed setting variable on Gitlab CI.
+```
+
+---
+
+Essentially, if your project is a git repository, and you have a `.gitlabrc` file or a GITLAB_TOKEN env variable,
+ this tool can be invoked simply as:
 
 ```sh
-$ setAllVars
+$ glci sav
+Using token from .gitlabrc.
 No URL specified, using git remote `origin`.
 Set AWS_CREDENTIALS = <value> for gitlab-org/gitlab-ce.
 Set NPM_INSTALL_TOKEN = <value> for gitlab-org/gitlab-ce.
 Completed setting variables on Gitlab CI.
 ```
+```sh
+$ glci sv --key <key> --value <value>
+Using token from environment variable GITLAB_TOKEN.
+No URL specified, using git remote `origin`.
+Set <key> = <value> for gitlab-org/gitlab-ce.
+Completed setting variable on Gitlab CI.
+```

package.json

@@ -4,7 +4,8 @@
   "description": "CLI tool to allow setting multiple pipeline variables on Gitlab CI.",
   "author": "Khoa Tran",
   "contributors": [
-    "Brendan Abbott <[email protected]>"
+    "Brendan Abbott <[email protected]>",
+    "Baptiste Redon <[email protected]>"
   ],
   "license": "MIT",
   "keywords": [
@@ -16,9 +17,9 @@
     "url": "[email protected]:temando/gitlab-ci-variables-cli.git"
   },
   "bin": {
-    "setAllVars": "bin/setAllVariables.js"
+    "glci": "bin/glci.js"
   },
-  "main": "bin/setAllVariables.js",
+  "main": "bin/glci.js",
   "files": [
     "bin"
   ],

src/glci-sav.js

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+
+import program from 'commander';
+import { getConf, getProperties } from './lib/utils';
+import gitlabCI from './lib/gitlab-ci';
+
+async function execute(cmd) {
+  const conf = await getConf();
+
+  const properties = getProperties();
+  const handler = gitlabCI(conf.url, conf.token);
+  const resp = await handler.setVariables(properties, !cmd.doNotForce);
+
+  console.log('Completed setting variables on Gitlab CI.');
+  return resp;
+}
+
+program
+  .description('Read all key/value pairs under gitlab.env.yml on the current directory and sets them as environment variables on Gitlab CI')
+  .option(
+    '--url <url>',
+    'Your Gitlab project URL, e.g. https://gitlab.com/gitlab-org/gitlab-ce',
+  )
+  .option(
+    '--token <token>',
+    'Your Gitlab token.',
+  )
+  .option(
+    '--do-not-force',
+    'Ignore variables if they already exist on gitlab CI. By default all variables are overridden',
+  )
+  .parse(process.argv);
+
+execute(program);

src/glci-sv.js

@@ -0,0 +1,61 @@
+#!/usr/bin/env node
+
+import program from 'commander';
+import { getConf } from './lib/utils';
+import gitlabCI from './lib/gitlab-ci';
+
+async function execute(cmd) {
+  let resp = null;
+  const conf = await getConf();
+
+  if (!conf.key || !conf.value) {
+    console.error('No key/value pair given.');
+    process.exit(1);
+  }
+
+  const handler = gitlabCI(conf.url, conf.token);
+
+  const existingKeys = (await handler.listVariables()).map(variable => variable.key);
+
+  const keyExists = existingKeys.includes(conf.key);
+
+  if (keyExists && cmd.doNotForce) {
+    console.log(`Skipping ${conf.key}, already set.`);
+    return undefined;
+  }
+
+  if (keyExists) {
+    resp = await handler.updateVariable(conf.key, conf.value);
+  } else {
+    resp = await handler.createVariable(conf.key, conf.value);
+  }
+
+  console.log('Completed setting variable on Gitlab CI.');
+  return resp;
+}
+
+program
+  .description('Set given key/value pair as environment variables on Gitlab CI')
+  .option(
+    '--url <url>',
+    'Your Gitlab project URL, e.g. https://gitlab.com/gitlab-org/gitlab-ce',
+  )
+  .option(
+    '--token <token>',
+    'Your Gitlab token.',
+  )
+  .option(
+    '--key <key>',
+    'Your Gitlab CI variable.',
+  )
+  .option(
+    '--value <value>',
+    'Your Gitlab CI value.',
+  )
+  .option(
+    '--do-not-force',
+    'Ignore variable if it already exists on gitlab CI. By default variable is overridden',
+  )
+  .parse(process.argv);
+
+execute(program);

src/glci.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+
+import program from 'commander';
+
+program
+  .version('0.1.0')
+  .command('sv', 'set a variable')
+  .command('sav', 'set all variables')
+  .parse(process.argv);
+
+
+if (!process.argv.slice(1).length) {
+  program.outputHelp();
+}

src/lib/gitlab-ci.js

@@ -37,14 +37,14 @@ export default function gitlabCI(url, token) {
   }
 
   /**
-   * Set project variable
+   * Create project variable
    *
    * @param key
    * @param value
    *
    * @return {Promise<Object>} variable object
    */
-  async function setVariable(key, value) {
+  async function createVariable(key, value) {
     const response = await axios({
       method: 'post',
       url: `${apiUrl}?${tokenQueryString}`,
@@ -107,7 +107,7 @@ export default function gitlabCI(url, token) {
 
     const promises = keysToSet.map(async (key) => {
       const value = properties[key];
-      const keyExists = existingKeys.some(existingKey => existingKey === key);
+      const keyExists = existingKeys.includes(key);
 
       if (keyExists && !forceUpdate) {
         console.log(`Skipping ${key}, already set for ${projectId}.`);
@@ -120,7 +120,7 @@ export default function gitlabCI(url, token) {
         variable = await updateVariable(key, value);
       } else {
         // Create variable
-        variable = await setVariable(key, value);
+        variable = await createVariable(key, value);
       }
 
       console.log(`Set ${key} = ${JSON.stringify(value)} for ${projectId}`);
@@ -133,7 +133,7 @@ export default function gitlabCI(url, token) {
   }
 
   return {
-    setVariable,
+    createVariable,
     updateVariable,
     listVariables,
     setVariables,

src/lib/utils.js

@@ -0,0 +1,60 @@
+import rc from 'rc';
+import fs from 'fs';
+import gitRemoteOriginUrl from 'git-remote-origin-url';
+import getUrlFromGitRemote from './git';
+import loadPropertiesFile from './properties-file';
+
+const gitlabEnvFileName = 'gitlab.env.yml';
+
+async function getConf() {
+  const conf = rc('gitlab');
+  const errors = [];
+
+  // Check for token
+  if (!conf.token) {
+    if (!process.env.GITLAB_TOKEN) {
+      errors.push('No Gitlab token given.');
+    } else {
+      conf.token = process.env.GITLAB_TOKEN;
+      console.log('Using token from environment variable GITLAB_TOKEN.');
+    }
+  }
+
+  if (conf.config) {
+    console.log(`Using token from ${conf.config}.`);
+  }
+
+  // If there is no url provided, get it!
+  if (!conf.url) {
+    try {
+      conf.url = await getUrlFromGitRemote(gitRemoteOriginUrl);
+      console.log('No URL specified, using git remote `origin`.');
+    } catch (err) {
+      errors.push('No Gitlab project URL given.');
+    }
+  }
+
+  if (errors.length > 0) {
+    console.error(errors.join('\n'));
+    process.exit(1);
+  }
+
+  return conf;
+}
+
+function getProperties() {
+  const cwd = process.cwd();
+  const path = `${cwd}/${gitlabEnvFileName}`;
+
+  if (!fs.existsSync(path)) {
+    console.error(`${gitlabEnvFileName} does not exist`);
+    process.exit(1);
+  }
+
+  return loadPropertiesFile(path);
+}
+
+export {
+  getConf,
+  getProperties,
+};