Add disable external url option (#97)

Co-authored-by: Tim Jacomb <21194782+timja@users.noreply.github.com>
jenkinsci · Mar 12, 2024 · 658454b · 658454b
1 parent 068a70c
commit 658454b
Show file tree

Hide file tree

Showing 7 changed files with 45 additions and 18 deletions.
diff --git a/src/main/java/com/microsoft/jenkins/artifactmanager/AzureArtifactConfig.java b/src/main/java/com/microsoft/jenkins/artifactmanager/AzureArtifactConfig.java
@@ -34,6 +34,7 @@ public class AzureArtifactConfig extends AbstractDescribableImpl<AzureArtifactCo
     private String storageCredentialId;
     private String container;
     private String prefix;
+    private boolean disableExternalUrl;
 
     public AzureArtifactConfig() {
     }
@@ -61,6 +62,15 @@ public void setPrefix(String prefix) {
         this.prefix = prefix;
     }
 
+    public boolean getDisableExternalUrl() {
+        return disableExternalUrl;
+    }
+
+    @DataBoundSetter
+    public void setDisableExternalUrl(boolean disableExternalUrl) {
+        this.disableExternalUrl = disableExternalUrl;
+    }
+
     public String getStorageCredentialId() {
         return this.storageCredentialId;
     }

diff --git a/src/main/java/com/microsoft/jenkins/artifactmanager/AzureArtifactManager.java b/src/main/java/com/microsoft/jenkins/artifactmanager/AzureArtifactManager.java
@@ -397,7 +397,8 @@ private BlobContainerClient getContainer() throws IOException,
 
     @Override
     public VirtualFile root() {
-        return new AzureBlobVirtualFile(this.actualContainerName, getVirtualPath("artifacts"), build);
+        return new AzureBlobVirtualFile(this.actualContainerName, getVirtualPath("artifacts"),
+            this.config.getDisableExternalUrl(), build);
     }
 
     @Override

diff --git a/src/main/java/com/microsoft/jenkins/artifactmanager/AzureBlobVirtualFile.java b/src/main/java/com/microsoft/jenkins/artifactmanager/AzureBlobVirtualFile.java
@@ -49,12 +49,15 @@ public class AzureBlobVirtualFile extends AzureAbstractVirtualFile {
 
     private final String container;
     private final String key;
+
+    private Boolean disableExternalUrl;
     private final transient Run<?, ?> build;
 
-    public AzureBlobVirtualFile(String container, String key, Run<?, ?> build) {
+    public AzureBlobVirtualFile(String container, String key, boolean disableExternalUrl, Run<?, ?> build) {
         this.container = container;
         this.key = key;
         this.build = build;
+        this.disableExternalUrl = disableExternalUrl;
     }
 
     public String getContainer() {
@@ -185,20 +188,24 @@ public URI toURI() {
     @CheckForNull
     @Override
     public URL toExternalURL() throws IOException {
-        StorageAccountInfo accountInfo = Utils.getStorageAccount(build.getParent());
-        String sas;
-        try {
-            sas = Utils.generateBlobSASURL(accountInfo, this.container, this.key);
-        } catch (Exception e) {
-            throw new IOException(e);
+        if (!this.disableExternalUrl) {
+            StorageAccountInfo accountInfo = Utils.getStorageAccount(build.getParent());
+            String sas;
+            try {
+                sas = Utils.generateBlobSASURL(accountInfo, this.container, this.key);
+            } catch (Exception e) {
+                throw new IOException(e);
+            }
+            return new URL(toURI() + "?" + sas);
+        } else {
+            return null;
         }
-        return new URL(toURI() + "?" + sas);
     }
 
     @Override
     public VirtualFile getParent() {
         return new AzureBlobVirtualFile(this.container, this.key.replaceFirst("/[^/]+$", Constants.EMPTY_STRING),
-                this.build);
+            this.disableExternalUrl, this.build);
     }
 
     @Override
@@ -283,7 +290,8 @@ public VirtualFile[] list() throws IOException {
                     .map(f -> f.substring(relSlash.length()).replaceFirst("/.+", ""))
                     .distinct() // ignore duplicates if have multiple files under one direct subdir
                     // direct children
-                    .map(simple -> new AzureBlobVirtualFile(this.container, keyS + simple, this.build))
+                    .map(simple -> new AzureBlobVirtualFile(this.container, keyS + simple,
+                        this.disableExternalUrl, this.build))
                     .toArray(VirtualFile[]::new);
             return virtualFiles;
         }
@@ -306,7 +314,8 @@ private List<VirtualFile> listBlobsFromPrefix(String keys, BlobContainerClient b
         PagedIterable<BlobItem> blobItems = blobContainerReference.listBlobsByHierarchy(keys);
         List<VirtualFile> files = new ArrayList<>();
         for (BlobItem blobItem : blobItems) {
-            files.add(new AzureBlobVirtualFile(this.container, stripTrailingSlash(blobItem.getName()), this.build));
+            files.add(new AzureBlobVirtualFile(this.container, stripTrailingSlash(blobItem.getName()),
+                this.disableExternalUrl, this.build));
         }
         return files;
     }
@@ -315,7 +324,7 @@ private List<VirtualFile> listBlobsFromPrefix(String keys, BlobContainerClient b
     @Override
     public VirtualFile child(@NonNull String name) {
         String joinedKey = stripTrailingSlash(this.key) + Constants.FORWARD_SLASH + name;
-        return new AzureBlobVirtualFile(this.container, joinedKey, build);
+        return new AzureBlobVirtualFile(this.container, joinedKey, this.disableExternalUrl, build);
     }
 
     @Override

diff --git a/src/main/resources/com/microsoft/jenkins/artifactmanager/AzureArtifactConfig/config.jelly b/src/main/resources/com/microsoft/jenkins/artifactmanager/AzureArtifactConfig/config.jelly
@@ -14,5 +14,8 @@
         <f:entry title="${%Prefix_title}" field="prefix">
             <f:textbox/>
         </f:entry>
+        <f:entry title="${%DisableExternalUrl_title}" field="disableExternalUrl">
+            <f:checkbox/>
+        </f:entry>
     </f:section>
 </j:jelly>
diff --git a/...ain/resources/com/microsoft/jenkins/artifactmanager/AzureArtifactConfig/config.properties b/...ain/resources/com/microsoft/jenkins/artifactmanager/AzureArtifactConfig/config.properties
@@ -3,3 +3,4 @@ Credentials_setting_title=Azure Storage Credentials Settings
 Access_setting_title=Azure Storage Access Settings
 Container_name_title=Azure Container Name
 Prefix_title=Base Prefix (Optional)
+DisableExternalUrl_title=Disable External URL (Optional)
diff --git a/...es/com/microsoft/jenkins/artifactmanager/AzureArtifactConfig/help-disableExternalUrl.html b/...es/com/microsoft/jenkins/artifactmanager/AzureArtifactConfig/help-disableExternalUrl.html
@@ -0,0 +1,3 @@
+<p>
+    If checked, artifacts will be accessed under a Jenkins URL and not an Azure Storage URL.
+</p>
diff --git a/...t/java/com/microsoft/jenkins/artifactmanager/IntegrationTests/AzureBlobVirtualFileIT.java b/...t/java/com/microsoft/jenkins/artifactmanager/IntegrationTests/AzureBlobVirtualFileIT.java
@@ -79,11 +79,11 @@ public void setUp() throws Exception {
         uploadFile(tempFile, TEMP_FILE_RELATIVE_PATH);
         uploadFile(subTempFile, SUB_TEMP_FILE_RELATIVE_PATH);
 
-        root = new AzureBlobVirtualFile(containerName, ROOT_FOLDER_NAME, run);
-        subDir = new AzureBlobVirtualFile(containerName, SUB_FOLDER_RELATIVE_PATH, run);
-        temp = new AzureBlobVirtualFile(containerName, TEMP_FILE_RELATIVE_PATH, run);
-        subTemp = new AzureBlobVirtualFile(containerName, SUB_TEMP_FILE_RELATIVE_PATH, run);
-        missing = new AzureBlobVirtualFile(containerName, "missing", run);
+        root = new AzureBlobVirtualFile(containerName, ROOT_FOLDER_NAME, false, run);
+        subDir = new AzureBlobVirtualFile(containerName, SUB_FOLDER_RELATIVE_PATH, false, run);
+        temp = new AzureBlobVirtualFile(containerName, TEMP_FILE_RELATIVE_PATH, false, run);
+        subTemp = new AzureBlobVirtualFile(containerName, SUB_TEMP_FILE_RELATIVE_PATH, false, run);
+        missing = new AzureBlobVirtualFile(containerName, "missing", false, run);
     }
 
     private void uploadFile(File file, String cloudFileName) {