org.jenkinsci.plugins.drupal.beans

Class DrushInvocation

java.lang.Object

org.jenkinsci.plugins.drupal.beans.DrushInvocation

public class DrushInvocation
extends Object

Invoke Drush commands.

Author:

Fengtan https://github.com/fengtan/

Field Summary

Fields

Modifier and Type	Field and Description
protected hudson.EnvVars	environment
protected hudson.Launcher	launcher
protected hudson.model.TaskListener	listener
protected hudson.FilePath	root
protected hudson.FilePath	workspace

Constructor Summary

Constructors

Constructor and Description
DrushInvocation(hudson.FilePath root, hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener, hudson.EnvVars environment)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	coderReview(File outputDir, Collection<String> reviews, Collection<String> projectNames, boolean ignoresPass) Run a code review.
boolean	download(String projects, String destination) Download projects/modules into a destination directory.
boolean	enable(String extensions) Enable extensions/modules.
protected boolean	execute(hudson.util.ArgumentListBuilder args) Execute a Drush command.
protected boolean	execute(hudson.util.ArgumentListBuilder args, hudson.model.TaskListener out) Execute a Drush command.
protected hudson.util.ArgumentListBuilder	getArgumentListBuilder() Get default Drush options.
protected String	getDrushExe() Get Drush executable.
protected DrushInstallation	getDrushInstallation() Get first Drush installation configured, or null if no installation is configured.
Map<String,DrupalExtension>	getProjects(boolean modulesOnly, boolean enabledOnly) Get a map of projects installed on Drupal, keyed by machine name.
Collection<DrupalTest>	getTests() Get a list of test classes available.
boolean	isModuleInstalled(String name, boolean enabledOnly) Check if a module exists / is enabled
boolean	make(File makefile) Make a Drupal site using a Makefile.
boolean	siteInstall(String db, String profile) Install a Drupal site using an installation profile.
boolean	status() Return true if the site is already installed, false otherwise.
boolean	testRun(File outputDir, String uri, Collection<String> targets) Run tests.
boolean	upDb() Run update.php.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

root

protected final hudson.FilePath root

workspace

protected final hudson.FilePath workspace

launcher

protected final hudson.Launcher launcher

listener

protected final hudson.model.TaskListener listener

environment

protected final hudson.EnvVars environment

Constructor Detail

DrushInvocation

public DrushInvocation(hudson.FilePath root,
               hudson.FilePath workspace,
               hudson.Launcher launcher,
               hudson.model.TaskListener listener,
               hudson.EnvVars environment)

Method Detail

getArgumentListBuilder

protected hudson.util.ArgumentListBuilder getArgumentListBuilder()

Get default Drush options.

getDrushExe

protected String getDrushExe()

Get Drush executable.

getDrushInstallation

protected DrushInstallation getDrushInstallation()

Get first Drush installation configured, or null if no installation is configured.

execute

protected boolean execute(hudson.util.ArgumentListBuilder args)
                   throws IOException,
                          InterruptedException

Execute a Drush command.

Throws:

IOException

InterruptedException

execute

protected boolean execute(hudson.util.ArgumentListBuilder args,
              hudson.model.TaskListener out)
                   throws IOException,
                          InterruptedException

Execute a Drush command.

Throws:

IOException

InterruptedException

upDb

public boolean upDb()
             throws IOException,
                    InterruptedException

Run update.php.

Throws:

IOException

InterruptedException

make

public boolean make(File makefile)
             throws IOException,
                    InterruptedException

Make a Drupal site using a Makefile.

Throws:

IOException

InterruptedException

siteInstall

public boolean siteInstall(String db,
                  String profile)
                    throws IOException,
                           InterruptedException

Install a Drupal site using an installation profile.

Throws:

IOException

InterruptedException

download

public boolean download(String projects,
               String destination)
                 throws IOException,
                        InterruptedException

Download projects/modules into a destination directory.

Throws:

IOException

InterruptedException

enable

public boolean enable(String extensions)
               throws IOException,
                      InterruptedException

Enable extensions/modules.

Throws:

IOException

InterruptedException

getProjects

public Map<String,DrupalExtension> getProjects(boolean modulesOnly,
                                      boolean enabledOnly)

Get a map of projects installed on Drupal, keyed by machine name.

isModuleInstalled

public boolean isModuleInstalled(String name,
                        boolean enabledOnly)

Check if a module exists / is enabled

status

public boolean status()

Return true if the site is already installed, false otherwise.

getTests

public Collection<DrupalTest> getTests()

Get a list of test classes available.

testRun

public boolean testRun(File outputDir,
              String uri,
              Collection<String> targets)
                throws IOException,
                       InterruptedException

Run tests.

Throws:

IOException

InterruptedException

coderReview

public boolean coderReview(File outputDir,
                  Collection<String> reviews,
                  Collection<String> projectNames,
                  boolean ignoresPass)
                    throws IOException,
                           InterruptedException

Run a code review.

Throws:

IOException

InterruptedException