hudson.plugins.git.SubmoduleCombinator Maven / Gradle / Ivy

Go to download
/*
 * The MIT License
 *
 * Copyright (c) 2004-2011, Oracle Corporation, Andrew Bayer, Anton Kozak, Nikita Levyankov
 *
 * 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 hudson.plugins.git;

import hudson.FilePath;
import hudson.model.TaskListener;
import hudson.plugins.git.util.GitUtils;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.eclipse.jgit.lib.ObjectId;

/**
 * A common usecase for git submodules is to have child submodules, and a parent 'configuration' project that ties the
 * correct versions together. It is useful to be able to speculatively compile all combinations of submodules, so that
 * you can _know_ if a particular combination is no longer compatible.
 *
 * @author nigelmagnay
 */
public class SubmoduleCombinator {
    IGitAPI git;
    File workspace;
    TaskListener listener;

    long tid = new Date().getTime();
    long idx = 1;

    Collection submoduleConfig;

    public SubmoduleCombinator(IGitAPI git, TaskListener listener, File workspace,
                               Collection cfg) {
        this.git = git;
        this.listener = listener;

        this.workspace = workspace;
        this.submoduleConfig = cfg;
    }

    public void createSubmoduleCombinations() throws GitException, IOException {
        Map> moduleBranches = new HashMap>();

        for (IndexEntry submodule : git.getSubmodules("HEAD")) {
            File subdir = new File(workspace, submodule.getFile());
            IGitAPI subGit = new GitAPI(git.getGitExe(), new FilePath(subdir), listener, git.getEnvironment());

            try {
                GitUtils gu = new GitUtils(listener, subGit);
                Collection items = gu.filterTipBranches(gu.getAllBranchRevisions());

                filterRevisions(submodule.getFile(), items);

                moduleBranches.put(submodule, items);
            } finally {
                git.close();
            }
        }

        // Remove any uninteresting branches


        for (IndexEntry entry : moduleBranches.keySet()) {
            listener.getLogger().print("Submodule " + entry.getFile() + " branches");
            for (Revision br : moduleBranches.get(entry)) {
                listener.getLogger().print(" " + br.toString());

            }
            listener.getLogger().print("\n");
        }

        // Make all the possible combinations
        List> combinations = createCombinations(moduleBranches);

        listener.getLogger().println("There are " + combinations.size() + " submodule/revision combinations possible");

        // Create a map which is SHA1 -> Submodule IDs that were present
        Map> entriesMap = new HashMap>();
        // Knock out already-defined configurations
        for (ObjectId sha1 : git.revListAll()) {
            // What's the submodule configuration
            List entries = git.getSubmodules(sha1.name());
            entriesMap.put(sha1, entries);

        }

        for (List entries : entriesMap.values()) {
            for (Iterator> it = combinations.iterator(); it.hasNext();) {
                Map item = it.next();
                if (matches(item, entries)) {
                    it.remove();
                    break;
                }

            }
        }

        listener.getLogger().println("There are " + combinations.size() + " configurations that could be generated.");

        ObjectId headSha1 = git.revParse("HEAD");


        // Make up the combinations

        for (Map combination : combinations) {
            // By default, use the head sha1
            ObjectId sha1 = headSha1;
            int min = Integer.MAX_VALUE;

            // But let's see if we can find the most appropriate place to create the branch
            for (ObjectId sha : entriesMap.keySet()) {
                List entries = entriesMap.get(sha);
                int value = difference(combination, entries);
                if (value > 0 && value < min) {
                    min = value;
                    sha1 = sha;
                }

                if (min == 1) {
                    break; // look no further
                }
            }

            git.checkout(sha1.name());
            makeCombination(combination);
        }

    }

    private Collection filterRevisions(String name, Collection items) {
        SubmoduleConfig config = getSubmoduleConfig(name);
        if (config == null) {
            return items;
        }

        for (Iterator it = items.iterator(); it.hasNext();) {
            Revision r = it.next();
            if (!config.revisionMatchesInterest(r)) {
                it.remove();
            }
        }

        return items;
    }

    private SubmoduleConfig getSubmoduleConfig(String name) {
        for (SubmoduleConfig config : this.submoduleConfig) {
            if (config.getSubmoduleName().equals(name)) {
                return config;
            }
        }
        return null;
    }

    protected void makeCombination(Map settings) {
        // Assume we are checked out
        String name = "combine-" + tid + "-" + (idx++);
        git.branch(name);
        git.checkout(name);

        String commit = "Hudson generated combination of:\n";

        for (IndexEntry submodule : settings.keySet()) {
            Revision branch = settings.get(submodule);
            commit += "  " + submodule.getFile() + " " + branch.toString() + "\n";
        }

        listener.getLogger().print(commit);


        for (IndexEntry submodule : settings.keySet()) {
            Revision branch = settings.get(submodule);
            File subdir = new File(workspace, submodule.getFile());
            IGitAPI subGit = new GitAPI(git.getGitExe(), new FilePath(subdir), listener, git.getEnvironment());

            try {
                subGit.checkout(branch.sha1.name());
                git.add(submodule.file);
            } finally {
                subGit.close();
            }

        }

        git.commit(commit);

    }

    public int difference(Map item, List entries) {
        int difference = 0;
        if (entries.size() != item.keySet().size()) {
            return -1;
        }

        for (IndexEntry entry : entries) {
            Revision b = null;
            for (IndexEntry e : item.keySet()) {
                if (e.getFile().equals(entry.getFile())) {
                    b = item.get(e);
                }
            }

            if (b == null) {
                return -1;
            }

            if (!entry.object.equals(b.getSha1())) {
                difference++;
            }

        }
        return difference;
    }

    protected boolean matches(Map item, List entries) {
        return (difference(item, entries) == 0);
    }

    public List> createCombinations(Map> moduleBranches) {

        if (moduleBranches.keySet().size() == 0) {
            return new ArrayList>();
        }

        // Get an entry:
        List> thisLevel = new ArrayList>();

        IndexEntry e = moduleBranches.keySet().iterator().next();

        for (Revision b : moduleBranches.remove(e)) {
            Map result = new HashMap();

            result.put(e, b);
            thisLevel.add(result);
        }

        List> children = createCombinations(moduleBranches);
        if (children.size() == 0) {
            return thisLevel;
        }

        // Merge the two together
        List> result = new ArrayList>();

        for (Map thisLevelEntry : thisLevel) {

            for (Map childLevelEntry : children) {
                HashMap r = new HashMap();
                r.putAll(thisLevelEntry);
                r.putAll(childLevelEntry);
                result.add(r);
            }

        }

        return result;
    }
}