001 package org.apache.maven.scm.provider.git.gitexe.command.tag;
002
003 /*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements. See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership. The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License. You may obtain a copy of the License at
011 *
012 * http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied. See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022 import java.io.File;
023 import java.io.IOException;
024
025 import org.apache.maven.scm.ScmException;
026 import org.apache.maven.scm.ScmFileSet;
027 import org.apache.maven.scm.ScmFileStatus;
028 import org.apache.maven.scm.ScmResult;
029 import org.apache.maven.scm.ScmTagParameters;
030 import org.apache.maven.scm.command.checkout.CheckOutScmResult;
031 import org.apache.maven.scm.command.tag.AbstractTagCommand;
032 import org.apache.maven.scm.command.tag.TagScmResult;
033 import org.apache.maven.scm.provider.ScmProviderRepository;
034 import org.apache.maven.scm.provider.git.command.GitCommand;
035 import org.apache.maven.scm.provider.git.gitexe.command.GitCommandLineUtils;
036 import org.apache.maven.scm.provider.git.gitexe.command.list.GitListCommand;
037 import org.apache.maven.scm.provider.git.gitexe.command.list.GitListConsumer;
038 import org.apache.maven.scm.provider.git.repository.GitScmProviderRepository;
039 import org.codehaus.plexus.util.FileUtils;
040 import org.codehaus.plexus.util.StringUtils;
041 import org.codehaus.plexus.util.cli.CommandLineUtils;
042 import org.codehaus.plexus.util.cli.Commandline;
043
044 /**
045 * @author <a href="mailto:struberg@yahoo.de">Mark Struberg</a>
046 * @version $Id: GitTagCommand.java 1070251 2011-02-13 15:35:40Z struberg $
047 */
048 public class GitTagCommand
049 extends AbstractTagCommand
050 implements GitCommand
051 {
052
053 public ScmResult executeTagCommand( ScmProviderRepository repo, ScmFileSet fileSet, String tag, String message )
054 throws ScmException
055 {
056 return executeTagCommand( repo, fileSet, tag, new ScmTagParameters( message ) );
057 }
058
059 /** {@inheritDoc} */
060 public ScmResult executeTagCommand( ScmProviderRepository repo, ScmFileSet fileSet, String tag, ScmTagParameters scmTagParameters )
061 throws ScmException
062 {
063 if ( tag == null || StringUtils.isEmpty( tag.trim() ) )
064 {
065 throw new ScmException( "tag name must be specified" );
066 }
067
068 if ( !fileSet.getFileList().isEmpty() )
069 {
070 throw new ScmException( "This provider doesn't support tagging subsets of a directory" );
071 }
072
073 GitScmProviderRepository repository = (GitScmProviderRepository) repo;
074
075 File messageFile = FileUtils.createTempFile( "maven-scm-", ".commit", null );
076
077 try
078 {
079 FileUtils.fileWrite( messageFile.getAbsolutePath(), scmTagParameters.getMessage() );
080 }
081 catch ( IOException ex )
082 {
083 return new TagScmResult( null, "Error while making a temporary file for the commit message: "
084 + ex.getMessage(), null, false );
085 }
086
087 try
088 {
089 CommandLineUtils.StringStreamConsumer stdout = new CommandLineUtils.StringStreamConsumer();
090 CommandLineUtils.StringStreamConsumer stderr = new CommandLineUtils.StringStreamConsumer();
091
092 int exitCode;
093
094 Commandline clTag = createCommandLine( repository, fileSet.getBasedir(), tag, messageFile );
095
096 exitCode = GitCommandLineUtils.execute( clTag, stdout, stderr, getLogger() );
097 if ( exitCode != 0 )
098 {
099 return new TagScmResult( clTag.toString(), "The git-tag command failed.", stderr.getOutput(), false );
100 }
101
102 if( repo.isPushChanges() )
103 {
104 // and now push the tag to the configured upstream repository
105 Commandline clPush = createPushCommandLine( repository, fileSet, tag );
106
107 exitCode = GitCommandLineUtils.execute( clPush, stdout, stderr, getLogger() );
108 if ( exitCode != 0 )
109 {
110 return new TagScmResult( clPush.toString(), "The git-push command failed.", stderr.getOutput(), false );
111 }
112 }
113
114 // plus search for the tagged files
115 GitListConsumer listConsumer = new GitListConsumer( getLogger(), fileSet.getBasedir(), ScmFileStatus.TAGGED );
116
117 Commandline clList = GitListCommand.createCommandLine( repository, fileSet.getBasedir() );
118
119 exitCode = GitCommandLineUtils.execute( clList, listConsumer, stderr, getLogger() );
120 if ( exitCode != 0 )
121 {
122 return new CheckOutScmResult( clList.toString(), "The git-ls-files command failed.",
123 stderr.getOutput(), false );
124 }
125
126 return new TagScmResult( clTag.toString(), listConsumer.getListedFiles() );
127 }
128 finally
129 {
130 try
131 {
132 FileUtils.forceDelete( messageFile );
133 }
134 catch ( IOException ex )
135 {
136 // ignore
137 }
138 }
139
140 }
141
142 // ----------------------------------------------------------------------
143 //
144 // ----------------------------------------------------------------------
145
146 public static Commandline createCommandLine( GitScmProviderRepository repository, File workingDirectory,
147 String tag, File messageFile )
148 {
149 Commandline cl = GitCommandLineUtils.getBaseGitCommandLine( workingDirectory, "tag" );
150
151 cl.createArg().setValue( "-F" );
152 cl.createArg().setValue( messageFile.getAbsolutePath() );
153
154 // Note: this currently assumes you have the tag base checked out too
155 cl.createArg().setValue( tag );
156
157 return cl;
158 }
159
160 public static Commandline createPushCommandLine( GitScmProviderRepository repository, ScmFileSet fileSet, String tag )
161 throws ScmException
162 {
163 Commandline cl = GitCommandLineUtils.getBaseGitCommandLine( fileSet.getBasedir(), "push" );
164
165 cl.createArg().setValue( repository.getPushUrl() );
166 cl.createArg().setValue( tag );
167
168 return cl;
169 }
170
171 }