com.atlassian.jgitflow.core.JGitFlow Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jgit-flow-core Show documentation
The core java library implementing git flow
The newest version!
package com.atlassian.jgitflow.core;

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

import com.atlassian.jgitflow.core.exception.AlreadyInitializedException;
import com.atlassian.jgitflow.core.exception.JGitFlowGitAPIException;
import com.atlassian.jgitflow.core.exception.JGitFlowIOException;
import com.atlassian.jgitflow.core.exception.SameBranchException;

import org.eclipse.jgit.api.Git;
import org.eclipse.jgit.lib.RepositoryBuilder;

/**
 * Offers a Git Flow API to interact with a git repository.
 * 
 * This class only offers methods to construct so-called command classes. Each
 * command is represented by one command class.

 * Example: this class offers a {@code featureStart} method returning an instance of
 * the {@code FeatureStartCommand} class. The {@code FeatureStartCommand} class has setters
 * for all the arguments and options. The {@code FeatureStartCommand} class also has a
 * {@code call} method to actually execute the command. 
 * 

 * All mandatory parameters for commands have to be specified in the methods of
 * this class, the optional parameters have to be specified by the
 * setter-methods of the Command class.
 */
public class JGitFlow
{
    private Git git;
    private GitFlowConfiguration gfConfig;
    private JGitFlowReporter reporter;
    
    private JGitFlow()
    {
    }

    JGitFlow(Git git, GitFlowConfiguration gfConfig, JGitFlowReporter reporter)
    {
        this.git = git;
        this.gfConfig = gfConfig;
        this.reporter = reporter;

        this.reporter.setGitFlowConfiguration(git,gfConfig);
    }

    /**
     * Initializes a project for use with git flow and returns a JGitFlow instance.
     * 

     *     This method will throw exceptions if the project has already been initialized
     * 
     * @param projectDir
     * @return
     * @throws JGitFlowIOException
     * @throws AlreadyInitializedException
     * @throws SameBranchException
     * @throws JGitFlowGitAPIException
     */
    public static JGitFlow init(File projectDir) throws JGitFlowIOException, AlreadyInitializedException, SameBranchException, JGitFlowGitAPIException
    {
        JGitFlowInitCommand initCommand = new JGitFlowInitCommand();
        return initCommand.setDirectory(projectDir).call();
    }

    /**
     * Initializes a project for use with git flow and returns a JGitFlow instance.
     * 
     *     This method will throw exceptions if the project has already been initialized
     * 
     * @param projectDir
     * @return
     * @throws JGitFlowIOException
     * @throws AlreadyInitializedException
     * @throws SameBranchException
     * @throws JGitFlowGitAPIException
     */
    public static JGitFlow init(File projectDir, String defaultOriginUrl) throws JGitFlowIOException, AlreadyInitializedException, SameBranchException, JGitFlowGitAPIException
    {
        JGitFlowInitCommand initCommand = new JGitFlowInitCommand();
        return initCommand.setDirectory(projectDir).setDefaultOriginUrl(defaultOriginUrl).call();
    }

    /**
     * Initializes a project for use with git flow using a custom context and returns a JGitFlow instance.
     * 
     *     This method will throw exceptions if the project has already been initialized
     * 
     * @param projectDir
     * @param context
     * @return
     * @throws JGitFlowIOException
     * @throws AlreadyInitializedException
     * @throws SameBranchException
     * @throws JGitFlowGitAPIException
     */
    public static JGitFlow init(File projectDir, InitContext context) throws JGitFlowIOException, AlreadyInitializedException, SameBranchException, JGitFlowGitAPIException
    {
        JGitFlowInitCommand initCommand = new JGitFlowInitCommand();
        return initCommand.setDirectory(projectDir).setInitContext(context).call();
    }

    /**
     * Initializes a project for use with git flow using a custom context and returns a JGitFlow instance.
     * 
     *     This method will throw exceptions if the project has already been initialized
     * 
     * @param projectDir
     * @param context
     * @return
     * @throws JGitFlowIOException
     * @throws AlreadyInitializedException
     * @throws SameBranchException
     * @throws JGitFlowGitAPIException
     */
    public static JGitFlow init(File projectDir, InitContext context, String defaultOriginUrl) throws JGitFlowIOException, AlreadyInitializedException, SameBranchException, JGitFlowGitAPIException
    {
        JGitFlowInitCommand initCommand = new JGitFlowInitCommand();
        return initCommand.setDirectory(projectDir).setDefaultOriginUrl(defaultOriginUrl).setInitContext(context).call();
    }

    /**
     * Initializes a project for use with git flow using a default context overriding any existing configuration.
     * @param projectDir
     * @return
     * @throws JGitFlowIOException
     * @throws AlreadyInitializedException
     * @throws SameBranchException
     * @throws JGitFlowGitAPIException
     */
    public static JGitFlow forceInit(File projectDir) throws JGitFlowIOException, AlreadyInitializedException, SameBranchException, JGitFlowGitAPIException
    {
        JGitFlowInitCommand initCommand = new JGitFlowInitCommand();
        return initCommand.setDirectory(projectDir).setForce(true).call();
    }

    /**
     * Initializes a project for use with git flow using a default context overriding any existing configuration.
     * @param projectDir
     * @return
     * @throws JGitFlowIOException
     * @throws AlreadyInitializedException
     * @throws SameBranchException
     * @throws JGitFlowGitAPIException
     */
    public static JGitFlow forceInit(File projectDir, String defaultOriginUrl) throws JGitFlowIOException, AlreadyInitializedException, SameBranchException, JGitFlowGitAPIException
    {
        JGitFlowInitCommand initCommand = new JGitFlowInitCommand();
        return initCommand.setDirectory(projectDir).setDefaultOriginUrl(defaultOriginUrl).setForce(true).call();
    }

    /**
     * Initializes a project for use with git flow using a custom context overriding any existing configuration.
     * @param projectDir
     * @param context
     * @return
     * @throws JGitFlowIOException
     * @throws AlreadyInitializedException
     * @throws SameBranchException
     * @throws JGitFlowGitAPIException
     */
    public static JGitFlow forceInit(File projectDir, InitContext context) throws JGitFlowIOException, AlreadyInitializedException, SameBranchException, JGitFlowGitAPIException
    {
        JGitFlowInitCommand initCommand = new JGitFlowInitCommand();
        return initCommand.setDirectory(projectDir).setForce(true).setInitContext(context).call();
    }

    /**
     * Initializes a project for use with git flow using a custom context overriding any existing configuration.
     * @param projectDir
     * @param context
     * @return
     * @throws JGitFlowIOException
     * @throws AlreadyInitializedException
     * @throws SameBranchException
     * @throws JGitFlowGitAPIException
     */
    public static JGitFlow forceInit(File projectDir, InitContext context, String defaultOriginUrl) throws JGitFlowIOException, AlreadyInitializedException, SameBranchException, JGitFlowGitAPIException
    {
        JGitFlowInitCommand initCommand = new JGitFlowInitCommand();
        return initCommand.setDirectory(projectDir).setDefaultOriginUrl(defaultOriginUrl).setForce(true).setInitContext(context).call();
    }

    /**
     * Gets an existing git flow project and returns a JGitFlow instance
     * @param projectDir
     * @return
     * @throws JGitFlowIOException
     */
    public static JGitFlow get(File projectDir) throws JGitFlowIOException
    {
        try
        {
            RepositoryBuilder rb = new RepositoryBuilder()
                    .readEnvironment()
                    .findGitDir(projectDir);

            File gitDir = rb.getGitDir();
            Git gitRepo = Git.open(gitDir);
            GitFlowConfiguration gfConfig = new GitFlowConfiguration(gitRepo);

            return new JGitFlow(gitRepo, gfConfig, new JGitFlowReporter());
        }
        catch (IOException e)
        {
            throw new JGitFlowIOException(e);
        }
    }

    /**
     * Initializes a project for use with git flow or gets an existing project and returns a JGitFlow instance.
     * @param projectDir
     * @return
     * @throws JGitFlowIOException
     * @throws AlreadyInitializedException
     * @throws SameBranchException
     * @throws JGitFlowGitAPIException
     */
    public static JGitFlow getOrInit(File projectDir) throws JGitFlowIOException, AlreadyInitializedException, SameBranchException, JGitFlowGitAPIException
    {
        if (isInitialized(projectDir))
        {
            return get(projectDir);
        }
        else
        {
            return init(projectDir);
        }
    }

    /**
     * Initializes a project for use with git flow or gets an existing project and returns a JGitFlow instance.
     * @param projectDir
     * @return
     * @throws JGitFlowIOException
     * @throws AlreadyInitializedException
     * @throws SameBranchException
     * @throws JGitFlowGitAPIException
     */
    public static JGitFlow getOrInit(File projectDir, String defaultOriginUrl) throws JGitFlowIOException, AlreadyInitializedException, SameBranchException, JGitFlowGitAPIException
    {
        if (isInitialized(projectDir))
        {
            return get(projectDir);
        }
        else
        {
            return init(projectDir,defaultOriginUrl);
        }
    }

    /**
     * Initializes a project for use with git flow using a custom context or gets an existing project and returns a JGitFlow instance.
     * @param projectDir
     * @param ctx
     * @return
     * @throws JGitFlowIOException
     * @throws AlreadyInitializedException
     * @throws SameBranchException
     * @throws JGitFlowGitAPIException
     */
    public static JGitFlow getOrInit(File projectDir, InitContext ctx) throws JGitFlowIOException, AlreadyInitializedException, SameBranchException, JGitFlowGitAPIException
    {
        if (isInitialized(projectDir))
        {
            return get(projectDir);
        }
        else
        {
            return init(projectDir, ctx);
        }
    }
    
    /**
     * Initializes a project for use with git flow using a custom context or gets an existing project and returns a JGitFlow instance.
     * @param projectDir
     * @param ctx
     * @return
     * @throws JGitFlowIOException
     * @throws AlreadyInitializedException
     * @throws SameBranchException
     * @throws JGitFlowGitAPIException
     */
    public static JGitFlow getOrInit(File projectDir, InitContext ctx, String defaultOriginUrl) throws JGitFlowIOException, AlreadyInitializedException, SameBranchException, JGitFlowGitAPIException
    {
        if (isInitialized(projectDir))
        {
            return get(projectDir);
        }
        else
        {
            return init(projectDir, ctx, defaultOriginUrl);
        }
    }
    

    /**
     * Tests whether a project folder is git flow enabled
     * @param dir
     * @return
     */
    public static boolean isInitialized(File dir)
    {
        boolean inited = false;
        try
        {
            RepositoryBuilder rb = new RepositoryBuilder()
                    .readEnvironment()
                    .findGitDir(dir);
            
            File gitDir = rb.getGitDir();
            if (gitDir != null)
            {
                Git gitRepo = Git.open(gitDir);
                GitFlowConfiguration gfConfig = new GitFlowConfiguration(gitRepo);
                inited = gfConfig.gitFlowIsInitialized();
            }
            
        }
        catch (IOException e)
        {
            //ignore
        }
        catch (JGitFlowGitAPIException e)
        {
            //ignore
        }

        return inited;
    }

    /**
     * Tests whether the current project is git flow enabled
     * @return
     */
    public boolean isInitialized()
    {
        boolean inited = false;
        try
        {
            inited = gfConfig.gitFlowIsInitialized();
        }
        catch (JGitFlowGitAPIException e)
        {
            //ignore
        }

        return inited;
    }

    /**
     * Returns a command object to start a feature
     * @param name
     * @return a {@link FeatureStartCommand}
     */
    public FeatureStartCommand featureStart(String name)
    {
        return new FeatureStartCommand(name, git, gfConfig, reporter);
    }

    /**
     * Returns a command object to finish a feature
     * @param name
     * @return a {@link FeatureFinishCommand}
     */
    public FeatureFinishCommand featureFinish(String name)
    {
        return new FeatureFinishCommand(name, git, gfConfig, reporter);
    }

    /**
     * Returns a command object to publish a feature
     * @param name
     * @return a {@link FeaturePublishCommand}
     */
    public FeaturePublishCommand featurePublish(String name)
    {
        return new FeaturePublishCommand(name, git, gfConfig, reporter);
    }

    /**
     * Returns a command object to start a release
     * @param name
     * @return a {@link ReleaseStartCommand}
     */
    public ReleaseStartCommand releaseStart(String name)
    {
        return new ReleaseStartCommand(name, git, gfConfig, reporter);
    }

    /**
     * Returns a command object to finish a release
     * @param name
     * @return a {@link ReleaseFinishCommand}
     */
    public ReleaseFinishCommand releaseFinish(String name)
    {
        return new ReleaseFinishCommand(name, git, gfConfig, reporter);
    }

    /**
     * Returns a command object to publish a release
     *
     * @param name
     * @return a {@link ReleasePublishCommand}
     */
    public ReleasePublishCommand releasePublish(String name)
    {
        return new ReleasePublishCommand(name, git, gfConfig, reporter);
    }

    /**
     * Returns a command object to start a hotfix
     * @param name
     * @return a {@link HotfixStartCommand}
     */
    public HotfixStartCommand hotfixStart(String name)
    {
        return new HotfixStartCommand(name, git, gfConfig, reporter);
    }

    /**
     * Returns a command object to finish a hotfix
     * @param name
     * @return a {@link HotfixFinishCommand}
     */
    public HotfixFinishCommand hotfixFinish(String name)
    {
        return new HotfixFinishCommand(name, git, gfConfig, reporter);
    }

    /**
     * Returns a command object to publish a hotfix
     *
     * @param name
     * @return a {@link HotfixPublishCommand}
     */
    public HotfixPublishCommand hotfixPublish(String name)
    {
        return new HotfixPublishCommand(name, git, gfConfig, reporter);
    }

    /**
     * Returns the {@link Git} instance used by this JGitFlow instance
     * @return
     */
    public Git git()
    {
        return git;
    }

    /**
     * Returns the master branch name configured for this instance's git flow project
     * @return
     */
    public String getMasterBranchName()
    {
        return gfConfig.getMaster();
    }

    /**
     * Returns the develop branch name configured for this instance's git flow project
     * @return
     */
    public String getDevelopBranchName()
    {
        return gfConfig.getDevelop();
    }

    /**
     * Returns the feature branch prefix configured for this instance's git flow project
     * @return
     */
    public String getFeatureBranchPrefix()
    {
        return gfConfig.getPrefixValue(JGitFlowConstants.PREFIXES.FEATURE.configKey());
    }

    /**
     * Returns the release branch prefix configured for this instance's git flow project
     * @return
     */
    public String getReleaseBranchPrefix()
    {
        return gfConfig.getPrefixValue(JGitFlowConstants.PREFIXES.RELEASE.configKey());
    }

    /**
     * Returns the hotfix branch prefix configured for this instance's git flow project
     * @return
     */
    public String getHotfixBranchPrefix()
    {
        return gfConfig.getPrefixValue(JGitFlowConstants.PREFIXES.HOTFIX.configKey());
    }

    public String getSupportBranchPrefix()
    {
        return gfConfig.getPrefixValue(JGitFlowConstants.PREFIXES.SUPPORT.configKey());
    }

    /**
     * Returns the versiontag prefix configured for this instance's git flow project
     * @return
     */
    public String getVersionTagPrefix()
    {
        return gfConfig.getPrefixValue(JGitFlowConstants.PREFIXES.VERSIONTAG.configKey());
    }

    public JGitFlowReporter getReporter()
    {
        return reporter;
    }
}