diff --git a/.github/workflows/example-gherkin-to-asciidoc-indexing-build.yml b/.github/workflows/example-gherkin-to-asciidoc-indexing-build.yml new file mode 100644 index 0000000..c1116a9 --- /dev/null +++ b/.github/workflows/example-gherkin-to-asciidoc-indexing-build.yml @@ -0,0 +1,36 @@ +name: Example - Gherkin to AsciiDoc Indexing Build +on: + push: + paths: + - 'examples/gherkin-to-asciidoc/indexing/**/*.feature' + - 'examples/gherkin-to-asciidoc/indexing/**/*.gradle' + - 'examples/gherkin-to-asciidoc/indexing/**/*.properties' + - 'examples/gherkin-to-asciidoc/indexing/**/libs.versions.toml' + - '.github/workflows/example-gherkin-to-asciidoc-indexing-build.yml' + +jobs: + Build-Example: + name: Build Example + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 + with: + fetch-depth: 1 + persist-credentials: false + + - name: Setup Java + uses: actions/setup-java@ad2b38190b15e4d6bdf0c97fb4fca8412226d287 # v5.3.0 + with: + distribution: 'temurin' + java-version: 21 + + - name: Setup Gradle + uses: gradle/actions/setup-gradle@3f131e8634966bd73d06cc69884922b02e6faf92 # v6.2.0 + + - name: Build example + run: | + cd examples/gherkin-to-asciidoc/indexing + chmod +x ./gradlew + ./gradlew generateFeatureDocs --no-daemon diff --git a/examples/gherkin-to-asciidoc/indexing/README.adoc b/examples/gherkin-to-asciidoc/indexing/README.adoc new file mode 100644 index 0000000..38290e0 --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/README.adoc @@ -0,0 +1,239 @@ += Gherkin to AsciiDoc — Indexing Example +:toc: left + +== Description + +This example applies the Gherkin to AsciiDoc plugin to a Gradle multi-project build made up of a root +project and four sub-projects - `off`, `feature`, `scenario`, and `all` - one per value of the `indexing` +DSL property. Every sub-project starts out with byte-for-byte identical copies of the same two +`.feature` files; the *only* difference between them is the `indexing` value each one configures. + +== Intent + +This example shows: + +* What each of the four `indexing` values actually does to the source `.feature` files: + `off` (nothing), `feature` (numbers `Feature` titles only), `scenario` (numbers `Scenario`/ + `Scenario Outline` titles only, continuously across every feature file), and `all` (numbers both, + scenarios as `.`). +* That indexing numbers features/scenarios alphabetically by feature file name - + `authentication.feature` is processed before `invoice.feature` - not in whatever order the + filesystem happens to list them. +* That indexing rewrites the source `.feature` files in place, and that this is reflected + automatically in the generated report, since the report is generated *from* the (now numbered) + source files. +* That running the build a second time is a no-op: indexing strips any numbering left over from a + previous run before reapplying it, so already-correctly-numbered files are left untouched. + +== Project Layout + +[source] +---- +indexing/ +├── build.gradle (root: applies the plugin everywhere, configures shared defaults) +├── off/ +│ ├── build.gradle (no override: indexing defaults to IndexingMode.OFF) +│ └── src/test/resources/ +│ ├── features-auth/authentication.feature +│ └── features-billing/invoice.feature +├── feature/ +│ ├── build.gradle (indexing = IndexingMode.FEATURE) +│ └── src/test/resources/... (same two files, byte-for-byte identical to off/) +├── scenario/ +│ ├── build.gradle (indexing = IndexingMode.SCENARIO) +│ └── src/test/resources/... (same two files, byte-for-byte identical to off/) +└── all/ + ├── build.gradle (indexing = IndexingMode.ALL) + └── src/test/resources/... (same two files, byte-for-byte identical to off/) +---- + +== Configuration + +.Root `build.gradle` +[source,groovy] +---- +plugins { + id 'com.arc-e-tect.gherkin-to-asciidoc' +} + +gherkinToAsciidoc { + systemUnderTestVersion = 'v1.0.0' + sourceDirs.from( + 'src/test/resources/features-auth', + 'src/test/resources/features-billing') +} + +subprojects { + apply plugin: 'com.arc-e-tect.gherkin-to-asciidoc' +} +---- + +.`off/build.gradle` +[source,groovy] +---- +// No gherkinToAsciidoc { } block: indexing defaults to IndexingMode.OFF. +---- + +.`feature/build.gradle` +[source,groovy] +---- +import com.arc_e_tect.gradle.gherkin.indexing.IndexingMode + +gherkinToAsciidoc { + indexing = IndexingMode.FEATURE +} +---- + +.`scenario/build.gradle` +[source,groovy] +---- +import com.arc_e_tect.gradle.gherkin.indexing.IndexingMode + +gherkinToAsciidoc { + indexing = IndexingMode.SCENARIO +} +---- + +.`all/build.gradle` +[source,groovy] +---- +import com.arc_e_tect.gradle.gherkin.indexing.IndexingMode + +gherkinToAsciidoc { + indexing = IndexingMode.ALL +} +---- + +`feature` and `all` both require `groupByFeature = true`, which - like `includeSubDirs = true` - is +already the plugin's default, so neither sub-project needs to configure it explicitly. + +== Build And Run + +[source,bash] +---- +cd examples/gherkin-to-asciidoc/indexing +./gradlew generateFeatureDocs +---- + +Running `generateFeatureDocs` from the root project without a project path runs it in *every* project +that has it - root, `off`, `feature`, `scenario`, and `all` - in one command. + +[IMPORTANT] +==== +This rewrites the `.feature` files under `off/`, `feature/`, `scenario/`, and `all/` *in place* - that +is the whole point of the `indexing` property. Running it again afterwards is a no-op (the files are +already correctly numbered for their sub-project's mode), but the working tree will show the four +sub-projects' `.feature` files as modified the first time you run it. Run `git diff` afterwards to see +exactly what each mode changed - or `git checkout -- off feature scenario all` to put the four pristine, +identically-worded copies back if you want to try it again from a clean baseline. +==== + +== What To Expect + +Before the build runs, `off/`, `feature/`, `scenario/`, and `all/` all contain the exact same +`authentication.feature` (three scenarios: a title-only scenario, a fully-worded scenario, and a +`Scenario Outline`) and `invoice.feature` (one scenario) - reproduced here from `off/`, which stays +this way after the build since its `indexing` is `off`: + +.`off/src/test/resources/features-auth/authentication.feature` (unchanged by any mode) +[source,gherkin] +---- +Feature: User authentication + + Scenario: User requests a password reset + # Not yet fleshed out - title only, no steps yet. + + Scenario: User logs in successfully + Given the login page is open + When the user submits valid credentials + Then the dashboard is displayed + + Scenario Outline: User logs in with different credential sets + Given the login page is open + When the user submits "" and "" + Then the result is "" + + Examples: + | username | password | outcome | + | alice | secret | success | + | bob | wrong | failure | +---- + +.`off/src/test/resources/features-billing/invoice.feature` (unchanged by any mode) +[source,gherkin] +---- +Feature: Invoice payment + + Scenario: User pays an invoice + Given an outstanding invoice + When the user pays the invoice + Then the invoice is marked as paid +---- + +=== Feature — numbers Feature titles only + +After the build runs, `feature/src/test/resources/features-auth/authentication.feature` starts with +`Feature: 1 - User authentication` and `feature/.../invoice.feature` starts with +`Feature: 2 - Invoice payment` - every `Scenario`/`Scenario Outline` title is untouched. The generated +report at `feature/build/generated-docs/features.adoc` shows the numbering in its feature headings: + +[source,asciidoc] +---- +== 1 - User authentication + +* Scenario: User requests a password reset +* Scenario: User logs in successfully +* Scenario Outline: User logs in with different credential sets + +== 2 - Invoice payment + +* Scenario: User pays an invoice +---- + +=== Scenario — numbers Scenario/Scenario Outline titles only, continuously + +After the build runs, every `Scenario`/`Scenario Outline` title in +`scenario/src/test/resources/features-auth/authentication.feature` is numbered 1 through 3, and the +one in `scenario/.../invoice.feature` continues the same count as 4 - `Feature` titles are untouched. +`scenario/build/generated-docs/features.adoc` reflects it: + +[source,asciidoc] +---- +== User authentication + +* Scenario: 1 - User requests a password reset +* Scenario: 2 - User logs in successfully +* Scenario Outline: 3 - User logs in with different credential sets + +== Invoice payment + +* Scenario: 4 - User pays an invoice +---- + +=== All — numbers both, scenarios per feature + +After the build runs, `all/src/test/resources/features-auth/authentication.feature` gets both: +`Feature: 1 - User authentication`, with its three scenarios numbered `1.1`, `1.2`, `1.3` - restarting +the scenario count for each feature, unlike `scenario` mode's continuous count. +`all/.../invoice.feature` gets `Feature: 2 - Invoice payment` with its one scenario numbered `2.1`. +`all/build/generated-docs/features.adoc` reflects both: + +[source,asciidoc] +---- +== 1 - User authentication + +* Scenario: 1.1 - User requests a password reset +* Scenario: 1.2 - User logs in successfully +* Scenario Outline: 1.3 - User logs in with different credential sets + +== 2 - Invoice payment + +* Scenario: 2.1 - User pays an invoice +---- + +[NOTE] +==== +This example is pinned to `gherkin-to-asciidoc = "2.0.0"` in `gradle/libs.versions.toml` - the version +`indexing` (and the breaking `includeSubDirs`/`groupByFeature` default changes it ships alongside) was +released as, resolved from the Gradle Plugin Portal like any other example in this repository. +==== diff --git a/examples/gherkin-to-asciidoc/indexing/all/build.gradle b/examples/gherkin-to-asciidoc/indexing/all/build.gradle new file mode 100644 index 0000000..8a83f3b --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/all/build.gradle @@ -0,0 +1,11 @@ +import com.arc_e_tect.gradle.gherkin.indexing.IndexingMode + +// The plugin is already applied to this project by the root project's `subprojects { }` block. +// This sub-project overrides indexing = IndexingMode.ALL: Feature titles are numbered exactly as +// in the feature sub-project, and Scenario/Scenario Outline titles are numbered per feature as +// . (1.1, 1.2, 1.3 in authentication.feature, then 2.1 in +// invoice.feature) instead of continuously like the scenario sub-project. ALL requires +// groupByFeature = true, which is already the plugin's default. +gherkinToAsciidoc { + indexing = IndexingMode.ALL +} diff --git a/examples/gherkin-to-asciidoc/indexing/all/src/test/resources/features-auth/authentication.feature b/examples/gherkin-to-asciidoc/indexing/all/src/test/resources/features-auth/authentication.feature new file mode 100644 index 0000000..ba1de52 --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/all/src/test/resources/features-auth/authentication.feature @@ -0,0 +1,19 @@ +Feature: 1 - User authentication + + Scenario: 1.1 - User requests a password reset + # Not yet fleshed out - title only, no steps yet. + + Scenario: 1.2 - User logs in successfully + Given the login page is open + When the user submits valid credentials + Then the dashboard is displayed + + Scenario Outline: 1.3 - User logs in with different credential sets + Given the login page is open + When the user submits "" and "" + Then the result is "" + + Examples: + | username | password | outcome | + | alice | secret | success | + | bob | wrong | failure | diff --git a/examples/gherkin-to-asciidoc/indexing/all/src/test/resources/features-billing/invoice.feature b/examples/gherkin-to-asciidoc/indexing/all/src/test/resources/features-billing/invoice.feature new file mode 100644 index 0000000..7716ca1 --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/all/src/test/resources/features-billing/invoice.feature @@ -0,0 +1,6 @@ +Feature: 2 - Invoice payment + + Scenario: 2.1 - User pays an invoice + Given an outstanding invoice + When the user pays the invoice + Then the invoice is marked as paid diff --git a/examples/gherkin-to-asciidoc/indexing/build.gradle b/examples/gherkin-to-asciidoc/indexing/build.gradle new file mode 100644 index 0000000..0bfbe2f --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/build.gradle @@ -0,0 +1,26 @@ +plugins { + alias(libs.plugins.gherkin.to.asciidoc) +} + +// Configuration here applies to every project below (root and all four sub-projects) unless a +// sub-project's own build.gradle overrides a given property for itself. Every sub-project below +// overrides only the one property this example is about: indexing. +gherkinToAsciidoc { + systemUnderTestVersion = 'v1.0.0' + + // None of the sub-projects configure sourceDirs themselves, so each one resolves these same + // relative paths against its own directory, e.g. off/src/test/resources/features-auth and + // off/src/test/resources/features-billing. Every sub-project's features-auth/authentication.feature + // and features-billing/invoice.feature start out byte-for-byte identical - only the indexing + // property differs, so the four generated reports (and the numbering baked into the four copies + // of the source files) are directly comparable. + sourceDirs.from( + 'src/test/resources/features-auth', + 'src/test/resources/features-billing') +} + +// Applies the plugin to off/feature/scenario/all too, reusing the version already resolved above. +// Each sub-project gets its own generateFeatureDocs task and its own generated report. +subprojects { + apply plugin: 'com.arc-e-tect.gherkin-to-asciidoc' +} diff --git a/examples/gherkin-to-asciidoc/indexing/feature/build.gradle b/examples/gherkin-to-asciidoc/indexing/feature/build.gradle new file mode 100644 index 0000000..29548d0 --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/feature/build.gradle @@ -0,0 +1,10 @@ +import com.arc_e_tect.gradle.gherkin.indexing.IndexingMode + +// The plugin is already applied to this project by the root project's `subprojects { }` block. +// This sub-project overrides indexing = IndexingMode.FEATURE: every Feature title in its (own +// copy of the) source .feature files is numbered, alphabetically by feature file name - +// authentication.feature before invoice.feature - while Scenario titles are left untouched. +// FEATURE requires groupByFeature = true, which is already the plugin's default. +gherkinToAsciidoc { + indexing = IndexingMode.FEATURE +} diff --git a/examples/gherkin-to-asciidoc/indexing/feature/src/test/resources/features-auth/authentication.feature b/examples/gherkin-to-asciidoc/indexing/feature/src/test/resources/features-auth/authentication.feature new file mode 100644 index 0000000..4ffa363 --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/feature/src/test/resources/features-auth/authentication.feature @@ -0,0 +1,19 @@ +Feature: 1 - User authentication + + Scenario: User requests a password reset + # Not yet fleshed out - title only, no steps yet. + + Scenario: User logs in successfully + Given the login page is open + When the user submits valid credentials + Then the dashboard is displayed + + Scenario Outline: User logs in with different credential sets + Given the login page is open + When the user submits "" and "" + Then the result is "" + + Examples: + | username | password | outcome | + | alice | secret | success | + | bob | wrong | failure | diff --git a/examples/gherkin-to-asciidoc/indexing/feature/src/test/resources/features-billing/invoice.feature b/examples/gherkin-to-asciidoc/indexing/feature/src/test/resources/features-billing/invoice.feature new file mode 100644 index 0000000..1042c02 --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/feature/src/test/resources/features-billing/invoice.feature @@ -0,0 +1,6 @@ +Feature: 2 - Invoice payment + + Scenario: User pays an invoice + Given an outstanding invoice + When the user pays the invoice + Then the invoice is marked as paid diff --git a/examples/gherkin-to-asciidoc/indexing/gradle.properties b/examples/gherkin-to-asciidoc/indexing/gradle.properties new file mode 100644 index 0000000..4183829 --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/gradle.properties @@ -0,0 +1,8 @@ +org.gradle.daemon=true +org.gradle.parallel=true +org.gradle.caching=true +org.gradle.configuration-cache=true +org.gradle.jvmargs=-Xmx8192m -Dfile.encoding=UTF-8 + +group=com.arc-e-tect +version = 0.0.1 diff --git a/examples/gherkin-to-asciidoc/indexing/gradle/libs.versions.toml b/examples/gherkin-to-asciidoc/indexing/gradle/libs.versions.toml new file mode 100644 index 0000000..e7d92f4 --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/gradle/libs.versions.toml @@ -0,0 +1,9 @@ +## Generated by $ ./gradlew refreshVersionsCatalog + +[plugins] + +gherkin-to-asciidoc = { id = "com.arc-e-tect.gherkin-to-asciidoc", version.ref = "gherkin-to-asciidoc" } + +[versions] + +gherkin-to-asciidoc = "2.0.0" diff --git a/examples/gherkin-to-asciidoc/indexing/gradle/wrapper/gradle-wrapper.jar b/examples/gherkin-to-asciidoc/indexing/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..b1b8ef5 Binary files /dev/null and b/examples/gherkin-to-asciidoc/indexing/gradle/wrapper/gradle-wrapper.jar differ diff --git a/examples/gherkin-to-asciidoc/indexing/gradle/wrapper/gradle-wrapper.properties b/examples/gherkin-to-asciidoc/indexing/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..a9db115 --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,9 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-9.6.1-bin.zip +networkTimeout=10000 +retries=0 +retryBackOffMs=500 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/examples/gherkin-to-asciidoc/indexing/gradlew b/examples/gherkin-to-asciidoc/indexing/gradlew new file mode 100755 index 0000000..249efbb --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# gradlew start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh gradlew +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/3d91ce3b8caaf77ad09f381f43615b715b53f72c/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/examples/gherkin-to-asciidoc/indexing/gradlew.bat b/examples/gherkin-to-asciidoc/indexing/gradlew.bat new file mode 100644 index 0000000..a51ec4f --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/gradlew.bat @@ -0,0 +1,82 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem gradlew startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables, and ensure extensions are enabled +setlocal EnableExtensions + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +"%COMSPEC%" /c exit 1 + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +"%COMSPEC%" /c exit 1 + +:execute +@rem Setup the command line + + + +@rem Execute gradlew +@rem endlocal doesn't take effect until after the line is parsed and variables are expanded +@rem which allows us to clear the local environment before executing the java command +endlocal & "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* & call :exitWithErrorLevel + +:exitWithErrorLevel +@rem Use "%COMSPEC%" /c exit to allow operators to work properly in scripts +"%COMSPEC%" /c exit %ERRORLEVEL% diff --git a/examples/gherkin-to-asciidoc/indexing/off/build.gradle b/examples/gherkin-to-asciidoc/indexing/off/build.gradle new file mode 100644 index 0000000..2b68984 --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/off/build.gradle @@ -0,0 +1,4 @@ +// The plugin is already applied to this project by the root project's `subprojects { }` block. +// No gherkinToAsciidoc { } block needed here: indexing defaults to IndexingMode.OFF, so this +// sub-project's Feature/Scenario titles are left exactly as written - the baseline the other +// three sub-projects (feature, scenario, all) are compared against. diff --git a/examples/gherkin-to-asciidoc/indexing/off/src/test/resources/features-auth/authentication.feature b/examples/gherkin-to-asciidoc/indexing/off/src/test/resources/features-auth/authentication.feature new file mode 100644 index 0000000..c25f9e8 --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/off/src/test/resources/features-auth/authentication.feature @@ -0,0 +1,19 @@ +Feature: User authentication + + Scenario: User requests a password reset + # Not yet fleshed out - title only, no steps yet. + + Scenario: User logs in successfully + Given the login page is open + When the user submits valid credentials + Then the dashboard is displayed + + Scenario Outline: User logs in with different credential sets + Given the login page is open + When the user submits "" and "" + Then the result is "" + + Examples: + | username | password | outcome | + | alice | secret | success | + | bob | wrong | failure | diff --git a/examples/gherkin-to-asciidoc/indexing/off/src/test/resources/features-billing/invoice.feature b/examples/gherkin-to-asciidoc/indexing/off/src/test/resources/features-billing/invoice.feature new file mode 100644 index 0000000..b62bf83 --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/off/src/test/resources/features-billing/invoice.feature @@ -0,0 +1,6 @@ +Feature: Invoice payment + + Scenario: User pays an invoice + Given an outstanding invoice + When the user pays the invoice + Then the invoice is marked as paid diff --git a/examples/gherkin-to-asciidoc/indexing/scenario/build.gradle b/examples/gherkin-to-asciidoc/indexing/scenario/build.gradle new file mode 100644 index 0000000..8bcbc33 --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/scenario/build.gradle @@ -0,0 +1,10 @@ +import com.arc_e_tect.gradle.gherkin.indexing.IndexingMode + +// The plugin is already applied to this project by the root project's `subprojects { }` block. +// This sub-project overrides indexing = IndexingMode.SCENARIO: every Scenario/Scenario Outline +// title in its (own copy of the) source .feature files is numbered continuously across both +// feature files, in the same alphabetical file order as FEATURE mode - while Feature titles are +// left untouched. Unlike FEATURE/ALL, SCENARIO does not require groupByFeature = true. +gherkinToAsciidoc { + indexing = IndexingMode.SCENARIO +} diff --git a/examples/gherkin-to-asciidoc/indexing/scenario/src/test/resources/features-auth/authentication.feature b/examples/gherkin-to-asciidoc/indexing/scenario/src/test/resources/features-auth/authentication.feature new file mode 100644 index 0000000..c8afd84 --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/scenario/src/test/resources/features-auth/authentication.feature @@ -0,0 +1,19 @@ +Feature: User authentication + + Scenario: 1 - User requests a password reset + # Not yet fleshed out - title only, no steps yet. + + Scenario: 2 - User logs in successfully + Given the login page is open + When the user submits valid credentials + Then the dashboard is displayed + + Scenario Outline: 3 - User logs in with different credential sets + Given the login page is open + When the user submits "" and "" + Then the result is "" + + Examples: + | username | password | outcome | + | alice | secret | success | + | bob | wrong | failure | diff --git a/examples/gherkin-to-asciidoc/indexing/scenario/src/test/resources/features-billing/invoice.feature b/examples/gherkin-to-asciidoc/indexing/scenario/src/test/resources/features-billing/invoice.feature new file mode 100644 index 0000000..a91987d --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/scenario/src/test/resources/features-billing/invoice.feature @@ -0,0 +1,6 @@ +Feature: Invoice payment + + Scenario: 4 - User pays an invoice + Given an outstanding invoice + When the user pays the invoice + Then the invoice is marked as paid diff --git a/examples/gherkin-to-asciidoc/indexing/settings.gradle b/examples/gherkin-to-asciidoc/indexing/settings.gradle new file mode 100644 index 0000000..153e349 --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/settings.gradle @@ -0,0 +1,20 @@ +pluginManagement { + repositories { + gradlePluginPortal() + } +} + +plugins { + id 'org.gradle.toolchains.foojay-resolver-convention' version '1.0.0' + id 'de.fayard.refreshVersions' version '0.60.6' +} + +refreshVersions { + rejectVersionIf { + candidate.stabilityLevel.isLessStableThan(current.stabilityLevel) + } +} + +rootProject.name = 'gherkin-to-asciidoc-indexing-example' + +include 'off', 'feature', 'scenario', 'all' diff --git a/examples/gherkin-to-asciidoc/indexing/versions.properties b/examples/gherkin-to-asciidoc/indexing/versions.properties new file mode 100644 index 0000000..a07c552 --- /dev/null +++ b/examples/gherkin-to-asciidoc/indexing/versions.properties @@ -0,0 +1,10 @@ +#### Dependencies and Plugin versions with their available updates. +#### Generated by `./gradlew refreshVersions` version 0.60.6 +#### +#### Don't manually edit or split the comments that start with four hashtags (####), +#### they will be overwritten by refreshVersions. +#### +#### suppress inspection "SpellCheckingInspection" for whole file +#### suppress inspection "UnusedProperty" for whole file +#### +#### NOTE: Some versions are filtered by the rejectVersionIf predicate. See the settings.gradle.kts file.