Skip to content

JENKINS-63395 - Move ZAP Proxy object initialisation to just prior to #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alehane wants to merge 2 commits into
base: development
Choose a base branch
from
+80 −41
Open

JENKINS-63395 - Move ZAP Proxy object initialisation to just prior to #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b00ae8
JENKINS-63395 - Move ZAP Proxy object initialisation to just prior to
alehane Aug 14, 2020
017daac
Update findbugs maven plugin to latest version
alehane Aug 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,11 @@
<additionalparam>-Xdoclint:none</additionalparam>
</configuration>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>findbugs-maven-plugin</artifactId>
<version>3.0.5</version>
</plugin>
</plugins>
</build>

Expand Down
116 changes: 75 additions & 41 deletions src/main/java/org/jenkinsci/plugins/zap/ZAPBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,21 +61,21 @@

/**
* The main class of the plugin. This class adds a build step in a Jenkins job that allows you to launch the ZAP security tool and generate reports based on the alerts.
*
*
* @author Goran Sarenkapa
* @author Mostafa AbdelMoez
* @author Tanguy de Lignières
* @author Abdellah Azougarh
* @author Thilina Madhusanka
* @author Johann Ollivier-Lapeyre
* @author Ludovic Roucoux
*
*
*/
public class ZAPBuilder extends Builder {

/**
* The @DataBoundConstructor is a constructor and it's parameter names must match the fields in associated config file {@link "com/github/jenkinsci/zaproxyplugin/ZAPBuilder/config.jelly"} and additional can set the parameter values for the global configurations {@link "com/github/jenkinsci/zaproxyplugin/ZAPBuilder/global.jelly"}.
*
*
* @param startZAPFirst
* of type boolean: start zap as a pre-build step or not.
* @param zapHost
Expand Down Expand Up @@ -128,6 +128,52 @@ public boolean prebuild(AbstractBuild<?, ?> build, BuildListener listener) {
Utils.lineBreak(listener);
Utils.loggerMessage(listener, 0, "[{0}] START PRE-BUILD ENVIRONMENT VARIABLE REPLACEMENT", Utils.ZAP);

/* Start ZAP as a Pre-Build step. */
if (startZAPFirst) {
initializeZapProxy(build, listener, false);

Utils.lineBreak(listener);
Utils.loggerMessage(listener, 0, "[{0}] START PRE-BUILD STEP", Utils.ZAP);
Utils.lineBreak(listener);

try {
Launcher launcher = null;
Node node = build.getBuiltOn();

/* Create launcher according to the build's location (Master or Slave) and the build's OS */
if ("".equals(node.getNodeName())) launcher = new LocalLauncher(listener, build.getWorkspace().getChannel());
else { /* Build on slave */
boolean isUnix;
if ("Unix".equals(((SlaveComputer) node.toComputer()).getOSDescription())) isUnix = true;
else isUnix = false;
launcher = new RemoteLauncher(listener, build.getWorkspace().getChannel(), isUnix);
}
proc = zaproxy.startZAP(build, listener, launcher);
}
catch (Exception e) {
e.printStackTrace();
listener.error(ExceptionUtils.getStackTrace(e));
return false;
}
Utils.loggerMessage(listener, 0, "[{0}] END PRE-BUILD STEP", Utils.ZAP);
Utils.lineBreak(listener);
Utils.loggerMessage(listener, 0, "[{0}] COMMENCEMENT OF SELENIUM SCRIPTS, ZAP WILL NOW LISTEN ON THE DESIGNATED PORT", Utils.ZAP);
Utils.lineBreak(listener);
}
return true;
}

/**
* Initialise the ZAP Proxy and perform variable substitution.
*
* @param build The builder object is use.
* @param listener The build listener.
* @param calledDuringBuild flag to indicate where in the build process this was called from.
*/
protected void initializeZapProxy(
final AbstractBuild<?, ?> build,
final BuildListener listener,
final boolean calledDuringBuild) {
/* Replaces the environment variables with the corresponding values */
String zapHost = zaproxy.getZapHost();
if (zapHost == null || zapHost.isEmpty()) throw new IllegalArgumentException("ZAP HOST IS MISSING");
Expand Down Expand Up @@ -208,10 +254,18 @@ public boolean prebuild(AbstractBuild<?, ?> build, BuildListener listener) {
listFiles = ws.act(new LogCallable(this.zaproxy.getZapSettingsDir()));
}
catch (IOException e) {
e.printStackTrace(); /* No listener because it's not during a build but it's on the job config page. */
if (calledDuringBuild) {
listener.error("IOxception occured during build", e);
} else {
e.printStackTrace(); /* No listener because it's not during a build but it's on the job config page. */
}
}
catch (InterruptedException e) {
e.printStackTrace(); /* No listener because it's not during a build but it's on the job config page. */
if (calledDuringBuild) {
listener.error("InterruptedException occured during build", e);
} else {
e.printStackTrace(); /* No listener because it's not during a build but it's on the job config page. */
}
}

Utils.loggerMessage(listener, 1, "CLEARING ZAP HOME DIRECTORY/{0}", ZAPDriver.NAME_LOG_DIR.toUpperCase());
Expand All @@ -224,47 +278,24 @@ public boolean prebuild(AbstractBuild<?, ?> build, BuildListener listener) {
stringForLogger = ws.act(new DeleteFileCallable(listFile.getAbsolutePath(), stringForLogger));
}
catch (IOException e) {
e.printStackTrace();
if (calledDuringBuild) {
listener.error("IOxception occured during build", e);
} else {
e.printStackTrace();
}
}
catch (InterruptedException e) {
e.printStackTrace();
if (calledDuringBuild) {
listener.error("InterruptedException occured during build", e);
} else {
e.printStackTrace();
}
}
Utils.loggerMessage(listener, 1, "{0}", stringForLogger);
Utils.lineBreak(listener);
}
}

/* Start ZAP as a Pre-Build step. */
if (startZAPFirst) {
Utils.lineBreak(listener);
Utils.loggerMessage(listener, 0, "[{0}] START PRE-BUILD STEP", Utils.ZAP);
Utils.lineBreak(listener);

try {
Launcher launcher = null;
Node node = build.getBuiltOn();

/* Create launcher according to the build's location (Master or Slave) and the build's OS */
if ("".equals(node.getNodeName())) launcher = new LocalLauncher(listener, build.getWorkspace().getChannel());
else { /* Build on slave */
boolean isUnix;
if ("Unix".equals(((SlaveComputer) node.toComputer()).getOSDescription())) isUnix = true;
else isUnix = false;
launcher = new RemoteLauncher(listener, build.getWorkspace().getChannel(), isUnix);
}
proc = zaproxy.startZAP(build, listener, launcher);
}
catch (Exception e) {
e.printStackTrace();
listener.error(ExceptionUtils.getStackTrace(e));
return false;
}
Utils.loggerMessage(listener, 0, "[{0}] END PRE-BUILD STEP", Utils.ZAP);
Utils.lineBreak(listener);
Utils.loggerMessage(listener, 0, "[{0}] COMMENCEMENT OF SELENIUM SCRIPTS, ZAP WILL NOW LISTEN ON THE DESIGNATED PORT", Utils.ZAP);
Utils.lineBreak(listener);
}
return true;
}

/** Method called when the build is launching */
Expand All @@ -274,6 +305,9 @@ public boolean perform(AbstractBuild<?, ?> build, Launcher launcher, BuildListen
Utils.lineBreak(listener);
Utils.loggerMessage(listener, 0, "[{0}] START BUILD STEP", Utils.ZAP);
Utils.lineBreak(listener);

initializeZapProxy(build, listener, true);

proc = zaproxy.startZAP(build, listener, launcher);
}
catch (Exception e) {
Expand Down Expand Up @@ -362,13 +396,13 @@ public static String applyMacro(AbstractBuild<?, ?> build, BuildListener listene

/**
* @Extension indicates to Jenkins this is an implementation of an extension point.
*
*
* Descriptor for {@link ZAPBuilder}. Used as a singleton. The class is marked as public so that it can be accessed from views.
*
* <p>
* See <tt>src/main/resources/com/github/jenkinsci/zaproxyplugin/ZAPBuilder/*.jelly</tt> for the actual HTML fragment for the configuration screen.
*/
@Extension
@Extension
public static final ZAPBuilderDescriptorImpl DESCRIPTOR = new ZAPBuilderDescriptorImpl();

public static final class ZAPBuilderDescriptorImpl extends BuildStepDescriptor<Builder> {
Expand Down Expand Up @@ -497,7 +531,7 @@ private static class CopyFileCallable implements FileCallable<String> {
private File sourceFile;
private String destination;
private String stringForLogger;

public CopyFileCallable(File sourceFile, String destination, String stringForLogger) {
this.sourceFile = sourceFile;
this.destination = destination;
Expand Down