Using CodeSonar With Hudson

• Before you start
• Integrate a Hudson Job with CodeSonar
• Examples

Before you start

The Hudson project has been discontinued and archived. If your development group is not currently using Hudson, we recommend using a different CI tool, such as Jenkins (which is the successor to Hudson).

This page is provided for users who are already using Hudson and wish to integrate with CodeSonar.

Integrate a Hudson Job with CodeSonar

There are three main steps.

• A. Set up a Hudson job to build your software.
• B. Make sure CodeSonar is ready to analyze your software.
• C. Incorporate the CodeSonar build/analysis in your Hudson job.

A. Set up a Hudson job to build your software

1. Using a web browser, navigate to the Hudson dashboard at http://localhost:8080.
2. Click New Job (in the menu at the left of the dashboard).
3. Provide basic job information:
   1. Enter a name for the job.
   2. Select Build a free-style software job.
   3. Click OK.
   Hudson will display a "Job Configurations" page.
4. Under Build, click Add build step, and select one of the options from the menu that pops up:
   • Select Execute shell if you normally build from a shell script (or from a shell command that you can embed in a shell script for use with Hudson).
   • Select Execute Windows batch command if you normally build by invoking a Windows batch file (or from a tool that can export a batch file for you to use with Hudson).
   • Select Invoke Ant if you normally build with Ant.
   • Note that the option to build a Maven 2/3 project (Legacy) is not recommended by the authors of the Hudson book (See The Hudson Book, chapter 6).
5. Specify the build details required for the option you selected in the previous step.
   • If you need additional help, click the help ("?") icon provided at the right of the form field.
6. Click Save.
   Hudson will display a page about your new job - this is the "Job Dashboard".
7. Test your new job.
   1. Click Build Now. Hudson will execute your specified build command.
      When the build command has completed, Hudson will update the Build History, including a colored dot to indicate whether or not the build was successful.
   2. Whether or not the build was successful, check the Latest Console output to ensure that the build proceeded as you expected.
   3. If necessary, click Configure and adjust your specified build step or steps, and make any other changes necessary to get your job running correctly.
8. Once your Hudson job is correctly building your software, go on to the next section to integrate the CodeSonar analysis into your build.

   The next step is B. Make sure CodeSonar is ready to analyze your software.

B. Make sure CodeSonar is ready to analyze your software

1. Make sure that $CSONAR/codesonar/bin is in the PATH of the user who is running Hudson.
   • Otherwise, the codesonar analyze command you construct in the next section will have to specify the path to the codesonar executable.
2. Start the CodeSonar hub to use for recording the analysis results (if it is not already running).
   The remainder of these instructions will refer to the hub location as host:port.
3. Establish a project directory and project name for the CodeSonar project that will be built and analyzed.
   • If you have previously analyzed your software with CodeSonar, you can use the existing project infrastructure.
   • Otherwise, choose a project directory, and create the directory if it does not already exist.
   In either case, make sure the project directory has a suitable location and read/write settings. If Hudson is running with different OS credentials to your own, remember to take this into account.
   • Use the same project directory and project name every time you perform the CodeSonar build/analysis for a given project.
   • The project directory should not be deleted at the end of the build: the CodeSonar GUI needs to interact with its contents, and incremental builds need information that is stored there.
     • Make sure that the project directory is in a location where Hudson will not automatically delete it after running the job. For example, it is probably a good idea to locate it outside the Hudson workspace.
     • Similarly, take steps to ensure that your other build tools will not delete the project directory.
   • Set the project directory permissions to allow the Hudson process to read and write to it.
   The remainder of these instructions will refer to the project directory as projdir and the project name as proj-name.
4. If the project directory does not include a general project configuration file (for example, because you just created the directory in the previous step), create one now:
   codesonar create-conf projdir/proj-name
5. Edit the general project configuration file (projdir/proj-name.conf) to specify your required configuration parameter settings (unless the factory settings are suitable). In particular:
   • You may wish to specify one or more CFLAGS_APPEND rules.
   • If you are performing a clean build every time, set INCREMENTAL_BUILD=No.
6. Make sure there is a CodeSonar launch daemon running on the analysis machine, with the same owner as the Hudson process.
   • If the analysis machine is running Windows, check to see whether there is a cslaunchd service on the analysis machine, with the same owner as the Hudson process. If not, set one up.

     Note that if Hudson is running as a service, its owner will usually be SYSTEM.

   • Otherwise, arrange to start the launch daemon at system startup.
7. Go on to C. Incorporate the CodeSonar build/analysis in your Hudson job.

C. Incorporate the CodeSonar build/analysis in your Hudson job

1. View the Job Dashboard for the Hudson job that is building your software.
2. Click Configure to open the Job Configurations page.
3. Edit the Build section to integrate the CodeSonar build/analysis.

   C and C++ projects	For every existing build step that involves C/C++ compilation, edit the build step to incorporate the CodeSonar build/analysis command (see Build and Analysis for C/C++ Projects for more information). If the current build step or steps contain one command that involves C/C++ compilation, this will involve constructing a single codesonar analyze command. Otherwise there are two possible approaches: Accumulate components into a CodeSonar project by constructing a codesonar build command for each software build command that involves C/C++ compilation, then add a final codesonar analyze command to analyze the project. or Replace the text of the build step or steps with an invocation of a shell script or batch file with equivalent contents, then construct a single codesonar analyze command based on that invocation. The codesonar analyze command must include either the -foreground option or the wait option (but not both). Note that -foreground cannot be used with -remote analysis-launchd. See Example 1 and Example 2.
   Java projects	Add a new, final build step that executes the CodeSonar Java build/analysis with a suitable cs-java-scan command (see Build and Analysis for Java Projects for more information). The codesonar analyze command must include either the -foreground option or the -wait option (but not both). Note that -foreground cannot be used with -remote analysis-launchd. See Example 3.
   Mixed Java and C/C++ projects	Combine the approaches for Java-only and C/C++-only projects: Edit the build steps to incorporate a codesonar build command for each software build command that involves C/C++ compilation. Add a new build step that executes codesonar build with a suitable cs-java-scan command. Add a new, final build step that invokes codesonar analyze to analyze the project. See Example 4 and Example 5.

4. Click OK.
5. Check that everything is working properly.
   1. Click Build Now. Hudson will execute the updated job.
   2. Check that the Hudson job executed successfully, and check the Latest Console output to ensure that the build proceeded as you expected.
      • If necessary, click Configure and adjust your edits, and make any other changes necessary to get your job running correctly.
      • If the CodeSonar build/analysis is not running to completion, the manual section on Troubleshooting the build may be helpful
   3. Open the CodeSonar GUI in your web browser and inspect your analysis results.

Examples

cd /myfiles/src/projX && make normal

cd /myfiles/src/projX &&
codesonar analyze /myfiles/csonar_projects/projX/ProjectX -foreground alexdesktop:7340 make normal

cd /myfiles/src/projX
rm -f *.o
gcc -c A.c
gcc -c B.c
gcc -c C.c

cd /myfiles/src/projX
rm -f *.o
codesonar build /myfiles/csonar_projects/projX/projectX -foreground  alexdesktop:7340 gcc -c A.c
codesonar build /myfiles/csonar_projects/projX/projectX -foreground alexdesktop:7340 gcc -c B.c
codesonar build /myfiles/csonar_projects/projX/projectX -foreground alexdesktop:7340 gcc -c C.c
codesonar analyze /myfiles/csonar_projects/projX/projectX -foreground alexdesktop:7340 

cd /myfiles/src/projX
rm -f *.o
gcc -c A.c
gcc -c B.c
gcc -c C.c

cd /path/to/dir && codesonar analyze projectX -foreground alexdesktop:7340 sh -xe mybuildscript.sh

cd \myfiles\src\projX
rm -f *.o
gcc -c A.c
gcc -c B.c
gcc -c C.c

codesonar analyze projectX -foreground alexdesktop:7340 path\to\dir\mybuildbat.bat

codesonar analyze /myfiles/csonar_projects/projX/ProjectX -foreground alexdesktop:7340 cs-java-scan -include-artifacts /myfiles/buildoutput/classes -include-sources /myfiles/sources

cd /myfiles/src/projX
make all

cd /myfiles/src/projX 
codesonar build /myfiles/csonar_projects/projX/ProjectX -foreground alexdesktop:7340 make all
codesonar build /myfiles/csonar_projects/projX/ProjectX -foreground alexdesktop:7340 cs-java-scan -include-artifacts /myfiles/buildoutput/classes -include-sources /myfiles/sources
codesonar analyze /myfiles/csonar_projects/projX/ProjectX -foreground alexdesktop:7340

cd /myfiles/src/projX
rm -f *.o
rm -f *.class
gcc -c A.c
gcc -c B.c
javac J.java

cd /myfiles/src/projX
rm -f *.o
rm -f *.class
codesonar build /myfiles/csonar_projects/projX/projectX -foreground  alexdesktop:7340 gcc -c A.c
codesonar build /myfiles/csonar_projects/projX/projectX -foreground alexdesktop:7340 gcc -c B.c
javac J.java
codesonar build /myfiles/csonar_projects/projX/ProjectX -foreground alexdesktop:7340 cs-java-scan -include-artifacts /myfiles/buildoutput/classes -include-sources J.java
codesonar analyze /myfiles/csonar_projects/projX/projectX -foreground alexdesktop:7340 

Do More With Hudson

To get the most value out of Hudson, you will probably want to take advantage of more of its features (if you are not already doing so).

Some initial suggestions:

• Install and use plug-ins relevant to the build tools that you use: see The Hudson Book, chapter 5.
• Integrate your Hudson project with your source control system: see The Hudson Book, chapter 9.
• Set up build triggers: see The Hudson Book, chapter 6.

We also highly recommend that you read 7 Ways to Optimize Jenkins/Hudson by Kohsuke Kawaguchi, who created Hudson and Jenkins.