Skip to content

Enhance release artifact handling andimproved ZIP validation #668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stijnpotters1 merged 2 commits into from
Jul 27, 2026
Merged

Enhance release artifact handling andimproved ZIP validation #668

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3ecaece
fix: enhance release artifact handling with improved ZIP validation a…
stijnpotters1 Jul 21, 2026
3a1494b
chore: solved sonar linting warnings
stijnpotters1 Jul 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 51 additions & 16 deletions src/main/java/org/frankframework/insights/release/ReleaseArtifactService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import java.io.InputStream;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.file.AtomicMoveNotSupportedException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
Expand All @@ -12,6 +13,7 @@
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import java.util.zip.ZipFile;
import lombok.extern.slf4j.Slf4j;
import org.frankframework.insights.common.util.TagNameSanitizer;
import org.frankframework.insights.release.releasecleanup.FileTreeDeleter;
Expand Down Expand Up @@ -44,24 +46,56 @@ public Path downloadReleaseZipToPvc(String tagName) throws IOException {
Path zipPath = archiveDir.resolve(safeFileName);

if (Files.exists(zipPath)) {
return zipPath;
if (isValidZip(zipPath)) {
return zipPath;
}
log.warn(
"Cached ZIP for {} is corrupt (likely a truncated download), re-downloading: {}", tagName, zipPath);
Files.deleteIfExists(zipPath);
}

log.info("ZIP not found op storage, downloading: {}", tagName);
String url = String.format(GITHUB_ZIP_URL_FORMAT, tagName);
try (InputStream in = new URI(url).toURL().openStream()) {
Files.copy(in, zipPath, StandardCopyOption.REPLACE_EXISTING);
Path tempZipPath = archiveDir.resolve(safeFileName + ".tmp");
try (InputStream in = openDownloadStream(url)) {
Files.copy(in, tempZipPath, StandardCopyOption.REPLACE_EXISTING);

if (!isValidZip(tempZipPath)) {
throw new IOException("Downloaded ZIP for " + tagName + " is not a valid archive");
}

moveIntoPlace(tempZipPath, zipPath);
log.info("ZIP succesfully downloading to storage: {}", zipPath);
} catch (IOException | URISyntaxException e) {
try {
Files.deleteIfExists(zipPath);
Files.deleteIfExists(tempZipPath);
} catch (IOException ignored) {
}
throw new IOException("Could not download release ZIP for " + tagName, e);
}
return zipPath;
}

private void moveIntoPlace(Path tempZipPath, Path zipPath) throws IOException {
try {
Files.move(tempZipPath, zipPath, StandardCopyOption.REPLACE_EXISTING, StandardCopyOption.ATOMIC_MOVE);
} catch (AtomicMoveNotSupportedException _) {
Files.move(tempZipPath, zipPath, StandardCopyOption.REPLACE_EXISTING);
}
}

protected InputStream openDownloadStream(String url) throws IOException, URISyntaxException {
return new URI(url).toURL().openStream();
}

protected boolean isValidZip(Path path) {
try (ZipFile _ = new ZipFile(path.toFile())) {
return true;
} catch (IOException _) {
return false;
}
}

public void deleteObsoleteReleaseArtifacts() {
List<Release> allReleases = releaseRepository.findAll();
Set<String> activeReleaseTags =
Expand All @@ -73,18 +107,19 @@ public void deleteObsoleteReleaseArtifacts() {
try (Stream<Path> files = Files.list(dir)) {
files.forEach(path -> {
String fileName = path.getFileName().toString();
if (fileName.endsWith(".zip")) {
String tagName = fileName.replace(".zip", "");
if (!activeReleaseTags.contains(tagName)) {
try {
log.info("Deletion of obsolete release artifact: {}", fileName);
fileTreeDeleter.deleteTreeRecursively(path);
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
log.error("Interrupted while deleting file: {}", fileName, e);
} catch (Exception e) {
log.error("Could not delete file: {}", fileName, e);
}
boolean isOrphanedTempFile = fileName.endsWith(".tmp");
boolean isObsoleteZip =
fileName.endsWith(".zip") && !activeReleaseTags.contains(fileName.replace(".zip", ""));

if (isOrphanedTempFile || isObsoleteZip) {
try {
log.info("Deletion of obsolete release artifact: {}", fileName);
fileTreeDeleter.deleteTreeRecursively(path);
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
log.error("Interrupted while deleting file: {}", fileName, e);
} catch (Exception e) {
log.error("Could not delete file: {}", fileName, e);
}
}
});
Expand Down
84 changes: 83 additions & 1 deletion src/test/java/org/frankframework/insights/release/ReleaseArtifactServiceIntegrationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,28 @@

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.when;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URISyntaxException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import java.util.zip.ZipEntry;
import java.util.zip.ZipOutputStream;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.junit.jupiter.api.io.TempDir;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.junit.jupiter.MockitoExtension;

/**
Expand All @@ -32,7 +42,7 @@ public class ReleaseArtifactServiceIntegrationTest {

@BeforeEach
public void setUp() {
releaseArtifactService = new ReleaseArtifactService(tempDir.toString(), releaseRepository);
releaseArtifactService = Mockito.spy(new ReleaseArtifactService(tempDir.toString(), releaseRepository));
}

private Release createRelease(String name, String tagName) {
Expand All @@ -42,6 +52,78 @@ private Release createRelease(String name, String tagName) {
return release;
}

private byte[] createValidZipBytes() throws IOException {
ByteArrayOutputStream baos = new ByteArrayOutputStream();
try (ZipOutputStream zos = new ZipOutputStream(baos)) {
zos.putNextEntry(new ZipEntry("test.txt"));
zos.write("hello world".getBytes());
zos.closeEntry();
}
return baos.toByteArray();
}

@Test
public void downloadReleaseZipToPvc_whenCorruptFileInCache_shouldRedownloadAndReplace() throws Exception {
String tagName = "v8.0.5";
Path corruptZip = tempDir.resolve("v8.0.5.zip");
Files.writeString(corruptZip, "this is not a zip file");

InputStream mockStream = new ByteArrayInputStream(createValidZipBytes());
doReturn(mockStream).when(releaseArtifactService).openDownloadStream(any());

Path downloaded = releaseArtifactService.downloadReleaseZipToPvc(tagName);

assertTrue(Files.exists(downloaded), "Downloaded zip should exist");
assertTrue(releaseArtifactService.isValidZip(downloaded), "Re-downloaded zip should be valid");
assertFalse(
Files.exists(tempDir.resolve("v8.0.5.zip.tmp")), "Temp file should not remain after a successful move");
}

@Test
public void downloadReleaseZipToPvc_whenDownloadIsCorrupt_shouldThrowAndCleanUpTempFile() throws Exception {
String tagName = "v8.0.6";
Path zip = tempDir.resolve("v8.0.6.zip");
Path tempZip = tempDir.resolve("v8.0.6.zip.tmp");

InputStream corruptStream = new ByteArrayInputStream("bad download".getBytes());
doReturn(corruptStream).when(releaseArtifactService).openDownloadStream(any());

assertThrows(IOException.class, () -> releaseArtifactService.downloadReleaseZipToPvc(tagName));

assertFalse(Files.exists(tempZip), "Temporary download file should be cleaned up on failure");
assertFalse(Files.exists(zip), "Invalid download should never be cached under its final name");
}

@Test
public void deleteObsoleteReleaseArtifacts_whenOrphanedTempFilesExist_shouldDeleteThem() throws IOException {
Path orphanedTemp = tempDir.resolve("v8.0.5.zip.tmp");
Path validZip = tempDir.resolve("v8.0.0.zip");

Files.writeString(orphanedTemp, "leftover temp");
Files.writeString(validZip, "valid zip content");

Release validRelease = createRelease("8.0.0", "v8.0.0");
when(releaseRepository.findAll()).thenReturn(List.of(validRelease));

releaseArtifactService.deleteObsoleteReleaseArtifacts();

assertFalse(Files.exists(orphanedTemp), "Orphaned temp file should be deleted");
assertTrue(Files.exists(validZip), "Valid active zip should still exist");
}

@Test
public void downloadReleaseZipToPvc_whenValidZipAlreadyCached_shouldReturnItWithoutDownloading()
throws IOException, URISyntaxException {
String tagName = "v8.1.0";
Path zipPath = tempDir.resolve("v8.1.0.zip");
Files.write(zipPath, createValidZipBytes());

Path result = releaseArtifactService.downloadReleaseZipToPvc(tagName);

assertEquals(zipPath, result);
Mockito.verify(releaseArtifactService, Mockito.never()).openDownloadStream(any());
}

@Test
public void deleteObsoleteReleaseArtifacts_whenObsoleteZipsExist_shouldDeleteThem() throws IOException {
Path validZip = tempDir.resolve("v8.0.0.zip");
Expand Down
Loading
Loading