Git: Use environment variables when pushing tags/branches to remote (#1270)

Add SSH based push tag/branch tests
Refactor SSH support for tests

This closes #1253

Author: kwin

maven-scm-api/src/main/java/org/apache/maven/scm/command/untag/AbstractUntagCommand.java

@@ -27,7 +27,7 @@
 import org.apache.maven.scm.command.AbstractCommand;
 import org.apache.maven.scm.provider.ScmProviderRepository;
 
-/** {@inheritDoc} */
+/** Removes a tag */
 public abstract class AbstractUntagCommand extends AbstractCommand {
     /**
      * execute untag command

maven-scm-plugin/src/test/java/org/apache/maven/scm/plugin/UntagMojoTest.java

@@ -63,7 +63,7 @@ public void setUp() throws Exception {
         checkoutMojo.execute();
 
         // Add a default user to the config
-        GitScmTestUtils.setDefaulGitConfig(checkoutDir);
+        GitScmTestUtils.setDefaultGitConfig(checkoutDir);
     }
 
     @Test

maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/GitExeScmProvider.java

@@ -66,7 +66,7 @@ protected GitCommand getAddCommand() {
 
     /** {@inheritDoc} */
     protected GitCommand getBranchCommand() {
-        return new GitBranchCommand();
+        return new GitBranchCommand(environmentVariables);
     }
 
     /** {@inheritDoc} */
@@ -106,12 +106,12 @@ protected GitCommand getStatusCommand() {
 
     /** {@inheritDoc} */
     protected GitCommand getTagCommand() {
-        return new GitTagCommand();
+        return new GitTagCommand(environmentVariables);
     }
 
     /** {@inheritDoc} */
     protected GitCommand getUntagCommand() {
-        return new GitUntagCommand();
+        return new GitUntagCommand(environmentVariables);
     }
 
     /** {@inheritDoc} */

maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/branch/GitBranchCommand.java

@@ -19,6 +19,7 @@
 package org.apache.maven.scm.provider.git.gitexe.command.branch;
 
 import java.io.File;
+import java.util.Map;
 
 import org.apache.maven.scm.ScmException;
 import org.apache.maven.scm.ScmFileSet;
@@ -40,6 +41,12 @@
  *
  */
 public class GitBranchCommand extends AbstractBranchCommand implements GitCommand {
+    private final Map<String, String> environmentVariables;
+
+    public GitBranchCommand(Map<String, String> environmentVariables) {
+        this.environmentVariables = environmentVariables;
+    }
+
     /** {@inheritDoc} */
     public ScmResult executeBranchCommand(ScmProviderRepository repo, ScmFileSet fileSet, String branch, String message)
             throws ScmException {
@@ -102,9 +109,9 @@ public static Commandline createCommandLine(
         return cl;
     }
 
-    public static Commandline createPushCommandLine(
-            GitScmProviderRepository repository, ScmFileSet fileSet, String branch) throws ScmException {
-        Commandline cl = GitCommandLineUtils.getBaseGitCommandLine(fileSet.getBasedir(), "push");
+    public Commandline createPushCommandLine(GitScmProviderRepository repository, ScmFileSet fileSet, String branch) {
+        Commandline cl = GitCommandLineUtils.getBaseGitCommandLine(
+                fileSet.getBasedir(), "push", repository, environmentVariables);
 
         cl.createArg().setValue(repository.getPushUrl());
         cl.createArg().setValue("refs/heads/" + branch);

maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/tag/GitTagCommand.java

@@ -20,6 +20,7 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.util.Map;
 
 import org.apache.maven.scm.ScmException;
 import org.apache.maven.scm.ScmFileSet;
@@ -44,6 +45,11 @@
  *
  */
 public class GitTagCommand extends AbstractTagCommand implements GitCommand {
+    private final Map<String, String> environmentVariables;
+
+    public GitTagCommand(Map<String, String> environmentVariables) {
+        this.environmentVariables = environmentVariables;
+    }
 
     public ScmResult executeTagCommand(ScmProviderRepository repo, ScmFileSet fileSet, String tag, String message)
             throws ScmException {
@@ -156,9 +162,9 @@ static Commandline createCommandLine(
         return cl;
     }
 
-    public static Commandline createPushCommandLine(GitScmProviderRepository repository, ScmFileSet fileSet, String tag)
-            throws ScmException {
-        Commandline cl = GitCommandLineUtils.getBaseGitCommandLine(fileSet.getBasedir(), "push");
+    public Commandline createPushCommandLine(GitScmProviderRepository repository, ScmFileSet fileSet, String tag) {
+        Commandline cl = GitCommandLineUtils.getBaseGitCommandLine(
+                fileSet.getBasedir(), "push", repository, environmentVariables);
 
         cl.createArg().setValue(repository.getPushUrl());
         cl.createArg().setValue("refs/tags/" + tag);

maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/main/java/org/apache/maven/scm/provider/git/gitexe/command/untag/GitUntagCommand.java

@@ -19,6 +19,7 @@
 package org.apache.maven.scm.provider.git.gitexe.command.untag;
 
 import java.io.File;
+import java.util.Map;
 
 import org.apache.maven.scm.ScmException;
 import org.apache.maven.scm.ScmFileSet;
@@ -35,6 +36,11 @@
 
 /** {@inheritDoc} */
 public class GitUntagCommand extends AbstractUntagCommand implements GitCommand {
+    private final Map<String, String> environmentVariables;
+
+    public GitUntagCommand(Map<String, String> environmentVariables) {
+        this.environmentVariables = environmentVariables;
+    }
 
     /** {@inheritDoc} */
     public ScmResult executeUntagCommand(
@@ -85,9 +91,9 @@ public static Commandline createCommandLine(
         return cl;
     }
 
-    public static Commandline createPushCommandLine(
-            GitScmProviderRepository repository, ScmFileSet fileSet, String tag) {
-        Commandline cl = GitCommandLineUtils.getBaseGitCommandLine(fileSet.getBasedir(), "push");
+    public Commandline createPushCommandLine(GitScmProviderRepository repository, ScmFileSet fileSet, String tag) {
+        Commandline cl = GitCommandLineUtils.getBaseGitCommandLine(
+                fileSet.getBasedir(), "push", repository, environmentVariables);
 
         cl.createArg().setValue("--delete");
         cl.createArg().setValue(repository.getPushUrl());

maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/test/java/org/apache/maven/scm/provider/git/gitexe/GitExeTestUtils.java

@@ -0,0 +1,61 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF 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 org.apache.maven.scm.provider.git.gitexe;
+
+import org.apache.commons.io.FilenameUtils;
+import org.apache.maven.scm.manager.NoSuchScmProviderException;
+import org.apache.maven.scm.manager.ScmManager;
+import org.apache.maven.scm.provider.ScmProviderRepositoryWithHost;
+import org.apache.maven.scm.repository.ScmRepository;
+import org.codehaus.plexus.util.StringUtils;
+
+public class GitExeTestUtils {
+
+    /**
+     * Environment variable to customize the SSH command used by git, requires git 2.3.0 or newer
+     * @see <a href="https://git-scm.com/docs/git#Documentation/git.txt-GITSSHCOMMAND">GIT_SSH_COMMAND</a>
+     */
+    public static final String VARIABLE_GIT_SSH_COMMAND = "GIT_SSH_COMMAND";
+
+    private GitExeTestUtils() {
+        // Utility class, no instantiation
+    }
+
+    /**
+     * Configures the git executable to use a custom SSH command that allows lenient host key checking.
+     * It uses the private key specified in the repository configuration.
+     * @param scmManager
+     * @param repository
+     * @throws NoSuchScmProviderException
+     */
+    public static void configureLenientSshAuthentication(ScmManager scmManager, ScmRepository repository)
+            throws NoSuchScmProviderException {
+        ScmProviderRepositoryWithHost providerRepository =
+                (ScmProviderRepositoryWithHost) repository.getProviderRepository();
+        GitExeScmProvider provider = (GitExeScmProvider) scmManager.getProviderByRepository(repository);
+        String privateKey = providerRepository.getPrivateKey();
+        if (StringUtils.isBlank(privateKey)) {
+            throw new IllegalArgumentException("Private key must be set in the repository configuration");
+        }
+        provider.setEnvironmentVariable(
+                VARIABLE_GIT_SSH_COMMAND,
+                "ssh -o StrictHostKeyChecking=no -o IdentitiesOnly=yes -i "
+                        + FilenameUtils.separatorsToUnix(providerRepository.getPrivateKey()));
+    }
+}

maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/test/java/org/apache/maven/scm/provider/git/gitexe/command/branch/GitExeSshBranchCommandTckTest.java

@@ -0,0 +1,46 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF 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 org.apache.maven.scm.provider.git.gitexe.command.branch;
+
+import java.security.GeneralSecurityException;
+
+import org.apache.maven.scm.provider.git.command.branch.GitSshBranchCommandTckTest;
+import org.apache.maven.scm.provider.git.gitexe.GitExeTestUtils;
+import org.apache.maven.scm.repository.ScmRepository;
+
+/**
+ *
+ */
+public class GitExeSshBranchCommandTckTest extends GitSshBranchCommandTckTest {
+
+    public GitExeSshBranchCommandTckTest() throws GeneralSecurityException {
+        super();
+    }
+
+    @Override
+    protected String getScmProvider() {
+        return "git";
+    }
+
+    @Override
+    public void configureCredentials(ScmRepository repository, String passphrase) throws Exception {
+        super.configureCredentials(repository, passphrase);
+        GitExeTestUtils.configureLenientSshAuthentication(getScmManager(), repository);
+    }
+}

maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/test/java/org/apache/maven/scm/provider/git/gitexe/command/checkin/GitCheckInCommandNoBranchTest.java

@@ -66,7 +66,7 @@ public void testCheckinNoBranch() throws Exception {
         CheckOutScmResult checkOutScmResult = checkoutRepo(scmRepository);
 
         // Add a default user to the config
-        GitScmTestUtils.setDefaulGitConfig(workingDirectory);
+        GitScmTestUtils.setDefaultGitConfig(workingDirectory);
 
         assertEquals(0, checkOutScmResult.getCheckedOutFiles().size());
 

maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/test/java/org/apache/maven/scm/provider/git/gitexe/command/checkin/GitCheckInCommandTest.java

@@ -100,7 +100,7 @@ public void testCheckinAfterRename() throws Exception {
         checkoutRepoInto(checkedOutRepo, scmRepository);
 
         // Add a default user to the config
-        GitScmTestUtils.setDefaulGitConfig(checkedOutRepo);
+        GitScmTestUtils.setDefaultGitConfig(checkedOutRepo);
 
         // Creating foo/bar/wine.xml
         File fooDir = new File(checkedOutRepo.getAbsolutePath(), "foo");
@@ -154,7 +154,7 @@ public void testCheckinWithFileSet() throws Exception {
         checkoutRepoInto(checkedOutRepo, scmRepository);
 
         // Add a default user to the config
-        GitScmTestUtils.setDefaulGitConfig(checkedOutRepo);
+        GitScmTestUtils.setDefaultGitConfig(checkedOutRepo);
 
         // Creating beer.xml and whiskey.xml
         File beerFile = new File(checkedOutRepo.getAbsolutePath(), "beer.xml");