view mercurial-common/src/jetbrains/buildServer/buildTriggers/vcs/mercurial/command/BaseCommand.java @ 886:bf83331f51f0

Report agent-side checkout progress to build log This also fixes 'hg pull' timeouts problem. In order to support custom configs we started to use 'hg init', 'hg pull' sequence instead of 'hg clone'. Need that in order to modify repository configs after 'hg init', 'hg clone' doesn't give such an opportunity. The default pull timeout wasn't enough to pull a big repository from scratch. With progress reporting the default pull timeout (1 hour) should be enough, because it is an idle timeout.
author Dmitry Neverov <dmitry.neverov@jetbrains.com>
date Wed, 15 Oct 2014 06:29:39 +0200
parents 39ff04730ccc
children 62ebe9e449a3
line wrap: on
line source
/*
 * Copyright 2000-2014 JetBrains s.r.o.
 *
 * 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 jetbrains.buildServer.buildTriggers.vcs.mercurial.command;

import jetbrains.buildServer.vcs.VcsException;
import org.jetbrains.annotations.NotNull;

import java.io.File;
import java.util.Set;

import static com.intellij.openapi.util.text.StringUtil.isEmpty;
import static java.util.Collections.emptySet;

/**
 * @author pavel
 */
public class BaseCommand {

  protected final CommandSettings myCommandSettings;
  private final String myHgPath;
  private final File myWorkDirectory;

  public BaseCommand(@NotNull final CommandSettings commandSettings,
                     @NotNull final String hgPath,
                     @NotNull final File workingDir) {
    myCommandSettings = commandSettings;
    myHgPath = hgPath;
    myWorkDirectory = workingDir;
  }

  public File getWorkDirectory() {
    return myWorkDirectory;
  }

  @NotNull
  protected MercurialCommandLine createCommandLine() {
    MercurialCommandLine cli = createCL();
    cli.setWorkDirectory(myWorkDirectory.getAbsolutePath());
    return cli;
  }

  @NotNull
  protected MercurialCommandLine createCL() {
    final MercurialCommandLine cl = new MercurialCommandLine(getPrivateData());
    cl.setExePath(myHgPath);
    cl.setEnvParams(myCommandSettings.getHgEnv());
    cl.setDescription(getDescription());

    //include global arguments if any
    cl.addParameters(myCommandSettings.getGlobalArguments());

    return cl;
  }

  @NotNull
  protected final CommandResult runCommand(@NotNull MercurialCommandLine cli) throws VcsException {
    return runCommand(cli, myCommandSettings);
  }

  @NotNull
  protected final CommandResult runCommand(@NotNull final MercurialCommandLine cli,
                                           @NotNull final CommandSettings commandSettings) throws VcsException {

    if (!myCommandSettings.getUseCommandlineViaFileWrapper()) {
      String commandDescription = cli.getDescription();
      if (!isEmpty(commandDescription))
        commandSettings.getProgress().progressStarted(commandDescription);
      try {
        return CommandUtil.runCommand(cli, commandSettings.setPrivateData(getPrivateData()));
      } finally {
        if (!isEmpty(commandDescription))
          commandSettings.getProgress().progressFinished(commandDescription + " finished");
      }
    }

    return CommandUtil.runWrappedCommand(cli, commandSettings);
  }

  protected void setupExtensionsFromResource(@NotNull final MercurialCommandLine cli,
                                             @NotNull final File tempDir,
                                             @NotNull final String commandPy) throws VcsException{
    CommandUtil.setupExtensionsFromResource(cli, tempDir, commandPy);
  }

  @NotNull
  protected Set<String> getPrivateData() {
    return emptySet();
  }

  protected String getHgPath() {
    return myHgPath;
  }

  @NotNull
  protected String getDescription() {
    return "";
  }
}