| package org.apache.maven.continuum.execution; |
| |
| /* |
| * 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. |
| */ |
| |
| import org.apache.continuum.utils.shell.ExecutionResult; |
| import org.apache.continuum.utils.shell.ShellCommandHelper; |
| import org.apache.maven.artifact.Artifact; |
| import org.apache.maven.continuum.installation.InstallationService; |
| import org.apache.maven.continuum.model.project.BuildDefinition; |
| import org.apache.maven.continuum.model.project.Project; |
| import org.apache.maven.continuum.model.scm.ChangeSet; |
| import org.apache.maven.continuum.model.system.Installation; |
| import org.apache.maven.continuum.model.system.Profile; |
| import org.apache.maven.continuum.project.ContinuumProjectState; |
| import org.apache.maven.continuum.utils.WorkingDirectoryService; |
| import org.codehaus.plexus.commandline.ExecutableResolver; |
| import org.codehaus.plexus.logging.AbstractLogEnabled; |
| import org.codehaus.plexus.personality.plexus.lifecycle.phase.Initializable; |
| import org.codehaus.plexus.personality.plexus.lifecycle.phase.InitializationException; |
| import org.codehaus.plexus.util.StringUtils; |
| import org.codehaus.plexus.util.cli.CommandLineException; |
| |
| import java.io.File; |
| import java.util.Collections; |
| import java.util.HashMap; |
| import java.util.List; |
| import java.util.Map; |
| import java.util.Properties; |
| |
| /** |
| * @author <a href="mailto:trygvis@inamo.no">Trygve Laugstøl</a> |
| * @version $Id$ |
| */ |
| public abstract class AbstractBuildExecutor |
| extends AbstractLogEnabled |
| implements ContinuumBuildExecutor, Initializable |
| { |
| private static final String SUDO_EXECUTABLE = "sudo"; |
| |
| private static final String CHROOT_EXECUTABLE = "chroot"; |
| |
| // ---------------------------------------------------------------------- |
| // |
| // ---------------------------------------------------------------------- |
| |
| /** |
| * @plexus.requirement |
| */ |
| private ShellCommandHelper shellCommandHelper; |
| |
| /** |
| * @plexus.requirement |
| */ |
| private ExecutableResolver executableResolver; |
| |
| /** |
| * @plexus.requirement |
| */ |
| private WorkingDirectoryService workingDirectoryService; |
| |
| /** |
| * @plexus.requirement |
| */ |
| private InstallationService installationService; |
| |
| /** |
| * @plexus.configuration |
| */ |
| private File chrootJailDirectory; |
| |
| /** |
| * @plexus.configuration |
| */ |
| private String defaultExecutable; |
| |
| // ---------------------------------------------------------------------- |
| // |
| // ---------------------------------------------------------------------- |
| |
| private String id; |
| |
| private boolean resolveExecutable; |
| |
| // ---------------------------------------------------------------------- |
| // |
| // ---------------------------------------------------------------------- |
| |
| protected AbstractBuildExecutor( String id, boolean resolveExecutable ) |
| { |
| this.id = id; |
| |
| this.resolveExecutable = resolveExecutable; |
| } |
| |
| public void setShellCommandHelper( ShellCommandHelper shellCommandHelper ) |
| { |
| this.shellCommandHelper = shellCommandHelper; |
| } |
| |
| public ShellCommandHelper getShellCommandHelper() |
| { |
| return shellCommandHelper; |
| } |
| |
| public void setWorkingDirectoryService( WorkingDirectoryService workingDirectoryService ) |
| { |
| this.workingDirectoryService = workingDirectoryService; |
| } |
| |
| public WorkingDirectoryService getWorkingDirectoryService() |
| { |
| return workingDirectoryService; |
| } |
| |
| public void setDefaultExecutable( String defaultExecutable ) |
| { |
| this.defaultExecutable = defaultExecutable; |
| } |
| |
| // ---------------------------------------------------------------------- |
| // Component Lifecycle |
| // ---------------------------------------------------------------------- |
| |
| public String getDefaultExecutable() |
| { |
| return defaultExecutable; |
| } |
| |
| public void initialize() |
| throws InitializationException |
| { |
| List path = executableResolver.getDefaultPath(); |
| |
| if ( resolveExecutable ) |
| { |
| if ( StringUtils.isEmpty( defaultExecutable ) ) |
| { |
| getLogger().warn( "The default executable for build executor '" + id + "' is not set. " + |
| "This will cause a problem unless the project has a executable configured." ); |
| } |
| else |
| { |
| File resolvedExecutable = executableResolver.findExecutable( defaultExecutable, path ); |
| |
| if ( resolvedExecutable == null ) |
| { |
| getLogger().warn( |
| "Could not find the executable '" + defaultExecutable + "' in the " + "path '" + path + "'." ); |
| } |
| else |
| { |
| getLogger().info( "Resolved the executable '" + defaultExecutable + "' to " + "'" + |
| resolvedExecutable.getAbsolutePath() + "'." ); |
| } |
| } |
| } |
| } |
| |
| // ---------------------------------------------------------------------- |
| // |
| // ---------------------------------------------------------------------- |
| |
| /** |
| * Find the actual executable path to be used |
| * |
| * @param defaultExecutable |
| * @return The executable path |
| */ |
| protected String findExecutable( Project project, String executable, String defaultExecutable, |
| boolean resolveExecutable, File workingDirectory ) |
| { |
| // ---------------------------------------------------------------------- |
| // If we're not searching the path for the executable, prefix the |
| // executable with the working directory to make sure the path is |
| // absolute and thus won't be tried resolved by using the PATH |
| // ---------------------------------------------------------------------- |
| |
| String actualExecutable; |
| |
| if ( !resolveExecutable ) |
| { |
| actualExecutable = new File( workingDirectory, executable ).getAbsolutePath(); |
| } |
| else |
| { |
| List<String> path = executableResolver.getDefaultPath(); |
| |
| if ( StringUtils.isEmpty( executable ) ) |
| { |
| executable = defaultExecutable; |
| } |
| |
| File e = executableResolver.findExecutable( executable, path ); |
| |
| if ( e == null ) |
| { |
| getLogger().warn( "Could not find the executable '" + executable + "' in this path: " ); |
| |
| for ( String element : path ) |
| { |
| getLogger().warn( element ); |
| } |
| |
| actualExecutable = defaultExecutable; |
| } |
| else |
| { |
| actualExecutable = e.getAbsolutePath(); |
| } |
| } |
| |
| //sometimes executable isn't found in path but it exit (CONTINUUM-365) |
| File actualExecutableFile = new File( actualExecutable ); |
| |
| if ( !actualExecutableFile.exists() ) |
| { |
| actualExecutable = executable; |
| } |
| |
| return actualExecutable; |
| } |
| |
| protected ContinuumBuildExecutionResult executeShellCommand( Project project, String executable, String arguments, |
| File output, Map<String, String> environments ) |
| throws ContinuumBuildExecutorException |
| { |
| |
| File workingDirectory = getWorkingDirectory( project ); |
| |
| String actualExecutable = |
| findExecutable( project, executable, defaultExecutable, resolveExecutable, workingDirectory ); |
| |
| // ---------------------------------------------------------------------- |
| // Execute the build |
| // ---------------------------------------------------------------------- |
| |
| try |
| { |
| File chrootJailDirectory = getChrootJailDirectory(); |
| if ( chrootJailDirectory != null ) |
| { |
| StringBuilder sb = new StringBuilder(); |
| sb.append( CHROOT_EXECUTABLE ); |
| sb.append( " " ); |
| sb.append( new File( chrootJailDirectory, project.getGroupId() ) ); |
| sb.append( " " ); |
| sb.append( " /bin/sh -c 'cd " ); |
| sb.append( getRelativePath( chrootJailDirectory, workingDirectory, project.getGroupId() ) ); |
| sb.append( " && " ); |
| sb.append( actualExecutable ); |
| sb.append( " " ); |
| sb.append( arguments ); |
| sb.append( "'" ); |
| |
| arguments = sb.toString(); |
| actualExecutable = SUDO_EXECUTABLE; |
| workingDirectory = chrootJailDirectory; // not really used but must exist |
| } |
| |
| ExecutionResult result = getShellCommandHelper().executeShellCommand( workingDirectory, actualExecutable, |
| arguments, output, project.getId(), |
| environments ); |
| |
| getLogger().info( "Exit code: " + result.getExitCode() ); |
| |
| return new ContinuumBuildExecutionResult( output, result.getExitCode() ); |
| } |
| catch ( CommandLineException e ) |
| { |
| if ( e.getCause() instanceof InterruptedException ) |
| { |
| throw new ContinuumBuildCancelledException( "The build was cancelled", e ); |
| } |
| else |
| { |
| throw new ContinuumBuildExecutorException( |
| "Error while executing shell command. The most common error is that '" + executable + "' " + |
| "is not in your path.", e ); |
| } |
| } |
| catch ( Exception e ) |
| { |
| throw new ContinuumBuildExecutorException( "Error while executing shell command. " + |
| "The most common error is that '" + executable + "' " + "is not in your path.", e ); |
| } |
| } |
| |
| private String getRelativePath( File chrootDir, File workingDirectory, String groupId ) |
| { |
| String path = workingDirectory.getPath(); |
| String chrootBase = new File( chrootDir, groupId ).getPath(); |
| if ( path.startsWith( chrootBase ) ) |
| { |
| return path.substring( chrootBase.length(), path.length() ); |
| } |
| else |
| { |
| throw new IllegalArgumentException( |
| "Working directory is not inside the chroot jail " + chrootBase + " , " + path ); |
| } |
| } |
| |
| protected abstract Map<String, String> getEnvironments( BuildDefinition buildDefinition ); |
| |
| protected String getJavaHomeValue( BuildDefinition buildDefinition ) |
| { |
| Profile profile = buildDefinition.getProfile(); |
| if ( profile == null ) |
| { |
| return null; |
| } |
| Installation jdk = profile.getJdk(); |
| if ( jdk == null ) |
| { |
| return null; |
| } |
| return jdk.getVarValue(); |
| } |
| |
| public void backupTestFiles( Project project, int buildId ) |
| { |
| //Nothing to do, by default |
| } |
| |
| /** |
| * By default, we return true because with a change, the project must be rebuilt. |
| */ |
| public boolean shouldBuild( List<ChangeSet> changes, Project continuumProject, File workingDirectory, |
| BuildDefinition buildDefinition ) |
| throws ContinuumBuildExecutorException |
| { |
| return true; |
| } |
| |
| protected Map<String, String> getEnvironmentVariables( BuildDefinition buildDefinition ) |
| { |
| Profile profile = buildDefinition.getProfile(); |
| Map<String, String> envVars = new HashMap<String, String>(); |
| if ( profile == null ) |
| { |
| return envVars; |
| } |
| List<Installation> environmentVariables = profile.getEnvironmentVariables(); |
| if ( environmentVariables.isEmpty() ) |
| { |
| return envVars; |
| } |
| for ( Installation installation : environmentVariables ) |
| { |
| envVars.put( installation.getVarName(), installation.getVarValue() ); |
| } |
| return envVars; |
| } |
| |
| protected Properties getContinuumSystemProperties( Project project ) |
| { |
| Properties properties = new Properties(); |
| properties.setProperty( "continuum.project.group.name", project.getProjectGroup().getName() ); |
| properties.setProperty( "continuum.project.lastBuild.state", String.valueOf( project.getOldState() ) ); |
| properties.setProperty( "continuum.project.lastBuild.number", String.valueOf( project.getBuildNumber() ) ); |
| properties.setProperty( "continuum.project.nextBuild.number", String.valueOf( project.getBuildNumber() + 1 ) ); |
| properties.setProperty( "continuum.project.id", String.valueOf( project.getId() ) ); |
| properties.setProperty( "continuum.project.name", project.getName() ); |
| properties.setProperty( "continuum.project.version", project.getVersion() ); |
| return properties; |
| } |
| |
| protected String getBuildFileForProject( Project project, BuildDefinition buildDefinition ) |
| { |
| String buildFile = StringUtils.clean( buildDefinition.getBuildFile() ); |
| String relPath = StringUtils.clean( project.getRelativePath() ); |
| |
| if ( StringUtils.isEmpty( relPath ) ) |
| { |
| return buildFile; |
| } |
| |
| return relPath + File.separator + buildFile; |
| } |
| |
| public boolean isBuilding( Project project ) |
| { |
| return project.getState() == ContinuumProjectState.BUILDING || |
| getShellCommandHelper().isRunning( project.getId() ); |
| } |
| |
| public void killProcess( Project project ) |
| { |
| getShellCommandHelper().killProcess( project.getId() ); |
| } |
| |
| public List<Artifact> getDeployableArtifacts( Project project, File workingDirectory, BuildDefinition buildDefinition ) |
| throws ContinuumBuildExecutorException |
| { |
| // Not supported by this builder |
| return Collections.EMPTY_LIST; |
| } |
| |
| public File getWorkingDirectory( Project project ) |
| { |
| return getWorkingDirectoryService().getWorkingDirectory( project ); |
| } |
| |
| public InstallationService getInstallationService() |
| { |
| return installationService; |
| } |
| |
| public void setInstallationService( InstallationService installationService ) |
| { |
| this.installationService = installationService; |
| } |
| |
| public boolean isResolveExecutable() |
| { |
| return resolveExecutable; |
| } |
| |
| public void setResolveExecutable( boolean resolveExecutable ) |
| { |
| this.resolveExecutable = resolveExecutable; |
| } |
| |
| public void setExecutableResolver( ExecutableResolver executableResolver ) |
| { |
| this.executableResolver = executableResolver; |
| } |
| |
| public ExecutableResolver getExecutableResolver() |
| { |
| return executableResolver; |
| } |
| |
| public void setChrootJailDirectory( File chrootJailDirectory ) |
| { |
| this.chrootJailDirectory = chrootJailDirectory; |
| } |
| |
| public File getChrootJailDirectory() |
| { |
| return chrootJailDirectory; |
| } |
| } |
