com.mathworks.ci

Interface MatlabBuild

All Known Implementing Classes:

MatlabBuildStepExecution, MatlabCommandStepExecution, MatlabRunTestsStepExecution, RunMatlabBuildBuilder, RunMatlabCommandBuilder, RunMatlabTestsBuilder

public interface MatlabBuild

Method Summary

Modifier and Type	Method and Description
default void	copyFileInWorkspace(String sourceFile, String targetFile, hudson.FilePath targetWorkspace)
default hudson.FilePath	getFilePathForUniqueFolder(hudson.Launcher launcher, String uniqueName, hudson.FilePath workspace)
default hudson.Launcher.ProcStarter	getProcessToRunMatlabCommand(hudson.FilePath workspace, hudson.Launcher launcher, hudson.model.TaskListener listener, hudson.EnvVars envVars, String matlabCommand, String uniqueName) This Method decorates the launcher with MATLAB command provided and returns the Process object to launch MATLAB with appropriate startup options like -r or -batch
default String	getRunnerScript(String script, String params, String uniqueTmpFldrName)
default String	getUniqueNameForRunnerFile()
default String	getValidMatlabFileName(String actualName)
default void	prepareTmpFldr(hudson.FilePath tmpFldr, String runnerScript)
default String	replaceZipPlaceholder(String script, String url)

Method Detail

getProcessToRunMatlabCommand

default hudson.Launcher.ProcStarter getProcessToRunMatlabCommand(hudson.FilePath workspace,
                                                                 hudson.Launcher launcher,
                                                                 hudson.model.TaskListener listener,
                                                                 hudson.EnvVars envVars,
                                                                 String matlabCommand,
                                                                 String uniqueName)
                                                          throws IOException,
                                                                 InterruptedException

This Method decorates the launcher with MATLAB command provided and returns the Process object to launch MATLAB with appropriate startup options like -r or -batch

Parameters:

workspace - Current build workspace

launcher - Current build launcher

listener - Current build listener

envVars - Environment variables of the current build

matlabCommand - MATLAB command to execute on shell

Returns:

matlabLauncher returns the process launcher to run MATLAB commands

Throws:

IOException

InterruptedException

copyFileInWorkspace

default void copyFileInWorkspace(String sourceFile,
                                 String targetFile,
                                 hudson.FilePath targetWorkspace)
                          throws IOException,
                                 InterruptedException

Throws:

IOException

InterruptedException

getFilePathForUniqueFolder

default hudson.FilePath getFilePathForUniqueFolder(hudson.Launcher launcher,
                                                   String uniqueName,
                                                   hudson.FilePath workspace)
                                            throws IOException,
                                                   InterruptedException

Throws:

IOException

InterruptedException

getUniqueNameForRunnerFile

default String getUniqueNameForRunnerFile()

prepareTmpFldr

default void prepareTmpFldr(hudson.FilePath tmpFldr,
                            String runnerScript)
                     throws IOException,
                            InterruptedException

Throws:

IOException

InterruptedException

replaceZipPlaceholder

default String replaceZipPlaceholder(String script,
                                     String url)

getRunnerScript

default String getRunnerScript(String script,
                               String params,
                               String uniqueTmpFldrName)

getValidMatlabFileName

default String getValidMatlabFileName(String actualName)