@docupace/pipeline 1.0.39-matttest.24 → 1.0.39-matttest.26

package/README.md

@@ -0,0 +1,136 @@
+# Pipeline Shared Scripts
+
+A collection of CLI tools for Docupace's CI/CD pipelines and deployment workflows.
+
+## Overview
+
+This package provides a set of command-line interfaces (CLIs) to facilitate various DevOps operations in the Docupace ecosystem:
+
+- `dp-next-cli`: Deployment and pipeline management for Next applications
+- `dp-changeset-cli`: Versioning and changeset management 
+- `dp-auth0-cli`: Auth0 tenant configuration and management
+
+## Installation
+
+```bash
+npm install @docupace/pipeline
+```
+
+Or with pnpm:
+
+```bash
+pnpm add @docupace/pipeline
+```
+
+## Command Line Interfaces
+
+### dp-next-cli
+
+Manages deployment, Docker image handling, and infrastructure configuration.
+
+```bash
+dp-next-cli [command] [options]
+```
+
+**Commands:**
+
+- `pull <imageName>`: Pull a Docker image from the registry
+- `sonar`: Run Sonar analysis
+- `addApacheSite`: Add site to apache
+- `connectClone`: Clone connect site
+- `haproxySync`: Sync haproxy config
+- `vaultAddSiteData`: Add m2m auth0 data to vault
+  - `-s, --site-name <siteName>`: Site name
+  - `-p, --site-config-remote-path <path>`: Site config remote path
+- `publish`: Publish a Docker image
+- `deploy-from-site`: Deploy an application for a specific site
+  - `-f, --from-env <fromEnv>`: Source environment
+  - `-t, --to-env <toEnv>`: Target environment
+  - `-F, --from-site <fromSite>`: Source site
+  - `-T, --to-site <toSite>`: Target site
+  - `-c, --deploy-core <deployCore>`: Deploy Core (default: "false")
+  - `-C, --deploy-connect <deployConnect>`: Deploy Connect (default: "false")
+- `deploy-template`: Deploy an application for a specific site
+- `deploy-app <application>`: Deploy an application for a specific site
+- `deploy-core <env> <site>`: Deploy Core
+  - `-l, --liquibase <liquibase>`: Application name (default: "true")
+  - `-b, --branch <branch>`: Branch (default: "master")
+- `deploy-connect <env> <site>`: Deploy Connect
+  - `-l, --liquibase <liquibase>`: Application name (default: "true")
+  - `-b, --branch <branch>`: Branch (default: "master")
+- `deploy-core-pipeline <env> <site>`: Deploy Core via pipeline
+  - `-l, --liquibase <liquibase>`: Application name (default: "true")
+  - `-b, --branch <branch>`: Branch (default: "master")
+- `copy`: Copy a Docker image between registries
+  - `-a, --application <application>`: Application name
+  - `-f, --from-env <fromEnv>`: Source environment
+  - `-t, --to-env <toEnv>`: Target environment
+  - `-g, --tag <tag>`: Image tag
+- `run-pipeline`: Trigger a pipeline by name
+  - `-r, --repository <repository>`: Repository name
+  - `-p, --pipeline-name <pipelineName>`: Pipeline name
+  - `-b, --branch <branch>`: Branch name
+  - `-v, --variables <key=value>`: Pipeline variable as key=value pair
+  - `-w, --wait`: Wait for the pipeline to complete (default: false)
+
+### dp-changeset-cli
+
+Manages versioning and changesets for mono-repos and single-package repos.
+
+```bash
+dp-changeset-cli [command] [options]
+```
+
+**Commands:**
+
+- `validate`: Validate changesets for the provided PR
+- `version`: Run Changeset versioning
+- `commit-tag`: Commit and tag the new version
+- `version-commit-tag`: Run versioning and commit-and-tag in sequence
+- `close-version`: Close a version and create a release branch
+- `create-changeset`: Create a changeset based on the current branch and Jira ticket information
+
+### dp-auth0-cli
+
+Manages Auth0 tenant configuration across environments.
+
+```bash
+dp-auth0-cli [command] [options]
+```
+
+**Commands:**
+
+- `configureFromSite <fromSite> <toSite> <fromEnv> <toEnv> <deployUI> <deployGraphQLServer> <useNewDomain> <useS3>`: Configure Auth0 tenants
+- `getVaultSecrets <vaultPath>`: Get secrets from Vault
+- `configureAlias <site> <env> <username> <password> <realm>`: Configure Core Alias for the given site
+- `exportConf <site> <env>`: Export Auth0 configuration for the given site
+- `getAuth0Metadata <site> <env>`: Get Auth0 metadata for the given site
+
+## Environment Configuration
+
+The CLI tools look for environment configuration in the following locations:
+- `.env.pipeline.local`
+- `config/.env.pipeline.local`
+
+## Examples
+
+```bash
+# Deploy from one site to another
+dp-next-cli deploy-from-site --from-env dev --to-env dev --from-site financialdev --to-site template --deploy-core true
+
+# Run a pipeline
+dp-next-cli run-pipeline -r docupace-next-e2e -b master -p run-tests-qa
+
+# Validate changesets
+dp-changeset-cli validate
+
+# Create a new changeset
+dp-changeset-cli create-changeset
+
+# Configure Auth0 for a site
+dp-auth0-cli configureFromSite sourceSite targetSite dev prod true true true false
+```
+
+## License
+
+ISC

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docupace/pipeline",
-  "version": "1.0.39-matttest.24",
+  "version": "1.0.39-matttest.26",
   "description": "",
   "main": "index.js",
   "type": "module",

package/src/auth0/configure.js

@@ -5,16 +5,16 @@ import crypto from 'crypto';
 
 import {
   cloneEnvRepository,
-  readDeployConfig,
-  pushDeployConfig,
   cloneRepository,
+  pushDeployConfig,
+  readDeployConfig,
 } from '../next/deploy.js';
 
 import { getVaultSecrets, updateVaultSecrets } from './vault.js';
 import {
-  getVaultSecretsConfigs,
-  environmentConfig,
   coreSiteEnvMap,
+  environmentConfig,
+  getVaultSecretsConfigs,
 } from '../next/config.js';
 
 async function ensureDirectoryExists(dirPath) {

package/src/auth0/metadata.js

@@ -1,11 +1,10 @@
 import fs from 'fs-extra';
 import axios from 'axios';
 import path from 'path';
-import { cloneRepository } from '../next/deploy.js';
+import { cloneRepository, pushDeployConfig } from '../next/deploy.js';
 import { getAuth0AuthToken } from './configure.js';
 import { getVaultSecrets } from './vault.js';
 import { getVaultSecretsConfigs } from '../next/config.js';
-import { pushDeployConfig } from '../next/deploy.js';
 
 export async function getAuth0Metadata(site, env) {
   try {

package/src/changeset/cli.js

@@ -3,10 +3,9 @@ import { Command } from 'commander';
 import { $ } from 'zx';
 import { validateChangesets } from './validate.js';
 import dotenv from 'dotenv';
-import { getChangedAppPackages, isMonoRepo, setGitInfo } from '../next/util.js';
+import { isMonoRepo, setGitInfo } from '../next/util.js';
 import { updateJiraWithVersion, versionCommand } from './version.js';
 import { createChangeset } from './create.js';
-import { getPackage } from './util.js';
 
 dotenv.config({ path: ['.env.pipeline.local', 'config/.env.pipeline.local'] });
 

package/src/changeset/create.js

@@ -4,7 +4,7 @@ import z from 'zod';
 import { zodResponseFormat } from 'openai/helpers/zod';
 import fs from 'fs';
 import path from 'path';
-import { getAllAppPackages, isMonoRepo } from '../next/util.js';
+import { getAllAppPackages, getAllPackages, isMonoRepo } from '../next/util.js';
 import inquirer from 'inquirer';
 import { getMainPackage, getPackage } from './util.js';
 
@@ -128,17 +128,17 @@ ${summary} [${jiraTicketId}]
 
 export async function createChangeset() {
   if (isMonoRepo()) {
-    const appPackages = await getAllAppPackages();
+    const allPackages = await getAllPackages();
     const response = await inquirer.prompt([
       {
         type: 'list',
         name: 'package',
         message: 'Which package do you want to generate changesetfor?',
-        choices: appPackages.map((appPackage) => appPackage.name),
+        choices: allPackages.map((appPackage) => appPackage.name),
       },
     ]);
 
-    const selectedPackage = appPackages.find(
+    const selectedPackage = allPackages.find(
       (appPackage) => appPackage.name == response.package,
     );
 

package/src/changeset/validate.js

@@ -4,20 +4,35 @@ import { $ } from 'zx';
 
 import { isMonoRepo, setGitInfo } from '../next/util.js';
 import { versionStatus } from './version.js';
-import { getAppReleases } from './cli.js';
 
 const CHANGESET_DIR = '.changeset';
 
+function areArraysEqualIgnoringOrder(arr1, arr2) {
+  if (arr1.length !== arr2.length) return false;
+
+  const sortedA = [...arr1].sort();
+  const sortedB = [...arr2].sort();
+
+  return sortedA.every((element, index) => element === sortedB[index]);
+}
+
 export async function validateChangesets() {
   if (isMonoRepo()) {
     await setGitInfo();
     const destBranch = process.env.BITBUCKET_PR_DESTINATION_BRANCH;
     await $`git fetch origin ${destBranch}:${destBranch}`;
-    const releases = await versionStatus(destBranch);
-    const appReleases = getAppReleases(releases);
-    if (appReleases.length == 0) {
-      throw new Error('Must have a changeset for at lease one app');
-    }
+    await versionStatus(destBranch);
+    /*const changedPackages = await getChangedPackages();
+    const releaseNames = releases.map((release) => release.name);
+    const changedPackageNames = changedPackages.map(
+      (changedPackage) => changedPackage.name,
+    );
+
+    if (!areArraysEqualIgnoringOrder(releaseNames, changedPackageNames)) {
+      throw new Error(
+        'Changesets must be created for all packages created and for those that have those changed as dependencies',
+      );
+    }*/
   } else {
     await validateChangesetPath(path.resolve(process.cwd(), CHANGESET_DIR));
   }

package/src/jenkins/setParams.groovy

@@ -1,6 +1,5 @@
 import groovy.json.JsonSlurper
-
-import hudson.model.*;
+import hudson.model.*
 
 def build = Thread.currentThread().executable
 def params = build.getEnvironment(listener)

package/src/next/apache.js

@@ -1,40 +1,43 @@
 import { $ } from 'zx';
 
 export async function addApacheSite() {
-    if (
-      !process.env.ENVIRONMENT ||
-      (process.env.ENVIRONMENT !== 'dev' && process.env.ENVIRONMENT !== 'qa')
-    ) {
-      log("Error: ENVIRONMENT must be either 'dev' or 'qa'.");
-      process.exit(1);
-    }
-    if (!process.env.SITE) {
-      log('Error: SITE cannot be empty.');
-      process.exit(1);
-    }
-  
-    // Save private key from base64
-    const haproxyPrivateKey = process.env.HAPROXY_PRIVATE_KEY;
-    if (!haproxyPrivateKey) {
-      log('Error: HAPROXY_PRIVATE_KEY not set.');
-      process.exit(1);
-    }
-  
-    await fs.writeFile('private.key', Buffer.from(haproxyPrivateKey, 'base64'));
-    await fs.chmod('private.key', 0o600);
-  
-    
-    console.log("Running command");
-    const sshCmd = (server,script) =>
-      $`ssh -i private.key -o StrictHostKeyChecking=no root@${server} ${script}`;
-  
-    let server = `${process.env.ENVIRONMENT}-apalb01a.corp.docupace.com`;
-    // The script is run twice in the Bash version
-    await sshCmd(server, `/root/repo/iis-preprod/scripts/addsite/add_core_site.sh ${process.env.ENVIRONMENT} ${process.env.SITE}`);
-
-    server = `${process.env.ENVIRONMENT}-apalb01b.corp.docupace.com`;
+  if (
+    !process.env.ENVIRONMENT ||
+    (process.env.ENVIRONMENT !== 'dev' && process.env.ENVIRONMENT !== 'qa')
+  ) {
+    log("Error: ENVIRONMENT must be either 'dev' or 'qa'.");
+    process.exit(1);
+  }
+  if (!process.env.SITE) {
+    log('Error: SITE cannot be empty.');
+    process.exit(1);
+  }
 
-    await sshCmd(server,`/root/repo/iis-preprod/scripts/addsite/add_core_site.sh ${process.env.ENVIRONMENT} ${process.env.SITE}`);
+  // Save private key from base64
+  const haproxyPrivateKey = process.env.HAPROXY_PRIVATE_KEY;
+  if (!haproxyPrivateKey) {
+    log('Error: HAPROXY_PRIVATE_KEY not set.');
+    process.exit(1);
   }
-  
-  
+
+  await fs.writeFile('private.key', Buffer.from(haproxyPrivateKey, 'base64'));
+  await fs.chmod('private.key', 0o600);
+
+  console.log('Running command');
+  const sshCmd = (server, script) =>
+    $`ssh -i private.key -o StrictHostKeyChecking=no root@${server} ${script}`;
+
+  let server = `${process.env.ENVIRONMENT}-apalb01a.corp.docupace.com`;
+  // The script is run twice in the Bash version
+  await sshCmd(
+    server,
+    `/root/repo/iis-preprod/scripts/addsite/add_core_site.sh ${process.env.ENVIRONMENT} ${process.env.SITE}`,
+  );
+
+  server = `${process.env.ENVIRONMENT}-apalb01b.corp.docupace.com`;
+
+  await sshCmd(
+    server,
+    `/root/repo/iis-preprod/scripts/addsite/add_core_site.sh ${process.env.ENVIRONMENT} ${process.env.SITE}`,
+  );
+}

package/src/next/cli.js

@@ -7,26 +7,24 @@ import { publish } from './publish.js';
 import {
   deployAppWithTag,
   deployFromSite,
+  deployTemplate,
   getDefaultDeploySite,
   getDeployTag,
 } from './deploy.js';
-import { deployTemplate } from './deploy.js';
 import { copy } from './copy.js';
 import { vaultAddSiteData } from './vault.js';
 import { addApacheSite } from './apache.js';
 import { haproxySync } from './haproxy.js';
 import { connectClone } from './connect.js';
 import dotenv from 'dotenv';
+import { $ } from 'zx';
+import { deployConnect, deployCore } from './jenkins.js';
+import { runPipeline } from './pipline.js';
 
 dotenv.config({ path: ['.env.pipeline.local', 'config/.env.pipeline.local'] });
 
 const program = new Command();
 
-import { $ } from 'zx';
-import { deployConnect, deployCore } from './jenkins.js';
-import { runPipeline } from './pipline.js';
-import { buildChangePackages } from './util.js';
-
 const GIT_SHA = (await $`git log --pretty=format:'%h' -n 1`).stdout.trim();
 
 program
@@ -165,13 +163,6 @@ program
     });
   });
 
-program
-  .command('build-mono-repo')
-  .description('Build Mono Repo')
-  .action(async () => {
-    await buildChangePackages();
-  });
-
 program
   .command('copy')
   .description('Copy a Docker image between registries')

package/src/next/deploy.js

@@ -6,7 +6,7 @@ import lodash from 'lodash';
 import { appInfo, environmentConfig, getRepUrl } from './config.js';
 import { copy2 } from './copy.js';
 import axios from 'axios';
-import { deployCore, deployConnect } from './jenkins.js';
+import { deployConnect, deployCore } from './jenkins.js';
 
 /**
  * Clone the repository, read the YAML file, and return the parsed data and file paths.

package/src/next/haproxy.js

@@ -1,12 +1,11 @@
 import { $ } from 'zx';
 
-
 export async function haproxySync() {
-    const repoPath = '/root/repo/docupace-ansible';
-    const inventory = path.join(repoPath, 'inventories/preprod/inventory');
-  
-    // Create haproxy.sh
-    const scriptContent = `
+  const repoPath = '/root/repo/docupace-ansible';
+  const inventory = path.join(repoPath, 'inventories/preprod/inventory');
+
+  // Create haproxy.sh
+  const scriptContent = `
   #!/bin/bash
   
   [[ ! -f ${inventory} ]] && ( echo "Alert: no inventory file: ${inventory}" ; exit 1 )
@@ -27,24 +26,24 @@ export async function haproxySync() {
   git commit -m "Sync haproxy"
   git push origin master
   `;
-  
-    await fs.writeFile('haproxy.sh', scriptContent);
-  
-    // Private key
-    const haproxyPrivateKey = process.env.HAPROXY_PRIVATE_KEY;
-    if (!haproxyPrivateKey) {
-      log('Error: HAPROXY_PRIVATE_KEY not set.');
-      process.exit(1);
-    }
-  
-    await fs.writeFile('private.key', Buffer.from(haproxyPrivateKey, 'base64'));
-    await fs.chmod('private.key', 0o600);
-  
-    await $`cat private.key`; // Just to mimic the script's behavior
-  
-    // Copy script to remote
-    await $`scp -i private.key -o StrictHostKeyChecking=no haproxy.sh root@10.10.28.198:/tmp/haproxy.sh`;
-  
-    // Execute script on remote
-    await $`ssh -i private.key -o StrictHostKeyChecking=no root@10.10.28.198 "bash /tmp/haproxy.sh"`;
+
+  await fs.writeFile('haproxy.sh', scriptContent);
+
+  // Private key
+  const haproxyPrivateKey = process.env.HAPROXY_PRIVATE_KEY;
+  if (!haproxyPrivateKey) {
+    log('Error: HAPROXY_PRIVATE_KEY not set.');
+    process.exit(1);
   }
+
+  await fs.writeFile('private.key', Buffer.from(haproxyPrivateKey, 'base64'));
+  await fs.chmod('private.key', 0o600);
+
+  await $`cat private.key`; // Just to mimic the script's behavior
+
+  // Copy script to remote
+  await $`scp -i private.key -o StrictHostKeyChecking=no haproxy.sh root@10.10.28.198:/tmp/haproxy.sh`;
+
+  // Execute script on remote
+  await $`ssh -i private.key -o StrictHostKeyChecking=no root@10.10.28.198 "bash /tmp/haproxy.sh"`;
+}

package/src/next/util.js

@@ -1,7 +1,6 @@
 import { existsSync } from 'fs';
-import { join } from 'path';
-import { $, nothrow } from 'zx';
-import path from 'path';
+import path, { join } from 'path';
+import { $ } from 'zx';
 
 export function isMonoRepo() {
   // Check for the presence of turbo.json which indicates a Turborepo monorepo
@@ -86,7 +85,9 @@ export async function getChangedAppPackages() {
 }
 
 export async function setGitInfo() {
-  await $`git config --global user.email "gitops@docupace.com"`;
-  await $`git config --global user.name "Gitops"`;
-  await $`git remote set-url origin https://${process.env.THIS_REP_TOKEN}@bitbucket.org/${process.env.BITBUCKET_REPO_FULL_NAME}.git`;
+  if (!process.env.IS_DEV) {
+    await $`git config --global user.email "gitops@docupace.com"`;
+    await $`git config --global user.name "Gitops"`;
+    await $`git remote set-url origin https://${process.env.THIS_REP_TOKEN}@bitbucket.org/${process.env.BITBUCKET_REPO_FULL_NAME}.git`;
+  }
 }

package/src/next/vault.js

@@ -3,8 +3,8 @@ import axios from 'axios';
 export async function vaultAddSiteData(SITE, SITE_CONFIG_REMOTE_PATH) {
   const AUTH0_CLIENT_ID = process.env.AUTH0_CLIENT_ID;
   const AUTH0_CLIENT_SECRET = process.env.AUTH0_CLIENT_SECRET;
-  const VAULT_ADDR = process.env.VAULT_ADDR;       // Vault host URL from environment variables
-  const VAULT_TOKEN = process.env.VAULT_TOKEN;     // Vault token from environment variables
+  const VAULT_ADDR = process.env.VAULT_ADDR; // Vault host URL from environment variables
+  const VAULT_TOKEN = process.env.VAULT_TOKEN; // Vault token from environment variables
 
   if (!VAULT_ADDR || !VAULT_TOKEN) {
     throw new Error('Missing VAULT_ADDR or VAULT_TOKEN environment variable.');
@@ -13,7 +13,6 @@ export async function vaultAddSiteData(SITE, SITE_CONFIG_REMOTE_PATH) {
   const vaultApiUrl = `${VAULT_ADDR}/v1/secret/data/${SITE}/common/config`;
 
   try {
-
     if (process.env.VAULT_SKIP_VERIFY === 'true') {
       process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';
     }
@@ -32,12 +31,15 @@ export async function vaultAddSiteData(SITE, SITE_CONFIG_REMOTE_PATH) {
           'X-Vault-Token': VAULT_TOKEN,
           'Content-Type': 'application/json',
         },
-      }
+      },
     );
 
     console.log('Data added to Vault successfully:', response.data);
   } catch (error) {
-    console.error('Error adding data to Vault:', error.response?.data || error.message);
+    console.error(
+      'Error adding data to Vault:',
+      error.response?.data || error.message,
+    );
     throw error;
   }
 }