refactor: use common vertx proxy options factory

BREAKING CHANGE: this version requires APIM in version 3.18 and upper

Author: a-cordier

README.adoc

@@ -34,6 +34,17 @@ processing.
 The result of the callout is placed in a variable called `calloutResponse` and is only available during policy
 execution. If no variable is configured the result of the callout is no longer available.
 
+== Compatibility with APIM
+
+|===
+|Plugin version | APIM version
+
+|2.x and upper                  | 3.18.x to latest
+|1.15.x and upper               | 3.15.x to 3.17.x
+|1.13.x to 1.14.x               | 3.10.x to 3.14.x
+|Up to 1.12.x                   | Up to 3.9.x
+|===
+
 == Configuration
 
 |===

pom.xml

@@ -36,8 +36,9 @@
     <properties>
         <gravitee-bom.version>1.0</gravitee-bom.version>
         <gravitee-gateway-api.version>1.31.0</gravitee-gateway-api.version>
+        <gravitee-node.version>1.23.0</gravitee-node.version>
         <gravitee-policy-api.version>1.10.0</gravitee-policy-api.version>
-        <gravitee-common.version>1.25.0</gravitee-common.version>
+        <gravitee-common.version>1.26.1</gravitee-common.version>
         <gravitee-expression-language.version>1.8.0</gravitee-expression-language.version>
         <json-schema-generator-maven-plugin.version>1.3.0</json-schema-generator-maven-plugin.version>
         <json-schema-generator-maven-plugin.outputDirectory>${project.build.directory}/schemas</json-schema-generator-maven-plugin.outputDirectory>
@@ -69,6 +70,13 @@
             <scope>provided</scope>
         </dependency>
 
+        <dependency>
+            <groupId>io.gravitee.node</groupId>
+            <artifactId>gravitee-node-api</artifactId>
+            <version>${gravitee-node.version}</version>
+            <scope>provided</scope>
+        </dependency>
+
         <dependency>
             <groupId>io.gravitee.el</groupId>
             <artifactId>gravitee-expression-language</artifactId>

src/main/java/io/gravitee/policy/callout/CalloutHttpPolicy.java

@@ -15,6 +15,8 @@
  */
 package io.gravitee.policy.callout;
 
+import static io.gravitee.common.util.VertxProxyOptionsUtils.*;
+
 import io.gravitee.el.TemplateEngine;
 import io.gravitee.gateway.api.ExecutionContext;
 import io.gravitee.gateway.api.Request;
@@ -24,6 +26,7 @@
 import io.gravitee.gateway.api.stream.BufferedReadWriteStream;
 import io.gravitee.gateway.api.stream.ReadWriteStream;
 import io.gravitee.gateway.api.stream.SimpleReadWriteStream;
+import io.gravitee.node.api.configuration.Configuration;
 import io.gravitee.policy.api.PolicyChain;
 import io.gravitee.policy.api.PolicyResult;
 import io.gravitee.policy.api.annotations.OnRequest;
@@ -33,18 +36,13 @@
 import io.gravitee.policy.callout.configuration.CalloutHttpPolicyConfiguration;
 import io.gravitee.policy.callout.configuration.PolicyScope;
 import io.vertx.core.Future;
-import io.vertx.core.Handler;
 import io.vertx.core.Vertx;
 import io.vertx.core.buffer.Buffer;
 import io.vertx.core.http.*;
-import io.vertx.core.net.ProxyOptions;
-import io.vertx.core.net.ProxyType;
 import java.net.URI;
-import java.util.Objects;
 import java.util.function.Consumer;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.springframework.core.env.Environment;
 
 /**
  * @author David BRASSELY (david.brassely at graviteesource.com)
@@ -59,16 +57,16 @@ public class CalloutHttpPolicy {
     private static final String CALLOUT_EXIT_ON_ERROR = "CALLOUT_EXIT_ON_ERROR";
     private static final String CALLOUT_HTTP_ERROR = "CALLOUT_HTTP_ERROR";
 
-    /**
-     * The associated configuration to this CalloutHttp Policy
-     */
-    private CalloutHttpPolicyConfiguration configuration;
-
     private static final String TEMPLATE_VARIABLE = "calloutResponse";
 
     private static final String REQUEST_TEMPLATE_VARIABLE = "request";
     private static final String RESPONSE_TEMPLATE_VARIABLE = "response";
 
+    /**
+     * The associated configuration to this CalloutHttp Policy
+     */
+    private final CalloutHttpPolicyConfiguration configuration;
+
     /**
      * Create a new CalloutHttp Policy instance based on its associated configuration
      *
@@ -196,8 +194,15 @@ private void doCallout(ExecutionContext context, Consumer<Void> onSuccess, Consu
             }
 
             if (configuration.isUseSystemProxy()) {
-                Environment env = context.getComponent(Environment.class);
-                options.setProxyOptions(getSystemProxyOptions(env));
+                Configuration configuration = context.getComponent(Configuration.class);
+                try {
+                    setSystemProxy(options, configuration);
+                } catch (IllegalStateException e) {
+                    LOGGER.warn(
+                        "CalloutHttp requires a system proxy to be defined but some configurations are missing or not well defined: {}. Ignoring proxy",
+                        e.getMessage()
+                    );
+                }
             }
 
             HttpClient httpClient = vertx.createHttpClient(options);
@@ -332,43 +337,6 @@ private void handleFailure(Consumer<Void> onSuccess, Consumer<PolicyResult> onEr
         httpClient.close();
     }
 
-    private ProxyOptions getSystemProxyOptions(Environment environment) {
-        StringBuilder errors = new StringBuilder();
-        ProxyOptions proxyOptions = new ProxyOptions();
-
-        // System proxy must be well configured. Check that this is the case.
-        if (environment.containsProperty("system.proxy.host")) {
-            proxyOptions.setHost(environment.getProperty("system.proxy.host"));
-        } else {
-            errors.append("'system.proxy.host' ");
-        }
-
-        try {
-            proxyOptions.setPort(Integer.parseInt(Objects.requireNonNull(environment.getProperty("system.proxy.port"))));
-        } catch (Exception e) {
-            errors.append("'system.proxy.port' [").append(environment.getProperty("system.proxy.port")).append("] ");
-        }
-
-        try {
-            proxyOptions.setType(ProxyType.valueOf(environment.getProperty("system.proxy.type")));
-        } catch (Exception e) {
-            errors.append("'system.proxy.type' [").append(environment.getProperty("system.proxy.type")).append("] ");
-        }
-
-        proxyOptions.setUsername(environment.getProperty("system.proxy.username"));
-        proxyOptions.setPassword(environment.getProperty("system.proxy.password"));
-
-        if (errors.length() == 0) {
-            return proxyOptions;
-        } else {
-            LOGGER.warn(
-                "CalloutHttp requires a system proxy to be defined but some configurations are missing or not well defined: {}. Ignoring proxy",
-                errors
-            );
-            return null;
-        }
-    }
-
     private HttpMethod convert(io.gravitee.common.http.HttpMethod httpMethod) {
         switch (httpMethod) {
             case CONNECT:

src/test/java/io/gravitee/policy/CalloutHttpPolicyTest.java

@@ -35,6 +35,7 @@
 import io.gravitee.gateway.api.Request;
 import io.gravitee.gateway.api.RequestWrapper;
 import io.gravitee.gateway.api.Response;
+import io.gravitee.node.api.configuration.Configuration;
 import io.gravitee.policy.api.PolicyChain;
 import io.gravitee.policy.api.PolicyResult;
 import io.gravitee.policy.callout.CalloutHttpPolicy;
@@ -53,7 +54,6 @@
 import org.junit.runner.RunWith;
 import org.mockito.Mock;
 import org.mockito.junit.MockitoJUnitRunner;
-import org.springframework.core.env.Environment;
 
 /**
  * @author David BRASSELY (david.brassely at graviteesource.com)
@@ -80,13 +80,13 @@ public class CalloutHttpPolicyTest {
     private CalloutHttpPolicyConfiguration configuration;
 
     @Mock
-    private Environment env;
+    private Configuration nodeConfiguration;
 
     @Before
     public void init() {
-        reset(configuration, executionContext, request, response, env);
+        reset(configuration, executionContext, request, response, nodeConfiguration);
         when(executionContext.getComponent(Vertx.class)).thenReturn(Vertx.vertx());
-        when(executionContext.getComponent(Environment.class)).thenReturn(env);
+        when(executionContext.getComponent(io.gravitee.node.api.configuration.Configuration.class)).thenReturn(nodeConfiguration);
         when(executionContext.getTemplateEngine()).thenReturn(new SpelTemplateEngineFactory().templateEngine());
 
         Request request = new RequestWrapper(mock(Request.class)) {
@@ -147,9 +147,6 @@ public void shouldProcessRequest_withProxy() throws Exception {
         when(configuration.isUseSystemProxy()).thenReturn(true);
         when(configuration.getUrl()).thenReturn("http://localhost:" + wireMockRule.port() + "/");
 
-        when(env.containsProperty(anyString())).thenReturn(true);
-        when(env.getProperty(anyString())).thenReturn("localhost-proxy", "3129", "HTTP", "null", "null");
-
         final CountDownLatch lock = new CountDownLatch(1);
         this.policyChain = spy(new CountDownPolicyChain(lock));
 
@@ -158,11 +155,11 @@ public void shouldProcessRequest_withProxy() throws Exception {
         lock.await(1000, TimeUnit.MILLISECONDS);
 
         verify(policyChain).doNext(request, response);
-        verify(env).getProperty("system.proxy.port");
-        verify(env).getProperty("system.proxy.type");
-        verify(env).getProperty("system.proxy.host");
-        verify(env).getProperty("system.proxy.username");
-        verify(env).getProperty("system.proxy.password");
+        verify(nodeConfiguration).getProperty("system.proxy.port");
+        verify(nodeConfiguration).getProperty("system.proxy.type");
+        verify(nodeConfiguration).getProperty("system.proxy.host");
+        verify(nodeConfiguration).getProperty("system.proxy.username");
+        verify(nodeConfiguration).getProperty("system.proxy.password");
     }
 
     @Test