clever-tools 2.8.0 → 2.9.1

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # clever-tools changelog
 
+## Unrelease (????-??-??)
+
+...
+
+## 2.9.1 (2022-02-28)
+
+* Upgrade opn to open
+
+## 2.9.0 (2022-01-12)
+
+* Add NewRelic support in `clever drains`
+
+## 2.8.1 (2022-01-10)
+
+* Fix `colors` to `1.4.0`
+
 ## 2.8.0 (2021-02-09)
 
 * Add options support for `clever addon create` (options like encryption-at-rest)

package/README.md

@@ -6,7 +6,7 @@ Command Line Interface for Clever Cloud.
 
 ## Installation
 
-The clever-tools CLI can be installed through many different channels depending on your system setup.
+The clever-tools CLI can be installed through many channels depending on your system setup.
 
 ### Via npm
 
@@ -26,38 +26,57 @@ npm install -g clever-tools@beta
 
 #### Debian/Ubuntu (.deb)
 
+---
+
+##### Warning
+
+We recently moved from Bintray to a self-hosted Nexus repository available at [https://nexus.clever-cloud.com](https://nexus.clever-cloud.com).
+If you were using Bintray to install our `.deb` packages, you will need to edit your `/etc/apt/sources.list` and remove the old entry with `https://dl.bintray.com/clevercloud/deb` before going further.
+
+---
+
 If you are using a GNU/Linux distribution that uses `.deb` packages like Debian or Ubuntu, you can run:
 
 ```sh
-apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys "379CE192D401AB61"
-echo "deb https://dl.bintray.com/clevercloud/deb stable main" | tee -a /etc/apt/sources.list
+curl -fsSL https://clever-tools.clever-cloud.com/gpg/cc-nexus-deb.public.gpg.key | gpg --dearmor -o /usr/share/keyrings/cc-nexus-deb.gpg
+echo "deb [signed-by=/usr/share/keyrings/cc-nexus-deb.gpg] https://nexus.clever-cloud.com/repository/deb stable main" | tee -a /etc/apt/sources.list
 apt-get update
 apt-get install clever-tools
 ```
 
 NOTES:
 
-* The `.deb` packages are hosted on Bintray (their GPG key is required to trust their signed packages).
+* The `.deb` packages are hosted on Clever Cloud's public Nexus instance available at [https://nexus.clever-cloud.com](https://nexus.clever-cloud.com).
+* Our PGP key is required to trust the repository.
 * If you want access to the beta channel, you can use this in your `sources.list`:
 
 ```sh
-echo "deb https://dl.bintray.com/clevercloud/deb unstable beta" | tee -a /etc/apt/sources.list
+echo "deb [signed-by=/usr/share/keyrings/cc-nexus-deb.gpg] https://nexus.clever-cloud.com/repository/deb-beta beta main" | tee -a /etc/apt/sources.list
 ```
 
 #### CentOS/Fedora (.rpm)
 
+---
+
+##### Warning
+
+We recently moved from Bintray to a self-hosted Nexus repository available at [https://nexus.clever-cloud.com](https://nexus.clever-cloud.com).
+If you were using Bintray to install our `.rpm` packages, you will need to remove the old `/etc/yum.repos.d/bintray-clevercloud-rpm.repo` before going further.
+
+---
+
 If you are using a GNU/Linux distribution that uses `.rpm` packages like CentOS or Fedora, you can run:
 
 ```sh
-curl https://bintray.com/clevercloud/rpm/rpm > /etc/yum.repos.d/bintray-clevercloud-rpm.repo
-echo "exclude=*beta*" >> /etc/yum.repos.d/bintray-clevercloud-rpm.repo
+curl -s https://clever-tools.clever-cloud.com/repos/cc-nexus-rpm.repo > /etc/yum.repos.d/cc-nexus-rpm.repo
+yum update
 yum install clever-tools
 ```
 
 NOTES:
 
-* The `.rpm` packages are hosted on Bintray.
-* If you want access to the beta channel, you can omit the second line which contains an exclude option.
+* The `.rpm` packages are hosted on Clever Cloud's public Nexus instance available at [https://nexus.clever-cloud.com](https://nexus.clever-cloud.com).
+* If you want access to the beta channel, you will need to edit `/etc/yum.repos.d/cc-nexus-rpm.repo` and set `enabled=1` for the `[clever-tools-beta]`.
 
 #### Arch Linux
 
@@ -98,11 +117,11 @@ NOTES:
 * The packages are available on Clever Cloud's Cellar bucket: [clever-tools-latest_linux.tar.gz](https://clever-tools.clever-cloud.com/releases/latest/clever-tools-latest_linux.tar.gz).
 * You can also retrieve any release (including beta) on this Cellar bucket by replacing `latest` (path and filename) with the version number you need.
 
-### On MacOS
+### On macOS
 
 #### Using homebrew
 
-If you are using MacOS and you have [homebrew](https://brew.sh) installed, you can run:
+If you are using macOS and you have [homebrew](https://brew.sh) installed, you can run:
 
 ```sh
 brew install CleverCloud/homebrew-tap/clever-tools
@@ -114,7 +133,7 @@ NOTES:
 
 #### Using the `.tar.gz` archive
 
-If you are using MacOS but you don't have [homebrew](https://brew.sh) installed, you can download a `.tar.gz` archive and extract the binary in your `PATH`:
+If you are using macOS, but you don't have [homebrew](https://brew.sh) installed, you can download a `.tar.gz` archive and extract the binary in your `PATH`:
 
 ```sh
 curl -O https://clever-tools.clever-cloud.com/releases/latest/clever-tools-latest_macos.tar.gz
@@ -131,20 +150,29 @@ NOTES:
 
 #### Using chocolatey
 
-If you are using Windows and you have [chocolatey](https://chocolatey.org) installed, you can run: 
+---
+
+##### Warning
+
+We recently moved from Bintray to a self-hosted Nexus repository available at [https://nexus.clever-cloud.com](https://nexus.clever-cloud.com).
+If you were using Bintray to install our `.nupkg` packages, you will need to remove the old source.
+
+---
+
+If you are using Windows and you have [chocolatey](https://chocolatey.org) installed, you can run:
 
 ```bash
-choco sources add -n=clevercloud -s='https://api.bintray.com/nuget/clevercloud/nupkg'
+choco sources add -n=clevercloud -s='https://nexus.clever-cloud.com/repository/nupkg/'
 choco install clever-tools
 ```
 
 NOTES:
 
-* If you want access to the beta channel, you can use `choco install --pre clever-tools` instead.
+* If you want access to the beta channel, you can use `choco sources add -n=clevercloud -s='https://nexus.clever-cloud.com/repository/nupkg-beta/'` instead.
 
 #### Using the `.zip` archive
 
-If you are using Windows but you don't have [chocolatey](https://chocolatey.org) installed, you can download a `.zip` archive and extract the binary in your `PATH`.
+If you are using Windows, but you don't have [chocolatey](https://chocolatey.org) installed, you can download a `.zip` archive and extract the binary in your `PATH`.
 
 NOTES:
 
@@ -160,15 +188,23 @@ docker pull clevercloud/clever-tools
 docker run --rm clever-tools <command>
 ```
 
+#### Dockerfile
+
+In your `Dockerfile` you can copy the clever-tools CLI from the image itself with a simple one liner:
+
+```Dockerfile
+COPY --from=clevercloud/clever-tools /bin/clever /usr/local/bin/clever
+```
+
 ### Via Nix
 
-If you are using Nix, you will find a Nix derivation on Fretlink's Github repository: https://github.com/fretlink/clever-tools-nix
+If you are using Nix, you will find a Nix derivation on Fretlink's GitHub repository: https://github.com/fretlink/clever-tools-nix
 
 ## Enabling autocompletion
 
 The clever-tools CLI comes with a comprehensive auto-completion system.
 Some installation methods like `.deb` packages, `.rpm` packages or brew will try to enable it automatically.
-If it does not work, try this for bash: 
+If it does not work, try this for bash:
 
 ```bash
 clever --bash-autocomplete-script $(which clever) | sudo tee /usr/share/bash-completion/completions/clever
@@ -193,7 +229,7 @@ clever login
 It will open the Web console in your browser and reuse your existing session if you're already logged in.
 
 `clever login` tries to open a browser through `xdg-open` on GNU/Linux systems (and in bash for windows).
-Make sure you have `xdg-utils` available as well as a default browser set (or you can copy and paste the URL displayed in the console.
+Make sure you have `xdg-utils` available as well as a default browser set, or you can copy and paste the URL displayed in the console.
 
 ### Create an application
 
@@ -288,6 +324,7 @@ Where `DRAIN-TYPE` is one of:
 - `HTTP`: for TCP syslog endpoint (note that this endpoint has optional username/passwordparameters as HTTP Basic Authentication);
 - `ElasticSearch`: for ElasticSearch endpoint (note that this endpoint requires username/password parameters as HTTP Basic Authentication);
 - `DatadogHTTP`: for Datadog endpoint (note that this endpoint needs your Datadog API Key).
+- `NewRelicHTTP`: for NewRelic endpoint (note that this endpoint needs your NewRelic API Key).
 
 #### ElasticSearch logs drains
 
@@ -305,6 +342,16 @@ clever drain create DatadogHTTP "https://http-intake.logs.datadoghq.com/v1/input
 
 Please note that the `host` query parameter is not mandatory: in the Datadog pipeline configuration, you can map `@source_host` which is the host provided by Clever Cloud in logs as `host` property.
 
+#### NewRelic logs drains
+
+NewRelic has two zones, EU and US. An account on one zone is not available on the other, make sure to target the good EU or US intake endpoint.
+
+To create a [NewRelic](https://docs.newrelic.com/docs/logs/log-api/introduction-log-api/) drain, you just need to use:
+
+```sh
+clever drain create NewRelicHTTP "https://log-api.eu.newrelic.com/log/v1" --api-key <API_KEY>
+```
+
 ### Display help
 
 You can display help about each command with `clever help`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clever-tools",
-  "version": "2.8.0",
+  "version": "2.9.1",
   "description": "Command Line Interface for Clever Cloud.",
   "main": "bin/clever.js",
   "keywords": [
@@ -25,45 +25,45 @@
     "scripts/*.sh"
   ],
   "dependencies": {
-    "@clevercloud/client": "^7.2.0",
+    "@clevercloud/client": "^7.4.0",
     "clf-date": "^0.2.0",
     "cliparse": "^0.3.3",
-    "colors": "^1.4.0",
+    "colors": "1.4.0",
     "common-env": "^6.4.0",
-    "eventsource": "^1.0.7",
-    "isomorphic-git": "1.7.4",
+    "eventsource": "^1.1.0",
+    "isomorphic-git": "^1.8.2",
     "linux-release-info": "^3.0.0",
-    "lodash": "^4.17.20",
+    "lodash": "^4.17.21",
     "mkdirp": "^1.0.4",
-    "moment": "^2.27.0",
-    "opn": "^6.0.0",
-    "slugify": "^1.4.5",
-    "string-length": "^3.1.0",
-    "superagent": "^6.0.0",
+    "moment": "^2.29.1",
+    "open": "^8.4.0",
+    "slugify": "^1.5.3",
+    "string-length": "^4.0.2",
+    "superagent": "^6.1.0",
     "text-table": "^0.2.0",
-    "update-notifier": "^4.1.1",
-    "ws": "^7.3.1",
+    "update-notifier": "^5.1.0",
+    "ws": "^7.4.6",
     "xdg": "^0.1.1"
   },
   "devDependencies": {
-    "aws-sdk": "^2.735.0",
-    "chai": "^4.2.0",
-    "del": "^5.1.0",
-    "eslint": "^7.7.0",
-    "eslint-config-standard": "^14.1.1",
-    "eslint-plugin-import": "^2.22.0",
+    "aws-sdk": "^2.919.0",
+    "chai": "^4.3.4",
+    "del": "^6.0.0",
+    "eslint": "^7.27.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-import": "^2.23.4",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-promise": "^4.2.1",
-    "eslint-plugin-standard": "^4.0.1",
-    "fs-extra": "^9.0.1",
-    "glob": "^7.1.6",
-    "grunt": "^1.2.1",
-    "grunt-cli": "^1.3.2",
+    "eslint-plugin-promise": "^5.1.0",
+    "eslint-plugin-standard": "^5.0.0",
+    "fs-extra": "^10.0.0",
+    "glob": "^7.1.7",
+    "grunt": "^1.4.1",
+    "grunt-cli": "^1.4.3",
     "grunt-http": "^2.3.3",
     "grunt-mocha-test": "^0.13.3",
-    "mocha": "^8.1.1",
-    "pkg": "^4.4.9",
-    "semver": "^7.3.2"
+    "mocha": "^8.4.0",
+    "pkg": "^5.2.1",
+    "semver": "^7.3.5"
   },
   "scripts": {
     "pretest": "npm run lint",
@@ -83,5 +83,9 @@
     "scripts": [
       "src/**/*.js"
     ]
+  },
+  "volta": {
+    "node": "12.22.8",
+    "npm": "6.14.15"
   }
 }

package/src/commands/console.js

@@ -2,7 +2,7 @@
 
 const AppConfig = require('../models/app_configuration.js');
 const Logger = require('../logger.js');
-const openPage = require('opn');
+const openPage = require('open');
 
 async function openConsole (params) {
   const { alias } = params.options;

package/src/commands/login.js

@@ -6,7 +6,7 @@ const util = require('util');
 const delay = util.promisify(setTimeout);
 
 const colors = require('colors/safe');
-const open = require('opn');
+const open = require('open');
 const superagent = require('superagent');
 
 const Logger = require('../logger.js');

package/src/commands/notify-email.js

@@ -55,6 +55,7 @@ function getEmailNotificationTargets (notifTargets) {
       if (el.toLowerCase() === 'organisation') {
         return { type: 'organisation' };
       }
+      return null;
     })
     .filter((e) => e != null);
 }

package/src/commands/open.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const openPage = require('opn');
+const openPage = require('open');
 
 const AppConfig = require('../models/app_configuration.js');
 const Domain = require('../models/domain.js');

package/src/models/accesslogs.js

@@ -23,7 +23,8 @@ function formatSource (l) {
   if (l.s != null) {
     const location = l.s.ct ? `${l.s.ct}, ${l.s.co}` : l.s.co;
     return `${l.ipS} - ${location}`;
-  } else {
+  }
+  else {
     return l.ipS;
   }
 }

package/src/models/configuration.js

@@ -1,11 +1,7 @@
 'use strict';
 
-const fs = require('fs');
+const { promises: fs } = require('fs');
 const path = require('path');
-const util = require('util');
-
-const readFile = util.promisify(fs.readFile);
-const writeFile = util.promisify(fs.writeFile);
 
 const commonEnv = require('common-env');
 const mkdirp = require('mkdirp');
@@ -14,7 +10,7 @@ const xdg = require('xdg');
 const Logger = require('../logger.js');
 const env = commonEnv(Logger);
 
-function getConfigPath () {
+function getConfigDir () {
   if (process.platform === 'win32') {
     return path.resolve(process.env.APPDATA, 'clever-cloud');
   }
@@ -23,6 +19,37 @@ function getConfigPath () {
   }
 }
 
+function getConfigPath () {
+  const configDir = getConfigDir();
+  return path.resolve(configDir, 'clever-tools.json');
+}
+
+async function isFile (path) {
+  try {
+    const pathStat = await fs.stat(path);
+    return pathStat.isFile();
+  }
+  catch (e) {
+    return false;
+  }
+}
+
+async function maybeMigrateFromLegacyConfigurationPath () {
+  // This used to be a file
+  const configDir = getConfigDir();
+  const legacyConfig = await isFile(configDir);
+  // If it is still a file, we replace it with a dir and move it inside
+  if (legacyConfig) {
+    const tmpConfigFile = `${configDir}.tmp`;
+    const configFile = getConfigPath();
+
+    // Rename so that we can create the directory
+    await fs.rename(configDir, tmpConfigFile);
+    await mkdirp(configDir, { mode: 0o700 });
+    await fs.rename(tmpConfigFile, configFile);
+  }
+}
+
 async function loadOAuthConf () {
   Logger.debug('Load configuration from environment variables');
   if (process.env.CLEVER_TOKEN != null && process.env.CLEVER_SECRET != null) {
@@ -32,8 +59,9 @@ async function loadOAuthConf () {
     };
   }
   Logger.debug('Load configuration from ' + conf.CONFIGURATION_FILE);
+  await maybeMigrateFromLegacyConfigurationPath();
   try {
-    const rawFile = await readFile(conf.CONFIGURATION_FILE);
+    const rawFile = await fs.readFile(conf.CONFIGURATION_FILE);
     return JSON.parse(rawFile);
   }
   catch (error) {
@@ -47,7 +75,7 @@ async function writeOAuthConf (oauthData) {
   const configDir = path.dirname(conf.CONFIGURATION_FILE);
   try {
     await mkdirp(configDir, { mode: 0o700 });
-    await writeFile(conf.CONFIGURATION_FILE, JSON.stringify(oauthData));
+    await fs.writeFile(conf.CONFIGURATION_FILE, JSON.stringify(oauthData));
   }
   catch (error) {
     throw new Error(`Cannot write configuration to ${conf.CONFIGURATION_FILE}\n${error.message}`);

package/src/models/deployments.js

@@ -30,6 +30,7 @@ async function waitForDeploymentStart ({ ownerId, appId, deploymentId, commitId,
           const isNew = knownDeployments.every(({ uuid }) => uuid !== d.uuid);
           return isNew && d.commit === commitId;
         }
+        return false;
       });
       if (deployment != null) {
         Logger.debug(`Deployment has started (state:${deployment.state})`);

package/src/models/drain.js

@@ -8,12 +8,13 @@ const DRAIN_TYPES = [
   { id: 'HTTP', credentials: 'OPTIONAL' },
   { id: 'ElasticSearch', credentials: 'MANDATORY' },
   { id: 'DatadogHTTP' },
+  { id: 'NewRelicHTTP', apiKey: 'MANDATORY' },
 ];
 
 function createDrainBody (appId, drainTargetURL, drainTargetType, drainTargetCredentials, drainTargetConfig) {
 
-  if (!authorizeDrainCreation(drainTargetType, drainTargetCredentials)) {
-    throw new Error("Credentials are: optional for HTTP, mandatory for ElasticSearch and TCPSyslog/UDPSyslog don't need them.");
+  if (!authorizeDrainCreation(drainTargetType, drainTargetCredentials, drainTargetConfig)) {
+    throw new Error("Credentials are: optional for HTTP, mandatory for ElasticSearch, NewRelicHTTP and TCPSyslog/UDPSyslog don't need them.");
   }
 
   const body = {
@@ -26,20 +27,37 @@ function createDrainBody (appId, drainTargetURL, drainTargetType, drainTargetCre
       password: drainTargetCredentials.password || '',
     };
   }
+  if (keyExist(drainTargetConfig)) {
+    body.APIKey = drainTargetConfig.apiKey;
+  }
   return body;
 }
 
-function authorizeDrainCreation (drainTargetType, drainTargetCredentials) {
+function authorizeDrainCreation (drainTargetType, drainTargetCredentials, drainTargetConfig) {
   if (drainTypeExists(drainTargetType)) {
     // retrieve creds for drain type ('mandatory', 'optional', undefined)
-    const status = credentialsStatus(drainTargetType).credentials;
-    if (status === 'MANDATORY') {
+    const credStatus = credentialsStatus(drainTargetType).credentials;
+    const keyStatus = credentialsStatus(drainTargetType).apiKey;
+
+    if (credStatus === 'MANDATORY') {
       return credentialsExist(drainTargetCredentials);
     }
-    if (status === 'OPTIONAL') {
+    if (credStatus === 'OPTIONAL') {
+      return true;
+    }
+    if (!credStatus && !keyStatus) {
+      return credentialsEmpty(drainTargetCredentials);
+    }
+
+    if (keyStatus === 'MANDATORY') {
+      return keyExist(drainTargetConfig);
+    }
+    if (keyStatus === 'OPTIONAL') {
       return true;
     }
-    return credentialsEmpty(drainTargetCredentials);
+    if (!keyStatus) {
+      return keyEmpty(drainTargetConfig);
+    }
   }
 }
 
@@ -59,6 +77,14 @@ function credentialsEmpty ({ username, password }) {
   return username == null && password == null;
 }
 
+function keyExist ({ apiKey }) {
+  return apiKey != null;
+}
+
+function keyEmpty ({ apiKey }) {
+  return apiKey == null;
+}
+
 function listDrainTypes () {
   return autocomplete.words(DRAIN_TYPES.map((type) => type.id));
 }

package/src/models/fs-utils.js

@@ -1,14 +1,11 @@
 'use strict';
 
 const { join } = require('path');
-const fs = require('fs');
-const { promisify } = require('util');
-
-const fsStat = promisify(fs.stat);
+const { promises: fs } = require('fs');
 
 function findPath (dir, name) {
   const fullPath = join(dir, name);
-  return fsStat(fullPath)
+  return fs.stat(fullPath)
     .then(() => dir)
     .catch((e) => {
       if (e.code === 'ENOENT' && dir !== '/') {