@govuk-pay/cli 0.0.60 → 0.0.62

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@govuk-pay/cli",
-  "version": "0.0.60",
+  "version": "0.0.62",
   "description": "GOV.UK Pay Command Line Interface",
   "bin": {
     "pay": "bin/cli.js",

package/readme.md

@@ -58,7 +58,7 @@ Config files needed by the pay cli will go in `$HOME/.pay-cli"
 
 #### Pay Local Config Files
 
-You can override environment variables set in the the .env files in [the pay local services local config directory](https://github.com/alphagov/pay-cli/tree/main/resources/legacy-ruby-cli/lib/pay_cli/commands/local/files/services` for
+You can override environment variables set in the .env files in [the pay local services local config directory](https://github.com/alphagov/pay-cli/tree/main/resources/legacy-ruby-cli/lib/pay_cli/commands/local/files/services) for
 specific containers by placing files in `$HOME/.pay-cli/local/environment-overrides/<app_name>.env`.
 
 For example to override an environment variable for connector which was set in [connector.env](https://github.com/alphagov/pay-cli/blob/main/resources/legacy-ruby-cli/lib/pay_cli/commands/local/files/services/connector.env)
@@ -67,6 +67,23 @@ you could create the file `$HOME/.pay-cli/local/environment-overrides/connector.
 Note: This will only override variables set in the .env files, it will not override any variables which get declared in an `environment` configuration option in the generated docker-compose files. These are generated from the
 [docker-compose.erb](https://github.com/alphagov/pay-cli/blob/main/resources/legacy-ruby-cli/lib/pay_cli/commands/local/files/docker-compose.erb#L5) template.
 
+You can configure custom clusters by creating a file at `$HOME/.pay-cli/local/custom-clusters.yaml` following the schema:
+```yaml
+clusters:
+  - name: my-cool-cluster
+    apps:
+      - connector
+      - selfservice
+      - frontend
+      - adminusers
+      - toolbox
+  - name: another-cool-cluster
+    apps:
+      - connector
+      - selfservice
+      - frontend
+```
+
 ## Vulnerability Disclosure
 
 GOV.UK Pay aims to stay secure for everyone. If you are a security researcher and have discovered a security vulnerability in this code, we appreciate your help in disclosing it to us in a responsible manner. Please refer to our [vulnerability disclosure policy](https://www.gov.uk/help/report-vulnerability) and our [security.txt](https://vdp.cabinetoffice.gov.uk/.well-known/security.txt) file for details.

package/src/commands/local/config/pay_local_cluster.js

@@ -3,12 +3,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadServicesConfig = exports.loadClusterConfig = exports.PayLocalCluster = exports.CLUSTERS = void 0;
+exports.loadCustomClusterConfig = exports.loadServicesConfig = exports.loadClusterConfig = exports.PayLocalCluster = exports.CUSTOM_CLUSTER_NAMES = exports.CUSTOM_CLUSTERS = exports.CUSTOM_CLUSTERS_PATH = exports.CLUSTERS = void 0;
 const node_fs_1 = __importDefault(require("node:fs"));
 const node_path_1 = __importDefault(require("node:path"));
 const yaml_1 = __importDefault(require("yaml"));
 const md5_js_1 = require("../../../util/md5.js");
+const configs_1 = require("../../../util/configs");
 exports.CLUSTERS = ['all', 'admin', 'card', 'paymentlinks', 'webhooks', 'endtoend', 'java', 'toolbox'];
+exports.CUSTOM_CLUSTERS_PATH = node_path_1.default.join((0, configs_1.ensureConfigDirectory)('local'), 'custom-clusters.yaml');
+exports.CUSTOM_CLUSTERS = loadCustomClusterConfig(exports.CUSTOM_CLUSTERS_PATH);
+exports.CUSTOM_CLUSTER_NAMES = exports.CUSTOM_CLUSTERS.clusters.map(cluster => cluster.name);
 // This is the complete cluster configuration that will be used as the context for template rendering
 class PayLocalCluster {
     name;
@@ -132,12 +136,30 @@ function loadServicesConfig() {
     return yaml_1.default.parse(serviceConfigFileContents);
 }
 exports.loadServicesConfig = loadServicesConfig;
+function loadCustomClusterConfig(customClusterPath) {
+    try {
+        const customClusterFileContents = node_fs_1.default.readFileSync(customClusterPath, 'utf8');
+        return yaml_1.default.parse(customClusterFileContents);
+    }
+    catch (e) {
+        return {
+            clusters: []
+        };
+    }
+}
+exports.loadCustomClusterConfig = loadCustomClusterConfig;
 function includeAppInCluster(cluster, options, serviceConfig) {
     if (cluster === 'all' || cluster === 'nuke' || serviceConfig.clusters.includes(cluster)) {
         if (options.apps.length === 0 || options.apps.includes(serviceConfig.name)) {
             return true;
         }
     }
+    else if (exports.CUSTOM_CLUSTER_NAMES.includes(cluster)) {
+        const customCluster = exports.CUSTOM_CLUSTERS.clusters.filter(c => c.name === cluster)[0];
+        if (customCluster.apps.includes(serviceConfig.name)) {
+            return true;
+        }
+    }
     return false;
 }
 function payServiceFromPayServiceConfig(config, upOptions, environmentOverridesPath) {

package/src/commands/local/subcommands/up.js

@@ -22,7 +22,7 @@ const builder = (yargs) => {
         .usage(`$0 local up | launch [--cluster <cluster>] [--local <app>] [--proxy] [--apps] [--rebuild] [--with-egress-proxy]\n\n${exports.desc}\n\nSpecify a list of apps that should use your locally checked out code using --local`)
         .option('cluster', {
         type: 'string',
-        choices: pay_local_cluster_js_1.CLUSTERS,
+        choices: [].concat(pay_local_cluster_js_1.CLUSTERS, pay_local_cluster_js_1.CUSTOM_CLUSTER_NAMES),
         default: 'all',
         description: 'Cluster of services to launch'
     })