@taqueria/plugin-jest 0.0.0-pr-840-be4b450e

package/DESIGN.md

@@ -0,0 +1,107 @@
+# Jest plugin for Taqueria
+
+Authors:    Michael Weichert <<michael.weichert@ecadlabs.com>>
+
+Date:       Apr 7, 2022
+
+Revision:   1
+
+---
+
+This plugin integrates automated testing into your workflow via the Jest Testing Framework.
+
+Our Jest plugin exposes the following tasks:
+
+`taq test init [testsDir]`
+
+Initializes the Jest plugin and Jest Testing Framework. Manual invocations of this task are not usually required, as uninitialzed test folders will be initialzed automatically. However, for explicit control, `taq test init` is available as a task for your convenience.
+
+When executed, a _.taq/jest.config.js_ file is created if one doesn't exist, and then too, a _jest.config.js_ is created in _testsDir_ as specified in the positional arguments. _testsDir_ defaults to _jestTestsRootDir if no value was provided.
+
+The _.taq/jest.config.js_ is known as the global jest configuration, and any other _jest.config.js_ files will inherit and override settings defined in the global jest configuration.
+
+E.g, below is an example of a _jest.config.js_ file that would get created in your _jestTestsRootDir_:
+```
+module.exports = {
+  ...require("/.taq/jest.config.js"),
+ // Set custom configuration here
+}
+```
+
+This assures that you can centralize Jest configuration settings that are global to your project, and yet allow granular and individual tweaks for particular use-cases.
+
+
+`taq test [testsDir] [pattern]`
+
+The _test_ task is used to execute your automated tests using the Jest testing framework. Running `taq test` would scan the _jestTestsRootDir_ directory, which defaults to _./tests_. The __jestTestsRootDir_ is a configuration setting specified in your .taq/config.json, and may be changed at any time.
+
+Running `taq test` without specifying a _testsDir_ will default to working with _jestTestsRootDir_. A pattern can be specified to pattern-match against filenames in the _testsDir_ to limit what automated tests are executed.
+
+If the _jest.config.js_ file is missing in the specified _testsDir_, then `taq init [testsDir]` will be invoked automatically.
+
+## Testing Directories / Partitions
+
+Tests can be segmented into partitions, exposed as separate directories underneath the _jestTestsRootDir_ directory. This is sometimes desired to achieve a logical tree-like directory structure for organizational purposes. For instance, a developer may wish to segment their tests for smart contracts from the tests used to test a web application that interacts with the smart contract.
+
+To do this, the developer could create two partitions:
+
+`taq test contracts`
+
+`taq test app`
+
+This would create and initialize two partitions for writing Jest automated tests. Assuming your _jestTestsRootDir_ hasn't been customized, then it will default to _./tests_ and the directory structure will look like the following:
+- tests
+- tests/contracts
+- tests/app
+
+To run all automated tests in the contracts partition, a developer would run:
+
+`taq test contracts`.
+
+To run all tests, regardless of partition, a developer could run
+
+`taq test`.
+
+## Compatibility with other Testing Plugins
+
+Its expected that other plugins will provide integration with testing frameworks other than Jest. For instance, the LIGO plugin is expected to provide integration with the LIGO Testing Framework which improve the developer workflow for smart contracts authored in one of many syntax available in the LIGO language.
+
+For instance, a developer may wish to organize their tests as such:
+- tests
+- tests/contracts (using the LIGO testing framework)
+- tests/app (using the Jest testing framework)
+
+To do so, a developer would change their _jestTestsRootDir_ to _tests/app_ and _ligoTestsRootDir_ to _tests/contracts_.
+
+A developer could run their tests written with LIGO with:
+
+`taq test --plugin ligo`
+
+Likewise, for Jest a developer would run:
+
+`taq test --plugin jest`
+
+## Future considerations
+
+### End-developer defined tasks
+
+As first mentioned in the State Architecture Design Document, a developer should have the ability to define their own tasks that can integrated into their workflow.
+
+End-developer defined tasks are configurated in _.taq/config.json_.
+
+This capability offers the ability to define a task which wraps existing ones.
+
+E.g.:
+
+```json
+...,
+"tasks": {
+  "test": {
+    "handler": "taq test --plugin ligo && taq test --plugin ligo"
+  }
+} 
+```
+
+This would expose a task that would run all tests defined using the LIGO and Jest plugin:
+
+`taq run test`

package/index.js

@@ -0,0 +1,112 @@
+import {Plugin as $d3MIr$Plugin, Task as $d3MIr$Task, PositionalArg as $d3MIr$PositionalArg, Option as $d3MIr$Option, sendAsyncErr as $d3MIr$sendAsyncErr, sendErr as $d3MIr$sendErr, sendAsyncRes as $d3MIr$sendAsyncRes} from "@taqueria/node-sdk";
+import {SanitizedAbsPath as $d3MIr$SanitizedAbsPath} from "@taqueria/node-sdk/types";
+import {execa as $d3MIr$execa} from "execa";
+import {stat as $d3MIr$stat, writeFile as $d3MIr$writeFile, mkdir as $d3MIr$mkdir} from "fs/promises";
+import {defaults as $d3MIr$defaults} from "jest-config";
+import {join as $d3MIr$join} from "path";
+
+
+
+
+
+
+
+
+const $74485658d1dbcd36$var$getDefaultConfig = (defaultConfig)=>`
+module.exports = ${JSON.stringify((0, $d3MIr$defaults), null, 4)}
+`;
+const $74485658d1dbcd36$var$ensureRootConfigExists = (projectDir)=>{
+    const jestRootConfig = $74485658d1dbcd36$var$getRootConfigAbspath(projectDir);
+    return (0, $d3MIr$stat)(jestRootConfig).catch((_)=>(0, $d3MIr$writeFile)(jestRootConfig, $74485658d1dbcd36$var$getDefaultConfig((0, $d3MIr$defaults)))).then((_)=>jestRootConfig);
+};
+const $74485658d1dbcd36$var$getRootConfigAbspath = (projectDir)=>(0, $d3MIr$SanitizedAbsPath).create((0, $d3MIr$join)(projectDir, ".taq", "jest.config.js"));
+const $74485658d1dbcd36$var$getTestsRootDir = (config)=>{
+    return config.jestTestsRootDir || "tests";
+};
+const $74485658d1dbcd36$var$toPartitionCfg = (partitionAbspath, rootConfigAbsPath)=>`
+const parentConfig = require('${rootConfigAbsPath}')
+
+module.exports = {
+    ...parentConfig,
+    roots: [
+        "${partitionAbspath}"
+    ]
+}
+`;
+const $74485658d1dbcd36$var$getPartitionAbspath = (partitionDir)=>(0, $d3MIr$SanitizedAbsPath).create(partitionDir);
+const $74485658d1dbcd36$var$getPartitionConfigAbspath = (partitionDir)=>(0, $d3MIr$SanitizedAbsPath).create((0, $d3MIr$join)(partitionDir, "jest.config.js"));
+const $74485658d1dbcd36$var$createPartition = async (partitionDir, projectDir)=>$74485658d1dbcd36$var$ensureRootConfigExists(projectDir).then((_)=>(0, $d3MIr$stat)(partitionDir)).then((stats)=>stats.isFile() ? (0, $d3MIr$sendAsyncErr)(`${partitionDir} is an invalid partition directory`) : stats).catch((_)=>(0, $d3MIr$mkdir)(partitionDir, {
+            recursive: true
+        })).then((_)=>$74485658d1dbcd36$var$getPartitionConfigAbspath(partitionDir)).then((partitionCfgAbsPath)=>(0, $d3MIr$stat)(partitionCfgAbsPath).catch((_)=>(0, $d3MIr$writeFile)(partitionCfgAbsPath, $74485658d1dbcd36$var$toPartitionCfg($74485658d1dbcd36$var$getPartitionAbspath(partitionDir), $74485658d1dbcd36$var$getRootConfigAbspath(projectDir))))).then((_)=>$74485658d1dbcd36$var$getPartitionConfigAbspath(partitionDir));
+const $74485658d1dbcd36$var$ensurePartitionExists = (args)=>args.partition ? $74485658d1dbcd36$var$createPartition((0, $d3MIr$SanitizedAbsPath).create((0, $d3MIr$join)(args.projectDir, args.partition)), args.projectDir) : $74485658d1dbcd36$var$createPartition((0, $d3MIr$SanitizedAbsPath).create((0, $d3MIr$join)(args.projectDir, $74485658d1dbcd36$var$getTestsRootDir(args.config))), args.projectDir);
+const $74485658d1dbcd36$var$execCmd = (cmd, args)=>{
+    return (0, $d3MIr$execa)(cmd, args, {
+        reject: false
+    });
+};
+var $74485658d1dbcd36$export$2e2bcd8739ae039 = async (args)=>{
+    const opts = args;
+    return $74485658d1dbcd36$var$ensurePartitionExists(opts).then((configAbsPath)=>{
+        if (!opts.init) {
+            const cmd = opts.testPattern ? $74485658d1dbcd36$var$execCmd("npx", [
+                "jest",
+                "-c",
+                configAbsPath,
+                "-t",
+                opts.testPattern
+            ]) : $74485658d1dbcd36$var$execCmd("npx", [
+                "jest",
+                "-c",
+                configAbsPath
+            ]);
+            return cmd.then(({ stdout: stdout , stderr: stderr  })=>{
+                if (stderr) (0, $d3MIr$sendErr)(stderr);
+                return (0, $d3MIr$sendAsyncRes)(stdout);
+            });
+        }
+        return (0, $d3MIr$sendAsyncRes)("Initialized successfully.");
+    });
+};
+
+
+(0, $d3MIr$Plugin).create(()=>({
+        schema: "0.1",
+        version: "0.4.0",
+        alias: "jest",
+        tasks: [
+            (0, $d3MIr$Task).create({
+                task: "test",
+                command: "test [partition]",
+                description: "Setup a directory as a partition to run Jest tests",
+                aliases: [
+                    "jest"
+                ],
+                handler: "proxy",
+                positionals: [
+                    (0, $d3MIr$PositionalArg).create({
+                        placeholder: "partition",
+                        description: "Name of the partition for these tests",
+                        defaultValue: "tests",
+                        type: "string"
+                    }), 
+                ],
+                options: [
+                    (0, $d3MIr$Option).create({
+                        flag: "init",
+                        shortFlag: "i",
+                        description: "Initializes the partition for Jest",
+                        boolean: true
+                    }),
+                    (0, $d3MIr$Option).create({
+                        flag: "testPattern",
+                        description: "Run test files that match the provided pattern",
+                        boolean: true
+                    }), 
+                ]
+            }), 
+        ],
+        proxy: $74485658d1dbcd36$export$2e2bcd8739ae039
+    }), process.argv);
+
+
+//# sourceMappingURL=index.js.map

package/index.js.map

@@ -0,0 +1 @@
+{"mappings":";;;;;;;AAAA;ACAA;;;;;;AAoBA,MAAM,sCAAgB,GAAG,CAAC,aAA4B,GAAK,CAAC;iBAC3C,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA,GAAA,eAAQ,CAAA,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AACrD,CAAC,AAAC;AAEF,MAAM,4CAAsB,GAAG,CAAC,UAA8B,GAAK;IAClE,MAAM,cAAc,GAAG,0CAAoB,CAAC,UAAU,CAAC,AAAC;IACxD,OAAO,CAAA,GAAA,WAAI,CAAA,CAAC,cAAc,CAAC,CACzB,KAAK,CAAC,CAAA,CAAC,GAAI,CAAA,GAAA,gBAAS,CAAA,CAAC,cAAc,EAAE,sCAAgB,CAAC,CAAA,GAAA,eAAQ,CAAA,CAAC,CAAC,CAAC,CACjE,IAAI,CAAC,CAAA,CAAC,GAAI,cAAc,CAAC,CAAC;CAC5B,AAAC;AAEF,MAAM,0CAAoB,GAAG,CAAC,UAA8B,GAC3D,CAAA,GAAA,uBAAgB,CAAA,CAAC,MAAM,CACtB,CAAA,GAAA,WAAI,CAAA,CAAC,UAAU,EAAE,MAAM,EAAE,gBAAgB,CAAC,CAC1C,AAAC;AAEH,MAAM,qCAAe,GAAG,CAAC,MAAoB,GAAK;IACjD,OAAO,MAAM,CAAC,gBAAgB,IAAI,OAAO,CAAC;CAC1C,AAAC;AAEF,MAAM,oCAAc,GAAG,CAAC,gBAAoC,EAAE,iBAAqC,GAAK,CAAC;8BAC3E,EAAE,iBAAiB,CAAC;;;;;SAKzC,EAAE,gBAAgB,CAAC;;;AAG5B,CAAC,AAAC;AAEF,MAAM,yCAAmB,GAAG,CAAC,YAAoB,GAAK,CAAA,GAAA,uBAAgB,CAAA,CAAC,MAAM,CAAC,YAAY,CAAC,AAAC;AAE5F,MAAM,+CAAyB,GAAG,CAAC,YAAoB,GACtD,CAAA,GAAA,uBAAgB,CAAA,CAAC,MAAM,CAAC,CAAA,GAAA,WAAI,CAAA,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC,AAAC;AAE/D,MAAM,qCAAe,GAAG,OAAO,YAAgC,EAAE,UAA8B,GAC9F,4CAAsB,CAAC,UAAU,CAAC,CAChC,IAAI,CAAC,CAAA,CAAC,GAAI,CAAA,GAAA,WAAI,CAAA,CAAC,YAAY,CAAC,CAAC,CAC7B,IAAI,CAAC,CAAA,KAAK,GACV,KAAK,CAAC,MAAM,EAAE,GACX,CAAA,GAAA,mBAAY,CAAA,CAAC,CAAC,EAAE,YAAY,CAAC,kCAAkC,CAAC,CAAC,GACjE,KAAK,CACR,CACA,KAAK,CAAC,CAAA,CAAC,GAAI,CAAA,GAAA,YAAK,CAAA,CAAC,YAAY,EAAE;YAAE,SAAS,EAAE,IAAI;SAAE,CAAC,CAAC,CACpD,IAAI,CAAC,CAAA,CAAC,GAAI,+CAAyB,CAAC,YAAY,CAAC,CAAC,CAClD,IAAI,CAAC,CAAA,mBAAmB,GACxB,CAAA,GAAA,WAAI,CAAA,CAAC,mBAAmB,CAAC,CACvB,KAAK,CAAC,CAAA,CAAC,GACP,CAAA,GAAA,gBAAS,CAAA,CACR,mBAAmB,EACnB,oCAAc,CACb,yCAAmB,CAAC,YAAY,CAAC,EACjC,0CAAoB,CAAC,UAAU,CAAC,CAChC,CACD,CACD,CACF,CACA,IAAI,CAAC,CAAA,CAAC,GAAI,+CAAyB,CAAC,YAAY,CAAC,CAAC,AAAC;AAEtD,MAAM,2CAAqB,GAAG,CAAC,IAAU,GACxC,IAAI,CAAC,SAAS,GACX,qCAAe,CAChB,CAAA,GAAA,uBAAgB,CAAA,CAAC,MAAM,CAAC,CAAA,GAAA,WAAI,CAAA,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,EAC9D,IAAI,CAAC,UAAU,CACf,GACC,qCAAe,CAChB,CAAA,GAAA,uBAAgB,CAAA,CAAC,MAAM,CACtB,CAAA,GAAA,WAAI,CAAA,CAAC,IAAI,CAAC,UAAU,EAAE,qCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CACnD,EACD,IAAI,CAAC,UAAU,CACf,AAAC;AAEJ,MAAM,6BAAO,GAAG,CAAC,GAAW,EAAE,IAAc,GAAK;IAChD,OAAO,CAAA,GAAA,YAAK,CAAA,CAAC,GAAG,EAAE,IAAI,EAAE;QAAE,MAAM,EAAE,KAAK;KAAE,CAAC,CAAC;CAC3C,AAAC;IAEF,wCAkBE,GAlBa,OAAO,IAAkC,GAAK;IAC5D,MAAM,IAAI,GAAG,IAAI,AAAQ,AAAC;IAE1B,OAAO,2CAAqB,CAAC,IAAI,CAAC,CAChC,IAAI,CAAC,CAAA,aAAa,GAAI;QACtB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACf,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,GACzB,6BAAO,CAAC,KAAK,EAAE;gBAAC,MAAM;gBAAE,IAAI;gBAAE,aAAa;gBAAE,IAAI;gBAAE,IAAI,CAAC,WAAW;aAAC,CAAC,GACrE,6BAAO,CAAC,KAAK,EAAE;gBAAC,MAAM;gBAAE,IAAI;gBAAE,aAAa;aAAC,CAAC,AAAC;YAEjD,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC,UAAE,MAAM,CAAA,UAAE,MAAM,CAAA,EAAE,GAAK;gBACvC,IAAI,MAAM,EAAE,CAAA,GAAA,cAAO,CAAA,CAAC,MAAM,CAAC,CAAC;gBAC5B,OAAO,CAAA,GAAA,mBAAY,CAAA,CAAC,MAAM,CAAC,CAAC;aAC5B,CAAC,CAAC;SACH;QAED,OAAO,CAAA,GAAA,mBAAY,CAAA,CAAC,2BAA2B,CAAC,CAAC;KACjD,CAAC,CAAC;CACJ;;;ADhHD,CAAA,GAAA,aAAM,CAAA,CAAC,MAAM,CAAC,IAAO,CAAA;QACpB,MAAM,EAAE,KAAK;QACb,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,MAAM;QACb,KAAK,EAAE;YACN,CAAA,GAAA,WAAI,CAAA,CAAC,MAAM,CAAC;gBACX,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,kBAAkB;gBAC3B,WAAW,EAAE,oDAAoD;gBACjE,OAAO,EAAE;oBAAC,MAAM;iBAAC;gBACjB,OAAO,EAAE,OAAO;gBAChB,WAAW,EAAE;oBACZ,CAAA,GAAA,oBAAa,CAAA,CAAC,MAAM,CAAC;wBACpB,WAAW,EAAE,WAAW;wBACxB,WAAW,EAAE,uCAAuC;wBACpD,YAAY,EAAE,OAAO;wBACrB,IAAI,EAAE,QAAQ;qBACd,CAAC;iBACF;gBACD,OAAO,EAAE;oBACR,CAAA,GAAA,aAAM,CAAA,CAAC,MAAM,CAAC;wBACb,IAAI,EAAE,MAAM;wBACZ,SAAS,EAAE,GAAG;wBACd,WAAW,EAAE,oCAAoC;wBACjD,OAAO,EAAE,IAAI;qBACb,CAAC;oBACF,CAAA,GAAA,aAAM,CAAA,CAAC,MAAM,CAAC;wBACb,IAAI,EAAE,aAAa;wBACnB,WAAW,EAAE,gDAAgD;wBAC7D,OAAO,EAAE,IAAI;qBACb,CAAC;iBACF;aACD,CAAC;SACF;eACD,wCAAK;KACL,CAAA,AAAC,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC","sources":["taqueria-plugin-jest/index.ts","taqueria-plugin-jest/proxy.ts"],"sourcesContent":["import { Option, Plugin, PositionalArg, Task } from '@taqueria/node-sdk';\nimport proxy from './proxy';\n\nPlugin.create(() => ({\n\tschema: '0.1',\n\tversion: '0.4.0',\n\talias: 'jest',\n\ttasks: [\n\t\tTask.create({\n\t\t\ttask: 'test',\n\t\t\tcommand: 'test [partition]',\n\t\t\tdescription: 'Setup a directory as a partition to run Jest tests',\n\t\t\taliases: ['jest'],\n\t\t\thandler: 'proxy',\n\t\t\tpositionals: [\n\t\t\t\tPositionalArg.create({\n\t\t\t\t\tplaceholder: 'partition',\n\t\t\t\t\tdescription: 'Name of the partition for these tests',\n\t\t\t\t\tdefaultValue: 'tests',\n\t\t\t\t\ttype: 'string',\n\t\t\t\t}),\n\t\t\t],\n\t\t\toptions: [\n\t\t\t\tOption.create({\n\t\t\t\t\tflag: 'init',\n\t\t\t\t\tshortFlag: 'i',\n\t\t\t\t\tdescription: 'Initializes the partition for Jest',\n\t\t\t\t\tboolean: true,\n\t\t\t\t}),\n\t\t\t\tOption.create({\n\t\t\t\t\tflag: 'testPattern',\n\t\t\t\t\tdescription: 'Run test files that match the provided pattern',\n\t\t\t\t\tboolean: true,\n\t\t\t\t}),\n\t\t\t],\n\t\t}),\n\t],\n\tproxy,\n}), process.argv);\n","import { sendAsyncErr, sendAsyncRes, sendErr } from '@taqueria/node-sdk';\nimport { LoadedConfig, RequestArgs, SanitizedAbsPath } from '@taqueria/node-sdk/types';\nimport { execa } from 'execa';\nimport { mkdir, stat, writeFile } from 'fs/promises';\nimport { defaults } from 'jest-config';\nimport { join } from 'path';\n\ntype DefaultConfig = typeof defaults;\n\ninterface CustomConfig extends LoadedConfig.t {\n\treadonly jestTestsRootDir?: string;\n}\n\ninterface Opts extends RequestArgs.ProxyRequestArgs {\n\treadonly config: CustomConfig;\n\treadonly init: boolean;\n\treadonly partition: string;\n\treadonly testPattern: string;\n}\n\nconst getDefaultConfig = (defaultConfig: DefaultConfig) => `\nmodule.exports = ${JSON.stringify(defaults, null, 4)}\n`;\n\nconst ensureRootConfigExists = (projectDir: SanitizedAbsPath.t) => {\n\tconst jestRootConfig = getRootConfigAbspath(projectDir);\n\treturn stat(jestRootConfig)\n\t\t.catch(_ => writeFile(jestRootConfig, getDefaultConfig(defaults)))\n\t\t.then(_ => jestRootConfig);\n};\n\nconst getRootConfigAbspath = (projectDir: SanitizedAbsPath.t) =>\n\tSanitizedAbsPath.create(\n\t\tjoin(projectDir, '.taq', 'jest.config.js'),\n\t);\n\nconst getTestsRootDir = (config: CustomConfig) => {\n\treturn config.jestTestsRootDir || 'tests';\n};\n\nconst toPartitionCfg = (partitionAbspath: SanitizedAbsPath.t, rootConfigAbsPath: SanitizedAbsPath.t) => `\nconst parentConfig = require('${rootConfigAbsPath}')\n\nmodule.exports = {\n    ...parentConfig,\n    roots: [\n        \"${partitionAbspath}\"\n    ]\n}\n`;\n\nconst getPartitionAbspath = (partitionDir: string) => SanitizedAbsPath.create(partitionDir);\n\nconst getPartitionConfigAbspath = (partitionDir: string) =>\n\tSanitizedAbsPath.create(join(partitionDir, 'jest.config.js'));\n\nconst createPartition = async (partitionDir: SanitizedAbsPath.t, projectDir: SanitizedAbsPath.t) =>\n\tensureRootConfigExists(projectDir)\n\t\t.then(_ => stat(partitionDir))\n\t\t.then(stats =>\n\t\t\tstats.isFile()\n\t\t\t\t? sendAsyncErr(`${partitionDir} is an invalid partition directory`)\n\t\t\t\t: stats\n\t\t)\n\t\t.catch(_ => mkdir(partitionDir, { recursive: true }))\n\t\t.then(_ => getPartitionConfigAbspath(partitionDir))\n\t\t.then(partitionCfgAbsPath =>\n\t\t\tstat(partitionCfgAbsPath)\n\t\t\t\t.catch(_ =>\n\t\t\t\t\twriteFile(\n\t\t\t\t\t\tpartitionCfgAbsPath,\n\t\t\t\t\t\ttoPartitionCfg(\n\t\t\t\t\t\t\tgetPartitionAbspath(partitionDir),\n\t\t\t\t\t\t\tgetRootConfigAbspath(projectDir),\n\t\t\t\t\t\t),\n\t\t\t\t\t)\n\t\t\t\t)\n\t\t)\n\t\t.then(_ => getPartitionConfigAbspath(partitionDir));\n\nconst ensurePartitionExists = (args: Opts) =>\n\targs.partition\n\t\t? createPartition(\n\t\t\tSanitizedAbsPath.create(join(args.projectDir, args.partition)),\n\t\t\targs.projectDir,\n\t\t)\n\t\t: createPartition(\n\t\t\tSanitizedAbsPath.create(\n\t\t\t\tjoin(args.projectDir, getTestsRootDir(args.config)),\n\t\t\t),\n\t\t\targs.projectDir,\n\t\t);\n\nconst execCmd = (cmd: string, args: string[]) => {\n\treturn execa(cmd, args, { reject: false });\n};\n\nexport default async (args: RequestArgs.ProxyRequestArgs) => {\n\tconst opts = args as Opts;\n\n\treturn ensurePartitionExists(opts)\n\t\t.then(configAbsPath => {\n\t\t\tif (!opts.init) {\n\t\t\t\tconst cmd = opts.testPattern\n\t\t\t\t\t? execCmd('npx', ['jest', '-c', configAbsPath, '-t', opts.testPattern])\n\t\t\t\t\t: execCmd('npx', ['jest', '-c', configAbsPath]);\n\n\t\t\t\treturn cmd.then(({ stdout, stderr }) => {\n\t\t\t\t\tif (stderr) sendErr(stderr);\n\t\t\t\t\treturn sendAsyncRes(stdout);\n\t\t\t\t});\n\t\t\t}\n\n\t\t\treturn sendAsyncRes('Initialized successfully.');\n\t\t});\n};\n"],"names":[],"version":3,"file":"index.js.map","sourceRoot":"../"}

package/index.ts

@@ -0,0 +1,39 @@
+import { Option, Plugin, PositionalArg, Task } from '@taqueria/node-sdk';
+import proxy from './proxy';
+
+Plugin.create(() => ({
+	schema: '0.1',
+	version: '0.4.0',
+	alias: 'jest',
+	tasks: [
+		Task.create({
+			task: 'test',
+			command: 'test [partition]',
+			description: 'Setup a directory as a partition to run Jest tests',
+			aliases: ['jest'],
+			handler: 'proxy',
+			positionals: [
+				PositionalArg.create({
+					placeholder: 'partition',
+					description: 'Name of the partition for these tests',
+					defaultValue: 'tests',
+					type: 'string',
+				}),
+			],
+			options: [
+				Option.create({
+					flag: 'init',
+					shortFlag: 'i',
+					description: 'Initializes the partition for Jest',
+					boolean: true,
+				}),
+				Option.create({
+					flag: 'testPattern',
+					description: 'Run test files that match the provided pattern',
+					boolean: true,
+				}),
+			],
+		}),
+	],
+	proxy,
+}), process.argv);

package/package.json

@@ -0,0 +1,49 @@
+{
+	"name": "@taqueria/plugin-jest",
+	"version": "0.0.0-pr-840-be4b450e",
+	"description": "A plugin for Taqueria providing automated testing using the Jest Testing Framework",
+	"keywords": [
+		"taqueria",
+		"plugin",
+		"jest",
+		"testing",
+		"tdd",
+		"ecad",
+		"ecadlabs",
+		"tezos"
+	],
+	"targets": {
+		"default": {
+			"source": "./index.ts",
+			"distDir": "./",
+			"context": "node",
+			"isLibrary": true,
+			"outputFormat": "esmodule"
+		}
+	},
+	"scripts": {
+		"build": "npx tsc -noEmit -p ./tsconfig.json && npx parcel build --no-cache 2>&1"
+	},
+	"author": "ECAD Labs",
+	"license": "Apache-2.0",
+	"type": "module",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/ecadlabs/taqueria.git",
+		"directory": "taqueria-plugin-jest"
+	},
+	"dependencies": {
+		"@taqueria/node-sdk": "^0.4.0",
+		"async-retry": "^1.3.3",
+		"execa": "^6.1.0",
+		"fast-glob": "^3.2.7",
+		"jest-cli": "^28.1.0",
+		"jest-config": "^28.1.0"
+	},
+	"devDependencies": {
+		"@types/async-retry": "^1.3.3",
+		"@types/jest": "^27.5.1",
+		"parcel": "^2.6.0",
+		"typescript": "4.7.2"
+	}
+}

package/proxy.ts

@@ -0,0 +1,116 @@
+import { sendAsyncErr, sendAsyncRes, sendErr } from '@taqueria/node-sdk';
+import { LoadedConfig, RequestArgs, SanitizedAbsPath } from '@taqueria/node-sdk/types';
+import { execa } from 'execa';
+import { mkdir, stat, writeFile } from 'fs/promises';
+import { defaults } from 'jest-config';
+import { join } from 'path';
+
+type DefaultConfig = typeof defaults;
+
+interface CustomConfig extends LoadedConfig.t {
+	readonly jestTestsRootDir?: string;
+}
+
+interface Opts extends RequestArgs.ProxyRequestArgs {
+	readonly config: CustomConfig;
+	readonly init: boolean;
+	readonly partition: string;
+	readonly testPattern: string;
+}
+
+const getDefaultConfig = (defaultConfig: DefaultConfig) => `
+module.exports = ${JSON.stringify(defaults, null, 4)}
+`;
+
+const ensureRootConfigExists = (projectDir: SanitizedAbsPath.t) => {
+	const jestRootConfig = getRootConfigAbspath(projectDir);
+	return stat(jestRootConfig)
+		.catch(_ => writeFile(jestRootConfig, getDefaultConfig(defaults)))
+		.then(_ => jestRootConfig);
+};
+
+const getRootConfigAbspath = (projectDir: SanitizedAbsPath.t) =>
+	SanitizedAbsPath.create(
+		join(projectDir, '.taq', 'jest.config.js'),
+	);
+
+const getTestsRootDir = (config: CustomConfig) => {
+	return config.jestTestsRootDir || 'tests';
+};
+
+const toPartitionCfg = (partitionAbspath: SanitizedAbsPath.t, rootConfigAbsPath: SanitizedAbsPath.t) => `
+const parentConfig = require('${rootConfigAbsPath}')
+
+module.exports = {
+    ...parentConfig,
+    roots: [
+        "${partitionAbspath}"
+    ]
+}
+`;
+
+const getPartitionAbspath = (partitionDir: string) => SanitizedAbsPath.create(partitionDir);
+
+const getPartitionConfigAbspath = (partitionDir: string) =>
+	SanitizedAbsPath.create(join(partitionDir, 'jest.config.js'));
+
+const createPartition = async (partitionDir: SanitizedAbsPath.t, projectDir: SanitizedAbsPath.t) =>
+	ensureRootConfigExists(projectDir)
+		.then(_ => stat(partitionDir))
+		.then(stats =>
+			stats.isFile()
+				? sendAsyncErr(`${partitionDir} is an invalid partition directory`)
+				: stats
+		)
+		.catch(_ => mkdir(partitionDir, { recursive: true }))
+		.then(_ => getPartitionConfigAbspath(partitionDir))
+		.then(partitionCfgAbsPath =>
+			stat(partitionCfgAbsPath)
+				.catch(_ =>
+					writeFile(
+						partitionCfgAbsPath,
+						toPartitionCfg(
+							getPartitionAbspath(partitionDir),
+							getRootConfigAbspath(projectDir),
+						),
+					)
+				)
+		)
+		.then(_ => getPartitionConfigAbspath(partitionDir));
+
+const ensurePartitionExists = (args: Opts) =>
+	args.partition
+		? createPartition(
+			SanitizedAbsPath.create(join(args.projectDir, args.partition)),
+			args.projectDir,
+		)
+		: createPartition(
+			SanitizedAbsPath.create(
+				join(args.projectDir, getTestsRootDir(args.config)),
+			),
+			args.projectDir,
+		);
+
+const execCmd = (cmd: string, args: string[]) => {
+	return execa(cmd, args, { reject: false });
+};
+
+export default async (args: RequestArgs.ProxyRequestArgs) => {
+	const opts = args as Opts;
+
+	return ensurePartitionExists(opts)
+		.then(configAbsPath => {
+			if (!opts.init) {
+				const cmd = opts.testPattern
+					? execCmd('npx', ['jest', '-c', configAbsPath, '-t', opts.testPattern])
+					: execCmd('npx', ['jest', '-c', configAbsPath]);
+
+				return cmd.then(({ stdout, stderr }) => {
+					if (stderr) sendErr(stderr);
+					return sendAsyncRes(stdout);
+				});
+			}
+
+			return sendAsyncRes('Initialized successfully.');
+		});
+};

package/tsconfig.json

@@ -0,0 +1,101 @@
+{
+	"compilerOptions": {
+		/* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+		/* Projects */
+		// "incremental": true,                              /* Enable incremental compilation */
+		// "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+		// "tsBuildInfoFile": "./",                          /* Specify the folder for .tsbuildinfo incremental compilation files. */
+		// "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects */
+		// "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+		// "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+		/* Language and Environment */
+		"target": "ES2021", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+		// "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+		// "jsx": "preserve",                                /* Specify what JSX code is generated. */
+		// "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+		// "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+		// "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
+		// "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+		// "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
+		// "reactNamespace": "",                             /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
+		// "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+		// "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+
+		/* Modules */
+		"module": "CommonJS", /* Specify what module code is generated. */
+		// "rootDir": "./",                                  /* Specify the root folder within your source files. */
+		// "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+		// "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+		// "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+		// "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+		// "typeRoots": [],                                  /* Specify multiple folders that act like `./node_modules/@types`. */
+		// "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+		// "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+		// "resolveJsonModule": true,                        /* Enable importing .json files */
+		// "noResolve": true,                                /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */
+
+		/* JavaScript Support */
+		// "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
+		// "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+		// "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */
+
+		/* Emit */
+		// "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+		// "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+		// "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+		// "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+		// "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
+		// "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+		// "removeComments": true,                           /* Disable emitting comments. */
+		// "noEmit": true,                                   /* Disable emitting files from a compilation. */
+		// "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+		// "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types */
+		// "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+		// "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+		// "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+		// "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+		// "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+		// "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+		// "newLine": "crlf",                                /* Set the newline character for emitting files. */
+		// "stripInternal": true,                            /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
+		// "noEmitHelpers": true,                            /* Disable generating custom helper functions like `__extends` in compiled output. */
+		// "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+		// "preserveConstEnums": true,                       /* Disable erasing `const enum` declarations in generated code. */
+		// "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+		// "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+		/* Interop Constraints */
+		"isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
+		"allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
+		"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
+		// "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+		"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
+
+		/* Type Checking */
+		"strict": true, /* Enable all strict type-checking options. */
+		// "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
+		// "strictNullChecks": true,                         /* When type checking, take into account `null` and `undefined`. */
+		// "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+		// "strictBindCallApply": true,                      /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
+		// "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+		// "noImplicitThis": true,                           /* Enable error reporting when `this` is given the type `any`. */
+		// "useUnknownInCatchVariables": true,               /* Type catch clause variables as 'unknown' instead of 'any'. */
+		// "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+		// "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
+		// "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read */
+		// "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+		// "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+		// "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+		// "noUncheckedIndexedAccess": true,                 /* Include 'undefined' in index signature results */
+		// "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+		// "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type */
+		// "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+		// "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+		/* Completeness */
+		// "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+		"skipLibCheck": true /* Skip type checking all .d.ts files. */
+	}
+}