[Core] Add --publish option #2070

aslakhellesoy · 2020-07-26T09:39:12Z

This pull request introduced --publish - a simplified interface for publishing reports, similar to cucumber/cucumber-ruby#1452

The report is printed to STDERR, because surefire suppresses STDOUT. The banner is only printed when the URL matches the message store URL. The base URL is hard-coded to https://messages.cucumber.io/api/reports, but can be overridden by defining the CUCUMBER_PLUGIN_PUBLISH_URL environment variable.

TODO:

Do not append /api/reports to the base url, and let users define the full URL with CUCUMBER_PLUGIN_PUBLISH_URL
Print a banner suggesting the use of --publish so users can more easily discover this feature.
Introduce a mechanism allowing users to suppress the banner (a config file)
Send additional HTTP authentication headers if an environment variable is defined (CUCUMBER_PLUGIN_PUBLISH_TOKEN)

Screenshots:

coveralls · 2020-07-26T10:32:04Z

Coverage decreased (-0.006%) to 86.177% when pulling e81fff8 on publish-option into 622bb25 on main.

mpkorstanje

I realize this is a work in progress.

I'm not convinced that reusing the messages plugin is the correct solution here. As a result the PluginFactory now has to be aware of the details of the --publish option. It might be better to introduce a new plugin instead.

And for the todo list the publish option should also be available as an system variable and a property in cucumber.properties and junit-platform.properties. To make this possible I would forgo using addPlugin(...) and instead consider adding a publish flag to RuntimeOptions

Also some minor comments below.

.travis.yml

core/src/main/java/io/cucumber/core/options/CucumberMessageStoreUrl.java

junit/src/main/java/io/cucumber/junit/JUnitCucumberOptionsProvider.java

core/src/main/java/io/cucumber/core/plugin/UrlReporter.java

mpkorstanje · 2020-07-26T12:17:44Z

For a bit of future proving. Consider using cucumber.plugin.publish.* as a prefix for all publish related properties. Currently it is not possible to inject properties into a plugin but we may make this possible in the future. The prefix for a generic plugin would be cucumber.plugin.<plugin-name>.

core/src/main/java/io/cucumber/core/options/CucumberMessageStoreUrl.java

(Only via Environment and CLI)

mpkorstanje · 2020-07-28T17:03:05Z

Looks like IDEA is mismatching the output to the wrong element in the hierarchy. This looks like an IDEA problem though.

mpkorstanje · 2020-07-30T13:19:55Z

core/src/main/resources/io/cucumber/core/options/USAGE.txt

@@ -153,3 +153,6 @@ cucumber.snippet-type=          # underscore or camelcase.
 Each property also has an `UPPER_CASE` and `snake_case` variant. For example
 `cucumber.ansi-colors.disabled` would also be understood as
 `CUCUMBER_ANSI_COLORS_DISABLED` and `cucumber_ansi_colors_disabled`.
+
+
+TODO: Document --publish and new properties here


TODO: Document --publish and new properties here

Annoyingly this documentation is also duplicated in cucumber-junit-platform-engine.

junit-platform-engine/src/main/java/io/cucumber/junit/platform/engine/Constants.java

mpkorstanje · 2020-07-30T13:23:27Z

junit/src/main/java/io/cucumber/junit/CucumberOptions.java

@@ -93,6 +93,14 @@
     */
    String[] plugin() default {};

+    /**
+     * Publish report to https://reports.cucumber.io.


Should be consistent with the documentation for the options with the same name

mpkorstanje · 2020-07-30T13:23:35Z

testng/src/main/java/io/cucumber/testng/CucumberOptions.java

@@ -93,6 +93,14 @@
     */
    String[] plugin() default {};

+    /**
+     * Publish report to https://reports.cucumber.io.


Should be consistent with the documentation for the options with the same name

mpkorstanje · 2020-07-30T14:22:00Z

Documentation aside I think we've got everything important now. I'd like to get rid of CucumberProperties.create(); but I don't quite see how yet so I'm willing to leave it. It doesn't seem that important yet.

We are using the `Runtime.Builder` to construct runtimes for various tests. To reduce the noise in the logs the publish feature should be off unless explicitly enabled. The publish plugin feature is enabled for the main, junit and testng runners.

…domain is now available.

mpkorstanje · 2020-08-15T07:57:36Z

@aslakhellesoy

we have a several sources of documentation.

The change log
The release notes
The git log/merge request

And when making a new release I often distil the release notes from the git log and merge requests. However currently neither the git log, nor the merge request describe how this feature works in full. This leaves a gap in the documentation making it harder for future contributors to work out how we intended something to work. This will in turn either result in having to answer questions or people failing to contribute.

Cucumber JVM is configured to squash merge all commits. So when merging in Cucumber-JVM you'll get the chance to edit the commit message. I usually use this as an opportunity to update the PR to describe the why and copy this into the commit message.

See also How to Write a Git Commit Message

aslakhellesoy · 2020-08-16T17:47:15Z

👍 I'll deal with this tomorrow before the release.

Aslak Hellesøy added 2 commits July 25, 2020 18:05

Add --publish option to publish to reports.cucumber.io

43b5195

Change banner to cyan

0d41b1e

aslakhellesoy requested review from vincent-psarga and mpkorstanje July 26, 2020 09:39

Override CUCUMBER_MESSAGE_STORE_URL

803f9ec

mpkorstanje reviewed Jul 26, 2020

View reviewed changes

core/src/main/java/io/cucumber/core/options/CucumberMessageStoreUrl.java Outdated Show resolved Hide resolved

Aslak Hellesøy and others added 17 commits July 27, 2020 11:51

Create separate PublishFormatter

ddde173

Allow --plugin to be enabled via properties

efe3f39

Prefer inheritance over composition

b8cf4d4

Use PLUGIN_PUBLISH_TOKEN_PROPERTY_NAME to enable publish plugin

40d985b

(Only via Environment and CLI)

Use properties.getOrDefault

29361b5

Register cucumber.plugin.publish.url as constant

41421aa

--publish enables the plugin, so does properties

f4fb2dd

Don't include publish plugin in supported plugins

e7564cc

Add color aware to reporter

ff43c64

Add monochrome test

67ab0de

Enable monochrome on publish formatter

d72c875

More color aware

3560de9

Clean up

1ef7165

Clean up

92999a4

Clean up

44ae655

Fix getOrDefault

69bd809

Publish should be the last plugin to receive events

a7c5ee2

mpkorstanje added 3 commits July 28, 2020 19:12

Add to Cucumber options

97521a2

Add to CucumberEngineOptions

3ca96c0

Add to CucumberEngineOptions

6214e10

require non null

93a4886

mpkorstanje reviewed Jul 30, 2020

View reviewed changes

Fix typo

53d5ff4

mpkorstanje reviewed Jul 30, 2020

View reviewed changes

junit-platform-engine/src/main/java/io/cucumber/junit/platform/engine/Constants.java Show resolved Hide resolved

mpkorstanje reviewed Jul 30, 2020

View reviewed changes

mpkorstanje added 3 commits July 30, 2020 16:00

Clean up

79d9db8

Revapi

250bd6a

Clean up

19ba439

mpkorstanje added 3 commits July 31, 2020 12:04

Remove unused

9c6e90a

Merge remote-tracking branch 'origin/main' into publish-option

73c0cff

Nice curloption

d9fc4b2

mpkorstanje changed the title ~~Publish option~~ [Core] Add --publish option Jul 31, 2020

mpkorstanje and others added 8 commits July 31, 2020 15:02

Nice curloption

b69a04a

Merge remote-tracking branch 'origin/main' into publish-option

31145a7

Clean up

ab3e2cb

Revapi

55f81f3

Merge remote-tracking branch 'origin/main' into publish-option

aaf0125

Merge branch 'main' into publish-option

90f8916

Merge branch 'main' into publish-option

d4a9b38

aslakhellesoy marked this pull request as ready for review August 12, 2020 21:43

Aslak Hellesøy added 3 commits August 12, 2020 22:45

Remove CUCUMBER_PLUGIN_PUBLISH_URL env var. The messages.cucumber.io …

e81fff8

…domain is now available.

Update changelog

ba136d0

Update changelog

7b30c84

aslakhellesoy merged commit a741b27 into main Aug 12, 2020

aslakhellesoy deleted the publish-option branch August 12, 2020 22:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Core] Add --publish option #2070

[Core] Add --publish option #2070

aslakhellesoy commented Jul 26, 2020 •

edited

Loading

coveralls commented Jul 26, 2020 •

edited

Loading

mpkorstanje left a comment •

edited

Loading

mpkorstanje commented Jul 26, 2020 •

edited

Loading

mpkorstanje commented Jul 28, 2020

mpkorstanje Jul 30, 2020

mpkorstanje Jul 30, 2020

mpkorstanje Jul 30, 2020

mpkorstanje Jul 30, 2020

mpkorstanje commented Jul 30, 2020

mpkorstanje commented Aug 15, 2020

aslakhellesoy commented Aug 16, 2020

[Core] Add --publish option #2070

[Core] Add --publish option #2070

Conversation

aslakhellesoy commented Jul 26, 2020 • edited Loading

coveralls commented Jul 26, 2020 • edited Loading

mpkorstanje left a comment • edited Loading

Choose a reason for hiding this comment

mpkorstanje commented Jul 26, 2020 • edited Loading

mpkorstanje commented Jul 28, 2020

mpkorstanje Jul 30, 2020

Choose a reason for hiding this comment

mpkorstanje Jul 30, 2020

Choose a reason for hiding this comment

mpkorstanje Jul 30, 2020

Choose a reason for hiding this comment

mpkorstanje Jul 30, 2020

Choose a reason for hiding this comment

mpkorstanje commented Jul 30, 2020

mpkorstanje commented Aug 15, 2020

aslakhellesoy commented Aug 16, 2020

aslakhellesoy commented Jul 26, 2020 •

edited

Loading

coveralls commented Jul 26, 2020 •

edited

Loading

mpkorstanje left a comment •

edited

Loading

mpkorstanje commented Jul 26, 2020 •

edited

Loading