pl.project13.maven.git.FileSystemMavenSandbox.java Source code

Introduction

Here is the source code for pl.project13.maven.git.FileSystemMavenSandbox.java

Source

/*
 * This file is part of git-commit-id-plugin by Konrad Malawski <konrad.malawski@java.pl>
 *
 * git-commit-id-plugin is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * git-commit-id-plugin is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with git-commit-id-plugin.  If not, see <http://www.gnu.org/licenses/>.
 */

package pl.project13.maven.git;

import org.apache.commons.io.FileUtils;
import org.apache.maven.project.MavenProject;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.io.File;
import java.io.IOException;

/**
 * Quick and dirty maven projects tree structure to create on disk during integration tests
 * Can have both parent and child projects set up
 * Copies sample git repository from prototype location to newly created project
 * Has ability to set target project for storing git repository
 *
 * @author mostr
 */
public class FileSystemMavenSandbox {

    private static final String FILE_SEPARATOR = System.getProperty("file.separator");

    private MavenProject childProject;
    private String rootSandboxPath;
    private MavenProject parentProject;

    /**
     * Sample git repository location to use as source in integration tests
     * Test should copy content of this folder to ".git" in correct destination
     */
    private File gitRepoSourceDir;

    @Nullable
    private File gitRepoTargetDir;

    public FileSystemMavenSandbox(String rootSandboxPath) {
        this.rootSandboxPath = rootSandboxPath;
    }

    @NotNull
    public FileSystemMavenSandbox withParentProject(String parentProjectDirName, String packaging) {
        parentProject = createProject(new File(rootSandboxPath + FILE_SEPARATOR + parentProjectDirName), packaging);
        return this;
    }

    @NotNull
    public FileSystemMavenSandbox withNoChildProject() {
        // no-op: marker for better tests readability
        return this;
    }

    @NotNull
    public FileSystemMavenSandbox withChildProject(String childProjectDirName, String packaging) {
        childProject = createProject(new File(parentProject.getBasedir(), childProjectDirName), packaging);
        childProject.setParent(parentProject);
        return this;
    }

    @NotNull
    public FileSystemMavenSandbox withGitRepoInParent(@NotNull AvailableGitTestRepo repo) {
        System.out.println("TEST: Will prepare sandbox repository based on: [" + repo.getDir() + "]");

        gitRepoSourceDir = repo.getDir();
        gitRepoTargetDir = parentProject.getBasedir();
        return this;
    }

    @NotNull
    public FileSystemMavenSandbox withGitRepoInChild(@NotNull AvailableGitTestRepo repo) {
        gitRepoSourceDir = repo.getDir();
        gitRepoTargetDir = childProject.getBasedir();
        return this;
    }

    @NotNull
    public FileSystemMavenSandbox withGitRepoAboveParent(@NotNull AvailableGitTestRepo repo) {
        gitRepoSourceDir = repo.getDir();
        gitRepoTargetDir = new File(rootSandboxPath);
        return this;
    }

    @NotNull
    public FileSystemMavenSandbox withNoGitRepoAvailable() {
        gitRepoTargetDir = null;
        return this;
    }

    @NotNull
    public FileSystemMavenSandbox create(CleanUp cleanupMode) throws RuntimeException {
        try {
            cleanupIfRequired(cleanupMode);
            createParentDir();
            createChildDirIfRequired();
            createGitRepoIfRequired();

            return this;
        } catch (Exception ex) {
            throw new RuntimeException(String.format("Failed creating %s...", getClass().getSimpleName()), ex);
        }
    }

    private void createGitRepoIfRequired() throws IOException {
        if (gitRepoTargetDir != null) {
            FileUtils.copyDirectory(gitRepoSourceDir, new File(gitRepoTargetDir, ".git"));
        }
    }

    private void createParentDir() throws IOException {
        FileUtils.forceMkdir(parentProject.getBasedir());
    }

    private void createChildDirIfRequired() throws IOException {
        if (childProject != null) {
            FileUtils.forceMkdir(childProject.getBasedir());
        }
    }

    private void cleanupIfRequired(CleanUp cleanupMode) throws IOException {
        if (CleanUp.CLEANUP_FIRST == cleanupMode) {
            cleanup();
        }
    }

    public void cleanup() {
        try {
            FileUtils.deleteDirectory(new File(rootSandboxPath));
        } catch (IOException e) {
            System.out.println("Unable to delete the directory: " + rootSandboxPath);
        }
    }

    public MavenProject getParentProject() {
        return parentProject;
    }

    public MavenProject getChildProject() {
        return childProject;
    }

    public File getSandboxDir() {
        return gitRepoTargetDir.getAbsoluteFile();
    }

    @NotNull
    private MavenProject createProject(File basedir, String packaging) {
        MavenProject project = new MavenProject();
        project.setBasedir(basedir);
        project.setPackaging(packaging);
        return project;
    }

    public static enum CleanUp {
        CLEANUP_FIRST, NO_CLEANUP
    }

    @Override
    public String toString() {
        return "FileSystemMavenSandbox{" + "gitRepoTargetDir=" + gitRepoTargetDir + ", gitRepoSourceDir="
                + gitRepoSourceDir + ", rootSandboxPath='" + rootSandboxPath + '\'' + '}';
    }
}