org.ajoberstar.gradle.git.tasks.GitPush.java Source code

Introduction

Here is the source code for org.ajoberstar.gradle.git.tasks.GitPush.java

Source

/*
 * Copyright 2012-2013 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.ajoberstar.gradle.git.tasks;

import groovy.lang.Closure;

import org.ajoberstar.gradle.git.auth.BasicPasswordCredentials;
import org.ajoberstar.gradle.git.auth.TransportAuthUtil;
import org.ajoberstar.gradle.util.ObjectUtil;
import org.eclipse.jgit.api.PushCommand;
import org.gradle.api.GradleException;
import org.gradle.api.artifacts.repositories.AuthenticationSupported;
import org.gradle.api.artifacts.repositories.PasswordCredentials;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.Optional;
import org.gradle.api.tasks.TaskAction;
import org.gradle.util.ConfigureUtil;

/**
 * Task to push changes to a remote repository.
 * @since 0.1.0
 */
public class GitPush extends GitBase implements AuthenticationSupported {
    private PasswordCredentials credentials = new BasicPasswordCredentials();
    private Object remote = null;
    private boolean pushTags = false;
    private boolean pushAll = false;
    private boolean force = false;

    /**
     * Pushes changes to a remote repository.
     */
    @TaskAction
    public void push() {
        PushCommand cmd = getGit().push();
        TransportAuthUtil.configure(cmd, this);
        cmd.setRemote(getRemote());
        if (isPushTags()) {
            cmd.setPushTags();
        }
        if (isPushAll()) {
            cmd.setPushAll();
        }
        cmd.setForce(isForce());
        try {
            cmd.call();
        } catch (Exception e) {
            throw new GradleException("Problem pushing to repository.", e);
        }
        //TODO add progress monitor to go to Gradle status bar
    }

    /**
     * Gets the credentials to use when pushing changes.
     * @return the credentials
     */
    @Input
    @Optional
    public PasswordCredentials getCredentials() {
        return credentials;
    }

    /**
     * Configures the credentials to use when pushing changes.
     * This will be passed a {@link PasswordCredentials} instance.
     * @param closure the configuration closure
     */
    @SuppressWarnings("rawtypes")
    public void credentials(Closure closure) {
        ConfigureUtil.configure(closure, getCredentials());
    }

    /**
     * Sets the credentials to use when pushing changes.
     * @param credentials the credentials
     */
    public void setCredentials(PasswordCredentials credentials) {
        this.credentials = credentials;
    }

    /**
     * Gets the remote to push to. Defaults to "origin".
     * @return the remote to push to
     */
    @Input
    public String getRemote() {
        return remote == null ? "origin" : ObjectUtil.unpackString(remote);
    }

    /**
     * Sets the remote to push to.
     * @param remote the remote to push to
     */
    public void setRemote(Object remote) {
        this.remote = remote;
    }

    /**
     * Gets whether tags will also be pushed.
     * @return whether to push tags
     */
    @Input
    public boolean isPushTags() {
        return pushTags;
    }

    /**
     * Sets whether tags will also be pushed.
     * @param pushTags whether to push tags
     */
    public void setPushTags(boolean pushTags) {
        this.pushTags = pushTags;
    }

    /**
     * Gets whether to push all branches.
     * @return whether to push all branches
     */
    @Input
    public boolean isPushAll() {
        return pushAll;
    }

    /**
     * Sets whether to push all branches.
     * @param pushAll whether to push all branches
     */
    public void setPushAll(boolean pushAll) {
        this.pushAll = pushAll;
    }

    /**
     * Gets whether to force the push.
     * @return whether to force the push
     */
    @Input
    public boolean isForce() {
        return force;
    }

    /**
     * Sets whether to force the push.
     * @param force whether to force the push
     */
    public void setForce(boolean force) {
        this.force = force;
    }
}