added the ability to pass argument to scan-build

Author: Joshua Kennedy

src/main/java/jenkins/plugins/clangscanbuild/ClangScanBuildBuilder.java

@@ -1,16 +1,22 @@
 package jenkins.plugins.clangscanbuild;
 
+import java.io.IOException;
+
+import javax.servlet.ServletException;
+
 import hudson.Extension;
 import hudson.FilePath;
 import hudson.Launcher;
 import hudson.Util;
 import hudson.model.BuildListener;
 import hudson.model.AbstractBuild;
 import hudson.tasks.Builder;
+import hudson.util.FormValidation;
 import jenkins.plugins.clangscanbuild.commands.BuildContextImpl;
 import jenkins.plugins.clangscanbuild.commands.ScanBuildCommand;
 
 import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.QueryParameter;
 
 /**
  * This builder provides a new build step for freestyle jobs.  Users can 
@@ -35,6 +41,7 @@ public class ClangScanBuildBuilder extends Builder{
     private String xcodeProjectSubPath;
     private String workspace;
     private String scheme;
+    private String scanbuildargs;
 
     @DataBoundConstructor
     public ClangScanBuildBuilder( 
@@ -44,7 +51,8 @@ public ClangScanBuildBuilder(
     		String clangInstallationName,
     		String xcodeProjectSubPath,
     		String workspace,
-    		String scheme ){
+    		String scheme,
+    		String scanbuildargs ){
 
         this.target = Util.fixEmptyAndTrim( target );
         this.targetSdk = Util.fixEmptyAndTrim( targetSdk );
@@ -53,6 +61,7 @@ public ClangScanBuildBuilder(
         this.xcodeProjectSubPath = Util.fixEmptyAndTrim( xcodeProjectSubPath );
         this.workspace = Util.fixEmptyAndTrim( workspace );
         this.scheme = Util.fixEmptyAndTrim( scheme );
+        this.scanbuildargs = Util.fixEmptyAndTrim( scanbuildargs );
     }
 
     public String getClangInstallationName(){
@@ -79,6 +88,10 @@ public String getScheme(){
 		return scheme;
 	}
 
+	public String getScanbuildargs(){
+		return scanbuildargs;
+	}
+	
 	/**
 	 * Removing slashes here in case the user adds a starting slash to the path.
 	 */
@@ -89,7 +102,7 @@ public String getXcodeProjectSubPath(){
 		}
 		return xcodeProjectSubPath;
 	}
-
+	
 	/**
 	 * This method is invoked when a job is actually executed.  It is the magic method.
 	 * @return boolean - if 'false', build will be aborted
@@ -109,6 +122,7 @@ public boolean perform( @SuppressWarnings("rawtypes") AbstractBuild build, Launc
 		xcodebuild.setTarget( getTarget() );
 		xcodebuild.setTargetSdk( getTargetSdk() );
 		xcodebuild.setConfig( getConfig() );
+		xcodebuild.setAdditionalScanBuildArguments( getScanbuildargs() );
 		xcodebuild.setClangOutputFolder( new FilePath( build.getWorkspace(), ClangScanBuildUtils.REPORT_OUTPUT_FOLDERNAME) );
 		xcodebuild.setWorkspace( getWorkspace() );
 		xcodebuild.setScheme( getScheme() );

src/main/java/jenkins/plugins/clangscanbuild/ClangScanBuildDescriptor.java

@@ -64,7 +64,6 @@ public void setInstallations( ClangScanBuildToolInstallation[] clangInstallation
         save();
     }
 
-	// TARGET SDK
     public FormValidation doCheckTargetSdk( @QueryParameter String value ) throws IOException, ServletException {
     	if( value.length() == 0 ) return FormValidation.error( "You must provide a target SDK.  You can execute 'xcodebuild -showsdks' from Terminal.app to see allowed values." );
         return FormValidation.ok();

src/main/java/jenkins/plugins/clangscanbuild/actions/ClangScanBuildAction.java

@@ -4,13 +4,17 @@
 import hudson.model.Action;
 import hudson.model.ModelObject;
 import hudson.model.AbstractBuild;
+import hudson.util.FormValidation;
 
 import java.io.IOException;
 import java.util.regex.Pattern;
 
+import javax.servlet.ServletException;
+
 import jenkins.plugins.clangscanbuild.ClangScanBuildUtils;
 import jenkins.plugins.clangscanbuild.history.ClangScanBuildBugSummary;
 
+import org.kohsuke.stapler.QueryParameter;
 import org.kohsuke.stapler.StaplerProxy;
 import org.kohsuke.stapler.StaplerRequest;
 import org.kohsuke.stapler.StaplerResponse;
@@ -120,8 +124,6 @@ public Object getTarget(){
 		return this;
 	}
 
-	
-	
 	/**
 	 * This method is used to serve up report HTML files from the hidden build folder.  It essentially exposes
 	 * the reports to the web.

src/main/java/jenkins/plugins/clangscanbuild/commands/ScanBuildCommand.java

@@ -15,6 +15,8 @@ public class ScanBuildCommand implements Command{
 
     private String target;
 
+    private String additionalScanBuildArguments; // Passed directly to shell
+    
     private String workspace;
     private String scheme;
 
@@ -30,12 +32,24 @@ public int execute( BuildContext context ) throws Exception {
 
 		ArgumentListBuilder args = new ArgumentListBuilder();
 		args.add( getClangScanBuildPath() );
+		
 		args.add( "-k" ); // keep going on failure
 		args.add( "-v" ); // verbose
 		args.add( "-v" ); // even more verbose
+		
 		args.add( "-o" ); // output folder
 		args.add( "" + clangOutputFolder.getRemote().replaceAll( " ", "/ " ) + "" );
 
+		String additionalArgs = getAdditionalScanBuildArguments();
+		if( isNotBlank( additionalArgs ) ){
+			// This is a hack.  I can't call the standard ArgumentListBuilder.add() method because it checks for spaces with-in
+			// the arg and quotes the arg if a space exists.  Since user's can pass commands like
+			// '--use-cc=`which clang`' or multiple commands...we cannot allow the quotes to be 
+			// inserted when spaces exist.  The ArgumentListBuilder.addTokenized() splits the arg on spaces and adds each piece 
+			// which ends up reinserting the spaces when the command is assembled.
+			args.addTokenized( additionalArgs );
+		}
+		
 		args.add( "xcodebuild" );
 
 		if( isNotBlank( getWorkspace() ) ){ 
@@ -147,4 +161,12 @@ public void setScheme(String scheme) {
 		this.scheme = scheme;
 	}
 
+	public String getAdditionalScanBuildArguments() {
+		return additionalScanBuildArguments;
+	}
+
+	public void setAdditionalScanBuildArguments(String additionalScanBuildArguments) {
+		this.additionalScanBuildArguments = additionalScanBuildArguments;
+	}
+
 }

src/main/resources/jenkins/plugins/clangscanbuild/ClangScanBuildBuilder/config.jelly

@@ -34,6 +34,10 @@
     		<f:textbox default="" />
   		</f:entry>
 
+  		<f:entry title="Additional scan-build arguments" field="scanbuildargs">
+    		<f:textbox default="" />
+  		</f:entry>
+  		
 	</f:advanced>
 
 </j:jelly>

src/main/resources/jenkins/plugins/clangscanbuild/ClangScanBuildBuilder/help-scanbuildargs.html

@@ -0,0 +1,3 @@
+This field can be used to pass additional arguments to clang scan-build.  The arguments will be inserted into the final command with a space before 
+and after what you type in this field.  The arguments will appear before the xcodebuild sub command.  You can view the assembled command by viewing the
+job's build console.

src/test/java/jenkins/plugins/clangscanbuild/ClangScanBuildBuilderTest.java

@@ -14,15 +14,15 @@ public void testRoundTripConfiguration() throws Exception{
 
 		FreeStyleProject p = createFreeStyleProject();
 
-		ClangScanBuildBuilder builderBefore = new ClangScanBuildBuilder( "target", "sdk", "config", "installName", "projPath", "workspace", "scheme" );
+		ClangScanBuildBuilder builderBefore = new ClangScanBuildBuilder( "target", "sdk", "config", "installName", "projPath", "workspace", "scheme", "someargs" );
 		p.getBuildersList().add( builderBefore );
 
 		HtmlForm form = createWebClient().getPage( p, "configure" ).getFormByName( "config" );
 		submit( form );
 
 		ClangScanBuildBuilder builderAfter = p.getBuildersList().get( ClangScanBuildBuilder.class );
 
-		assertEqualBeans( builderBefore, builderAfter, "target,config,targetSdk,xcodeProjectSubPath,workspace,scheme" );
+		assertEqualBeans( builderBefore, builderAfter, "target,config,targetSdk,xcodeProjectSubPath,workspace,scheme,scanbuildargs" );
 	}
 
 }

src/test/java/jenkins/plugins/clangscanbuild/commands/ScanBuildCommandTest.java

@@ -40,7 +40,7 @@ public void xcode4WorkspaceSet() throws Exception{
 		command.setTarget( "myTarget" );
 		command.setTargetSdk( "myTargetSdk" );
 		command.setWorkspace( "myWorkspace" );
-		
+
 		String actual = buildCommandAndReturn( command );
 
 		String expected = "/ScanBuild -k -v -v -o OutputFolder xcodebuild -workspace myWorkspace -scheme myScheme -configuration myConfig -sdk myTargetSdk clean build";
@@ -78,4 +78,45 @@ private String buildCommandAndReturn( ScanBuildCommand command ) throws Exceptio
 		return argumentListCapture.getValue().toStringWithQuote();
 	}
 
+	@Test
+	public void xcode4WorkspaceSetWithSingleScanBuildArgument() throws Exception{
+		// XCode 4 workspace/scheme should override unnecessary target
+		ScanBuildCommand command = new ScanBuildCommand();
+		command.setClangOutputFolder( new FilePath( new File( "OutputFolder" ) ) );
+		command.setClangScanBuildPath( "/ScanBuild" );
+		command.setConfig( "myConfig" );
+		command.setProjectDirectory( new FilePath( new File( "/ProjectDir" ) ) );
+		command.setScheme( "myScheme" );
+		command.setTarget( "myTarget" );
+		command.setTargetSdk( "myTargetSdk" );
+		command.setWorkspace( "myWorkspace" );
+		command.setAdditionalScanBuildArguments( "--use-cc=`which clang`" );
+
+		String actual = buildCommandAndReturn( command );
+		
+		// Jenkins core quotes this due to the space in between 'which' and 'clang' .  Not sure if this is OK or not... :(
+		String expected = "/ScanBuild -k -v -v -o OutputFolder --use-cc=`which clang` xcodebuild -workspace myWorkspace -scheme myScheme -configuration myConfig -sdk myTargetSdk clean build";
+		Assert.assertEquals( expected, actual );
+	}
+	
+	@Test
+	public void xcode4WorkspaceSetWithMultipleScanBuildArguments() throws Exception{
+		// XCode 4 workspace/scheme should override unnecessary target
+		ScanBuildCommand command = new ScanBuildCommand();
+		command.setClangOutputFolder( new FilePath( new File( "OutputFolder" ) ) );
+		command.setClangScanBuildPath( "/ScanBuild" );
+		command.setConfig( "myConfig" );
+		command.setProjectDirectory( new FilePath( new File( "/ProjectDir" ) ) );
+		command.setScheme( "myScheme" );
+		command.setTarget( "myTarget" );
+		command.setTargetSdk( "myTargetSdk" );
+		command.setWorkspace( "myWorkspace" );
+		command.setAdditionalScanBuildArguments( "-h -x somevalue" );
+
+		String actual = buildCommandAndReturn( command );
+		
+		String expected = "/ScanBuild -k -v -v -o OutputFolder -h -x somevalue xcodebuild -workspace myWorkspace -scheme myScheme -configuration myConfig -sdk myTargetSdk clean build";
+		Assert.assertEquals( expected, actual );
+	}
+	
 }