001package org.apache.maven.scm.plugin; 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 java.io.File; 023import java.io.IOException; 024 025import org.apache.maven.plugin.MojoExecutionException; 026import org.apache.maven.plugins.annotations.Mojo; 027import org.apache.maven.plugins.annotations.Parameter; 028import org.apache.maven.scm.ScmException; 029import org.apache.maven.scm.ScmFileSet; 030import org.apache.maven.scm.ScmResult; 031import org.apache.maven.scm.repository.ScmRepository; 032import org.codehaus.plexus.util.FileUtils; 033 034/** 035 * Get a fresh copy of the latest source from the configured scm url. 036 * 037 * @author <a href="evenisse@apache.org">Emmanuel Venisse</a> 038 */ 039@Mojo( name = "checkout", requiresProject = false ) 040public class CheckoutMojo 041 extends AbstractScmMojo 042{ 043 /** 044 * Use Export instead of checkout 045 */ 046 @Parameter( property = "useExport", defaultValue = "false" ) 047 private boolean useExport; 048 049 /** 050 * The directory to checkout the sources to for the bootstrap and checkout goals. 051 */ 052 @Parameter( property = "checkoutDirectory", defaultValue = "${project.build.directory}/checkout" ) 053 private File checkoutDirectory; 054 055 /** 056 * Skip checkout if checkoutDirectory exists. 057 */ 058 @Parameter( property = "skipCheckoutIfExists", defaultValue = "false" ) 059 private boolean skipCheckoutIfExists = false; 060 061 /** 062 * The version type (branch/tag/revision) of scmVersion. 063 */ 064 @Parameter( property = "scmVersionType" ) 065 private String scmVersionType; 066 067 /** 068 * The version (revision number/branch name/tag name). 069 */ 070 @Parameter( property = "scmVersion" ) 071 private String scmVersion; 072 073 /** 074 * allow extended mojo (ie BootStrap ) to see checkout result 075 */ 076 private ScmResult checkoutResult; 077 078 /** {@inheritDoc} */ 079 public void execute() 080 throws MojoExecutionException 081 { 082 super.execute(); 083 084 //skip checkout if checkout directory is already created. See SCM-201 085 checkoutResult = null; 086 if ( !getCheckoutDirectory().isDirectory() || !this.skipCheckoutIfExists ) 087 { 088 checkoutResult = checkout(); 089 } 090 } 091 092 protected File getCheckoutDirectory() 093 { 094 if ( this.checkoutDirectory.getPath().contains( "${project.basedir}" )) 095 { 096 //project.basedir is not set under maven 3.x when run without a project 097 this.checkoutDirectory = new File( this.getBasedir(), "target/checkout"); 098 } 099 return this.checkoutDirectory; 100 } 101 102 public void setCheckoutDirectory( File checkoutDirectory ) 103 { 104 this.checkoutDirectory = checkoutDirectory; 105 } 106 107 protected ScmResult checkout() 108 throws MojoExecutionException 109 { 110 try 111 { 112 ScmRepository repository = getScmRepository(); 113 114 this.prepareOutputDirectory( getCheckoutDirectory() ); 115 116 ScmResult result = null; 117 118 ScmFileSet fileSet = new ScmFileSet( getCheckoutDirectory().getAbsoluteFile() ); 119 if ( useExport ) 120 { 121 result = getScmManager().export( repository,fileSet, getScmVersion( scmVersionType, scmVersion ) ); 122 } 123 else 124 { 125 result = getScmManager().checkOut( repository,fileSet , getScmVersion( scmVersionType, scmVersion ) ); 126 } 127 128 checkResult( result ); 129 130 131 handleExcludesIncludesAfterCheckoutAndExport( this.checkoutDirectory ); 132 133 return result; 134 } 135 catch ( ScmException e ) 136 { 137 throw new MojoExecutionException( "Cannot run checkout command : ", e ); 138 } 139 } 140 141 private void prepareOutputDirectory( File ouputDirectory ) 142 throws MojoExecutionException 143 { 144 try 145 { 146 this.getLog().info( "Removing " + ouputDirectory ); 147 148 FileUtils.deleteDirectory( getCheckoutDirectory() ); 149 } 150 catch ( IOException e ) 151 { 152 throw new MojoExecutionException( "Cannot remove " + ouputDirectory ); 153 } 154 155 if ( !getCheckoutDirectory().mkdirs() ) 156 { 157 throw new MojoExecutionException( "Cannot create " + ouputDirectory ); 158 } 159 } 160 161 protected ScmResult getCheckoutResult() 162 { 163 return checkoutResult; 164 } 165 166 167}