[JENKINS-75157] Bitbucket client fail to retrieve resource with HTTP 404 for bitbucket server (#970)

Remove the HttpHost parameter when calling in Apache client as the request could be different than the host configured in jenkins, for example in Bitbucket Server request using mirror link.
Do not catch the FileNotFoundException in executeMethod to respect the SCMFile interface.

Author: nfalco79

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/filesystem/BitbucketSCMFile.java

@@ -28,6 +28,7 @@
 import edu.umd.cs.findbugs.annotations.NonNull;
 import java.io.IOException;
 import java.io.InputStream;
+import java.util.Collections;
 import jenkins.scm.api.SCMFile;
 
 public class BitbucketSCMFile  extends SCMFile {
@@ -45,13 +46,13 @@ public void setRef(String ref) {
     }
 
     @Deprecated
-    public BitbucketSCMFile(BitbucketSCMFileSystem bitBucketSCMFileSystem,
+    public BitbucketSCMFile(BitbucketSCMFileSystem bitbucketSCMFileSystem,
                             BitbucketApi api,
                             String ref) {
-        this(bitBucketSCMFileSystem, api, ref, null);
+        this(bitbucketSCMFileSystem, api, ref, null);
     }
 
-    public BitbucketSCMFile(BitbucketSCMFileSystem bitBucketSCMFileSystem,
+    public BitbucketSCMFile(BitbucketSCMFileSystem bitbucketSCMFileSystem,
                             BitbucketApi api,
                             String ref, String hash) {
         super();
@@ -85,7 +86,8 @@ public Iterable<SCMFile> children() throws IOException,
         if (this.isDirectory()) {
             return api.getDirectoryContent(this);
         } else {
-            throw new IOException("Cannot get children from a regular file");
+            // respect the interface javadoc
+            return Collections.emptyList();
         }
     }
 
@@ -108,7 +110,7 @@ public long lastModified() throws IOException, InterruptedException {
     @Override
     @NonNull
     protected SCMFile newChild(String name, boolean assumeIsDirectory) {
-        return new BitbucketSCMFile(this, name, assumeIsDirectory?Type.DIRECTORY:Type.REGULAR_FILE, hash);
+        return new BitbucketSCMFile(this, name, assumeIsDirectory ? Type.DIRECTORY : Type.REGULAR_FILE, hash);
     }
 
     @Override

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/filesystem/BitbucketSCMFileSystem.java

@@ -43,7 +43,6 @@
 import hudson.Util;
 import hudson.model.Item;
 import hudson.model.Queue;
-import hudson.model.queue.Tasks;
 import hudson.scm.SCM;
 import hudson.scm.SCMDescriptor;
 import hudson.security.ACL;
@@ -116,22 +115,24 @@ public SCMFileSystem build(@NonNull Item owner, @NonNull SCM scm, @CheckForNull
         }
 
         private static StandardCredentials lookupScanCredentials(@CheckForNull Item context,
-                @CheckForNull String scanCredentialsId, String serverUrl) {
-            if (Util.fixEmpty(scanCredentialsId) == null) {
+                                                                 @CheckForNull String scanCredentialsId,
+                                                                 String serverURL) {
+            scanCredentialsId = Util.fixEmpty(scanCredentialsId);
+            if (scanCredentialsId == null) {
                 return null;
             } else {
                 return CredentialsMatchers.firstOrNull(
-                        CredentialsProvider.lookupCredentials(
+                        CredentialsProvider.lookupCredentialsInItem(
                                 StandardCredentials.class,
                                 context,
-                                context instanceof Queue.Task
-                                        ? Tasks.getDefaultAuthenticationOf((Queue.Task) context)
-                                        : ACL.SYSTEM,
-                                URIRequirementBuilder.fromUri(serverUrl).build()
+                                context instanceof Queue.Task task
+                                        ? task.getDefaultAuthentication2()
+                                        : ACL.SYSTEM2,
+                                URIRequirementBuilder.fromUri(serverURL).build()
                         ),
                         CredentialsMatchers.allOf(
                                 CredentialsMatchers.withId(scanCredentialsId),
-                                AuthenticationTokens.matcher(BitbucketAuthenticator.authenticationContext(serverUrl))
+                                AuthenticationTokens.matcher(BitbucketAuthenticator.authenticationContext(serverURL))
                         )
                 );
             }

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/impl/client/AbstractBitbucketApi.java

@@ -36,8 +36,6 @@
 import java.io.InputStream;
 import java.net.InetSocketAddress;
 import java.net.Proxy;
-import java.net.URI;
-import java.net.URISyntaxException;
 import java.nio.charset.StandardCharsets;
 import java.util.List;
 import java.util.concurrent.TimeUnit;
@@ -220,21 +218,21 @@ private void setClientProxyParams(String host, HttpClientBuilder builder) {
     @NonNull
     protected abstract CloseableHttpClient getClient();
 
-    protected CloseableHttpResponse executeMethod(HttpHost host,
-                                                  HttpRequestBase httpMethod,
-                                                  boolean requireAuthentication) throws IOException {
+    protected CloseableHttpResponse executeMethod(HttpRequestBase request, boolean requireAuthentication) throws IOException {
         if (requireAuthentication && authenticator != null) {
-            authenticator.configureRequest(httpMethod);
+            authenticator.configureRequest(request);
         }
-        return getClient().execute(host, httpMethod, context);
+        // the Apache client determinate the host from request.getURI()
+        // in some cases like requests to mirror or avatar, the host could not be the same of configured in Jenkins
+        return getClient().execute(request, context);
     }
 
-    protected CloseableHttpResponse executeMethod(HttpHost host, HttpRequestBase httpMethod) throws IOException {
-        return executeMethod(host, httpMethod, true);
+    protected CloseableHttpResponse executeMethod(HttpRequestBase httpMethod) throws IOException {
+        return executeMethod(httpMethod, true);
     }
 
     protected String doRequest(HttpRequestBase request, boolean requireAuthentication) throws IOException {
-        try (CloseableHttpResponse response =  executeMethod(getHost(), request, requireAuthentication)) {
+        try (CloseableHttpResponse response =  executeMethod(request, requireAuthentication)) {
             int statusCode = response.getStatusLine().getStatusCode();
             if (statusCode == HttpStatus.SC_NOT_FOUND) {
                 throw new FileNotFoundException("URL: " + request.getURI());
@@ -250,7 +248,7 @@ protected String doRequest(HttpRequestBase request, boolean requireAuthenticatio
                 throw buildResponseException(response, content);
             }
             return content;
-        } catch (BitbucketRequestException e) {
+        } catch (FileNotFoundException | BitbucketRequestException e) {
             throw e;
         } catch (IOException e) {
             throw new IOException("Communication error for url: " + request, e);
@@ -276,19 +274,7 @@ private void release(HttpRequestBase method) {
      */
     protected InputStream getRequestAsInputStream(String path) throws IOException {
         HttpGet httpget = new HttpGet(path);
-        HttpHost host = getHost();
-
-        // Extract host from URL, if present
-        try {
-            URI uri = new URI(host.toURI());
-            if (uri.isAbsolute() && ! uri.isOpaque()) {
-                host = HttpHost.create(uri.getScheme() + "://" + uri.getAuthority());
-            }
-        } catch (URISyntaxException ex) {
-            // use default
-        }
-
-        CloseableHttpResponse response =  executeMethod(host, httpget);
+        CloseableHttpResponse response =  executeMethod(httpget);
         int statusCode = response.getStatusLine().getStatusCode();
         if (statusCode == HttpStatus.SC_NOT_FOUND) {
             EntityUtils.consume(response.getEntity());
@@ -303,7 +289,7 @@ protected InputStream getRequestAsInputStream(String path) throws IOException {
 
     protected int headRequestStatus(String path) throws IOException {
         HttpHead httpHead = new HttpHead(path);
-        try (CloseableHttpResponse response = executeMethod(getHost(), httpHead)) {
+        try (CloseableHttpResponse response = executeMethod(httpHead)) {
             EntityUtils.consume(response.getEntity());
             return response.getStatusLine().getStatusCode();
         } catch (IOException e) {

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/server/client/BitbucketServerAPIClient.java

@@ -952,7 +952,7 @@ protected CloseableHttpClient getClient() {
     protected HttpHost getHost() {
         String url = baseURL;
         try {
-            // it's really needed?
+            // it's needed because the serverURL can contains a context root different than '/' and the HttpHost must contains only schema, host and port
             URL tmp = new URL(baseURL);
             String schema = tmp.getProtocol() == null ? "http" : tmp.getProtocol();
             return new HttpHost(tmp.getHost(), tmp.getPort(), schema);

src/test/java/com/cloudbees/jenkins/plugins/bitbucket/client/BitbucketIntegrationClientFactory.java

@@ -27,12 +27,12 @@
 import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketAuthenticator;
 import com.cloudbees.jenkins.plugins.bitbucket.impl.util.BitbucketApiUtils;
 import com.cloudbees.jenkins.plugins.bitbucket.server.client.BitbucketServerAPIClient;
+import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.io.InputStream;
 import java.nio.charset.StandardCharsets;
 import org.apache.commons.io.IOUtils;
 import org.apache.http.HttpEntity;
-import org.apache.http.HttpHost;
 import org.apache.http.StatusLine;
 import org.apache.http.client.methods.CloseableHttpResponse;
 import org.apache.http.client.methods.HttpRequestBase;
@@ -53,7 +53,7 @@ default void request(HttpRequestBase request) {
         default CloseableHttpResponse loadResponseFromResources(Class<?> resourceBase, String path, String payloadPath) throws IOException {
             try (InputStream json = resourceBase.getResourceAsStream(payloadPath)) {
                 if (json == null) {
-                    throw new IllegalStateException("Payload for the REST path " + path + " could not be found: " + payloadPath);
+                    throw new FileNotFoundException("Payload for the REST path " + path + " could not be found: " + payloadPath);
                 }
                 HttpEntity entity = mock(HttpEntity.class);
                 String jsonString = IOUtils.toString(json, StandardCharsets.UTF_8);
@@ -104,19 +104,17 @@ private BitbucketServerIntegrationClient(String payloadRootPath, String baseURL,
         }
 
         @Override
-        protected CloseableHttpResponse executeMethod(HttpHost host,
-                                                      HttpRequestBase httpMethod,
-                                                      boolean requireAuthentication) throws IOException {
-            String path = httpMethod.getURI().toString();
-            audit.request(httpMethod);
+        protected CloseableHttpResponse executeMethod(HttpRequestBase request, boolean requireAuthentication) throws IOException {
+            String requestURI = request.getURI().toString();
+            audit.request(request);
 
-            String payloadPath = path.substring(path.indexOf("/rest/"))
+            String payloadPath = requestURI.substring(requestURI.indexOf("/rest/"))
                     .replace("/rest/api/", "")
                     .replace("/rest/", "")
                     .replace('/', '-').replaceAll("[=%&?]", "_");
             payloadPath = payloadRootPath + payloadPath + ".json";
 
-            return loadResponseFromResources(getClass(), path, payloadPath);
+            return loadResponseFromResources(getClass(), requestURI, payloadPath);
         }
 
         @Override
@@ -155,9 +153,7 @@ private BitbucketClouldIntegrationClient(String payloadRootPath, String owner, S
         }
 
         @Override
-        protected CloseableHttpResponse executeMethod(HttpHost host,
-                                                      HttpRequestBase httpMethod,
-                                                      boolean requireAuthentication) throws IOException {
+        protected CloseableHttpResponse executeMethod(HttpRequestBase httpMethod, boolean requireAuthentication) throws IOException {
             String path = httpMethod.getURI().toString();
             audit.request(httpMethod);
 

src/test/java/com/cloudbees/jenkins/plugins/bitbucket/filesystem/BitbucketSCMFileTest.java

@@ -0,0 +1,50 @@
+/*
+ * The MIT License
+ *
+ * Copyright (c) 2025, Nikolas Falco
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.cloudbees.jenkins.plugins.bitbucket.filesystem;
+
+import com.cloudbees.jenkins.plugins.bitbucket.api.BitbucketApi;
+import com.cloudbees.jenkins.plugins.bitbucket.client.BitbucketIntegrationClientFactory;
+import java.io.FileNotFoundException;
+import jenkins.scm.api.SCMFile.Type;
+import org.junit.jupiter.api.Test;
+import org.jvnet.hudson.test.Issue;
+import org.jvnet.hudson.test.JenkinsRule;
+import org.jvnet.hudson.test.junit.jupiter.WithJenkins;
+
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+import static org.mockito.Mockito.mock;
+
+class BitbucketSCMFileTest {
+
+    @WithJenkins
+    @Issue("JENKINS-75157")
+    @Test
+    void test(JenkinsRule r) {
+        BitbucketApi client = BitbucketIntegrationClientFactory.getApiMockClient("https://acme.bitbucket.com");
+
+        BitbucketSCMFile parent = new BitbucketSCMFile(mock(BitbucketSCMFileSystem.class), client, "ref", "hash");
+        BitbucketSCMFile file = new BitbucketSCMFile(parent, "pipeline_config.groovy", Type.REGULAR_FILE, "046d9a3c1532acf4cf08fe93235c00e4d673c1d2");
+        assertThatThrownBy(file::content).isInstanceOf(FileNotFoundException.class);
+    }
+}