Allow using a HTTP proxy to send results

[aslakhellesoy]

We should allow users behind a HTTP(S) proxy to publish results. See https://docs.oracle.com/javase/8/docs/api/java/net/doc-files/net-properties.html

[aslakhellesoy]

We should make sure all implementations use the same environment variables to configure proxy settings.

• Allow using a HTTP proxy to send results cucumber-ruby#1526
• Allow using a HTTP proxy to send results cucumber-js#1644

[mpkorstanje]

At this point it would be prudent to replace the HttpURLConnection with a proper shaded http client. When using the http.* properties will affect all components in java.net including those of the system under tests. So this may not be feasible. Especially in more complicated setups.

[mpkorstanje]

Java 11 does come with a HttpClient that is an overall improvement over the HttpURLConnection, but as Cucumber is currently still on Java 8 we can not use this yet. We do have a major version in the works that would allow us to increase the minimum version of the JRE on which Cucumber is ran.

https://docs.oracle.com/en/java/javase/11/docs/api/java.net.http/java/net/http/HttpClient.html

[aslakhellesoy]

Can't we just use a java.net.Proxy object and take the configuration from cucumber-specific environment variables? For example:

• CUCUMBER_PUBLISH_HTTP_PROXY_HOST
• CUCUMBER_PUBLISH_HTTP_PROXY_PORT

[mpkorstanje]

Not on a HttpURLConnection, you could create a URL instance with a custom implementation of URLStreamHandler but that's all sorts painful.

[aslakhellesoy]

Not on a HttpURLConnection, you could create a URL instance with a custom implementation of URLStreamHandler but that's all sorts painful.

Why not?

At

cucumber-jvm/core/src/main/java/io/cucumber/core/plugin/UrlOutputStream.java

Line 72 in 0a101a3

HttpURLConnection urlConnection = (HttpURLConnection) url.openConnection();

we could pass in a proxy object. See https://docs.oracle.com/javase/7/docs/api/java/net/URL.html#openConnection%28java.net.Proxy%29

[mpkorstanje]

Didn't even know you could do that.

[mpkorstanje]

We can probably extend the curl option syntax with the curl option for proxy:

curl https://example.com -x http://<proxy>:<port>

[aslakhellesoy]

We can probably extend the curl option syntax with the curl option for proxy

Ooo nice idea!!!

[mpkorstanje]

And if we could use PluginOption.forClass with a curl option as an argument this would also be a bit simpler:

    private List<Plugin> getPublishPlugin() {
        if (!enablePublishPlugin) {
            return emptyList();
        }
        if (publishToken != null) {
            return singletonList(PluginOption.forClass(PublishFormatter.class, publishToken));
        }
        if (publish) {
            return singletonList(PluginOption.forClass(PublishFormatter.class));
        }
        if (publishQuiet) {
            return emptyList();
        }
        return singletonList(PluginOption.forClass(NoPublishFormatter.class));
    }

Esp because then we wouldn't need CucumberProperties.create(); in PublishFormatter which doesn't look at at junit-platform.properties.

    private static CurlOption createCurlOption(String token) {
        Map<String, String> properties = CucumberProperties.create();
        String url = properties.getOrDefault(PLUGIN_PUBLISH_URL_PROPERTY_NAME, DEFAULT_CUCUMBER_MESSAGE_STORE_URL);
        if (token != null) {
            url = url + String.format(" -H 'Authorization: Bearer %s'", token);
        }
        return CurlOption.parse(url);
    }

[ghost]

Is there any progress?

[aslakhellesoy]

Not yet. You could help by submitting a pull request.