001package org.apache.maven.scm.provider.integrity.command.checkout;
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 com.mks.api.response.APIException;
023import com.mks.api.response.Response;
024import com.mks.api.response.Result;
025import com.mks.api.response.WorkItem;
026import com.mks.api.response.WorkItemIterator;
027import com.mks.api.si.SIModelTypeName;
028import org.apache.maven.scm.ScmException;
029import org.apache.maven.scm.ScmFileSet;
030import org.apache.maven.scm.ScmVersion;
031import org.apache.maven.scm.command.checkout.AbstractCheckOutCommand;
032import org.apache.maven.scm.command.checkout.CheckOutScmResult;
033import org.apache.maven.scm.provider.ScmProviderRepository;
034import org.apache.maven.scm.provider.integrity.ExceptionHandler;
035import org.apache.maven.scm.provider.integrity.Sandbox;
036import org.apache.maven.scm.provider.integrity.repository.IntegrityScmProviderRepository;
037
038/**
039 * MKS Integrity implementation for Maven's AbstractCheckOutCommand
040 * <br>The Checkout command will create a fresh sandbox in the checkoutDirectory
041 * <br>Since, Maven deletes the prior checkout folder, this command will check
042 * for a prior sandbox in the checkout directory and if a sandbox was found,
043 * then the command will resynchronize the sandbox.
044 *
045 * @author <a href="mailto:cletus@mks.com">Cletus D'Souza</a>
046 * @version $Id: IntegrityCheckOutCommand.java 1.3 2011/08/22 13:06:21EDT Cletus D'Souza (dsouza) Exp  $
047 * @since 1.6
048 */
049public class IntegrityCheckOutCommand
050    extends AbstractCheckOutCommand
051{
052    /**
053     * Overridden function that performs a checkout (resynchronize) operation against an MKS Source Project
054     * This function ignores the scmVerion and recursive arguments passed into this function as while there is
055     * a suitable equivalent to checkout/resynchronize by label/revision, it doesn't make sense for the way
056     * Maven seems to want to execute this command.  Hence we will create/resynchronize a sandbox, which will
057     * be recursive in nature.  If the user chooses to checkout a specific versioned configuration (checkpoint),
058     * then that information will be contained in the Configuration Path obtained from the
059     * IntegrityScmProviderRepository
060     */
061    @Override
062    public CheckOutScmResult executeCheckOutCommand( ScmProviderRepository repository, ScmFileSet fileSet,
063                                                    ScmVersion scmVersion, boolean recursive, boolean shallow )
064        throws ScmException
065    {
066        CheckOutScmResult result;
067        IntegrityScmProviderRepository iRepo = (IntegrityScmProviderRepository) repository;
068        try
069        {
070            getLogger().info(
071                "Attempting to checkout source for project " + iRepo.getProject().getConfigurationPath() );
072            String checkoutDir = System.getProperty( "checkoutDirectory" );
073            // Override the sandbox definition, if a checkout directory is specified for this command
074            Sandbox siSandbox;
075            if ( null != checkoutDir && checkoutDir.length() > 0 )
076            {
077                siSandbox = new Sandbox( iRepo.getAPISession(), iRepo.getProject(), checkoutDir );
078                iRepo.setSandbox( siSandbox );
079            }
080            else
081            {
082                siSandbox = iRepo.getSandbox();
083            }
084            getLogger().info( "Sandbox location is " + siSandbox.getSandboxDir() );
085            // Now attempt to create the sandbox, if it doesn't already exist
086            if ( siSandbox.create() )
087            {
088                // Resynchronize the new or previously created sandbox
089                Response res = siSandbox.resync();
090                // Lets output what we got from running this command
091                WorkItemIterator wit = res.getWorkItems();
092                while ( wit.hasNext() )
093                {
094                    WorkItem wi = wit.next();
095                    if ( wi.getModelType().equals( SIModelTypeName.MEMBER ) )
096                    {
097                        Result message = wi.getResult();
098                        getLogger().debug( wi.getDisplayId() + " " + ( null != message ? message.getMessage() : "" ) );
099                    }
100                }
101                int exitCode = res.getExitCode();
102                boolean success = ( exitCode == 0 ? true : false );
103                result = new CheckOutScmResult( res.getCommandString(), "", "Exit Code: " + exitCode, success );
104            }
105            else
106            {
107                result = new CheckOutScmResult( "si createsandbox", "Failed to create sandbox!", "", false );
108            }
109        }
110        catch ( APIException aex )
111        {
112            ExceptionHandler eh = new ExceptionHandler( aex );
113            getLogger().error( "MKS API Exception: " + eh.getMessage() );
114            getLogger().info( eh.getCommand() + " exited with return code " + eh.getExitCode() );
115            result = new CheckOutScmResult( eh.getCommand(), eh.getMessage(), "Exit Code: " + eh.getExitCode(), false );
116        }
117
118        return result;
119    }
120
121}