/* * The MIT License * * Copyright 2016 Peter Hayes. * * 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 jenkins.plugins.jobcacher; import hudson.EnvVars; import hudson.Extension; import hudson.FilePath; import hudson.Launcher; import hudson.model.AbstractProject; import hudson.model.Run; import hudson.model.TaskListener; import hudson.tasks.BuildWrapperDescriptor; import jenkins.model.Jenkins; import jenkins.plugins.itemstorage.GlobalItemStorage; import jenkins.plugins.itemstorage.ItemStorage; import jenkins.tasks.SimpleBuildWrapper; import org.kohsuke.stapler.DataBoundConstructor; import javax.annotation.Nonnull; import java.io.IOException; import java.util.ArrayList; import java.util.Collections; import java.util.List; /** * This is the entry point for the caching capability when used as a build wrapper. * * @author Peter Hayes */ public class CacheWrapper extends SimpleBuildWrapper { private long maxCacheSize = 0L; private List<Cache> caches = new ArrayList<>(); public CacheWrapper() { } @DataBoundConstructor public CacheWrapper(long maxCacheSize, List<Cache> caches) { this.maxCacheSize = maxCacheSize; this.caches = caches == null ? Collections.EMPTY_LIST : new ArrayList<>(caches); } @SuppressWarnings("unused") public ItemStorage getStorage() { return GlobalItemStorage.get().getStorage(); } @SuppressWarnings("unused") public long getMaxCacheSize() { return maxCacheSize; } @SuppressWarnings("unused") public void setMaxCacheSize(long maxCacheSize) { this.maxCacheSize = maxCacheSize; } public List<Cache> getCaches() { return caches == null ? Collections.EMPTY_LIST : Collections.unmodifiableList(caches); } public void setCaches(List<Cache> caches) { this.caches = caches; } @Override public void setUp(Context context, Run<?, ?> build, FilePath workspace, Launcher launcher, TaskListener listener, EnvVars initialEnvironment) throws IOException, InterruptedException { List<Cache.Saver> cacheSavers = CacheManager.cache(getStorage(), build, workspace, launcher, listener, initialEnvironment, caches); context.setDisposer(new CacheDisposer(getStorage(), maxCacheSize, caches, cacheSavers)); } @Extension @SuppressWarnings("unused") public static final DescriptorImpl DESCRIPTOR = new DescriptorImpl(); public static final class DescriptorImpl extends BuildWrapperDescriptor { @Nonnull @Override public String getDisplayName() { return Messages.CacheWrapper_DisplayName(); } @Override public boolean isApplicable(AbstractProject<?, ?> item) { return true; } @SuppressWarnings("unused") public List<CacheDescriptor> getCacheDescriptors() { Jenkins jenkins = Jenkins.getInstance(); if (jenkins != null) { return jenkins.getDescriptorList(Cache.class); } else { return Collections.emptyList(); } } } private static class CacheDisposer extends Disposer { private ItemStorage storage; private long maxCacheSize; private List<Cache> caches; private List<Cache.Saver> cacheSavers; @DataBoundConstructor public CacheDisposer(ItemStorage storage, long maxCacheSize, List<Cache> caches, List<Cache.Saver> cacheSavers) { this.storage = storage; this.maxCacheSize = maxCacheSize; this.caches = caches; this.cacheSavers = cacheSavers; } @Override public void tearDown(Run<?, ?> build, FilePath workspace, Launcher launcher, TaskListener listener) throws IOException, InterruptedException { CacheManager.save(storage, build, workspace, launcher, listener, maxCacheSize, caches, cacheSavers); } } }