001package org.apache.maven.scm.provider.tfs.command;
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
022import org.apache.maven.scm.ScmException;
023import org.apache.maven.scm.ScmFileSet;
024import org.apache.maven.scm.ScmVersion;
025import org.apache.maven.scm.command.checkin.AbstractCheckInCommand;
026import org.apache.maven.scm.command.checkin.CheckInScmResult;
027import org.apache.maven.scm.provider.ScmProviderRepository;
028import org.apache.maven.scm.provider.tfs.TfsScmProviderRepository;
029import org.apache.maven.scm.provider.tfs.command.consumer.ErrorStreamConsumer;
030import org.apache.maven.scm.provider.tfs.command.consumer.FileListConsumer;
031import org.codehaus.plexus.util.StringUtils;
032
033/**
034 * 
035 */
036public class TfsCheckInCommand
037    extends AbstractCheckInCommand
038{
039    private static final String TFS_CHECKIN_POLICIES_ERROR = "TF10139";
040
041    protected CheckInScmResult executeCheckInCommand( ScmProviderRepository r, ScmFileSet f, String m, ScmVersion v )
042        throws ScmException
043    {
044        TfsCommand command = createCommand( r, f, m );
045        FileListConsumer fileConsumer = new FileListConsumer();
046        ErrorStreamConsumer err = new ErrorStreamConsumer();
047
048        int status = command.execute( fileConsumer, err );
049        getLogger().debug( "status of checkin command is= " + status + "; err= " + err.getOutput() );
050
051        //[SCM-753] support TFS checkin-policies - TFS returns error, that can be ignored.
052        if ( err.hasBeenFed() && err.getOutput().startsWith( TFS_CHECKIN_POLICIES_ERROR ) )
053        {
054            getLogger().debug( "exclusion: got error " + TFS_CHECKIN_POLICIES_ERROR
055                                   + " due to checkin policies. Ignoring it..." );
056        }
057
058        if ( status != 0 || ( err.hasBeenFed() && !err.getOutput().startsWith( TFS_CHECKIN_POLICIES_ERROR ) ) )
059        {
060            getLogger().error( "ERROR in command: " + command.getCommandString()
061                                   + "; Error code for TFS checkin command - " + status );
062            return new CheckInScmResult( command.getCommandString(), "Error code for TFS checkin command - " + status,
063                                         err.getOutput(), false );
064        }
065        return new CheckInScmResult( command.getCommandString(), fileConsumer.getFiles() );
066    }
067
068    public TfsCommand createCommand( ScmProviderRepository r, ScmFileSet f, String m )
069    {
070        TfsCommand command = new TfsCommand( "checkin", r, f, getLogger() );
071        command.addArgument( "-noprompt" );
072        if ( StringUtils.isNotBlank( m ) )
073        {
074            command.addArgument( "-comment:" + m );
075        }
076        command.addArgument( f );
077
078        TfsScmProviderRepository tfsScmProviderRepo = (TfsScmProviderRepository) r;
079        if ( tfsScmProviderRepo.isUseCheckinPolicies() )
080        {
081            // handle TFS-policies (by adding "/override:";Auto-Build: Version Update";)
082            command.addArgument( "/override:checkin_policy" );
083        }
084
085        return command;
086    }
087
088}