io.jenkins.updatebot.commands.CommandContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of updatebot-core Show documentation
There is a newer version: 1.1.7
/*
 * Copyright 2016 Red Hat, Inc.
 *
 * Red Hat licenses this file to you 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 io.jenkins.updatebot.commands;

import io.fabric8.utils.Strings;
import io.jenkins.updatebot.Configuration;
import io.jenkins.updatebot.git.GitPlugin;
import io.jenkins.updatebot.github.GitHubHelpers;
import io.jenkins.updatebot.kind.Kind;
import io.jenkins.updatebot.model.DependencyVersionChange;
import io.jenkins.updatebot.repository.LocalRepository;
import io.jenkins.updatebot.support.Markdown;
import org.kohsuke.github.GHIssue;
import org.kohsuke.github.GHPullRequest;
import org.kohsuke.github.GHRepository;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import java.util.TreeSet;

/**
 */
public class CommandContext {
    private static final transient Logger LOG = LoggerFactory.getLogger(CommandContext.class);

    private final LocalRepository repository;
    private final Configuration configuration;
    private final Set updatedFiles = new TreeSet<>();
    private final CommandContext parentContext;
    private List children = new ArrayList<>();
    private GHIssue issue;
    private GHPullRequest pullRequest;
    private Status status = Status.PENDING;

    public CommandContext(LocalRepository repository, Configuration configuration) {
        this.repository = repository;
        this.configuration = configuration;
        this.parentContext = null;
    }

    public CommandContext(CommandContext parentContext) {
        this.repository = parentContext.getRepository();
        this.configuration = parentContext.getConfiguration();
        this.parentContext = parentContext;
        this.parentContext.addChild(this);
    }

    public Configuration getConfiguration() {
        return configuration;
    }

    public CommandContext getParentContext() {
        return parentContext;
    }

    public List getChildren() {
        return children;
    }

    public LocalRepository getRepository() {
        return repository;
    }


    public GHIssue getIssue() {
        return issue;
    }

    public void setIssue(GHIssue issue) {
        this.issue = issue;
    }

    public GHPullRequest getPullRequest() {
        return pullRequest;
    }

    public void setPullRequest(GHPullRequest pullRequest) {
        this.pullRequest = pullRequest;
    }

    public String getRepositoryFullName() {
        return repository.getRepo().getFullName();
    }

    public Status getStatus() {
        return status;
    }

    public void setStatus(Status status) {
        this.status = status;
    }

    /**
     * Returns true if one or more files have been updated
     */
    public boolean isUpdated() {
        return updatedFiles.size() > 0;
    }

    public Set getUpdatedFiles() {
        return updatedFiles;
    }


    public String getCloneUrl() {
        return repository.getCloneUrl();
    }

    public File getDir() {
        return repository.getDir();
    }

    /**
     * Returns the underlying github repository or null if its not a github repo
     */
    public GHRepository gitHubRepository() {
        return GitHubHelpers.getGitHubRepository(repository);
    }

    /**
     * Returns the relative file path within the local repo
     */
    public File file(String relativePath) {
        return new File(repository.getDir(), relativePath);
    }

    public void updatedFile(File file) {
        updatedFiles.add(file);
    }

    public GitPlugin getGit() {
        return getConfiguration().getGit();
    }

    // TODO inline or remove?? should use the Command rather than context?
    public PushVersionChangesContext updateVersion(Kind kind, String name, String version) {
        return new PushVersionChangesContext(this, new DependencyVersionChange(kind, name, version));
    }

    public String createPullRequestTitle() {
        CommandContext child = firstChild();
        if (child != null) {
            return child.createPullRequestTitle();
        }
        return "Pulling new versions";
    }

    public String createIssueTitlePrefix() {
        return "UpdateBot found version conflicts";
    }

    public String createPullRequestTitlePrefix() {
        CommandContext child = firstChild();
        if (child != null) {
            return child.createPullRequestTitlePrefix();
        }
        return createPullRequestTitle();
    }

    public String createCommit() {
        CommandContext child = firstChild();
        if (child != null) {
            return child.createCommit();
        }
        return createPullRequestTitle();
    }


    public String createPullRequestBody() {
        CommandContext child = firstChild();
        if (child != null) {
            return child.createPullRequestBody();
        }
        return Markdown.GENERATED_BY;
    }

    protected void addChild(CommandContext child) {
        children.add(child);
    }

    /**
     * Lets remove a child context if it wasn't applicable (to avoid generating unnecessary change comments etc
     */
    public void removeChild(CommandContext child) {
        children.remove(child);
    }

    protected CommandContext firstChild() {
        if (!children.isEmpty()) {
            return children.get(0);
        }
        return null;
    }

    public StatusInfo createStatusInfo() {
        return new StatusInfo(getRepository(), status, issue, pullRequest);
    }

    public void info(Logger log, String message) {
        getConfiguration().info(log, message);
    }

    public void warn(Logger log, String message) {
        getConfiguration().warn(log, message);
    }

    public void warn(Logger log, String message, Throwable e) {
        getConfiguration().warn(log, message, e);
    }

    public void error(Logger log, String message) {
        getConfiguration().error(log, message);
    }

    public void error(Logger log, String message, Throwable e) {
        getConfiguration().error(log, message, e);
    }
}