harmonyc 0.1.0 → 0.2.0

package/README.md

@@ -0,0 +1,85 @@
+# Harmony Code
+
+A simple model-based test design tool that generates Cucumber feature files.
+
+## Setup
+
+You need to have Node.js installed. Then you can install Harmony Code in your project folder by:
+
+```bash
+npm install harmonyc
+```
+
+And then run it for all `.harmony` files in your `src` folder:
+
+```bash
+harmonyc src/**/*.harmony
+```
+
+This will generate `.feature` files next to the `.harmony` files.
+
+## Syntax
+
+A `.harmony` file is a text file with a syntax that looks like this:
+
+```
+Products API:
++ Create:
+  + Anonymous:
+    - create product => error: unauthorized
+  + Admin:
+    - authenticate admin
+    - create product => product created
+    - Delete:
+      - delete product => product deleted
+```
+
+Compiling this with `harmonyc` will generate this `.feature` file:
+
+```gherkin
+Feature: products
+
+    Scenario: T1 - Products API - Create - Anonymous
+        When create product -- products
+        Then error: unauthorized -- products
+    
+    Scenario: T2 - Products API - Create - Admin - Delete
+        When authenticate admin -- products
+        When create product -- products
+        Then product created -- products
+        When delete product -- products
+        Then product deleted -- products
+```
+
+### Indentation
+
+The lines of a file are nodes of a tree. The tree is specified with the indentation of the lines, which is n times 2 spaces and a `+` or `-` with one more space. The `+` or `-` sign is considered to be part of the indentation.
+
+### Sequences and forks
+
+`-` means a sequence: the node follows the previous sibling node and its descendants.
+
+`+` means a fork: the node directly follows its parent node. All siblings with `+` are separate branches, they will generate separate scenarios.
+
+### Labels
+
+Label are nodes that end with `:`. You can use them to structure your test design.
+They are not included in the test case, but the test case name is generated from the labels.
+
+### Comments
+
+Lines starting with `#` or `//` are comments and are ignored.
+
+### Steps
+
+All other lines are steps. A step consists of an action, and one or more responses denoted by `=>`.
+Actions will become `When` steps, and responses will become `Then` steps.
+
+
+## Running the tests
+
+Currenlty `harmonyc` only compiles `.harmony` files to `.feature` files. To run the tests, you need to set up Cucumber or Specflow, depending on your environment.
+
+## License
+
+MIT

package/cli.js

@@ -2,7 +2,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const compiler_1 = require("./compiler");
-if (process.argv.length < 3) {
+if (process.argv.length < 3 || process.argv.includes('--help')) {
     console.error("Usage: harmonyc <input files glob pattern>");
     process.exit(1);
 }

package/compile.js

@@ -6,7 +6,7 @@ const indent_1 = require("./util/indent");
 const model_1 = require("./model");
 const parser_1 = require("./parser");
 function compileFeature(name, src) {
-    const root = (0, parser_1.parse)(src);
+    const root = (0, parser_1.parse)(src).setFeatureName(name);
     const tests = (0, model_1.makeTests)(root);
     const lines = [
         `Feature: ${name}`,

package/model.js

@@ -14,6 +14,11 @@ class Branch {
         this.isFork = isFork;
         return this;
     }
+    setFeatureName(featureName) {
+        for (const child of this.children)
+            child.setFeatureName(featureName);
+        return this;
+    }
     addChild(child, index = this.children.length) {
         this.children.splice(index, 0, child);
         child.parent = this;
@@ -54,10 +59,10 @@ class Branch {
 }
 exports.Branch = Branch;
 class Step extends Branch {
-    constructor(action = '', responses = [], children, isFork = false) {
+    constructor(action = '', responses = [], children, isFork = false, featureName = '') {
         super(children);
-        this.action = new Action(action);
-        this.responses = responses.map((response) => new Response(response));
+        this.action = new Action(action, featureName);
+        this.responses = responses.map((response) => new Response(response, featureName));
         this.isFork = isFork;
     }
     get phrases() {
@@ -66,6 +71,12 @@ class Step extends Branch {
     toGherkin() {
         return this.phrases.flatMap((phrase) => phrase.toGherkin());
     }
+    setFeatureName(featureName) {
+        this.action.setFeatureName(featureName);
+        for (const response of this.responses)
+            response.setFeatureName(featureName);
+        return super.setFeatureName(featureName);
+    }
 }
 exports.Step = Step;
 class State {
@@ -89,11 +100,15 @@ class Section extends Branch {
 }
 exports.Section = Section;
 class Phrase {
-    constructor(text = '') {
+    constructor(text = '', featureName = '') {
         this.text = text;
+        this.featureName = featureName;
+    }
+    setFeatureName(featureName) {
+        this.featureName = featureName;
     }
     toGherkin() {
-        return [`${this.kind === 'action' ? 'When' : 'Then'} ${this.text}`];
+        return [`${this.kind === 'action' ? 'When' : 'Then'} ${this.text} -- ${this.featureName}`];
     }
 }
 exports.Phrase = Phrase;

package/package.json

@@ -1,28 +1,41 @@
-{
-  "name": "harmonyc",
-  "description": "Harmony Code - Test design compiler from high-level model to Gherkin",
-  "version": "0.1.0",
-  "author": "Bernát Kalló",
-  "bin": {
-    "harmonyc": "./cli.js"
-  },
-  "homepage": "https://github.com/harmony-ac/code#readme",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/harmony-ac/code.git"
-  },
-  "bugs": {
-    "url": "https://github.com/harmony-ac/code/issues"
-  },
-  "dependencies": {
-    "fast-glob": "^3.3.2",
-    "typescript-parsec": "0.3.4"
-  },
-  "license": "MIT",
-  "keywords": [
-    "unit test", "unit testing", "cucumber", "bdd", "behavior-driven",
-    "test design", "test design automation", "gherkin", "cucumber",
-    "specflow", "harmony.ac", "test framework", "model-based test",
-    "model-based testing", "test model", "test modeling", "test modelling"
-  ]
-}
+{
+  "name": "harmonyc",
+  "description": "Harmony Code - Test design compiler from high-level model to Gherkin",
+  "version": "0.2.0",
+  "author": "Bernát Kalló",
+  "bin": {
+    "harmonyc": "./cli.js"
+  },
+  "homepage": "https://github.com/harmony-ac/code#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/harmony-ac/code.git"
+  },
+  "bugs": {
+    "url": "https://github.com/harmony-ac/code/issues"
+  },
+  "dependencies": {
+    "fast-glob": "^3.3.2",
+    "typescript-parsec": "0.3.4"
+  },
+  "license": "MIT",
+  "keywords": [
+    "unit test",
+    "unit testing",
+    "cucumber",
+    "bdd",
+    "behavior-driven",
+    "test design",
+    "test design automation",
+    "gherkin",
+    "cucumber",
+    "specflow",
+    "harmony.ac",
+    "test framework",
+    "model-based test",
+    "model-based testing",
+    "test model",
+    "test modeling",
+    "test modelling"
+  ]
+}

package/util/xmur3.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.xmur3 = void 0;
-// https://stackoverflow.com/a/47593316
+// https://stackoverflow.com/revisions/47593316/25 by bryc (github.com/bryc)
 function xmur3(str) {
     let h = 1779033703 ^ str.length;
     for (let i = 0; i < str.length; i++)