aberlaas-setup 2.22.2 → 2.23.0

package/lib/circleci.js

@@ -1,7 +1,7 @@
 import { _ } from 'golgoth';
 import { consoleError, consoleInfo, consoleSuccess } from 'firost';
-import circleCiHelper from './helpers/circleci.js';
-import githubHelper from './helpers/github.js';
+import { api, hasToken } from './helpers/circleci.js';
+import { getRepoData } from './helpers/github.js';
 
 export let __;
 
@@ -11,11 +11,11 @@ export let __;
  * @returns {boolean} True if enabled, false otherwise
  */
 export async function enable() {
-  const { username, repo } = await githubHelper.repoData();
+  const { username, repo } = await __.getRepoData();
   const projectUrl = `https://app.circleci.com/pipelines/github/${username}/${repo}`;
 
   // Fail early if no token available
-  if (!circleCiHelper.hasToken()) {
+  if (!__.hasToken()) {
     __.consoleError(
       'CircleCI: ABERLAAS_CIRCLECI_TOKEN environment variable must be set',
     );
@@ -46,8 +46,8 @@ __ = {
   async isEnabled() {
     // There is no endpoint to check if a project is followed or not, so we get
     // the list of all followed projects and check if the current one is in it
-    const allProjects = await circleCiHelper.api('projects');
-    const { username, repo } = await githubHelper.repoData();
+    const allProjects = await __.api('projects');
+    const { username, repo } = await __.getRepoData();
     const thisProject = _.find(allProjects, { username, reponame: repo });
     return !!thisProject;
   },
@@ -55,14 +55,17 @@ __ = {
    * Automatically follow the repo on CircleCI.
    */
   async followRepo() {
-    const { username, repo } = await githubHelper.repoData();
-    await circleCiHelper.api(`project/github/${username}/${repo}/follow`, {
+    const { username, repo } = await __.getRepoData();
+    await __.api(`project/github/${username}/${repo}/follow`, {
       method: 'post',
     });
   },
   consoleInfo,
   consoleSuccess,
   consoleError,
+  getRepoData,
+  hasToken,
+  api,
 };
 
 export default { enable };

package/lib/github.js

@@ -1,6 +1,6 @@
 import { _ } from 'golgoth';
 import { consoleError, consoleInfo, consoleSuccess } from 'firost';
-import githubHelper from './helpers/github.js';
+import { getRepoData, hasToken, octokit } from './helpers/github.js';
 
 export let __;
 
@@ -18,11 +18,11 @@ const gitHubSettings = {
  * @returns {boolean} True if enabled, false otherwise
  */
 export async function enable() {
-  const { username, repo } = await githubHelper.repoData();
+  const { username, repo } = await __.getRepoData();
   const settingsUrl = `https://github.com/${username}/${repo}/settings`;
 
   // Fail early if no token available
-  if (!githubHelper.hasToken()) {
+  if (!__.hasToken()) {
     __.consoleError(
       'GitHub: ABERLAAS_GITHUB_TOKEN environment variable must be set',
     );
@@ -48,7 +48,7 @@ export async function enable() {
     throw error;
   }
 
-  await githubHelper.octokit('repos.update', {
+  await __.octokit('repos.update', {
     owner: username,
     repo,
     ...gitHubSettings,
@@ -65,8 +65,8 @@ __ = {
    * @returns {boolean} True if already configured, false otherwise
    */
   async isAlreadyConfigured() {
-    const { username, repo } = await githubHelper.repoData();
-    const repoData = await githubHelper.octokit('repos.get', {
+    const { username, repo } = await __.getRepoData();
+    const repoData = await __.octokit('repos.get', {
       owner: username,
       repo,
     });
@@ -76,6 +76,9 @@ __ = {
   consoleSuccess,
   consoleInfo,
   consoleError,
+  getRepoData,
+  hasToken,
+  octokit,
 };
 
 export default { enable };

package/lib/helpers/circleci.js

@@ -1,7 +1,41 @@
 import { _, got } from 'golgoth';
 import { firostError } from 'firost';
 
-export default {
+export let __;
+
+/**
+ * Check if a CircleCI token is available
+ * @returns {boolean} True if a token is defined
+ */
+export function hasToken() {
+  return !!__.token();
+}
+
+/**
+ * Make a call to the CircleCI v1 API
+ * @param {string} urlPath Part of the url after the /api/v1.1/
+ * @param {object} userGotOptions Options to pass to the got call
+ * @returns {object} Object returned by the API
+ */
+export async function api(urlPath, userGotOptions = {}) {
+  const token = __.token();
+  const apiUrl = `https://circleci.com/api/v1.1/${urlPath}?circle-token=${token}`;
+  const defaultGotOptions = {
+    responseType: 'json',
+  };
+  const gotOptions = _.merge({}, defaultGotOptions, userGotOptions);
+  try {
+    const response = await __.got(apiUrl, gotOptions);
+    return response.body;
+  } catch (_error) {
+    throw firostError(
+      'ABERLAAS_SETUP_CIRCLECI_API',
+      "Can't connect to CircleCI API. Check that you have a valid ABERLAAS_CIRCLECI_TOKEN",
+    );
+  }
+}
+
+__ = {
   /**
    * Returns the CircleCI token saved in ENV
    * @returns {string} The CircleCI token
@@ -9,35 +43,5 @@ export default {
   token() {
     return process.env.ABERLAAS_CIRCLECI_TOKEN;
   },
-  /**
-   * Check if a CircleCI token is available
-   * @returns {boolean} True if a token is defined
-   */
-  hasToken() {
-    return !!this.token();
-  },
-  /**
-   * Make a call to the CircleCI v1 API
-   * @param {string} urlPath Part of the url after the /api/v1.1/
-   * @param {object} userGotOptions Options to pass to the got call
-   * @returns {object} Object returned by the API
-   */
-  async api(urlPath, userGotOptions = {}) {
-    const token = this.token();
-    const apiUrl = `https://circleci.com/api/v1.1/${urlPath}?circle-token=${token}`;
-    const defaultGotOptions = {
-      responseType: 'json',
-    };
-    const gotOptions = _.merge({}, defaultGotOptions, userGotOptions);
-    try {
-      const response = await this.__got(apiUrl, gotOptions);
-      return response.body;
-    } catch (_error) {
-      throw firostError(
-        'ABERLAAS_SETUP_CIRCLECI_API',
-        "Can't connect to CircleCI API. Check that you have a valid ABERLAAS_CIRCLECI_TOKEN",
-      );
-    }
-  },
-  __got: got,
+  got,
 };

package/lib/helpers/github.js

@@ -1,9 +1,68 @@
 import { _ } from 'golgoth';
 import { run } from 'firost';
 import { Octokit } from '@octokit/rest';
+import { hostGitRoot } from 'aberlaas-helper';
+import Gilmore from 'gilmore';
 import parseGithubUrl from 'parse-github-repo-url';
 
-export default {
+export let __;
+/**
+ * Check if a GitHub token is available
+ * @returns {boolean} True if a token is defined
+ */
+export function hasToken() {
+  return !!__.token();
+}
+/**
+ * Returns some data from the git config
+ * @returns {object} Object with .username, .repo and .email keys
+ */
+export async function getRepoData() {
+  if (__.cache.repoData) {
+    return __.cache.repoData;
+  }
+
+  const email = await __.config('user.email');
+  const remoteUrl = await __.config('remote.origin.url');
+  const [username, repo] = parseGithubUrl(remoteUrl);
+
+  const result = { username, repo, email };
+  __.cache.repoData = result;
+  return result;
+}
+/**
+ * Wraps Octokit and return the results
+ * @param {string} methodPath Path of the method to call
+ * @param {object} options Options to pass to the method
+ * @returns {*} Response from the API
+ */
+export async function octokit(methodPath, options) {
+  // Instanciate Octokit if not available
+  if (!__.cache.octokit) {
+    const githubToken = __.token();
+    __.cache.octokit = __.newOctokit({
+      auth: githubToken,
+      log: {
+        debug: __.noOp,
+        info: __.noOp,
+        warn: __.noOp,
+        error: __.noOp,
+      },
+    });
+  }
+
+  const octokitInstance = __.cache.octokit;
+  const method = _.get(octokitInstance, methodPath);
+  const response = await method(options);
+  return response.data;
+}
+
+__ = {
+  cache: {},
+  clearCache() {
+    __.cache = {};
+  },
+  noOp: () => {},
   /**
    * Returns the GitHub token saved in ENV
    * @returns {string} The GitHub token
@@ -11,69 +70,26 @@ export default {
   token() {
     return process.env.ABERLAAS_GITHUB_TOKEN;
   },
-  /**
-   * Check if a GitHub token is available
-   * @returns {boolean} True if a token is defined
-   */
-  hasToken() {
-    return !!this.token();
-  },
-  /**
-   * Returns some data from the git config
-   * @returns {object} Object with .username, .repo and .email keys
-   */
-  async repoData() {
-    if (this.__cache.repoData) {
-      return this.__cache.repoData;
-    }
-
-    const email = await this.config('user.email');
-    const remoteUrl = await this.config('remote.origin.url');
-    const [username, repo] = parseGithubUrl(remoteUrl);
-
-    const result = { username, repo, email };
-    this.__cache.githubData = result;
-    return result;
-  },
   /**
    * Return the value of a git config
    * @param {string} key Config key
    * @returns {string} Config value
    */
   async config(key) {
-    const response = await this.__run(`git config ${key}`, {
-      stdout: false,
-    });
-    return response.stdout;
+    if (!__.cache.repository) {
+      __.cache.repository = new Gilmore(hostGitRoot());
+    }
+
+    const repository = __.cache.repository;
+    return await repository.getConfig(key);
   },
   /**
-   * Wraps Octokit and return the results
-   * @param {string} methodPath Path of the method to call
-   * @param {object} options Options to pass to the method
-   * @returns {*} Response from the API
+   * Creates a new Octokit instance
+   * @param {...any} args - Arguments to pass to the Octokit constructor
+   * @returns {Octokit} A new Octokit instance
    */
-  async octokit(methodPath, options) {
-    // Instanciate Octokit if not available
-    if (!this.__cache.octokit) {
-      const githubToken = this.token();
-      this.__cache.octokit = new this.__Octokit({
-        auth: githubToken,
-        log: {
-          debug: this.__noOp,
-          info: this.__noOp,
-          warn: this.__noOp,
-          error: this.__noOp,
-        },
-      });
-    }
-
-    const octokit = this.__cache.octokit;
-    const method = _.get(octokit, methodPath);
-    const response = await method(options);
-    return response.data;
+  newOctokit(...args) {
+    return new Octokit(...args);
   },
-  __run: run,
-  __Octokit: Octokit,
-  __cache: {},
-  __noOp: () => {},
+  run,
 };

package/lib/renovate.js

@@ -1,22 +1,20 @@
 import { consoleError, consoleInfo, consoleSuccess } from 'firost';
-import githubHelper from './helpers/github.js';
+import { getRepoData, hasToken, octokit } from './helpers/github.js';
 
 export let __;
 
-const RENOVATE_ID = 2471197;
-
 /**
  * Attempt to automatically add the current repo to renovate, otherwise
  * display the link to do it manually
  * @returns {boolean} True if enabled, false otherwise
  */
 export async function enable() {
-  const { username, repo } = await githubHelper.repoData();
-  const manualUrl = `https://github.com/settings/installations/${RENOVATE_ID}`;
+  const { username, repo } = await __.getRepoData();
+  const manualUrl = `https://github.com/settings/installations/${__.renovateId}`;
   const renovateDashboardUrl = `https://developer.mend.io/github/${username}/${repo}`;
 
   // Fail early if no token available
-  if (!githubHelper.hasToken()) {
+  if (!__.hasToken()) {
     __.consoleError(
       'Renovate: ABERLAAS_GITHUB_TOKEN environment variable must be set',
     );
@@ -34,8 +32,8 @@ export async function enable() {
 
   try {
     const repositoryId = await __.getRepositoryId();
-    await githubHelper.octokit('apps.addRepoToInstallation', {
-      installation_id: RENOVATE_ID,
+    await __.octokit('apps.addRepoToInstallation', {
+      installation_id: __.renovateId,
       repository_id: repositoryId,
     });
   } catch (_err) {
@@ -51,13 +49,14 @@ export async function enable() {
 }
 
 __ = {
+  renovateId: 2471197,
   /**
    * Returns the GitHub repository Id
    * @returns {number} Repository Id
    */
   async getRepositoryId() {
-    const { username, repo } = await githubHelper.repoData();
-    const { id } = await githubHelper.octokit('repos.get', {
+    const { username, repo } = await __.getRepoData();
+    const { id } = await __.octokit('repos.get', {
       owner: username,
       repo,
     });
@@ -69,17 +68,16 @@ __ = {
    */
   async isAlreadyEnabled() {
     try {
-      const { username, repo } = await githubHelper.repoData();
-      const installations = await githubHelper.octokit(
+      const { username, repo } = await __.getRepoData();
+      const installations = await __.octokit(
         'apps.listReposAccessibleToInstallation',
         {
-          installation_id: RENOVATE_ID,
+          installation_id: __.renovateId,
         },
       );
 
       return installations.repositories.some(
-        (repoData) =>
-          repoData.owner.login === username && repoData.name === repo,
+        (item) => item.owner.login === username && item.name === repo,
       );
     } catch {
       // API call fails if Renovate app is not installed - treat as not enabled
@@ -89,6 +87,9 @@ __ = {
   consoleSuccess,
   consoleInfo,
   consoleError,
+  getRepoData,
+  hasToken,
+  octokit,
 };
 
 export default { enable };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aberlaas-setup",
-  "version": "2.22.2",
+  "version": "2.23.0",
   "type": "module",
   "description": "aberlaas setup helper: Setup third parties like GitHub, Netlify or CircleCI",
   "author": "Tim Carry <tim@pixelastic.com>",
@@ -21,8 +21,9 @@
   "main": "./lib/main.js",
   "dependencies": {
     "@octokit/rest": "22.0.1",
-    "aberlaas-helper": "2.22.2",
-    "firost": "5.5.1",
+    "aberlaas-helper": "2.23.0",
+    "firost": "5.5.2",
+    "gilmore": "1.2.0",
     "golgoth": "3.1.0",
     "parse-github-repo-url": "1.4.1"
   },

package/lib/helpers/npm.js

@@ -1,16 +0,0 @@
-export default {
-  /**
-   * Returns the npm token saved in ENV
-   * @returns {string} The npm token
-   */
-  token() {
-    return process.env.ABERLAAS_NPM_TOKEN;
-  },
-  /**
-   * Check if a npm token is available
-   * @returns {boolean} True if a token is defined
-   */
-  hasToken() {
-    return !!this.token();
-  },
-};

package/lib/helpers/ssh.js

@@ -1,77 +0,0 @@
-import path from 'node:path';
-import { _ } from 'golgoth';
-import { exists, mkdirp, read, run, which } from 'firost';
-import { hostGitPath } from 'aberlaas-helper';
-import githubHelper from './github.js';
-
-export default {
-  /**
-   * Check if ssh-keygen is available
-   * @returns {boolean} True if available, false otherwise
-   */
-  async hasBinary() {
-    const sshKeygenPath = await this.__which('ssh-keygen');
-    return !!sshKeygenPath;
-  },
-  /**
-   * Returns SSH keys (generate them if needed)
-   * @returns {object} Object with .public, .private and .privateFingerprint
-   */
-  async getKeys() {
-    const keyPath = hostGitPath('./tmp/ssh/key');
-
-    // Generating keys if do not exist
-    const keyExists = await exists(keyPath);
-    if (!keyExists) {
-      await this.generateKeys(keyPath);
-    }
-
-    const publicKeyPath = `${keyPath}.pub`;
-    const publicKey = await read(publicKeyPath);
-    const privateKey = await read(keyPath);
-    const privateFingerprint = await this.getFingerprint(keyPath);
-
-    return {
-      public: publicKey,
-      private: privateKey,
-      privateFingerprint,
-    };
-  },
-  /**
-   * Generate SSH keys
-   * @param {string} keyPath Path to the public key
-   */
-  async generateKeys(keyPath) {
-    const keyDirectory = path.dirname(keyPath);
-    await mkdirp(keyDirectory);
-    const { email: keyEmail } = await githubHelper.repoData();
-    const sshKeygenArguments = [
-      '-m PEM',
-      '-t rsa',
-      `-C ${keyEmail}`,
-      `-f ${keyPath}`,
-      "-N ''",
-    ];
-    const command = `ssh-keygen ${sshKeygenArguments.join(' ')}`;
-    // Need to run in shell mode, otherwise does not understand the empty
-    // passphrase
-    await this.__run(command, { shell: true, stdout: false });
-  },
-  /**
-   * Returns the md5 fingerprint from a key path
-   * @param {string} keyPath Filepath to the key file
-   * @returns {string} Fingerprint as used by CircleCI and GitHub
-   */
-  async getFingerprint(keyPath) {
-    const command = `ssh-keygen -E md5 -l -f ${keyPath}`;
-    const result = await this.__run(command, { stdout: false });
-    return _.chain(result)
-      .get('stdout')
-      .split(' ')
-      .nth(1)
-      .replace('MD5:', '')
-      .value();
-  },
-  __which: which,
-  __run: run,
-};