Skip to content
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

Jump to bottom

Log used cacheValidityDecidingFile(s) and hash #290

Merged
merged 1 commit into from
Apr 17, 2024
Merged

Log used cacheValidityDecidingFile(s) and hash #290

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 22 additions & 9 deletions src/main/java/jenkins/plugins/jobcacher/ArbitraryFileCache.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,9 @@
import java.security.NoSuchAlgorithmException;
import java.time.Duration;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;
import java.util.zip.Deflater;

/**
Expand Down Expand Up @@ -265,7 +267,7 @@ private boolean isCacheOutdated(ObjectPath cachesRoot, FilePath workspace, TaskL
return true;
}

if (!matchesCurrentCacheValidityDecidingFileHash(previousClearCacheTriggerFileHash, workspace)) {
if (!matchesCurrentCacheValidityDecidingFileHash(previousClearCacheTriggerFileHash, workspace, listener)) {
logMessage("cacheValidityDecidingFile configured, but previous hash does not match - cache outdated", listener);
return true;
}
Expand All @@ -287,7 +289,7 @@ private String createCacheValidityDecidingFileHashFileName(String baseName) {
return baseName + CACHE_VALIDITY_DECIDING_FILE_HASH_FILE_EXTENSION;
}

private boolean matchesCurrentCacheValidityDecidingFileHash(ObjectPath previousCacheValidityDecidingFileHashFile, FilePath workspace) throws IOException, InterruptedException {
private boolean matchesCurrentCacheValidityDecidingFileHash(ObjectPath previousCacheValidityDecidingFileHashFile, FilePath workspace, TaskListener listener) throws IOException, InterruptedException {
if (!isOneCacheValidityDecidingFilePresent(workspace)) {
return false;
}
Expand All @@ -297,33 +299,44 @@ private boolean matchesCurrentCacheValidityDecidingFileHash(ObjectPath previousC

try (InputStream inputStream = tempFile.get().read()) {
String previousCacheValidityDecidingFileHash = IOUtils.toString(inputStream, StandardCharsets.UTF_8);
String currentCacheValidityDecidingFileHash = getCurrentCacheValidityDecidingFileHash(workspace);
String currentCacheValidityDecidingFileHash = getCurrentCacheValidityDecidingFileHash(workspace, listener);

return StringUtils.equals(previousCacheValidityDecidingFileHash, currentCacheValidityDecidingFileHash);
}
}
}

private String getCurrentCacheValidityDecidingFileHash(FilePath workspace) throws IOException, InterruptedException {
private String getCurrentCacheValidityDecidingFileHash(FilePath workspace, TaskListener listener) throws IOException, InterruptedException {
if (!isOneCacheValidityDecidingFilePresent(workspace)) {
throw new IllegalStateException("path " + cacheValidityDecidingFile + " cannot be resolved within the current workspace");
}

try {
MessageDigest messageDigest = MessageDigest.getInstance(CACHE_VALIDITY_DECIDING_FILE_DIGEST_ALGORITHM);
for (FilePath cacheValidityDecidingFile : resolveCacheValidityDecidingFiles(workspace)) {

FilePath[] cacheValidityDecidingFiles = resolveCacheValidityDecidingFiles(workspace);
for (FilePath cacheValidityDecidingFile : cacheValidityDecidingFiles) {
try (InputStream inputStream = cacheValidityDecidingFile.read()) {
DigestInputStream digestInputStream = new DigestInputStream(inputStream, messageDigest);
IOUtils.copy(digestInputStream, NullOutputStream.NULL_OUTPUT_STREAM);
}
}

return Util.toHexString(messageDigest.digest());
String hash = Util.toHexString(messageDigest.digest());
logMessage("got hash " + hash + " for cacheValidityDecidingFile(s) - actual file(s): " + joinAsRelativePaths(cacheValidityDecidingFiles), listener);

return hash;
} catch (NoSuchAlgorithmException e) {
throw new IOException(e);
}
}

private String joinAsRelativePaths(FilePath[] cacheValidityDecidingFiles) {
return Arrays.stream(cacheValidityDecidingFiles)
.map(FilePath::getRemote)
.collect(Collectors.joining(", "));
}

private boolean isOneCacheValidityDecidingFilePresent(FilePath workspace) throws IOException, InterruptedException {
return resolveCacheValidityDecidingFiles(workspace).length > 0;
}
Expand Down Expand Up @@ -390,7 +403,7 @@ public void save(ObjectPath cachesRoot, Run<?, ?> build, FilePath workspace, Lau
try {
compressionMethod.getCacheStrategy().cache(resolvedPath, includes, excludes, useDefaultExcludes, cache, workspace);
if (isCacheValidityDecidingFileConfigured() && isOneCacheValidityDecidingFilePresent(workspace)) {
updateSkipCacheTriggerFileHash(cachesRoot, workspace);
updateSkipCacheTriggerFileHash(cachesRoot, workspace, listener);
}
long cacheCreationEndTime = System.nanoTime();
logMessage("Cache created in " + Duration.ofNanos(cacheCreationEndTime - cacheCreationStartTime).toMillis() + "ms", listener);
Expand All @@ -407,9 +420,9 @@ private boolean isMaybeInsideDockerContainer(FilePath workspace) {
return workspace.getChannel() == null || workspace.getChannel() instanceof LocalChannel;
}

private void updateSkipCacheTriggerFileHash(ObjectPath cachesRoot, FilePath workspace) throws IOException, InterruptedException {
private void updateSkipCacheTriggerFileHash(ObjectPath cachesRoot, FilePath workspace, TaskListener listener) throws IOException, InterruptedException {
try (TempFile tempFile = WorkspaceHelper.createTempFile(workspace, CACHE_VALIDITY_DECIDING_FILE_HASH_FILE_EXTENSION)) {
tempFile.get().write(getCurrentCacheValidityDecidingFileHash(workspace), StandardCharsets.UTF_8.displayName());
tempFile.get().write(getCurrentCacheValidityDecidingFileHash(workspace, listener), StandardCharsets.UTF_8.displayName());

ObjectPath skipCacheTriggerFileHashFile = cachesRoot.child(getSkipCacheTriggerFileHashFileName());
skipCacheTriggerFileHashFile.copyFrom(tempFile.get());
Expand Down