diff --git a/.github/workflows/release-npm.yml b/.github/workflows/release-npm.yml index 5f8768d7..77ce5e4f 100644 --- a/.github/workflows/release-npm.yml +++ b/.github/workflows/release-npm.yml @@ -13,7 +13,7 @@ jobs: - uses: actions/checkout@v4 - uses: actions/setup-node@v4 with: - node-version: '16' + node-version: '22' cache: 'npm' cache-dependency-path: javascript/package-lock.json - run: npm install-test diff --git a/.github/workflows/test-javascript.yml b/.github/workflows/test-javascript.yml index b2a173de..d792967d 100644 --- a/.github/workflows/test-javascript.yml +++ b/.github/workflows/test-javascript.yml @@ -18,12 +18,12 @@ jobs: matrix: os: - ubuntu-latest - node-version: ["16.x", "17.x", "18.x"] + node-version: ["18.x", "20.x", "22.x"] include: - os: windows-latest - node-version: "18.x" + node-version: "22.x" - os: macos-latest - node-version: "18.x" + node-version: "22.x" steps: - uses: actions/checkout@v4 diff --git a/CHANGELOG.md b/CHANGELOG.md index 9202082d..4b0f3f20 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,9 +8,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ## [Unreleased] ### Added +- New methods in JavaScript implementation to match Java ([#62](https://github.com/cucumber/query/pull/62)) - Update dependency @cucumber/messages to v26 ((#52)[https://github.com/cucumber/query/pull/52]) - Update dependency io.cucumber:messages up to v26 ((#53)[https://github.com/cucumber/query/pull/53]) +### Changed +- BREAKING CHANGE: `countMostSevereTestStepResultStatus` now returns `EnumMap` with all statuses regardless of count ([#62](https://github.com/cucumber/query/pull/62)) +- BREAKING CHANGE: `findAllTestCaseStarted` now omits `TestCaseStarted` messages where there is or will be another attempt ([#62](https://github.com/cucumber/query/pull/62)) +- BREAKING CHANGE: Rename `findMostSevereTestStepResulBy` to `findMostSevereTestStepResultBy` ([#62](https://github.com/cucumber/query/pull/62)) + +### Removed +- BREAKING CHANGE: Remove support for Node.js 16.x and 17.x ([#62](https://github.com/cucumber/query/pull/62)) + ## [12.2.0] - 2024-06-22 ### Changed - Include pickle name if parameterized ((#44)[https://github.com/cucumber/query/pull/44]) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..de5729a9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing + +For general guidance on contributing to Cucumber, see https://github.com/cucumber/.github/blob/main/CONTRIBUTING.md + +## Adding or changing query methods + +This is a polyglot repo with several languages adhering to a common suite of acceptance tests. A change should be made consistently across all languages. Currently, the list is: + +- Java (reference) +- JavaScript + +Java is the reference implementation in the sense that it is responsible for generating the fixtures that are used in the acceptance tests to verify all implementations. + +So your playbook for adding a method would be something like: + +1. Add the method in `Query.Java` with test(s) in `QueryTest.java` +2. Extend `QueryAcceptanceTest.java` to include verifications for the new method +3. Run `QueryAcceptanceTest::updateExpectedQueryResultFiles` to regenerate the fixtures +4. Implement other languages + +## Types + +Choosing which type to use in another language based on what we did in Java is an inexact science. This table defines all the decisions we've made so far: + +| Java | JavaScript | +|---------------------|-------------------------| +| `Optional` | `T \| undefined`[^1] | +| `List` | `ReadonlyArray` | +| `Map` | `Map` | +| `EnumMap` | `Record` | +| `List>` | `ReadonlyArray<[T, V]>` | + +[^1]: See \ No newline at end of file diff --git a/java/src/main/java/io/cucumber/query/Query.java b/java/src/main/java/io/cucumber/query/Query.java index 518081ed..19d3d51c 100644 --- a/java/src/main/java/io/cucumber/query/Query.java +++ b/java/src/main/java/io/cucumber/query/Query.java @@ -23,19 +23,14 @@ import io.cucumber.messages.types.Timestamp; import java.time.Duration; +import java.util.*; import java.util.AbstractMap.SimpleEntry; -import java.util.ArrayList; -import java.util.Comparator; -import java.util.Deque; -import java.util.LinkedHashMap; -import java.util.List; -import java.util.Map; import java.util.Map.Entry; -import java.util.Optional; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentLinkedDeque; import java.util.function.BiFunction; import java.util.function.Supplier; +import java.util.stream.Collectors; import static java.util.Collections.emptyList; import static java.util.Comparator.comparing; @@ -61,6 +56,8 @@ * @see Cucumber Messages - Message Overview */ public final class Query { + private static final Map ZEROES_BY_TEST_STEP_RESULT_STATUSES = Arrays.stream(TestStepResultStatus.values()) + .collect(Collectors.toMap(identity(), (s) -> 0L)); private final Comparator testStepResultComparator = nullsFirst(comparing(o -> o.getStatus().ordinal())); private final Deque testCaseStarted = new ConcurrentLinkedDeque<>(); private final Map testCaseFinishedByTestCaseStartedId = new ConcurrentHashMap<>(); @@ -74,13 +71,15 @@ public final class Query { private TestRunStarted testRunStarted; private TestRunFinished testRunFinished; - public Map countMostSevereTestStepResultStatus() { - return findAllTestCaseStarted().stream() - .map(this::findMostSevereTestStepResulBy) + public EnumMap countMostSevereTestStepResultStatus() { + final EnumMap results = new EnumMap<>(ZEROES_BY_TEST_STEP_RESULT_STATUSES); + results.putAll(findAllTestCaseStarted().stream() + .map(this::findMostSevereTestStepResultBy) .filter(Optional::isPresent) .map(Optional::get) .map(TestStepResult::getStatus) - .collect(groupingBy(identity(), LinkedHashMap::new, counting())); + .collect(groupingBy(identity(), LinkedHashMap::new, counting()))); + return results; } public int countTestCasesStarted() { @@ -100,7 +99,11 @@ public List findAllPickleSteps() { } public List findAllTestCaseStarted() { - return new ArrayList<>(testCaseStarted); + return this.testCaseStarted.stream() + .filter(testCaseStarted1 -> !findTestCaseFinishedBy(testCaseStarted1) + .filter(TestCaseFinished::getWillBeRetried) + .isPresent()) + .collect(toList()); } public Map, List> findAllTestCaseStartedGroupedByFeature() { @@ -136,7 +139,7 @@ public Optional findFeatureBy(TestCaseStarted testCaseStarted) { return findLineageBy(testCaseStarted).flatMap(Lineage::feature); } - public Optional findMostSevereTestStepResulBy(TestCaseStarted testCaseStarted) { + public Optional findMostSevereTestStepResultBy(TestCaseStarted testCaseStarted) { requireNonNull(testCaseStarted); return findTestStepsFinishedBy(testCaseStarted) .stream() diff --git a/java/src/test/java/io/cucumber/query/QueryAcceptanceTest.java b/java/src/test/java/io/cucumber/query/QueryAcceptanceTest.java index 5197f387..367a0660 100644 --- a/java/src/test/java/io/cucumber/query/QueryAcceptanceTest.java +++ b/java/src/test/java/io/cucumber/query/QueryAcceptanceTest.java @@ -115,8 +115,8 @@ private static Map createQueryResults(Query query) { .map(query::findFeatureBy) .map(feature -> feature.map(Feature::getName)) .collect(toList())); - results.put("findMostSevereTestStepResulBy", query.findAllTestCaseStarted().stream() - .map(query::findMostSevereTestStepResulBy) + results.put("findMostSevereTestStepResultBy", query.findAllTestCaseStarted().stream() + .map(query::findMostSevereTestStepResultBy) .map(testStepResult -> testStepResult.map(TestStepResult::getStatus)) .collect(toList())); diff --git a/java/src/test/java/io/cucumber/query/QueryTest.java b/java/src/test/java/io/cucumber/query/QueryTest.java index beb73d35..f20e52e0 100644 --- a/java/src/test/java/io/cucumber/query/QueryTest.java +++ b/java/src/test/java/io/cucumber/query/QueryTest.java @@ -1,6 +1,7 @@ package io.cucumber.query; import io.cucumber.messages.types.Envelope; +import io.cucumber.messages.types.TestCaseFinished; import io.cucumber.messages.types.TestCaseStarted; import io.cucumber.messages.types.Timestamp; import org.junit.jupiter.api.Test; @@ -27,6 +28,23 @@ void retainsInsertionOrderForTestCaseStarted() { assertThat(query.findAllTestCaseStarted()).containsExactly(a, b, c); } + @Test + void omitsTestCaseStartedIfFinishedAndWillBeRetried() { + TestCaseStarted a = new TestCaseStarted(0L, randomId(), randomId(), "main", new Timestamp(0L, 0L)); + TestCaseFinished b = new TestCaseFinished(a.getId(), new Timestamp(0L, 0L), true); + TestCaseStarted c = new TestCaseStarted(0L, randomId(), randomId(), "main", new Timestamp(0L, 0L)); + TestCaseFinished d = new TestCaseFinished(c.getId(), new Timestamp(0L, 0L), false); + + Stream.of(a, c) + .map(Envelope::of) + .forEach(query::update); + Stream.of(b, d) + .map(Envelope::of) + .forEach(query::update); + + assertThat(query.findAllTestCaseStarted()).containsExactly(c); + } + private static String randomId() { return UUID.randomUUID().toString(); } diff --git a/javascript/package-lock.json b/javascript/package-lock.json index fa0384e0..68c4b22b 100644 --- a/javascript/package-lock.json +++ b/javascript/package-lock.json @@ -9,8 +9,8 @@ "version": "12.2.0", "license": "MIT", "dependencies": { - "@cucumber/messages": "<=27", - "@teppeis/multimaps": "3.0.0" + "@teppeis/multimaps": "3.0.0", + "assert": "^2.1.0" }, "devDependencies": { "@cucumber/compatibility-kit": "^15.0.0", @@ -18,6 +18,7 @@ "@cucumber/gherkin": "^29.0.0", "@cucumber/gherkin-streams": "^5.0.1", "@cucumber/gherkin-utils": "^9.0.0", + "@cucumber/messages": "26.0.1", "@types/mocha": "10.0.9", "@types/node": "20.17.6", "@typescript-eslint/eslint-plugin": "7.18.0", @@ -32,6 +33,7 @@ "eslint-plugin-react": "7.37.2", "eslint-plugin-react-hooks": "4.6.2", "eslint-plugin-simple-import-sort": "12.1.1", + "glob": "^11.0.0", "mocha": "10.8.2", "prettier": "3.3.3", "pretty-quick": "4.0.0", @@ -39,6 +41,9 @@ "ts-node": "10.9.2", "tsconfig-paths": "4.2.0", "typescript": "5.6.3" + }, + "peerDependencies": { + "@cucumber/messages": "*" } }, "node_modules/@aashutoshrathi/word-wrap": { @@ -108,6 +113,50 @@ "@cucumber/messages": ">=19.0" } }, + "node_modules/@cucumber/fake-cucumber/node_modules/brace-expansion": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", + "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", + "dev": true, + "license": "MIT", + "dependencies": { + "balanced-match": "^1.0.0" + } + }, + "node_modules/@cucumber/fake-cucumber/node_modules/glob": { + "version": "8.0.3", + "resolved": "https://registry.npmjs.org/glob/-/glob-8.0.3.tgz", + "integrity": "sha512-ull455NHSHI/Y1FqGaaYFaLGkNMMJbavMrEGFXG/PGrg6y7sutWHUHrz6gy6WEBH6akM1M414dWKCNs+IhKdiQ==", + "deprecated": "Glob versions prior to v9 are no longer supported", + "dev": true, + "license": "ISC", + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^5.0.1", + "once": "^1.3.0" + }, + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/@cucumber/fake-cucumber/node_modules/minimatch": { + "version": "5.1.6", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.6.tgz", + "integrity": "sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g==", + "dev": true, + "license": "ISC", + "dependencies": { + "brace-expansion": "^2.0.1" + }, + "engines": { + "node": ">=10" + } + }, "node_modules/@cucumber/gherkin": { "version": "29.0.0", "resolved": "https://registry.npmjs.org/@cucumber/gherkin/-/gherkin-29.0.0.tgz", @@ -172,19 +221,6 @@ "@cucumber/messages": ">=19.1.4 <=24" } }, - "node_modules/@cucumber/gherkin-utils/node_modules/@cucumber/messages": { - "version": "24.1.0", - "resolved": "https://registry.npmjs.org/@cucumber/messages/-/messages-24.1.0.tgz", - "integrity": "sha512-hxVHiBurORcobhVk80I9+JkaKaNXkW6YwGOEFIh/2aO+apAN+5XJgUUWjng9NwqaQrW1sCFuawLB1AuzmBaNdQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/uuid": "9.0.8", - "class-transformer": "0.5.1", - "reflect-metadata": "0.2.1", - "uuid": "9.0.1" - } - }, "node_modules/@cucumber/gherkin-utils/node_modules/commander": { "version": "12.0.0", "resolved": "https://registry.npmjs.org/commander/-/commander-12.0.0.tgz", @@ -195,26 +231,6 @@ "node": ">=18" } }, - "node_modules/@cucumber/gherkin/node_modules/@cucumber/messages": { - "version": "25.0.1", - "resolved": "https://registry.npmjs.org/@cucumber/messages/-/messages-25.0.1.tgz", - "integrity": "sha512-RjjhmzcauX5eYfcKns5pgenefDJQcfXE3ZDrVWdUDGcoaoyFVDmj+ZzQZWRWqFrfMjP3lKHJss6LtvIP/z+h8g==", - "dev": true, - "license": "MIT", - "dependencies": { - "@types/uuid": "9.0.8", - "class-transformer": "0.5.1", - "reflect-metadata": "0.2.2", - "uuid": "9.0.1" - } - }, - "node_modules/@cucumber/gherkin/node_modules/reflect-metadata": { - "version": "0.2.2", - "resolved": "https://registry.npmjs.org/reflect-metadata/-/reflect-metadata-0.2.2.tgz", - "integrity": "sha512-urBwgfrvVP/eAyXx4hluJivBKzuEbSQs9rKWCrCkbSxNv8mxPcUZKeuoF3Uy4mJl3Lwprp6yy5/39VWigZ4K6Q==", - "dev": true, - "license": "Apache-2.0" - }, "node_modules/@cucumber/message-streams": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/@cucumber/message-streams/-/message-streams-4.0.1.tgz", @@ -226,9 +242,10 @@ } }, "node_modules/@cucumber/messages": { - "version": "27.0.0", - "resolved": "https://registry.npmjs.org/@cucumber/messages/-/messages-27.0.0.tgz", - "integrity": "sha512-w0Qfu+IibH/uAMcf8TZPvSXSrbf7BLIfIxMmYvwx31jH6wuBcf/3RQetutS7Ge98rydjmpRphs2HCbugySarCA==", + "version": "26.0.1", + "resolved": "https://registry.npmjs.org/@cucumber/messages/-/messages-26.0.1.tgz", + "integrity": "sha512-DIxSg+ZGariumO+Lq6bn4kOUIUET83A4umrnWmidjGFl8XxkBieUZtsmNbLYgH/gnsmP07EfxxdTr0hOchV1Sg==", + "dev": true, "license": "MIT", "dependencies": { "@types/uuid": "10.0.0", @@ -241,18 +258,21 @@ "version": "10.0.0", "resolved": "https://registry.npmjs.org/@types/uuid/-/uuid-10.0.0.tgz", "integrity": "sha512-7gqG38EyHgyP1S+7+xomFtL+ZNHcKv6DwNaCZmJmo1vgMugyF3TCnXVg4t1uk89mLNwnLtnY3TpOpCOyp1/xHQ==", + "dev": true, "license": "MIT" }, "node_modules/@cucumber/messages/node_modules/reflect-metadata": { "version": "0.2.2", "resolved": "https://registry.npmjs.org/reflect-metadata/-/reflect-metadata-0.2.2.tgz", "integrity": "sha512-urBwgfrvVP/eAyXx4hluJivBKzuEbSQs9rKWCrCkbSxNv8mxPcUZKeuoF3Uy4mJl3Lwprp6yy5/39VWigZ4K6Q==", + "dev": true, "license": "Apache-2.0" }, "node_modules/@cucumber/messages/node_modules/uuid": { "version": "10.0.0", "resolved": "https://registry.npmjs.org/uuid/-/uuid-10.0.0.tgz", "integrity": "sha512-8XkAphELsDnEGrDxUOHB3RGvXz6TeuYSGEZBOjtTtPm2lwhGBjLgOzLHB63IUWfBpNucQjND6d3AOudO+H3RWQ==", + "dev": true, "funding": [ "https://github.com/sponsors/broofa", "https://github.com/sponsors/ctavan" @@ -624,13 +644,6 @@ "integrity": "sha512-Hl219/BT5fLAaz6NDkSuhzasy49dwQS/DSdu4MdggFB8zcXv7vflBI3xp7FEmkmdDkBUI2bPUNeMttp2knYdxw==", "dev": true }, - "node_modules/@types/uuid": { - "version": "9.0.8", - "resolved": "https://registry.npmjs.org/@types/uuid/-/uuid-9.0.8.tgz", - "integrity": "sha512-jg+97EGIcY9AGHJJRaaPVgetKDsrTgbRjQ5Msgjh/DQKEFl0DtyRr/VCOyD1T2R1MNeWPK/u7JoGhlDZnKBAfA==", - "dev": true, - "license": "MIT" - }, "node_modules/@typescript-eslint/eslint-plugin": { "version": "7.18.0", "resolved": "https://registry.npmjs.org/@typescript-eslint/eslint-plugin/-/eslint-plugin-7.18.0.tgz", @@ -1159,11 +1172,23 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/assert": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/assert/-/assert-2.1.0.tgz", + "integrity": "sha512-eLHpSK/Y4nhMJ07gDaAzoX/XAKS8PSaojml3M0DM4JpV1LAi5JOJ/p6H/XWrl8L+DzVEvVCW1z3vWAaB9oTsQw==", + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "is-nan": "^1.3.2", + "object-is": "^1.1.5", + "object.assign": "^4.1.4", + "util": "^0.12.5" + } + }, "node_modules/available-typed-arrays": { "version": "1.0.7", "resolved": "https://registry.npmjs.org/available-typed-arrays/-/available-typed-arrays-1.0.7.tgz", "integrity": "sha512-wvUjBtSGN7+7SjNpq/9M2Tg350UZD3q62IFZLbRAR1bSMlCo1ZaeW+BJ+D090e4hIIZLBcTDWe4Mh4jvUDajzQ==", - "dev": true, "dependencies": { "possible-typed-array-names": "^1.0.0" }, @@ -1227,7 +1252,6 @@ "version": "1.0.7", "resolved": "https://registry.npmjs.org/call-bind/-/call-bind-1.0.7.tgz", "integrity": "sha512-GHTSNSYICQ7scH7sZ+M2rFopRoLh8t2bLSW6BbgrtLsahOIB5iyAVJf9GjWK3cYTDaMj4XdBpM1cA6pIS0Kv2w==", - "dev": true, "dependencies": { "es-define-property": "^1.0.0", "es-errors": "^1.3.0", @@ -1309,7 +1333,8 @@ "node_modules/class-transformer": { "version": "0.5.1", "resolved": "https://registry.npmjs.org/class-transformer/-/class-transformer-0.5.1.tgz", - "integrity": "sha512-SQa1Ws6hUbfC98vKGxZH3KFY0Y1lm5Zm0SY8XX9zbK7FJCyVEac3ATW0RIpwzW+oOfmHE5PMPufDG9hCfoEOMw==" + "integrity": "sha512-SQa1Ws6hUbfC98vKGxZH3KFY0Y1lm5Zm0SY8XX9zbK7FJCyVEac3ATW0RIpwzW+oOfmHE5PMPufDG9hCfoEOMw==", + "dev": true }, "node_modules/cliui": { "version": "7.0.4", @@ -1482,7 +1507,6 @@ "version": "1.1.4", "resolved": "https://registry.npmjs.org/define-data-property/-/define-data-property-1.1.4.tgz", "integrity": "sha512-rBMvIzlpA8v6E+SJZoo++HAYqsLrkg7MSfIinMPFhmkorw7X+dOXVJQs+QT69zGkzMyfDnIMN2Wid1+NbL3T+A==", - "dev": true, "dependencies": { "es-define-property": "^1.0.0", "es-errors": "^1.3.0", @@ -1499,7 +1523,6 @@ "version": "1.2.1", "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.2.1.tgz", "integrity": "sha512-8QmQKqEASLd5nx0U1B1okLElbUuuttJ/AnYmRXbbbGDWh6uS208EjD4Xqq/I9wK7u0v6O08XhTWnt5XtEbR6Dg==", - "dev": true, "dependencies": { "define-data-property": "^1.0.1", "has-property-descriptors": "^1.0.0", @@ -1635,7 +1658,6 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/es-define-property/-/es-define-property-1.0.0.tgz", "integrity": "sha512-jxayLKShrEqqzJ0eumQbVhTYQM27CfT1T35+gCgDFoL82JLsXqTJ76zv6A0YLOgEnLUMvLzsDsGIrl8NFpT2gQ==", - "dev": true, "dependencies": { "get-intrinsic": "^1.2.4" }, @@ -1647,7 +1669,6 @@ "version": "1.3.0", "resolved": "https://registry.npmjs.org/es-errors/-/es-errors-1.3.0.tgz", "integrity": "sha512-Zf5H2Kxt2xjTvbJvP2ZWLEICxA6j+hAmMzIlypy4xcBg1vKVnx89Wy0GbS+kf5cwCVFFzdCFh2XSCFNULS6csw==", - "dev": true, "engines": { "node": ">= 0.4" } @@ -2371,6 +2392,7 @@ "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.3.2.tgz", "integrity": "sha512-oX2ruAFQwf/Orj8m737Y5adxDQO0LAB7/S5MnxCdTNDd4p6BsyIVsv9JQsATbTSq8KHRpLwIHbVlUNatxd+1Ow==", "dev": true, + "license": "MIT", "dependencies": { "@nodelib/fs.stat": "^2.0.2", "@nodelib/fs.walk": "^1.2.3", @@ -2546,7 +2568,6 @@ "version": "0.3.3", "resolved": "https://registry.npmjs.org/for-each/-/for-each-0.3.3.tgz", "integrity": "sha512-jqYfLp7mo9vIyQf8ykW2v7A+2N4QjeCeI5+Dz9XraiO1ign81wjiH7Fb9vSOWvQfNtmSa4H2RoQTrrXivdUZmw==", - "dev": true, "dependencies": { "is-callable": "^1.1.3" } @@ -2589,7 +2610,6 @@ "version": "1.1.2", "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.2.tgz", "integrity": "sha512-7XHNxH7qX9xG5mIwxkhumTox/MIRNcOgDrxWsMt2pAr23WHp6MrRlN7FBSFpCpr+oVO0F744iUgR82nJMfG2SA==", - "dev": true, "funding": { "url": "https://github.com/sponsors/ljharb" } @@ -2634,7 +2654,6 @@ "version": "1.2.4", "resolved": "https://registry.npmjs.org/get-intrinsic/-/get-intrinsic-1.2.4.tgz", "integrity": "sha512-5uYhsJH8VJBTv7oslg4BznJYhDoRI6waYCxMmCdnTrcCrHA/fCFKoTFz2JKKE0HdDFUF7/oQuhzumXJK7paBRQ==", - "dev": true, "dependencies": { "es-errors": "^1.3.0", "function-bind": "^1.1.2", @@ -2692,19 +2711,24 @@ } }, "node_modules/glob": { - "version": "8.0.3", - "resolved": "https://registry.npmjs.org/glob/-/glob-8.0.3.tgz", - "integrity": "sha512-ull455NHSHI/Y1FqGaaYFaLGkNMMJbavMrEGFXG/PGrg6y7sutWHUHrz6gy6WEBH6akM1M414dWKCNs+IhKdiQ==", + "version": "11.0.0", + "resolved": "https://registry.npmjs.org/glob/-/glob-11.0.0.tgz", + "integrity": "sha512-9UiX/Bl6J2yaBbxKoEBRm4Cipxgok8kQYcOPEhScPwebu2I0HoQOuYdIO6S3hLuWoZgpDpwQZMzTFxgpkyT76g==", "dev": true, + "license": "ISC", "dependencies": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^5.0.1", - "once": "^1.3.0" + "foreground-child": "^3.1.0", + "jackspeak": "^4.0.1", + "minimatch": "^10.0.0", + "minipass": "^7.1.2", + "package-json-from-dist": "^1.0.0", + "path-scurry": "^2.0.0" + }, + "bin": { + "glob": "dist/esm/bin.mjs" }, "engines": { - "node": ">=12" + "node": "20 || >=22" }, "funding": { "url": "https://github.com/sponsors/isaacs" @@ -2727,20 +2751,58 @@ "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz", "integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==", "dev": true, + "license": "MIT", "dependencies": { "balanced-match": "^1.0.0" } }, + "node_modules/glob/node_modules/jackspeak": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-4.0.2.tgz", + "integrity": "sha512-bZsjR/iRjl1Nk1UkjGpAzLNfQtzuijhn2g+pbZb98HQ1Gk8vM9hfbxeMBP+M2/UUdwj0RqGG3mlvk2MsAqwvEw==", + "dev": true, + "license": "BlueOak-1.0.0", + "dependencies": { + "@isaacs/cliui": "^8.0.2" + }, + "engines": { + "node": "20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, "node_modules/glob/node_modules/minimatch": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-5.1.0.tgz", - "integrity": "sha512-9TPBGGak4nHfGZsPBohm9AWg6NoT7QTCehS3BIJABslyZbzxfV78QM2Y6+i741OPZIafFAaiiEMh5OyIrJPgtg==", + "version": "10.0.1", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.0.1.tgz", + "integrity": "sha512-ethXTt3SGGR+95gudmqJ1eNhRO7eGEGIgYA9vnPatK4/etz2MEVDno5GMCibdMTuBMyElzIlgxMna3K94XDIDQ==", "dev": true, + "license": "ISC", "dependencies": { "brace-expansion": "^2.0.1" }, "engines": { - "node": ">=10" + "node": "20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/glob/node_modules/path-scurry": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-2.0.0.tgz", + "integrity": "sha512-ypGJsmGtdXUOeM5u93TyeIEfEhM6s+ljAhrk5vAvSx8uyY/02OvrZnA0YNGUrPXfpJMgI1ODd3nwz8Npx4O4cg==", + "dev": true, + "license": "BlueOak-1.0.0", + "dependencies": { + "lru-cache": "^11.0.0", + "minipass": "^7.1.2" + }, + "engines": { + "node": "20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" } }, "node_modules/globals": { @@ -2799,7 +2861,6 @@ "version": "1.0.1", "resolved": "https://registry.npmjs.org/gopd/-/gopd-1.0.1.tgz", "integrity": "sha512-d65bNlIadxvpb/A2abVdlqKqV563juRnZ1Wtk6s1sIR8uNsXR70xqIzVqxVf1eTqDunwT2MkczEeaezCKTZhwA==", - "dev": true, "dependencies": { "get-intrinsic": "^1.1.3" }, @@ -2842,7 +2903,6 @@ "version": "1.0.2", "resolved": "https://registry.npmjs.org/has-property-descriptors/-/has-property-descriptors-1.0.2.tgz", "integrity": "sha512-55JNKuIW+vq4Ke1BjOTjM2YctQIvCT7GFzHwmfZPGo5wnrgkid0YQtnAleFSqumZm4az3n2BS+erby5ipJdgrg==", - "dev": true, "dependencies": { "es-define-property": "^1.0.0" }, @@ -2854,7 +2914,6 @@ "version": "1.0.3", "resolved": "https://registry.npmjs.org/has-proto/-/has-proto-1.0.3.tgz", "integrity": "sha512-SJ1amZAJUiZS+PhsVLf5tGydlaVB8EdFpaSO4gmiUKUOxk8qzn5AIy4ZeJUmh22znIdk/uMAUT2pl3FxzVUH+Q==", - "dev": true, "engines": { "node": ">= 0.4" }, @@ -2866,7 +2925,6 @@ "version": "1.0.3", "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.3.tgz", "integrity": "sha512-l3LCuF6MgDNwTDKkdYGEihYjt5pRPbEg46rtlmnSPlUbgmB8LOIrKJbYYFBSbnPaJexMKtiPO8hmeRjRz2Td+A==", - "dev": true, "engines": { "node": ">= 0.4" }, @@ -2878,7 +2936,6 @@ "version": "1.0.2", "resolved": "https://registry.npmjs.org/has-tostringtag/-/has-tostringtag-1.0.2.tgz", "integrity": "sha512-NqADB8VjPFLM2V0VvHUewwwsw0ZWBaIdgo+ieHtK3hasLz4qeCRjYcqfB6AQrBggRKppKF8L52/VqdVsO47Dlw==", - "dev": true, "dependencies": { "has-symbols": "^1.0.3" }, @@ -2893,7 +2950,6 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/hasown/-/hasown-2.0.2.tgz", "integrity": "sha512-0hJU9SCPvmMzIBdZFqNPXWa6dqh7WdH0cII9y+CyS8rG3nL48Bclra9HmKhVVUHyPWNH5Y7xDwAB7bfgSjkUMQ==", - "dev": true, "dependencies": { "function-bind": "^1.1.2" }, @@ -2967,8 +3023,7 @@ "node_modules/inherits": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", - "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", - "dev": true + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==" }, "node_modules/internal-slot": { "version": "1.0.7", @@ -2984,6 +3039,22 @@ "node": ">= 0.4" } }, + "node_modules/is-arguments": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/is-arguments/-/is-arguments-1.1.1.tgz", + "integrity": "sha512-8Q7EARjzEnKpt/PCD7e1cgUS0a6X8u5tdSiMqXhojOdoV9TsMsiO+9VLC5vAmO8N7/GmXn7yjR8qnA6bVAEzfA==", + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.2", + "has-tostringtag": "^1.0.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-array-buffer": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/is-array-buffer/-/is-array-buffer-3.0.4.tgz", @@ -3060,7 +3131,6 @@ "version": "1.2.7", "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.2.7.tgz", "integrity": "sha512-1BC0BVFhS/p0qtw6enp8e+8OD0UrK0oFLztSjNzhcKA3WDuJxxAPXzPuPtKkjEY9UUoEWlX/8fgKeu2S8i9JTA==", - "dev": true, "engines": { "node": ">= 0.4" }, @@ -3149,7 +3219,6 @@ "version": "1.0.10", "resolved": "https://registry.npmjs.org/is-generator-function/-/is-generator-function-1.0.10.tgz", "integrity": "sha512-jsEjy9l3yiXEQ+PsXdmBwEPcOxaXWLspKdplFUVI9vq1iZgIekeC0L167qeu86czQaxed3q/Uzuw0swL0irL8A==", - "dev": true, "license": "MIT", "dependencies": { "has-tostringtag": "^1.0.0" @@ -3186,6 +3255,22 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/is-nan": { + "version": "1.3.2", + "resolved": "https://registry.npmjs.org/is-nan/-/is-nan-1.3.2.tgz", + "integrity": "sha512-E+zBKpQ2t6MEo1VsonYmluk9NxGrbzpeeLC2xIViuO2EjU2xsXsBPwTr3Ykv9l08UYEVEdWeRZNouaZqF6RN0w==", + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.0", + "define-properties": "^1.1.3" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/is-negative-zero": { "version": "2.0.3", "resolved": "https://registry.npmjs.org/is-negative-zero/-/is-negative-zero-2.0.3.tgz", @@ -3330,7 +3415,6 @@ "version": "1.1.13", "resolved": "https://registry.npmjs.org/is-typed-array/-/is-typed-array-1.1.13.tgz", "integrity": "sha512-uZ25/bUAlUY5fR4OKT4rZQEBrzQWYV9ZJYGGsUmEJ6thodVJ1HX64ePQ6Z0qPWP+m+Uq6e9UugrE38jeYsDSMw==", - "dev": true, "dependencies": { "which-typed-array": "^1.1.14" }, @@ -3569,6 +3653,16 @@ "loose-envify": "cli.js" } }, + "node_modules/lru-cache": { + "version": "11.0.2", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-11.0.2.tgz", + "integrity": "sha512-123qHRfJBmo2jXDbo/a5YOQrJoHF/GNQTLzQ5+IdK5pWpceK17yRc6ozlWd25FxvGKQbIUs91fDFkXmDHTKcyA==", + "dev": true, + "license": "ISC", + "engines": { + "node": "20 || >=22" + } + }, "node_modules/make-error": { "version": "1.3.6", "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz", @@ -3633,6 +3727,16 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/minipass": { + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.1.2.tgz", + "integrity": "sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw==", + "dev": true, + "license": "ISC", + "engines": { + "node": ">=16 || 14 >=14.17" + } + }, "node_modules/mocha": { "version": "10.8.2", "resolved": "https://registry.npmjs.org/mocha/-/mocha-10.8.2.tgz", @@ -3816,11 +3920,26 @@ "url": "https://github.com/sponsors/ljharb" } }, + "node_modules/object-is": { + "version": "1.1.6", + "resolved": "https://registry.npmjs.org/object-is/-/object-is-1.1.6.tgz", + "integrity": "sha512-F8cZ+KfGlSGi09lJT7/Nd6KJZ9ygtvYC0/UYYLI9nmQKLMnydpB9yvbv9K1uSkEu7FU9vYPmVwLg328tX+ot3Q==", + "license": "MIT", + "dependencies": { + "call-bind": "^1.0.7", + "define-properties": "^1.2.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/object-keys": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", - "dev": true, "engines": { "node": ">= 0.4" } @@ -3829,7 +3948,6 @@ "version": "4.1.5", "resolved": "https://registry.npmjs.org/object.assign/-/object.assign-4.1.5.tgz", "integrity": "sha512-byy+U7gp+FVwmyzKPYhW2h5l3crpmGsxl7X2s8y43IgxvG4g3QZ6CffDtsNQy1WsmZpQbO+ybo0AlW7TY6DcBQ==", - "dev": true, "dependencies": { "call-bind": "^1.0.5", "define-properties": "^1.2.1", @@ -3978,6 +4096,13 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/package-json-from-dist": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/package-json-from-dist/-/package-json-from-dist-1.0.1.tgz", + "integrity": "sha512-UEZIS3/by4OC8vL3P2dTXRETpebLI2NiI5vIrjaD/5UtrkFX/tNbwjTSRAGC/+7CAo2pIcBaRgWmcBBHcsaCIw==", + "dev": true, + "license": "BlueOak-1.0.0" + }, "node_modules/parent-module": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/parent-module/-/parent-module-1.0.1.tgz", @@ -4048,15 +4173,6 @@ "node": "14 || >=16.14" } }, - "node_modules/path-scurry/node_modules/minipass": { - "version": "7.0.4", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.0.4.tgz", - "integrity": "sha512-jYofLM5Dam9279rdkWzqHozUo4ybjdZmCsDHePy5V/PbBcVMiSZR97gmAy45aqi8CK1lG2ECd356FU86avfwUQ==", - "dev": true, - "engines": { - "node": ">=16 || 14 >=14.17" - } - }, "node_modules/path-type": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", @@ -4088,7 +4204,6 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/possible-typed-array-names/-/possible-typed-array-names-1.0.0.tgz", "integrity": "sha512-d7Uw+eZoloe0EHDIYoe+bQ5WXnGMOpmiZFTuMWCwpjzzkL2nTjcKiAk4hh8TjnGye2TwWOk3UXucZ+3rbmBa8Q==", - "dev": true, "engines": { "node": ">= 0.4" } @@ -4232,14 +4347,6 @@ "node": ">=8.10.0" } }, - "node_modules/reflect-metadata": { - "version": "0.2.1", - "resolved": "https://registry.npmjs.org/reflect-metadata/-/reflect-metadata-0.2.1.tgz", - "integrity": "sha512-i5lLI6iw9AU3Uu4szRNPPEkomnkjRTaVt9hy/bn5g/oSzekBSMeLZblcjP74AW0vBabqERLLIrz+gR8QYR54Tw==", - "deprecated": "This version has a critical bug in fallback handling. Please upgrade to reflect-metadata@0.2.2 or newer.", - "dev": true, - "license": "Apache-2.0" - }, "node_modules/reflect.getprototypeof": { "version": "1.0.6", "resolved": "https://registry.npmjs.org/reflect.getprototypeof/-/reflect.getprototypeof-1.0.6.tgz", @@ -4426,15 +4533,6 @@ "url": "https://github.com/sponsors/isaacs" } }, - "node_modules/rimraf/node_modules/minipass": { - "version": "7.0.4", - "resolved": "https://registry.npmjs.org/minipass/-/minipass-7.0.4.tgz", - "integrity": "sha512-jYofLM5Dam9279rdkWzqHozUo4ybjdZmCsDHePy5V/PbBcVMiSZR97gmAy45aqi8CK1lG2ECd356FU86avfwUQ==", - "dev": true, - "engines": { - "node": ">=16 || 14 >=14.17" - } - }, "node_modules/run-parallel": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", @@ -4538,7 +4636,6 @@ "version": "1.2.1", "resolved": "https://registry.npmjs.org/set-function-length/-/set-function-length-1.2.1.tgz", "integrity": "sha512-j4t6ccc+VsKwYHso+kElc5neZpjtq9EnRICFZtWyBsLojhmeF/ZBd/elqm22WJh/BziDe/SBiOeAt0m2mfLD0g==", - "dev": true, "dependencies": { "define-data-property": "^1.1.2", "es-errors": "^1.3.0", @@ -5128,18 +5225,17 @@ "punycode": "^2.1.0" } }, - "node_modules/uuid": { - "version": "9.0.1", - "resolved": "https://registry.npmjs.org/uuid/-/uuid-9.0.1.tgz", - "integrity": "sha512-b+1eJOlsR9K8HJpow9Ok3fiWOWSIcIzXodvv0rQjVoOVNpWMpxf1wZNpt4y9h10odCNrqnYp1OBzRktckBe3sA==", - "dev": true, - "funding": [ - "https://github.com/sponsors/broofa", - "https://github.com/sponsors/ctavan" - ], + "node_modules/util": { + "version": "0.12.5", + "resolved": "https://registry.npmjs.org/util/-/util-0.12.5.tgz", + "integrity": "sha512-kZf/K6hEIrWHI6XqOFUiiMa+79wE/D8Q+NCNAWclkyg3b4d2k7s0QGepNjiABc+aR3N1PAyHL7p6UcLY6LmrnA==", "license": "MIT", - "bin": { - "uuid": "dist/bin/uuid" + "dependencies": { + "inherits": "^2.0.3", + "is-arguments": "^1.0.4", + "is-generator-function": "^1.0.7", + "is-typed-array": "^1.1.3", + "which-typed-array": "^1.1.2" } }, "node_modules/v8-compile-cache-lib": { @@ -5229,7 +5325,6 @@ "version": "1.1.15", "resolved": "https://registry.npmjs.org/which-typed-array/-/which-typed-array-1.1.15.tgz", "integrity": "sha512-oV0jmFtUky6CXfkqehVvBP/LSWJ2sy4vWMioiENyJLePrBO/yKyV9OyJySfAKosh+RYkIl5zJCNZ8/4JncrpdA==", - "dev": true, "dependencies": { "available-typed-arrays": "^1.0.7", "call-bind": "^1.0.7", diff --git a/javascript/package.json b/javascript/package.json index 37ae1a10..ae746333 100644 --- a/javascript/package.json +++ b/javascript/package.json @@ -9,7 +9,7 @@ "clean": "rm -rf dist", "eslint-fix": "eslint --ext ts,tsx --max-warnings 0 --fix", "eslint": "eslint --ext ts,tsx --max-warnings 0", - "test": "mocha", + "test": "mocha 'src/**/*.spec.*'", "prepublishOnly": "tsc --build tsconfig.build.json" }, "repository": { @@ -31,6 +31,7 @@ "@cucumber/gherkin": "^29.0.0", "@cucumber/gherkin-streams": "^5.0.1", "@cucumber/gherkin-utils": "^9.0.0", + "@cucumber/messages": "26.0.1", "@types/mocha": "10.0.9", "@types/node": "20.17.6", "@typescript-eslint/eslint-plugin": "7.18.0", @@ -45,6 +46,7 @@ "eslint-plugin-react": "7.37.2", "eslint-plugin-react-hooks": "4.6.2", "eslint-plugin-simple-import-sort": "12.1.1", + "glob": "^11.0.0", "mocha": "10.8.2", "prettier": "3.3.3", "pretty-quick": "4.0.0", @@ -53,9 +55,15 @@ "tsconfig-paths": "4.2.0", "typescript": "5.6.3" }, + "peerDependencies": { + "@cucumber/messages": "*" + }, "dependencies": { - "@cucumber/messages": "<=27", - "@teppeis/multimaps": "3.0.0" + "@teppeis/multimaps": "3.0.0", + "assert": "^2.1.0" + }, + "overrides": { + "@cucumber/messages": "26.0.1" }, "directories": { "test": "test" diff --git a/javascript/src/Lineage.ts b/javascript/src/Lineage.ts new file mode 100644 index 00000000..a5214253 --- /dev/null +++ b/javascript/src/Lineage.ts @@ -0,0 +1,110 @@ +import { + Examples, + Feature, + GherkinDocument, + Pickle, + Rule, + Scenario, + TableRow, +} from '@cucumber/messages' + +export interface Lineage { + gherkinDocument?: GherkinDocument + feature?: Feature + rule?: Rule + scenario?: Scenario + examples?: Examples + examplesIndex?: number + example?: TableRow + exampleIndex?: number +} + +export interface LineageReducer { + reduce: (lineage: Lineage, pickle: Pickle) => T +} + +export type NamingStrategy = LineageReducer + +export enum NamingStrategyLength { + LONG = 'LONG', + SHORT = 'SHORT', +} + +export enum NamingStrategyFeatureName { + INCLUDE = 'INCLUDE', + EXCLUDE = 'EXCLUDE', +} + +export enum NamingStrategyExampleName { + NUMBER = 'NUMBER', + PICKLE = 'PICKLE', + NUMBER_AND_PICKLE_IF_PARAMETERIZED = 'NUMBER_AND_PICKLE_IF_PARAMETERIZED', +} + +class BuiltinNamingStrategy implements NamingStrategy { + constructor( + private readonly length: NamingStrategyLength, + private readonly featureName: NamingStrategyFeatureName, + private readonly exampleName: NamingStrategyExampleName + ) {} + + reduce(lineage: Lineage, pickle: Pickle): string { + const parts: string[] = [] + + if (lineage.feature?.name && this.featureName === NamingStrategyFeatureName.INCLUDE) { + parts.push(lineage.feature.name) + } + + if (lineage.rule?.name) { + parts.push(lineage.rule.name) + } + + if (lineage.scenario?.name) { + parts.push(lineage.scenario.name) + } else { + parts.push(pickle.name) + } + + if (lineage.examples?.name) { + parts.push(lineage.examples.name) + } + + if (lineage.example) { + const exampleNumber = [ + '#', + (lineage.examplesIndex ?? 0) + 1, + '.', + (lineage.exampleIndex ?? 0) + 1, + ].join('') + + switch (this.exampleName) { + case NamingStrategyExampleName.NUMBER: + parts.push(exampleNumber) + break + case NamingStrategyExampleName.NUMBER_AND_PICKLE_IF_PARAMETERIZED: + if (lineage.scenario?.name !== pickle.name) { + parts.push(exampleNumber + ': ' + pickle.name) + } else { + parts.push(exampleNumber) + } + break + case NamingStrategyExampleName.PICKLE: + parts.push(pickle.name) + break + } + } + + if (this.length === NamingStrategyLength.SHORT) { + return parts.at(-1) as string + } + return parts.filter((part) => !!part).join(' - ') + } +} + +export function namingStrategy( + length: NamingStrategyLength, + featureName: NamingStrategyFeatureName = NamingStrategyFeatureName.INCLUDE, + exampleName: NamingStrategyExampleName = NamingStrategyExampleName.NUMBER_AND_PICKLE_IF_PARAMETERIZED +): NamingStrategy { + return new BuiltinNamingStrategy(length, featureName, exampleName) +} diff --git a/javascript/test/QueryTest.ts b/javascript/src/Query.spec.ts similarity index 99% rename from javascript/test/QueryTest.ts rename to javascript/src/Query.spec.ts index b22fe6be..7046250e 100644 --- a/javascript/test/QueryTest.ts +++ b/javascript/src/Query.spec.ts @@ -14,7 +14,7 @@ import { } from '@cucumber/fake-cucumber' import { promisify } from 'util' -import Query from '../src/Query' +import Query from './Query' const pipelinePromise = promisify(pipeline) diff --git a/javascript/src/Query.ts b/javascript/src/Query.ts index cbc835e3..57d5431d 100644 --- a/javascript/src/Query.ts +++ b/javascript/src/Query.ts @@ -1,6 +1,29 @@ import * as messages from '@cucumber/messages' -import { getWorstTestStepResult } from '@cucumber/messages' -import { ArrayMultimap } from '@teppeis/multimaps' +import { + Duration, + Feature, + getWorstTestStepResult, + GherkinDocument, + Pickle, + PickleStep, + Rule, + Scenario, + Step, + TestCase, + TestCaseFinished, + TestCaseStarted, + TestRunFinished, + TestRunStarted, + TestStep, + TestStepFinished, + TestStepResult, + TestStepResultStatus, + TimeConversion +} from '@cucumber/messages' +import {ArrayMultimap} from '@teppeis/multimaps' +import {Lineage, NamingStrategy} from "./Lineage"; +import assert from 'assert'; +import { comparatorBy, comparatorById, comparatorByStatus } from './helpers' export default class Query { private readonly testStepResultByPickleId = new ArrayMultimap() @@ -8,9 +31,7 @@ export default class Query { string, messages.TestStepResult >() - private readonly testStepById = new Map() private readonly testCaseByPickleId = new Map() - private readonly testCaseByTestCaseId = new Map() private readonly pickleIdByTestStepId = new Map() private readonly pickleStepIdByTestStepId = new Map() private readonly testStepResultsbyTestStepId = new ArrayMultimap< @@ -19,64 +40,189 @@ export default class Query { >() private readonly testStepIdsByPickleStepId = new ArrayMultimap() private readonly hooksById = new Map() - private readonly attachmentsByTestStepId = new ArrayMultimap() - private readonly stepMatchArgumentsListsByPickleStepId = new Map< string, readonly messages.StepMatchArgumentsList[] >() + private testRunStarted: TestRunStarted + private testRunFinished: TestRunFinished + private readonly testCaseStarted: Array = [] + private readonly lineageById: Map = new Map() + private readonly stepById: Map = new Map() + private readonly pickleById: Map = new Map() + private readonly pickleStepById: Map = new Map() + private readonly testCaseById: Map = new Map() + private readonly testStepById: Map = new Map() + private readonly testCaseFinishedByTestCaseStartedId: Map = new Map() + private readonly testStepFinishedByTestCaseStartedId: ArrayMultimap = + new ArrayMultimap() + public update(envelope: messages.Envelope) { + if (envelope.gherkinDocument) { + this.updateGherkinDocument(envelope.gherkinDocument) + } + if (envelope.pickle) { + this.updatePickle(envelope.pickle) + } + if (envelope.hook) { + this.hooksById.set(envelope.hook.id, envelope.hook) + } + if (envelope.testRunStarted) { + this.testRunStarted = envelope.testRunStarted + } if (envelope.testCase) { - this.testCaseByTestCaseId.set(envelope.testCase.id, envelope.testCase) - this.testCaseByPickleId.set(envelope.testCase.pickleId, envelope.testCase) - for (const testStep of envelope.testCase.testSteps) { - this.testStepById.set(testStep.id, testStep) - this.pickleIdByTestStepId.set(testStep.id, envelope.testCase.pickleId) - this.pickleStepIdByTestStepId.set(testStep.id, testStep.pickleStepId) - this.testStepIdsByPickleStepId.put(testStep.pickleStepId, testStep.id) - this.stepMatchArgumentsListsByPickleStepId.set( + this.updateTestCase(envelope.testCase) + } + if (envelope.testCaseStarted) { + this.updateTestCaseStarted(envelope.testCaseStarted) + } + if (envelope.attachment) { + this.attachmentsByTestStepId.put(envelope.attachment.testStepId, envelope.attachment) + } + if (envelope.testStepFinished) { + this.updateTestStepFinished(envelope.testStepFinished) + } + if (envelope.testCaseFinished) { + this.updateTestCaseFinished(envelope.testCaseFinished) + } + if (envelope.testRunFinished) { + this.testRunFinished = envelope.testRunFinished + } + } + + private updateGherkinDocument(gherkinDocument: GherkinDocument) { + if (gherkinDocument.feature) { + this.updateFeature(gherkinDocument.feature, { + gherkinDocument, + }) + } + } + + private updateFeature(feature: Feature, lineage: Lineage) { + feature.children.forEach((featureChild) => { + if (featureChild.background) { + this.updateSteps(featureChild.background.steps) + } + if (featureChild.scenario) { + this.updateScenario(featureChild.scenario, { + ...lineage, + feature, + }) + } + if (featureChild.rule) { + this.updateRule(featureChild.rule, { + ...lineage, + feature, + }) + } + }) + } + + private updateRule(rule: Rule, lineage: Lineage) { + rule.children.forEach((ruleChild) => { + if (ruleChild.background) { + this.updateSteps(ruleChild.background.steps) + } + if (ruleChild.scenario) { + this.updateScenario(ruleChild.scenario, { + ...lineage, + rule, + }) + } + }) + } + + private updateScenario(scenario: Scenario, lineage: Lineage) { + this.lineageById.set(scenario.id, { + ...lineage, + scenario, + }) + scenario.examples.forEach((examples, examplesIndex) => { + this.lineageById.set(examples.id, { + ...lineage, + scenario, + examples, + examplesIndex, + }) + examples.tableBody.forEach((example, exampleIndex) => { + this.lineageById.set(example.id, { + ...lineage, + scenario, + examples, + examplesIndex, + example, + exampleIndex, + }) + }) + }) + this.updateSteps(scenario.steps) + } + + private updateSteps(steps: ReadonlyArray) { + steps.forEach((step) => this.stepById.set(step.id, step)) + } + + private updatePickle(pickle: Pickle) { + this.pickleById.set(pickle.id, pickle) + pickle.steps.forEach((pickleStep) => this.pickleStepById.set(pickleStep.id, pickleStep)) + } + + private updateTestCase(testCase: TestCase) { + this.testCaseById.set(testCase.id, testCase) + + this.testCaseByPickleId.set(testCase.pickleId, testCase) + testCase.testSteps.forEach((testStep) => { + this.testStepById.set(testStep.id, testStep) + this.pickleIdByTestStepId.set(testStep.id, testCase.pickleId) + this.pickleStepIdByTestStepId.set(testStep.id, testStep.pickleStepId) + this.testStepIdsByPickleStepId.put(testStep.pickleStepId, testStep.id) + this.stepMatchArgumentsListsByPickleStepId.set( testStep.pickleStepId, testStep.stepMatchArgumentsLists - ) - } - } + ) + }) + } + + private updateTestCaseStarted(testCaseStarted: TestCaseStarted) { + this.testCaseStarted.push(testCaseStarted) /* when a test case attempt starts besides the first one, clear all existing results and attachments for that test case, so we always report on the latest attempt - TODO keep track of results and attachments from all attempts, expand API accordingly + (applies to legacy pickle-oriented query methods only) */ - if (envelope.testCaseStarted && envelope.testCaseStarted.attempt > 0) { - const testCase = this.testCaseByTestCaseId.get(envelope.testCaseStarted.testCaseId) - this.testStepResultByPickleId.delete(testCase.pickleId) - for (const testStep of testCase.testSteps) { - this.testStepResultsByPickleStepId.delete(testStep.pickleStepId) - this.testStepResultsbyTestStepId.delete(testStep.id) - this.attachmentsByTestStepId.delete(testStep.id) - } + const testCase = this.testCaseById.get(testCaseStarted.testCaseId) + this.testStepResultByPickleId.delete(testCase.pickleId) + for (const testStep of testCase.testSteps) { + this.testStepResultsByPickleStepId.delete(testStep.pickleStepId) + this.testStepResultsbyTestStepId.delete(testStep.id) + this.attachmentsByTestStepId.delete(testStep.id) } + } - if (envelope.testStepFinished) { - const pickleId = this.pickleIdByTestStepId.get(envelope.testStepFinished.testStepId) - this.testStepResultByPickleId.put(pickleId, envelope.testStepFinished.testStepResult) + private updateTestStepFinished(testStepFinished: TestStepFinished) { + this.testStepFinishedByTestCaseStartedId.put( + testStepFinished.testCaseStartedId, + testStepFinished + ) - const testStep = this.testStepById.get(envelope.testStepFinished.testStepId) - this.testStepResultsByPickleStepId.put( + const pickleId = this.pickleIdByTestStepId.get(testStepFinished.testStepId) + this.testStepResultByPickleId.put(pickleId, testStepFinished.testStepResult) + const testStep = this.testStepById.get(testStepFinished.testStepId) + this.testStepResultsByPickleStepId.put( testStep.pickleStepId, - envelope.testStepFinished.testStepResult - ) - this.testStepResultsbyTestStepId.put(testStep.id, envelope.testStepFinished.testStepResult) - } - - if (envelope.hook) { - this.hooksById.set(envelope.hook.id, envelope.hook) - } + testStepFinished.testStepResult + ) + this.testStepResultsbyTestStepId.put(testStep.id, testStepFinished.testStepResult) + } - if (envelope.attachment) { - this.attachmentsByTestStepId.put(envelope.attachment.testStepId, envelope.attachment) - } + private updateTestCaseFinished(testCaseFinished: TestCaseFinished) { + this.testCaseFinishedByTestCaseStartedId.set( + testCaseFinished.testCaseStartedId, + testCaseFinished + ) } /** @@ -212,4 +358,164 @@ export default class Query { } return result } + + /* new common interface with Java starts here */ + + public countMostSevereTestStepResultStatus(): Record { + const result: Record = { + [TestStepResultStatus.AMBIGUOUS]: 0, + [TestStepResultStatus.FAILED]: 0, + [TestStepResultStatus.PASSED]: 0, + [TestStepResultStatus.PENDING]: 0, + [TestStepResultStatus.SKIPPED]: 0, + [TestStepResultStatus.UNDEFINED]: 0, + [TestStepResultStatus.UNKNOWN]: 0, + } + for (const testCaseStarted of this.findAllTestCaseStarted()) { + const mostSevereResult = this.findTestStepFinishedAndTestStepBy(testCaseStarted) + .map(([testStepFinished]) => testStepFinished.testStepResult) + .sort(comparatorByStatus) + .at(-1) + if (mostSevereResult) { + result[mostSevereResult.status]++ + } + } + return result + } + + public countTestCasesStarted(): number { + return this.findAllTestCaseStarted().length + } + + public findAllPickles(): ReadonlyArray { + const pickles = [...this.pickleById.values()] + return pickles.sort(comparatorById) + } + + public findAllPickleSteps(): ReadonlyArray { + const pickleSteps = [...this.pickleStepById.values()] + return pickleSteps.sort(comparatorById) + } + + public findAllTestCaseStarted(): ReadonlyArray { + return this.testCaseStarted.filter((testCaseStarted) => { + const testCaseFinished = this.testCaseFinishedByTestCaseStartedId.get(testCaseStarted.id) + // only include if not yet finished OR won't be retried + return !testCaseFinished?.willBeRetried + }) + } + + public findAllTestCaseStartedGroupedByFeature(): Map> { + const results = new Map(); + this.findAllTestCaseStarted() + .map(testCaseStarted => ([this.findLineageBy(testCaseStarted), testCaseStarted] as const)) + .sort(([a], [b]) => comparatorBy(a.gherkinDocument, b.gherkinDocument, "uri")) + .forEach(([{feature}, testCaseStarted]) => { + results.set(feature, [...results.get(feature) ?? [], testCaseStarted]) + }) + return results + } + + public findAllTestSteps(): ReadonlyArray { + const testSteps = [...this.testStepById.values()] + return testSteps.sort(comparatorById) + } + + public findFeatureBy(testCaseStarted: TestCaseStarted): Feature | undefined { + return this.findLineageBy(testCaseStarted)?.feature + } + + public findMostSevereTestStepResultBy(testCaseStarted: TestCaseStarted): TestStepResult | undefined { + return this.findTestStepFinishedAndTestStepBy(testCaseStarted) + .map(([testStepFinished]) => testStepFinished.testStepResult) + .sort(comparatorByStatus) + .at(-1) + } + + public findNameOf(pickle: Pickle, namingStrategy: NamingStrategy): string { + const lineage = this.findLineageBy(pickle) + return lineage ? namingStrategy.reduce(lineage, pickle) : pickle.name + } + + public findPickleBy(testCaseStarted: TestCaseStarted): Pickle | undefined { + const testCase = this.findTestCaseBy(testCaseStarted) + assert.ok(testCase, 'Expected to find TestCase from TestCaseStarted') + return this.pickleById.get(testCase.pickleId) + } + + public findPickleStepBy(testStep: TestStep): PickleStep | undefined { + assert.ok(testStep.pickleStepId, 'Expected TestStep to have a pickleStepId') + return this.pickleStepById.get(testStep.pickleStepId) + } + + public findStepBy(pickleStep: PickleStep): Step | undefined { + const [astNodeId] = pickleStep.astNodeIds + assert.ok('Expected PickleStep to have an astNodeId') + return this.stepById.get(astNodeId) + } + + public findTestCaseBy(testCaseStarted: TestCaseStarted): TestCase | undefined { + return this.testCaseById.get(testCaseStarted.testCaseId) + } + + public findTestCaseDurationBy(testCaseStarted: TestCaseStarted): Duration | undefined { + const testCaseFinished = this.findTestCaseFinishedBy(testCaseStarted) + if (!testCaseFinished) { + return undefined + } + return TimeConversion.millisecondsToDuration( + TimeConversion.timestampToMillisecondsSinceEpoch(testCaseFinished.timestamp) - + TimeConversion.timestampToMillisecondsSinceEpoch(testCaseStarted.timestamp) + ) + } + + public findTestCaseFinishedBy(testCaseStarted: TestCaseStarted): TestCaseFinished | undefined { + return this.testCaseFinishedByTestCaseStartedId.get(testCaseStarted.id) + } + + public findTestRunDuration(): Duration | undefined { + if (!this.testRunStarted || !this.testRunFinished) { + return undefined + } + return TimeConversion.millisecondsToDuration( + TimeConversion.timestampToMillisecondsSinceEpoch(this.testRunFinished.timestamp) - + TimeConversion.timestampToMillisecondsSinceEpoch(this.testRunStarted.timestamp) + ) + } + + public findTestRunFinished(): TestRunFinished | undefined { + return this.testRunFinished + } + + public findTestRunStarted(): TestRunStarted | undefined { + return this.testRunStarted + } + + public findTestStepBy(testStepFinished: TestStepFinished): TestStep | undefined { + return this.testStepById.get(testStepFinished.testStepId) + } + + public findTestStepsFinishedBy(testCaseStarted: TestCaseStarted): ReadonlyArray { + // multimaps `get` implements `getOrDefault([])` behaviour internally + return [...this.testStepFinishedByTestCaseStartedId.get(testCaseStarted.id)] + } + + public findTestStepFinishedAndTestStepBy( + testCaseStarted: TestCaseStarted + ): ReadonlyArray<[TestStepFinished, TestStep]> { + return this.testStepFinishedByTestCaseStartedId + .get(testCaseStarted.id) + .map((testStepFinished) => { + const testStep = this.findTestStepBy(testStepFinished) + assert.ok(testStep, 'Expected to find TestStep by TestStepFinished') + return [testStepFinished, testStep] + }) + } + + private findLineageBy(element: Pickle | TestCaseStarted) { + const pickle = "testCaseId" in element ? this.findPickleBy(element) : element + const deepestAstNodeId = pickle.astNodeIds.at(-1) + assert.ok(deepestAstNodeId, 'Expected Pickle to have at least one astNodeId') + return this.lineageById.get(deepestAstNodeId) + } } diff --git a/javascript/src/acceptance.spec.ts b/javascript/src/acceptance.spec.ts new file mode 100644 index 00000000..c42f388a --- /dev/null +++ b/javascript/src/acceptance.spec.ts @@ -0,0 +1,164 @@ +import assert from 'node:assert' +import fs from 'node:fs' +import * as path from 'node:path' +import {pipeline, Writable} from 'node:stream' +import util from 'node:util' + +import {NdjsonToMessageStream} from '@cucumber/message-streams' +import {Duration, Envelope, TestRunFinished, TestRunStarted, TestStepResultStatus} from '@cucumber/messages' +import {glob} from 'glob' + +import Query from './Query' +import { + namingStrategy, + NamingStrategyExampleName, + NamingStrategyFeatureName, + NamingStrategyLength +} from './Lineage' + +const asyncPipeline = util.promisify(pipeline) +const TESTDATA_PATH = path.join(__dirname, '..', '..', 'testdata') + +describe('Acceptance Tests', async () => { + const fixtureFiles = glob.sync(`*.query-results.json`, { + cwd: TESTDATA_PATH, + absolute: true + }) + + for (const fixtureFile of fixtureFiles) { + const [suiteName] = path.basename(fixtureFile).split('.') + const ndjsonFile = fixtureFile.replace('.query-results.json', '.ndjson') + + it(suiteName, async () => { + const query = new Query() + + await asyncPipeline( + fs.createReadStream(ndjsonFile, { encoding: 'utf-8' }), + new NdjsonToMessageStream(), + new Writable({ + objectMode: true, + write(envelope: Envelope, _: BufferEncoding, callback) { + query.update(envelope) + callback() + }, + }) + ) + + const expectedResults: ResultsFixture = { + ...defaults, + ...JSON.parse(fs.readFileSync(fixtureFile, { + encoding: 'utf-8', + })) + } + + const actualResults: ResultsFixture = JSON.parse(JSON.stringify({ + countMostSevereTestStepResultStatus: query.countMostSevereTestStepResultStatus(), + countTestCasesStarted: query.countTestCasesStarted(), + findAllPickles: query.findAllPickles().length, + findAllPickleSteps: query.findAllPickleSteps().length, + findAllTestCaseStarted: query.findAllTestCaseStarted().length, + findAllTestSteps: query.findAllTestSteps().length, + findAllTestCaseStartedGroupedByFeature: [...query.findAllTestCaseStartedGroupedByFeature().entries()] + .map(([feature, testCaseStarteds]) => [feature.name, testCaseStarteds.map(testCaseStarted => testCaseStarted.id)]), + findFeatureBy: query.findAllTestCaseStarted() + .map(testCaseStarted => query.findFeatureBy(testCaseStarted)) + .map(feature => feature?.name), + findMostSevereTestStepResultBy: query.findAllTestCaseStarted() + .map(testCaseStarted => query.findMostSevereTestStepResultBy(testCaseStarted)) + .map(testStepResult => testStepResult?.status), + findNameOf: { + long : query.findAllPickles().map(pickle => query.findNameOf(pickle, namingStrategy(NamingStrategyLength.LONG))), + excludeFeatureName : query.findAllPickles().map(pickle => query.findNameOf(pickle, namingStrategy(NamingStrategyLength.LONG, NamingStrategyFeatureName.EXCLUDE))), + longPickleName : query.findAllPickles().map(pickle => query.findNameOf(pickle, namingStrategy(NamingStrategyLength.LONG, NamingStrategyFeatureName.INCLUDE, NamingStrategyExampleName.PICKLE))), + short : query.findAllPickles().map(pickle => query.findNameOf(pickle, namingStrategy(NamingStrategyLength.SHORT))), + shortPickleName : query.findAllPickles().map(pickle => query.findNameOf(pickle, namingStrategy(NamingStrategyLength.SHORT, NamingStrategyFeatureName.INCLUDE, NamingStrategyExampleName.PICKLE))) + }, + findPickleBy: query.findAllTestCaseStarted() + .map(testCaseStarted => query.findPickleBy(testCaseStarted)) + .map(pickle => pickle?.name), + findPickleStepBy: query.findAllTestSteps() + .map(testStep => query.findPickleStepBy(testStep)) + .map(pickleStep => pickleStep?.text), + findStepBy: query.findAllPickleSteps() + .map(pickleStep => query.findStepBy(pickleStep)) + .map(step => step?.text), + findTestCaseBy: query.findAllTestCaseStarted() + .map(testCaseStarted => query.findTestCaseBy(testCaseStarted)) + .map(testCase => testCase?.id), + findTestCaseDurationBy: query.findAllTestCaseStarted() + .map(testCaseStarted => query.findTestCaseDurationBy(testCaseStarted)), + findTestCaseFinishedBy: query.findAllTestCaseStarted() + .map(testCaseStarted => query.findTestCaseFinishedBy(testCaseStarted)) + .map(testCaseFinished => testCaseFinished?.testCaseStartedId), + findTestRunDuration: query.findTestRunDuration(), + findTestRunFinished: query.findTestRunFinished(), + findTestRunStarted: query.findTestRunStarted(), + findTestStepBy: query.findAllTestCaseStarted() + .flatMap(testCaseStarted => query.findTestStepsFinishedBy(testCaseStarted)) + .map(testStepFinished => query.findTestStepBy(testStepFinished)) + .map(testStep => testStep?.id), + findTestStepsFinishedBy: query.findAllTestCaseStarted() + .map(testCaseStarted => query.findTestStepsFinishedBy(testCaseStarted)) + .map(testStepFinisheds => testStepFinisheds.map(testStepFinished => testStepFinished?.testStepId)), + findTestStepFinishedAndTestStepBy: query.findAllTestCaseStarted() + .flatMap(testCaseStarted => query.findTestStepFinishedAndTestStepBy(testCaseStarted)) + .map(([testStepFinished, testStep]) => ([testStepFinished.testStepId, testStep.id])) + })) + + assert.deepStrictEqual(actualResults, expectedResults) + }) + } +}) + +interface ResultsFixture { + countMostSevereTestStepResultStatus: Record, + countTestCasesStarted: number, + findAllPickles: number, + findAllPickleSteps: number, + findAllTestCaseStarted: number, + findAllTestSteps: number, + findAllTestCaseStartedGroupedByFeature: Array<[string, string[]]>, + findFeatureBy: Array, + findMostSevereTestStepResultBy: Array, + findNameOf: { + long: Array, + excludeFeatureName: Array, + longPickleName: Array, + short: Array, + shortPickleName: Array + }, + findPickleBy: Array, + findPickleStepBy: Array, + findStepBy: Array, + findTestCaseBy: Array, + findTestCaseDurationBy: Array, + findTestCaseFinishedBy: Array, + findTestRunDuration: Duration, + findTestRunFinished: TestRunFinished, + findTestRunStarted: TestRunStarted, + findTestStepBy: Array, + findTestStepsFinishedBy: Array> + findTestStepFinishedAndTestStepBy: Array<[string, string]> +} + +const defaults: Partial = { + findAllTestCaseStartedGroupedByFeature: [], + findFeatureBy: [], + findMostSevereTestStepResultBy: [], + findNameOf: { + long: [], + excludeFeatureName: [], + longPickleName: [], + short: [], + shortPickleName: [] + }, + findPickleBy: [], + findPickleStepBy: [], + findStepBy: [], + findTestCaseBy: [], + findTestCaseDurationBy: [], + findTestCaseFinishedBy: [], + findTestStepBy: [], + findTestStepsFinishedBy: [], + findTestStepFinishedAndTestStepBy: [] +} \ No newline at end of file diff --git a/javascript/src/helpers.spec.ts b/javascript/src/helpers.spec.ts new file mode 100644 index 00000000..97430323 --- /dev/null +++ b/javascript/src/helpers.spec.ts @@ -0,0 +1,15 @@ +import assert from 'node:assert' +import { comparatorByStatus } from './helpers' +import { TestStepResult, TestStepResultStatus } from '@cucumber/messages' + +describe('comparatorByStatus', () => { + function resultWithStatus(status: TestStepResultStatus) { + return { status } as TestStepResult + } + + it('puts the more severe status after the less severe', () => { + assert.strictEqual(comparatorByStatus(resultWithStatus(TestStepResultStatus.PASSED), resultWithStatus(TestStepResultStatus.FAILED)), -1) + assert.strictEqual(comparatorByStatus(resultWithStatus(TestStepResultStatus.FAILED), resultWithStatus(TestStepResultStatus.PASSED)), 1) + assert.strictEqual(comparatorByStatus(resultWithStatus(TestStepResultStatus.FAILED), resultWithStatus(TestStepResultStatus.FAILED)), 0) + }) +}) \ No newline at end of file diff --git a/javascript/src/helpers.ts b/javascript/src/helpers.ts new file mode 100644 index 00000000..948fb703 --- /dev/null +++ b/javascript/src/helpers.ts @@ -0,0 +1,41 @@ +import { TestStepResult, TestStepResultStatus } from '@cucumber/messages' + +interface WithId { + id: string | number +} + +export function comparatorById(a: WithId, b: WithId) { + return comparatorBy(a, b, "id") +} + +export function comparatorBy(a: any, b: any, key: string) { + if ( a[key] < b[key] ){ + return -1; + } + if ( a[key] > b[key] ){ + return 1; + } + return 0; +} + +export function comparatorByStatus(a: TestStepResult, b: TestStepResult) { + if (ordinal(a.status) < ordinal(b.status)) { + return -1; + } + if (ordinal(a.status) > ordinal(b.status) ){ + return 1; + } + return 0; +} + +function ordinal(status: TestStepResultStatus) { + return [ + TestStepResultStatus.UNKNOWN, + TestStepResultStatus.PASSED, + TestStepResultStatus.SKIPPED, + TestStepResultStatus.PENDING, + TestStepResultStatus.UNDEFINED, + TestStepResultStatus.AMBIGUOUS, + TestStepResultStatus.FAILED, + ].indexOf(status) +} \ No newline at end of file diff --git a/javascript/tsconfig.build.json b/javascript/tsconfig.build.json index 62f91b3e..bedb1374 100644 --- a/javascript/tsconfig.build.json +++ b/javascript/tsconfig.build.json @@ -11,5 +11,10 @@ "target": "es6", "module": "commonjs" }, - "include": ["src", "test", "package.json"] + "include": [ + "src" + ], + "exclude": [ + "src/**/*.spec.*" + ] } diff --git a/testdata/empty.feature.query-results.json b/testdata/empty.feature.query-results.json index af395f06..999a7a1c 100644 --- a/testdata/empty.feature.query-results.json +++ b/testdata/empty.feature.query-results.json @@ -1,4 +1,13 @@ { + "countMostSevereTestStepResultStatus" : { + "UNKNOWN" : 0, + "PASSED" : 0, + "SKIPPED" : 0, + "PENDING" : 0, + "UNDEFINED" : 0, + "AMBIGUOUS" : 0, + "FAILED" : 0 + }, "countTestCasesStarted" : 0, "findAllPickles" : 0, "findAllPickleSteps" : 0, diff --git a/testdata/examples-tables.feature.query-results.json b/testdata/examples-tables.feature.query-results.json index 5e6689dc..a7ed16a0 100644 --- a/testdata/examples-tables.feature.query-results.json +++ b/testdata/examples-tables.feature.query-results.json @@ -1,8 +1,12 @@ { "countMostSevereTestStepResultStatus" : { + "UNKNOWN" : 0, "PASSED" : 5, - "FAILED" : 2, - "UNDEFINED" : 2 + "SKIPPED" : 0, + "PENDING" : 0, + "UNDEFINED" : 2, + "AMBIGUOUS" : 0, + "FAILED" : 2 }, "countTestCasesStarted" : 9, "findAllPickles" : 9, @@ -36,7 +40,7 @@ "Examples Tables", "Examples Tables" ], - "findMostSevereTestStepResulBy" : [ + "findMostSevereTestStepResultBy" : [ "PASSED", "PASSED", "FAILED", diff --git a/testdata/minimal.feature.query-results.json b/testdata/minimal.feature.query-results.json index e50eaca8..6bf98eff 100644 --- a/testdata/minimal.feature.query-results.json +++ b/testdata/minimal.feature.query-results.json @@ -1,6 +1,12 @@ { "countMostSevereTestStepResultStatus" : { - "PASSED" : 1 + "UNKNOWN" : 0, + "PASSED" : 1, + "SKIPPED" : 0, + "PENDING" : 0, + "UNDEFINED" : 0, + "AMBIGUOUS" : 0, + "FAILED" : 0 }, "countTestCasesStarted" : 1, "findAllPickles" : 1, @@ -18,7 +24,7 @@ "findFeatureBy" : [ "minimal" ], - "findMostSevereTestStepResulBy" : [ + "findMostSevereTestStepResultBy" : [ "PASSED" ], "findNameOf" : { diff --git a/testdata/rules.feature.query-results.json b/testdata/rules.feature.query-results.json index 6de5353c..dd05d44c 100644 --- a/testdata/rules.feature.query-results.json +++ b/testdata/rules.feature.query-results.json @@ -1,6 +1,12 @@ { "countMostSevereTestStepResultStatus" : { - "PASSED" : 3 + "UNKNOWN" : 0, + "PASSED" : 3, + "SKIPPED" : 0, + "PENDING" : 0, + "UNDEFINED" : 0, + "AMBIGUOUS" : 0, + "FAILED" : 0 }, "countTestCasesStarted" : 3, "findAllPickles" : 3, @@ -22,7 +28,7 @@ "Usage of a `Rule`", "Usage of a `Rule`" ], - "findMostSevereTestStepResulBy" : [ + "findMostSevereTestStepResultBy" : [ "PASSED", "PASSED", "PASSED"