DHFPROD-6667: Another attempt at GetProjectAsZipTest

Author: rjrudin

marklogic-data-hub/src/test/java/com/marklogic/hub/hubcentral/GetProjectAsZipTest.java

@@ -5,19 +5,11 @@
 import com.marklogic.hub.HubConfig;
 import org.junit.jupiter.api.Test;
 
-import java.io.File;
-import java.io.FileInputStream;
-import java.io.FileOutputStream;
-import java.io.IOException;
-import java.io.InputStream;
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Properties;
-import java.util.Set;
+import java.io.*;
+import java.util.*;
 import java.util.stream.Stream;
 import java.util.zip.ZipEntry;
+import java.util.zip.ZipException;
 import java.util.zip.ZipFile;
 import java.util.zip.ZipInputStream;
 
@@ -36,11 +28,18 @@ public class GetProjectAsZipTest extends AbstractHubCoreTest {
     @Test
     void forbiddenUser() {
         runAsTestUserWithRoles("data-hub-operator");
-        verifyTestUserIsForbiddenTo(()->writeProjectToZipFile(getHubClient()), "A user must have the data-hub-download-project-files privilege");
+        verifyTestUserIsForbiddenTo(() -> {
+                try {
+                    writeProjectToZipFile(getHubClient());
+                } catch (IOException ex) {
+                    throw new RuntimeException(ex);
+                }
+            },
+            "A user must have the data-hub-download-project-files privilege"
+        );
     }
 
     /**
-     *
      * @throws IOException
      */
     @Test
@@ -52,7 +51,7 @@ void permittedUser() throws IOException {
         // Download the project, verify the zip is correct
         runAsTestUserWithRoles("hub-central-downloader");
 
-        writeProjectToZipFile(getHubClient());
+        writeProjectToZipFileWithRetry(getHubClient());
         verifyZipProject();
         project.verifyZipArtifacts();
 
@@ -66,7 +65,7 @@ void permittedUser() throws IOException {
 
         // Verify that downloading returns a zip without artifacts, since the database was cleared of user files
         runAsTestUser();
-        writeProjectToZipFile(getHubClient());
+        writeProjectToZipFileWithRetry(getHubClient());
         verifyZipProject();
         assertEquals(0, project.getHubCentralFilesZipEntries().size(), "The zip should be empty since the project was reset, and thus there are " +
             "no user artifacts to download; zipEntries: " + new AllArtifactsProject(getHubClient()).getHubCentralFilesZipEntries());
@@ -76,24 +75,43 @@ void permittedUser() throws IOException {
         installUserArtifacts();
 
         runAsTestUser();
-        writeProjectToZipFile(getHubClient());
+        writeProjectToZipFileWithRetry(getHubClient());
         verifyZipProject();
         project.verifyZipArtifacts();
     }
 
-    private void writeProjectToZipFile(HubClient hubClient) {
-        try {
-            zipProjectFile = new File("build/allProject.zip");
-            FileOutputStream fos = new FileOutputStream(zipProjectFile);
-            new HubCentralManager().writeProjectFilesAsZip(hubClient, fos);
-            fos.close();
-            project = new AllArtifactsProject(getHubClient());
-            readZipProject();
-            project.readZipArtifacts(new ZipFile(zipProjectFile), Collections.enumeration(artifactZipEntries));
+    /**
+     * Reading the zip after it's written fails intermittently in Jenkins due to the following error:
+     * java.util.zip.ZipException: invalid CEN header (bad signature)
+     * It may be a bug in Java; thus, this method will try multiple times.
+     *
+     * @param hubClient
+     */
+    private void writeProjectToZipFileWithRetry(HubClient hubClient) {
+        final int retryLimit = 10;
+        int attempt = 1;
+        do {
+            try {
+                logger.info("Attempting to write project to and read project from zip file; attempt: " + attempt);
+                writeProjectToZipFile(hubClient);
+                attempt = retryLimit + 1;
+            } catch (ZipException ex) {
+                logger.warn("Caught ZipException: " + ex + "; retrying, attempt: " + attempt);
+                attempt++;
+            } catch (IOException ex) {
+                throw new RuntimeException("Unexpected IOException: " + ex.getMessage(), ex);
+            }
+        } while (attempt <= retryLimit);
+    }
 
-        } catch (IOException e) {
-            throw new RuntimeException(e);
+    private void writeProjectToZipFile(HubClient hubClient) throws IOException {
+        zipProjectFile = new File("build/allProject.zip");
+        try (FileOutputStream fos = new FileOutputStream(zipProjectFile)) {
+            new HubCentralManager().writeProjectFilesAsZip(hubClient, fos);
         }
+        project = new AllArtifactsProject(getHubClient());
+        readZipProject();
+        project.readZipArtifacts(new ZipFile(zipProjectFile), Collections.enumeration(artifactZipEntries));
     }
 
     private void readZipProject() throws IOException {
@@ -104,21 +122,20 @@ private void readZipProject() throws IOException {
         String[] artifactDirs = {"flows", "steps", "entities", "src/main/entity-config", "src/main/ml-config/security/protected-paths",
             "src/main/ml-config/security/query-rolesets"};
 
-        try(ZipInputStream zipIn = new ZipInputStream(new FileInputStream(zipProjectFile))){
+        try (ZipInputStream zipIn = new ZipInputStream(new FileInputStream(zipProjectFile))) {
             ZipEntry entry = zipIn.getNextEntry();
             while (entry != null) {
-                if("gradle.properties".equals(entry.getName())){
+                if ("gradle.properties".equals(entry.getName())) {
                     InputStream input = zip.getInputStream(entry);
                     gradleProps.load(input);
                 }
-                if("gradle-dhs.properties".equals(entry.getName())){
+                if ("gradle-dhs.properties".equals(entry.getName())) {
                     InputStream input = zip.getInputStream(entry);
                     gradleDhsProps.load(input);
                 }
-                if(Stream.of(artifactDirs).anyMatch(entry.getName()::startsWith) && !entry.isDirectory()){
+                if (Stream.of(artifactDirs).anyMatch(entry.getName()::startsWith) && !entry.isDirectory()) {
                     artifactZipEntries.add(entry);
-                }
-                else{
+                } else {
                     zipProjectEntries.add(entry.getName());
                 }
                 zipIn.closeEntry();
@@ -127,7 +144,7 @@ private void readZipProject() throws IOException {
         }
     }
 
-    public void verifyZipProject(){
+    public void verifyZipProject() {
         assertEquals(HubConfig.DEFAULT_STAGING_NAME, gradleProps.getProperty("mlStagingDbName"));
         assertEquals(String.valueOf(HubConfig.DEFAULT_FINAL_PORT), gradleProps.getProperty("mlFinalPort"));
         assertEquals(HubConfig.DEFAULT_JOB_NAME, gradleProps.getProperty("mlJobAppserverName"));