Merge branch 'master' into update-kubernetes-client-api-6.4.x

Author: Vlatombe

src/main/java/org/csanchez/jenkins/plugins/kubernetes/KubernetesFactoryAdapter.java

@@ -1,6 +1,7 @@
 package org.csanchez.jenkins.plugins.kubernetes;
 
 
+import edu.umd.cs.findbugs.annotations.NonNull;
 import hudson.Util;
 import io.fabric8.kubernetes.client.KubernetesClientBuilder;
 import java.util.Base64;
@@ -152,12 +153,40 @@ public KubernetesClient createClient() throws KubernetesAuthException {
                         builder.withProxyUsername(p.name);
                         builder.withProxyPassword(password);
                     }
-                    builder.withNoProxy(p.getNoProxyHost().split("\n"));
+                    builder.withNoProxy(getNoProxyHosts(p));
                 }
             }
         }
         return new KubernetesClientBuilder().withConfig(builder.build()).build();
     }
+
+    /**
+     * Get the no proxy hosts in the format supported by the Kubernetes Client implementation. In particular
+     * <code>*</code> are not supported.
+     *
+     * For Example:
+     * * <code>example.com</code> to not use the proxy for <code>example.com</code> and its subdomain.
+     * * <code>.example.com</code> to not use the proxy for subdomains of <code>example.com</code>. But use it
+     * for <code>.example.com</code>.
+     *
+     * Note: Jenkins Proxy supports wildcard such as <code>192.168.*</code> or <code>*my*.example.com</code> that cannot
+     * be converted to the current kubernetes client implementation.
+     *
+     * @see https://github.com/fabric8io/kubernetes-client/blob/master/CHANGELOG.md#610-2022-08-31
+     * @see https://www.gnu.org/software/wget/manual/html_node/Proxies.html.
+     * @param proxy a {@link ProxyConfiguration}
+     * @return the array of no proxy hosts
+     */
+    private String[] getNoProxyHosts(@NonNull ProxyConfiguration proxy) {
+        String[] noProxyHosts = proxy.getNoProxyHost().split("\n");
+        int i=0;
+        while(i<noProxyHosts.length) {
+            noProxyHosts[i] = noProxyHosts[i].replace("*", "");
+            i++;
+        }
+        return noProxyHosts;
+    }
+
     private String getProxyPasswordDecrypted(ProxyConfiguration p) {
         String passwordEncrypted = p.getPassword();
         String password = null;

src/main/resources/org/csanchez/jenkins/plugins/kubernetes/PodTemplate/help-inheritFrom.html

@@ -1,3 +1,6 @@
+<p>
+    <b>Name</b> of the podTemplate to inherit from.
+</p>
 <p>
     A podTemplate may or may not inherit from an existing template.<br/>
     This means that the podTemplate will inherit node selector, service account, image pull secrets, containerTemplates and volumes from the template it inherits from.

src/main/resources/org/csanchez/jenkins/plugins/kubernetes/PodTemplate/help-name.html

@@ -13,6 +13,10 @@
   ~ See the License for the specific language governing permissions and
   ~ limitations under the License.
   -->
-
-The name prefix of the pod.
-Defaults to the label.
+<p>
+    Name that identifies the pod template. Also used to prefix the name of the node and pod created.
+</p>
+<p>
+    When omitted, the agent and pod name is randomly generated using <i>jenkins-agent-</i> as a prefix.
+    When omitted <b>in a <i>podTemplate(...)</i> step</b>, the <i>label</i> is used as a prefix for the name of the dynamic pod template.
+</p>

src/test/java/org/csanchez/jenkins/plugins/kubernetes/KubernetesFactoryAdapterTest.java

@@ -24,17 +24,32 @@
 
 package org.csanchez.jenkins.plugins.kubernetes;
 
-import static org.junit.Assert.*;
-
-import java.util.HashMap;
-import java.util.Map;
-
+import hudson.ProxyConfiguration;
+import io.fabric8.kubernetes.client.KubernetesClient;
+import io.fabric8.kubernetes.client.utils.HttpClientUtils;
+import org.jenkinsci.plugins.kubernetes.auth.KubernetesAuthException;
 import org.junit.After;
 import org.junit.Before;
+import org.junit.Rule;
 import org.junit.Test;
+import org.jvnet.hudson.test.Issue;
+import org.jvnet.hudson.test.JenkinsRule;
 
-import static io.fabric8.kubernetes.client.Config.*;
-import io.fabric8.kubernetes.client.KubernetesClient;
+import java.net.MalformedURLException;
+import java.util.HashMap;
+import java.util.Map;
+
+import static io.fabric8.kubernetes.client.Config.KUBERNETES_HTTPS_PROXY;
+import static io.fabric8.kubernetes.client.Config.KUBERNETES_HTTP_PROXY;
+import static io.fabric8.kubernetes.client.Config.KUBERNETES_KUBECONFIG_FILE;
+import static io.fabric8.kubernetes.client.Config.KUBERNETES_NAMESPACE_FILE;
+import static io.fabric8.kubernetes.client.Config.KUBERNETES_NO_PROXY;
+import static io.fabric8.kubernetes.client.Config.KUBERNETES_PROXY_PASSWORD;
+import static io.fabric8.kubernetes.client.Config.KUBERNETES_PROXY_USERNAME;
+import static org.junit.Assert.assertArrayEquals;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
 
 /**
  * Test the creation of clients
@@ -59,6 +74,9 @@ public class KubernetesFactoryAdapterTest {
 
     private Map<String, String> systemProperties = new HashMap<>();
 
+    @Rule
+    public JenkinsRule j = new JenkinsRule();
+
     @Before
     public void saveSystemProperties() {
         for (String key : SYSTEM_PROPERTY_NAMES) {
@@ -117,4 +135,35 @@ public void autoConfigWithMasterUrl() throws Exception {
         assertEquals(PROXY_USERNAME, client.getConfiguration().getProxyUsername());
         assertEquals(PROXY_PASSWORD, client.getConfiguration().getProxyPassword());
     }
+
+    @Test
+    @Issue("JENKINS-70563")
+    public void jenkinsProxyConfiguration() throws KubernetesAuthException, MalformedURLException {
+
+        j.jenkins.setProxy(new ProxyConfiguration("proxy.com", 123, PROXY_USERNAME, PROXY_PASSWORD, "*acme.com\n*acme*.com\n*.example.com|192.168.*"));
+        KubernetesFactoryAdapter factory = new KubernetesFactoryAdapter("http://acme.com", null, null, null, false, 15, 5, 32, true);
+        try(KubernetesClient client = factory.createClient()) {
+            assertNull(HttpClientUtils.getProxyUrl(client.getConfiguration()));
+        }
+
+        j.jenkins.setProxy(new ProxyConfiguration("proxy.com", 123, PROXY_USERNAME, PROXY_PASSWORD, "*acme.com"));
+        factory = new KubernetesFactoryAdapter("http://acme.com", null, null, null, false, 15, 5, 32, true);
+        try(KubernetesClient client = factory.createClient()) {
+            assertNull(HttpClientUtils.getProxyUrl(client.getConfiguration()));
+        }
+        factory = new KubernetesFactoryAdapter("http://k8s.acme.com", null, null, null, false, 15, 5, 32, true);
+        try(KubernetesClient client = factory.createClient()) {
+            assertNull(HttpClientUtils.getProxyUrl(client.getConfiguration()));
+        }
+
+        j.jenkins.setProxy(new ProxyConfiguration("proxy.com", 123, PROXY_USERNAME, PROXY_PASSWORD, "*.acme.com"));
+        factory = new KubernetesFactoryAdapter("http://acme.com", null, null, null, false, 15, 5, 32, true);
+        try(KubernetesClient client = factory.createClient()) {
+            assertNotNull(HttpClientUtils.getProxyUrl(client.getConfiguration()));
+        }
+        factory = new KubernetesFactoryAdapter("http://k8s.acme.com", null, null, null, false, 15, 5, 32, true);
+        try(KubernetesClient client = factory.createClient()) {
+            assertNull(HttpClientUtils.getProxyUrl(client.getConfiguration()));
+        }
+    }
 }

test-in-k8s.yaml

@@ -24,7 +24,7 @@ spec:
   serviceAccountName: jenkins
   containers:
   - name: jenkins
-    image: maven:3.8.7-eclipse-temurin-17
+    image: maven:3.9.0-eclipse-temurin-17
     command:
       - sleep
     args: