clever-tools 2.10.0-beta.2 → 2.10.0

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unrelease (????-??-??)
 
+* add `clever database backups DATABASE-ID` command to list backups of a database 
+* add `clever database backups download DATABASE-ID BACKUP-IP` command to download a backup 
+* add `clever curl` so we can prefix any `curl` command with `clever` and benefit from the local oAuth v1 auth
+
 ## 2.10.0-beta.2 (2022-09-13)
 
 * NetworkGroups fix wrong function call.

package/LICENSE

@@ -187,7 +187,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2022 Clever Cloud
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/bin/clever.js

@@ -88,6 +88,8 @@ function run () {
       parser: Parsers.appIdOrName,
     }),
     appNameCreation: cliparse.argument('app-name', { description: 'Application name' }),
+    backupId: cliparse.argument('backup-id', { description: 'A Database backup ID (format: UUID)' }),
+    databaseId: cliparse.argument('database-id', { description: 'A database ID (format: postgres_UUID)' }),
     drainId: cliparse.argument('drain-id', { description: 'Drain ID' }),
     drainType: cliparse.argument('drain-type', {
       description: 'Drain type',
@@ -183,6 +185,10 @@ function run () {
       metavar: 'commit id',
       description: 'Restart the application with a specific commit id',
     }),
+    databaseId: cliparse.option('database-id', {
+      metavar: 'database_id',
+      description: 'The Database ID (postgresql_xxx)',
+    }),
     deploymentId: cliparse.option('deployment-id', {
       metavar: 'deployment_id',
       description: 'Fetch logs for a given deployment',
@@ -287,6 +293,10 @@ function run () {
       description: 'Organisation ID (or name, if unambiguous)',
       parser: Parsers.orgaIdOrName,
     }),
+    output: cliparse.option('output', {
+      aliases: ['out'],
+      description: 'redirect the output of the command in a file',
+    }),
     drainPassword: cliparse.option('password', {
       aliases: ['p'],
       metavar: 'password',
@@ -996,6 +1006,26 @@ function run () {
     commands: [addWebhookCommand, removeWebhookCommand],
   }, webhooks('list'));
 
+  // DATABASES COMMANDS
+  const database = lazyRequirePromiseModule('../src/commands/database.js');
+  const downloadBackupCommand = cliparse.command('download', {
+    description: 'Download a database backup',
+    args: [args.databaseId, args.backupId],
+    options: [opts.orgaIdOrName, opts.output],
+  }, database('downloadBackups'));
+  const backupsCommand = cliparse.command('backups', {
+    description: 'List available database backups',
+    args: [args.databaseId],
+    options: [opts.orgaIdOrName],
+    commands: [
+      downloadBackupCommand,
+    ],
+  }, database('listBackups'));
+  const databaseCommand = cliparse.command('database', {
+    description: 'List available databases',
+    commands: [backupsCommand],
+  }, () => console.info('not available yet'));
+
   // CLI PARSER
   const cliParser = cliparse.cli({
     name: 'clever',
@@ -1012,6 +1042,7 @@ function run () {
       appUnlinkCommand,
       cancelDeployCommand,
       configCommands,
+      databaseCommand,
       deleteCommand,
       deployCommand,
       diagCommand,
@@ -1023,8 +1054,9 @@ function run () {
       logoutCommand,
       logsCommand,
       makeDefaultCommand,
-      networkGroupsCommand,
-      ngCommand,
+      // Not ready for stable release yet
+      // networkGroupsCommand,
+      // ngCommand,
       openCommand,
       consoleCommand,
       profileCommand,
@@ -1047,4 +1079,11 @@ function run () {
   cliparse.parse(cliParser, cliArgs);
 }
 
-run();
+// Right now, this is the only way to do this properly
+// cliparse doesn't allow unknown options/arguments
+if (process.argv[2] === 'curl') {
+  require('../src/commands/curl.js').curl();
+}
+else {
+  run();
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clever-tools",
-  "version": "2.10.0-beta.2",
+  "version": "2.10.0",
   "description": "Command Line Interface for Clever Cloud.",
   "main": "bin/clever.js",
   "keywords": [
@@ -30,6 +30,7 @@
     "cliparse": "^0.3.3",
     "colors": "1.4.0",
     "common-env": "^6.4.0",
+    "curlconverter": "^3.21.0",
     "eventsource": "^1.1.0",
     "isomorphic-git": "^1.8.2",
     "linux-release-info": "^3.0.0",

package/src/commands/curl.js

@@ -0,0 +1,51 @@
+'use strict';
+
+const { parseCurlCommand } = require('curlconverter/util.js');
+const { spawn } = require('child_process');
+const { loadOAuthConf, conf } = require('../models/configuration.js');
+const { addOauthHeader } = require('@clevercloud/client/cjs/oauth.node.js');
+
+async function loadTokens () {
+  const tokens = await loadOAuthConf();
+  return {
+    OAUTH_CONSUMER_KEY: conf.OAUTH_CONSUMER_KEY,
+    OAUTH_CONSUMER_SECRET: conf.OAUTH_CONSUMER_SECRET,
+    API_OAUTH_TOKEN: tokens.token,
+    API_OAUTH_TOKEN_SECRET: tokens.secret,
+  };
+}
+
+async function curl () {
+
+  // We have to add single quotes on values for the parser
+  const curlString = process.argv
+    .slice(2)
+    .map((str) => !str.startsWith('-') ? `'${str}'` : str)
+    .join(' ');
+
+  const curlDetails = parseCurlCommand(curlString);
+
+  const tokens = await loadTokens();
+
+  const requestParams = {
+    method: curlDetails.method,
+    url: curlDetails.urlWithoutQuery,
+    headers: curlDetails.headers,
+    queryParams: curlDetails.query,
+  };
+
+  const oauthHeader = await Promise.resolve(requestParams)
+    .then(addOauthHeader(tokens))
+    .then((request) => request.headers.Authorization);
+
+  // Reuse raw curl command
+  const curlParams = process.argv.slice(3);
+
+  // Add oauth
+  curlParams.push('-H', `Authorization: ${oauthHeader}`);
+
+  spawn('curl', curlParams, { stdio: 'inherit' });
+
+}
+
+module.exports = { curl };

package/src/commands/database.js

@@ -0,0 +1,101 @@
+'use strict';
+
+const { sendToApi } = require('../models/send-to-api.js');
+const { getBackups } = require('@clevercloud/client/cjs/api/v2/backups.js');
+const { println } = require('../logger.js');
+const formatTable = require('../format-table')();
+const superagent = require('superagent');
+const { getSummary } = require('@clevercloud/client/cjs/api/v2/user.js');
+const fs = require('fs');
+
+async function listBackups (params) {
+
+  const [databaseId] = params.args;
+  const { org } = params.options;
+
+  const ownerId = await resolveOwnerId(org, databaseId);
+  if (ownerId == null) {
+    throw new Error('organisation ID is mandatory');
+  }
+
+  const backups = await getBackups({ ownerId, ref: databaseId }).then(sendToApi);
+
+  const formattedLines = backups
+    .sort((a, b) => a.creation_date.localeCompare(b.creation_date))
+    .map((backup) => [
+      backup.backup_id,
+      backup.creation_date,
+      backup.status,
+    ]);
+
+  const head = [
+    'BACKUP ID',
+    'CREATION DATE',
+    'STATUS',
+  ];
+
+  println(formatTable([
+    head,
+    ...formattedLines,
+  ]));
+}
+
+async function downloadBackups (params) {
+
+  const [databaseId, backupId] = params.args;
+  const { org, output } = params.options;
+
+  const ownerId = await resolveOwnerId(org, databaseId);
+  if (ownerId == null) {
+    throw new Error('organisation ID is mandatory');
+  }
+
+  const backups = await getBackups({ ownerId, ref: databaseId }).then(sendToApi);
+  const backup = backups.find((backup) => backup.backup_id === backupId);
+
+  if (backup == null) {
+    throw new Error('no backup with this ID');
+  }
+
+  const res = await superagent
+    .get(backup.download_url)
+    .responseType('blob');
+
+  if (output) {
+    fs.writeFileSync(output, res.body);
+    return;
+  }
+
+  process.stdout.write(res.body);
+}
+
+/**
+ * Try to get an ownerId from the API
+ * @param {*} org cliparse param's option for orga
+ * @param {String} databaseId the resource which belong to the owner we are looking for
+ * @returns the owner ID (or null if cannot be found)
+ */
+async function resolveOwnerId (org, databaseId) {
+
+  if (org != null && org.orga_name != null) {
+    return org.orga_name;
+  }
+
+  const summary = await getSummary().then(sendToApi);
+
+  const userHasAddon = summary.user.addons.some((addon) => addon.readId === databaseId);
+  if (userHasAddon) {
+    return summary.user.id;
+  }
+
+  for (const orga of summary.organisations) {
+    const orgaHasAddon = orga.addons.some((addon) => addon.realId === databaseId);
+    if (orgaHasAddon) {
+      return orga.id;
+    }
+  }
+
+  return null;
+}
+
+module.exports = { listBackups, downloadBackups };

package/src/commands/networkgroups/index.js

@@ -9,7 +9,7 @@ const NetworkGroup = require('../../models/networkgroup.js');
 const Formatter = require('../../models/format-string.js');
 const TableFormatter = require('../../models/format-ng-table.js');
 
-async function listNetworkGroups(params) {
+async function listNetworkGroups (params) {
   const { org: orgaIdOrName, alias, json } = params.options;
   const ownerId = await NetworkGroup.getOwnerId(orgaIdOrName, alias);
 
@@ -32,7 +32,7 @@ async function listNetworkGroups(params) {
   }
 }
 
-async function createNg(params) {
+async function createNg (params) {
   const { org: orgaIdOrName, alias, label, description, tags, json } = params.options;
   const ownerId = await NetworkGroup.getOwnerId(orgaIdOrName, alias);
 
@@ -49,7 +49,7 @@ async function createNg(params) {
   }
 }
 
-async function deleteNg(params) {
+async function deleteNg (params) {
   const { org: orgaIdOrName, alias, ng: networkGroupIdOrLabel } = params.options;
   const ownerId = await NetworkGroup.getOwnerId(orgaIdOrName, alias);
   const networkGroupId = await NetworkGroup.getId(ownerId, networkGroupIdOrLabel);

package/src/commands/networkgroups/members.js

@@ -9,7 +9,7 @@ const NetworkGroup = require('../../models/networkgroup.js');
 const Formatter = require('../../models/format-string.js');
 const TableFormatter = require('../../models/format-ng-table.js');
 
-async function listMembers(params) {
+async function listMembers (params) {
   const { org: orgaIdOrName, alias, ng: networkGroupIdOrLabel, 'natural-name': naturalName, json } = params.options;
   const ownerId = await NetworkGroup.getOwnerId(orgaIdOrName, alias);
   const networkGroupId = await NetworkGroup.getId(ownerId, networkGroupIdOrLabel);
@@ -33,10 +33,10 @@ async function listMembers(params) {
   }
 }
 
-async function getMember(params) {
+async function getMember (params) {
   const { org: orgaIdOrName, alias, ng: networkGroupIdOrLabel, 'member-id': memberId, 'natural-name': naturalName, json } = params.options;
   const ownerId = await NetworkGroup.getOwnerId(orgaIdOrName, alias);
-  const networkGroupId = await NetworkGroup.getId(ownerId, networkGroupIdOrLabel);;
+  const networkGroupId = await NetworkGroup.getId(ownerId, networkGroupIdOrLabel); ;
 
   Logger.info(`Getting details for member ${Formatter.formatString(memberId)} in Network Group ${Formatter.formatString(networkGroupId)}`);
   const result = await ngApi.getNetworkGroupMember({ ownerId, networkGroupId, memberId: memberId }).then(sendToApi);
@@ -50,7 +50,7 @@ async function getMember(params) {
   }
 }
 
-async function addMember(params) {
+async function addMember (params) {
   const { org: orgaIdOrName, alias, ng: networkGroupIdOrLabel, 'member-id': memberId, type, 'domain-name': domainName, label } = params.options;
   const ownerId = await NetworkGroup.getOwnerId(orgaIdOrName, alias);
   const networkGroupId = await NetworkGroup.getId(ownerId, networkGroupIdOrLabel);
@@ -62,7 +62,7 @@ async function addMember(params) {
   Logger.println(`Successfully added member ${Formatter.formatString(memberId)} to Network Group ${Formatter.formatString(networkGroupId)}.`);
 }
 
-async function removeMember(params) {
+async function removeMember (params) {
   const { org: orgaIdOrName, alias, ng: networkGroupIdOrLabel, 'member-id': memberId } = params.options;
   const ownerId = await NetworkGroup.getOwnerId(orgaIdOrName, alias);
   const networkGroupId = await NetworkGroup.getId(ownerId, networkGroupIdOrLabel);

package/src/commands/networkgroups/peers.js

@@ -9,7 +9,7 @@ const NetworkGroup = require('../../models/networkgroup.js');
 const Formatter = require('../../models/format-string.js');
 const TableFormatter = require('../../models/format-ng-table.js');
 
-async function listPeers(params) {
+async function listPeers (params) {
   const { org: orgaIdOrName, alias, ng: networkGroupIdOrLabel, json } = params.options;
   const ownerId = await NetworkGroup.getOwnerId(orgaIdOrName, alias);
   const networkGroupId = await NetworkGroup.getId(ownerId, networkGroupIdOrLabel);
@@ -33,7 +33,7 @@ async function listPeers(params) {
   }
 }
 
-async function getPeer(params) {
+async function getPeer (params) {
   const { org: orgaIdOrName, alias, ng: networkGroupIdOrLabel, 'peer-id': peerId, json } = params.options;
   const ownerId = await NetworkGroup.getOwnerId(orgaIdOrName, alias);
   const networkGroupId = await NetworkGroup.getId(ownerId, networkGroupIdOrLabel);
@@ -50,7 +50,7 @@ async function getPeer(params) {
   }
 }
 
-async function addExternalPeer(params) {
+async function addExternalPeer (params) {
   const { org: orgaIdOrName, alias, ng: networkGroupIdOrLabel, role, 'public-key': publicKey, label, parent, ip, port } = params.options;
   const ownerId = await NetworkGroup.getOwnerId(orgaIdOrName, alias);
   const networkGroupId = await NetworkGroup.getId(ownerId, networkGroupIdOrLabel);
@@ -64,7 +64,7 @@ async function addExternalPeer(params) {
   return peerId;
 }
 
-async function removeExternalPeer(params) {
+async function removeExternalPeer (params) {
   const { org: orgaIdOrName, alias, ng: networkGroupIdOrLabel, 'peer-id': peerId } = params.options;
   const ownerId = await NetworkGroup.getOwnerId(orgaIdOrName, alias);
   const networkGroupId = await NetworkGroup.getId(ownerId, networkGroupIdOrLabel);

package/src/models/configuration.js

@@ -89,6 +89,7 @@ const conf = env.getOrElseAll({
   LOG_HTTP_URL: 'https://api.clever-cloud.com/v2/logs/<%- appId %>',
   EVENT_URL: 'wss://api.clever-cloud.com/v2/events/event-socket',
   WARP_10_EXEC_URL: 'https://c1-warp10-clevercloud-customers.services.clever-cloud.com/api/v0/exec',
+  // the disclosure of these tokens is not considered as a vulnerability. Do not report this to our security service.
   OAUTH_CONSUMER_KEY: 'T5nFjKeHH4AIlEveuGhB5S3xg8T19e',
   OAUTH_CONSUMER_SECRET: 'MgVMqTr6fWlf2M0tkC2MXOnhfqBWDT',
   SSH_GATEWAY: 'ssh@sshgateway-clevercloud-customers.services.clever-cloud.com',

package/src/models/networkgroup.js

@@ -7,19 +7,21 @@ const AppConfig = require('./app_configuration.js');
 const ngApi = require('@clevercloud/client/cjs/api/v4/network-group.js');
 const { sendToApi } = require('./send-to-api.js');
 
-async function getOwnerId(orgaIdOrName, alias) {
+async function getOwnerId (orgaIdOrName, alias) {
   if (orgaIdOrName == null) {
     try {
-      return (await AppConfig.getAppDetails({alias})).ownerId;
-    } catch (error) {
-      return (await User.getCurrentId())
+      return (await AppConfig.getAppDetails({ alias })).ownerId;
     }
-  } else {
+    catch (error) {
+      return (await User.getCurrentId());
+    }
+  }
+  else {
     return (await Organisation.getId(orgaIdOrName));
   }
 }
 
-async function getId(ownerId, ngIdOrLabel) {
+async function getId (ownerId, ngIdOrLabel) {
   if (ngIdOrLabel == null) {
     return null;
   }
@@ -32,7 +34,7 @@ async function getId(ownerId, ngIdOrLabel) {
     .then((ng) => ng.id);
 }
 
-async function getByLabel(owner_id, label) {
+async function getByLabel (owner_id, label) {
   const networkGroups = await ngApi.listNetworkGroups({ owner_id }).then(sendToApi);
   const filteredNgs = networkGroups.filter((ng) => ng.label === label);
 
@@ -46,11 +48,11 @@ async function getByLabel(owner_id, label) {
   return filteredNgs[0];
 }
 
-function listAvailablePeerRoles() {
+function listAvailablePeerRoles () {
   return autocomplete.words(['client', 'server']);
 }
 
-function listAvailableMemberTypes() {
+function listAvailableMemberTypes () {
   return autocomplete.words(['application', 'addon', 'external']);
 }