@constructor-io/constructorio-connect-cli 1.14.0 → 1.15.1

package/README.md

@@ -43,18 +43,22 @@ With the new repository initialized, you can start developing your catalog integ
 
 ## `constructorio-connect-cli deploy ENV`
 
-Deploys all templates defined on the `connectrc.js` file to the specified environment.
+Deploys all templates defined on the `connectrc.js` file to the specified environment, after running tests ('--force' to skip).
 
 ```
 USAGE
-  $ constructorio-connect-cli deploy ENV
+  $ constructorio-connect-cli deploy ENV [-f]
 
 ARGUMENTS
   ENV  (development|qa|production|demo) The target Constructor environment to deploy to.
 
+FLAGS
+  -f, --force  Skip tests before deploying
+
 DESCRIPTION
 
-  Deploys all templates defined on the `connectrc.js` file to the specified environment.
+  Deploys all templates defined on the `connectrc.js` file to the specified environment, after running tests ('--force'
+  to skip).
 
   The script will use the `CONNECT_AUTH_TOKEN` environment variable to authenticate with Constructor.
 
@@ -64,6 +68,8 @@ EXAMPLES
   $ constructorio-connect-cli deploy qa
 
   $ constructorio-connect-cli deploy production
+
+  $ constructorio-connect-cli deploy production --force
 ```
 
 

package/boilerplate-repo/.github/workflows/deploy.yml

@@ -5,7 +5,7 @@
 #
 #   This workflow can be triggered from the GitHub Actions tab. Just open the actions tab,
 #   select the workflow, and click the "Run workflow" button. Then, select your desired
-#   environment and confirm the deployment.
+#   environment, select if you want to skip tests and confirm the deployment.
 #
 #   Only one deployment per environment can run at a time. If a deployment is already in
 #   progress, triggering a new deployment will cancel the previous one.
@@ -27,6 +27,11 @@ on:
           - qa
           - production
           - demo
+      force:
+        description: Skip tests during deployment
+        required: false
+        type: boolean
+        default: false
 
 concurrency:
   group: deploy-${{ github.event.inputs.environment }}
@@ -48,12 +53,12 @@ jobs:
       - name: Setup node
         uses: actions/setup-node@v4
         with:
-          node-version: '18.18.0'
+          node-version: "18.18.0"
 
       - name: Install dependencies
         run: npm ci
 
       - name: Deploy
-        run: IS_CI=true npm run deploy ${{ github.event.inputs.environment }}
+        run: IS_CI=true npm run deploy ${{ github.event.inputs.environment }} ${{ github.event.inputs.force && '--force' || '' }}
         env:
           CONNECT_AUTH_TOKEN: ${{ secrets.CONNECT_AUTH_TOKEN }}

package/boilerplate-repo/test/templates/item/item.spec.mjs

@@ -1,10 +1,18 @@
 /**
  * Check out the documentation to see how to write and maintain tests:
  * @see https://docs.constructor.com/docs/integrating-with-constructor-connect-cli-development-flow#step-3-test-your-templates
-*/
+ */
+
+import { executeTemplate, buildFixture } from "@constructor-io/constructorio-connect-cli";
 
 describe("item", () => {
-  it("should be defined", async () => {
-    expect(true).toBe(true);
+  it("should match snapshot", async () => {
+    const result = await executeTemplate({
+      type: "item",
+      name: "item.jsonata",
+      fixture: buildFixture("item", "item.json"),
+    });
+
+    expect(result).toMatchSnapshot();
   });
 });

package/boilerplate-repo/test/templates/item_group/item_group.spec.mjs

@@ -1,10 +1,18 @@
 /**
  * Check out the documentation to see how to write and maintain tests:
  * @see https://docs.constructor.com/docs/integrating-with-constructor-connect-cli-development-flow#step-3-test-your-templates
-*/
+ */
+
+import { executeTemplate, buildFixture } from "@constructor-io/constructorio-connect-cli";
 
 describe("item_group", () => {
-  it("should be defined", async () => {
-    expect(true).toBe(true);
+  it("should match snapshot", async () => {
+    const result = await executeTemplate({
+      type: "item_group",
+      name: "item_group.jsonata",
+      fixture: buildFixture("item_group", "item_group.json"),
+    });
+
+    expect(result).toMatchSnapshot();
   });
 });

package/boilerplate-repo/test/templates/mapping/mapping.spec.mjs

@@ -1,10 +1,38 @@
 /**
  * Check out the documentation to see how to write and maintain tests:
  * @see https://docs.constructor.com/docs/integrating-with-constructor-connect-cli-development-flow#step-3-test-your-templates
-*/
+ */
+
+import { executeTemplate, buildFixture } from "@constructor-io/constructorio-connect-cli";
 
 describe("mapping", () => {
-  it("should be defined", async () => {
-    expect(true).toBe(true);
+  it("should map item groups", async () => {
+    const result = await executeTemplate({
+      type: "mapping",
+      name: "mapping.jsonata",
+      fixture: buildFixture("mapping", "mapping.json"),
+    });
+
+    expect(result.item_groups).toMatchSnapshot();
+  });
+
+  it("should map items", async () => {
+    const result = await executeTemplate({
+      type: "mapping",
+      name: "mapping.jsonata",
+      fixture: buildFixture("mapping", "mapping.json"),
+    });
+
+    expect(result.items).toMatchSnapshot();
+  });
+
+  it("should map variations", async () => {
+    const result = await executeTemplate({
+      type: "mapping",
+      name: "mapping.jsonata",
+      fixture: buildFixture("mapping", "mapping.json"),
+    });
+
+    expect(result.variations).toMatchSnapshot();
   });
 });

package/boilerplate-repo/test/templates/variation/variation.spec.mjs

@@ -1,10 +1,18 @@
 /**
  * Check out the documentation to see how to write and maintain tests:
  * @see https://docs.constructor.com/docs/integrating-with-constructor-connect-cli-development-flow#step-3-test-your-templates
-*/
+ */
+
+import { executeTemplate, buildFixture } from "@constructor-io/constructorio-connect-cli";
 
 describe("variation", () => {
-  it("should be defined", async () => {
-    expect(true).toBe(true);
+  it("should match snapshot", async () => {
+    const result = await executeTemplate({
+      type: "variation",
+      name: "variation.jsonata",
+      fixture: buildFixture("variation", "variation.json"),
+    });
+
+    expect(result).toMatchSnapshot();
   });
 });

package/dist/commands/deploy.d.ts

@@ -3,6 +3,9 @@ export default class Deploy extends RefreshConnectionsCommand {
     static args: {
         env: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
     };
+    static flags: {
+        force: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
     static description: string;
     static examples: string[];
     runCommand(): Promise<any>;

package/dist/commands/deploy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../src/commands/deploy.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,yBAAyB;IAC3D,MAAM,CAAC,IAAI;;MAMT;IAEF,MAAM,CAAC,WAAW,SAGqF;IAEvG,MAAM,CAAC,QAAQ,WAIb;IAEI,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC;CAgDjC"}
+{"version":3,"file":"deploy.d.ts","sourceRoot":"","sources":["../../src/commands/deploy.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE1E,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,yBAAyB;IAC3D,MAAM,CAAC,IAAI;;MAMT;IAEF,MAAM,CAAC,KAAK;;MAKV;IAEF,MAAM,CAAC,WAAW,SAGqF;IAEvG,MAAM,CAAC,QAAQ,WAKb;IAEI,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC;CA+DjC"}

package/dist/commands/deploy.js

@@ -13,6 +13,7 @@ const ux_action_1 = require("../helpers/ux-action");
 const deploy_request_1 = require("../http/deploy-request");
 const render_tip_1 = require("../rendering/render-tip");
 const refresh_connections_command_1 = require("./refresh-connections-command");
+const child_process_1 = require("child_process");
 class Deploy extends refresh_connections_command_1.RefreshConnectionsCommand {
     static args = {
         env: core_1.Args.string({
@@ -21,17 +22,37 @@ class Deploy extends refresh_connections_command_1.RefreshConnectionsCommand {
             required: true,
         }),
     };
+    static flags = {
+        force: core_1.Flags.boolean({
+            char: "f",
+            description: "Skip tests before deploying",
+        }),
+    };
     static description = `
-  Deploys all templates defined on the \`connectrc.js\` file to the specified environment.
+  Deploys all templates defined on the \`connectrc.js\` file to the specified environment, after running tests ('--force' to skip).
 
   The script will use the \`CONNECT_AUTH_TOKEN\` environment variable to authenticate with Constructor.`;
     static examples = [
         "$ <%= config.bin %> deploy development",
         "$ <%= config.bin %> deploy qa",
         "$ <%= config.bin %> deploy production",
+        "$ <%= config.bin %> deploy production --force",
     ];
     async runCommand() {
-        const { args } = await this.parse(Deploy);
+        const { flags, args } = await this.parse(Deploy);
+        if (!flags.force) {
+            try {
+                (0, child_process_1.execSync)("npm run test", {
+                    stdio: "inherit",
+                    cwd: process.cwd(),
+                });
+                this.log(`\n`);
+            }
+            catch (_) {
+                this.log(`\n${kleur_1.default.red("❌ Tests failed!")}\n`);
+                throw new errors_1.CLIError(`Tests failed. Fix the tests or use --force to deploy anyway.`);
+            }
+        }
         const config = await (0, ux_action_1.uxAction)("📡 Reading your config", async () => {
             return await (0, config_1.getRepositoryConfigFile)();
         })();

package/dist/version.d.ts

@@ -1,3 +1,3 @@
-declare const _default: "1.14.0";
+declare const _default: "1.15.1";
 export default _default;
 //# sourceMappingURL=version.d.ts.map

package/dist/version.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '1.14.0';
+exports.default = '1.15.1';

package/oclif.manifest.json

@@ -15,13 +15,22 @@
           "required": true
         }
       },
-      "description": "\n  Deploys all templates defined on the `connectrc.js` file to the specified environment.\n\n  The script will use the `CONNECT_AUTH_TOKEN` environment variable to authenticate with Constructor.",
+      "description": "\n  Deploys all templates defined on the `connectrc.js` file to the specified environment, after running tests ('--force' to skip).\n\n  The script will use the `CONNECT_AUTH_TOKEN` environment variable to authenticate with Constructor.",
       "examples": [
         "$ <%= config.bin %> deploy development",
         "$ <%= config.bin %> deploy qa",
-        "$ <%= config.bin %> deploy production"
+        "$ <%= config.bin %> deploy production",
+        "$ <%= config.bin %> deploy production --force"
       ],
-      "flags": {},
+      "flags": {
+        "force": {
+          "char": "f",
+          "description": "Skip tests before deploying",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
       "id": "deploy",
@@ -190,5 +199,5 @@
       ]
     }
   },
-  "version": "1.14.0"
+  "version": "1.15.1"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-connect-cli",
-  "version": "1.14.0",
+  "version": "1.15.1",
   "description": "CLI tool to enable users to interface with the Constructor Connect Ecosystem",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",