Skip to main content

Inspect code with FindBugs

Today I'd like to introduce an Open Source software we use for three years at least to perform code review and identify potential bugs in our Java code. Its name is FindBugs. It works performing static analysis of the Java bytecode. It covers different categories of bugs, including those related to the web applications security (this was the main reason we started to use it, but later we begun to use it for different categories of bugs). The software is distributed as a standalone GUI application or as plug-in available for the most famous IDEs. In this post I will refer to the plugin for Eclipse Indigo.
You can download FindBugs from the the official website
http://findbugs.sourceforge.net/
If you plan to use FindBugs as Eclipse plug-in you don’t need to download and install the standalone application too.
The plug-in requires the Eclipse release 3.3 or later and the JDK release 1.5 or later. The installation of the plug-in is very simple:
  • In Eclipse, click on Help -> Install New Software...
  • Click on the Add button.
  • Enter the following and after click OK:  Name: FindBugs update site , Location: one of the following (note: no final slash on the url) , http://findbugs.cs.umd.edu/eclipse for official releases , http://findbugs.cs.umd.edu/eclipse-candidate for candidate releases and official releases , http://findbugs.cs.umd.edu/eclipse-daily for all releases, including developmental ones
  • Click on the Select All button and the on the Next button.
  • In the Installation Details window click on the Next button.
  • Accept the terms of the license agreement and then click on the Finish button.
  • The plugin is not digitally signed. Go ahead and install it anyway.
  • Click Restart Now to make Eclipse restart itself.

FindBugs plugin provides a FindBugs perspective (see Figure 1). To execute on a project double click on the project name and then click on Find Bugs



Figure 1 – The FindBugs perspective

At the end of the project code analysis the Bug Explorer will show a list of the found bugs grouped by category. Clicking on a bug you will see the fragment of code affected by the bug and a more detailed description of the bug with suggestions to eliminate it. You can refer to the official documentation on the website for a full detailed explanation of the error categories.
You can customize the plugin by the project properties menu (see Figure 2). It is possible to include/exclude bug categories, set the analysis effort, set the XML report parameters and add filters.



Figure 2 – FindBugs preference settings
Labels:

Comments

  1. GooglielmoMay 26, 2013 at 4:04 PM

    This week the blog reached (and went beyond) the 1000 visits. I want to say "Thank you" to the readers and to the people that contacted me to share viewpoints about the arguments of my posts.

    ReplyDelete

Post a Comment

Popular posts from this blog

Exporting InfluxDB data to a CVS file

Sometimes you would need to export a sample of the data from an InfluxDB table to a CSV file (for example to allow a data scientist to do some offline analysis using a tool like Jupyter, Zeppelin or Spark Notebook). It is possible to perform this operation through the influx command line client. This is the general syntax: sudo /usr/bin/influx -database '<database_name>' -host '<hostname>' -username '<username>'  -password '<password>' -execute 'select_statement' -format '<format>' > <file_path>/<file_name>.csv where the format could be csv , json or column . Example: sudo /usr/bin/influx -database 'telegraf' -host 'localhost' -username 'admin'  -password '123456789' -execute 'select * from mem' -format 'csv' > /home/googlielmo/influxdb-export/mem-export.csv
6 comments
Read more

jOOQ: code generation in Eclipse

jOOQ allows code generation from a database schema through ANT tasks, Maven and shell command tools. But if you're working with Eclipse it's easier to create a new Run Configuration to perform this operation. First of all you have to write the usual XML configuration file for the code generation starting from the database: <?xml version="1.0" encoding="UTF-8" standalone="yes"?> <configuration xmlns="http://www.jooq.org/xsd/jooq-codegen-2.0.4.xsd">   <jdbc>     <driver>oracle.jdbc.driver.OracleDriver</driver>     <url>jdbc:oracle:thin:@dbhost:1700:DBSID</url>     <user>DB_FTRS</user>     <password>password</password>   </jdbc>   <generator>     <name>org.jooq.util.DefaultGenerator</name>     <database>       <name>org.jooq.util.oracle.OracleDatabase</name>     ...
Post a Comment
Read more

Turning Python Scripts into Working Web Apps Quickly with Streamlit

 I just realized that I am using Streamlit since almost one year now, posted about in Twitter or LinkedIn several times, but never wrote a blog post about it before. Communication in Data Science and Machine Learning is the key. Being able to showcase work in progress and share results with the business makes the difference. Verbal and non-verbal communication skills are important. Having some tool that could support you in this kind of conversation with a mixed audience that couldn't have a technical background or would like to hear in terms of results and business value would be of great help. I found that Streamlit fits well this scenario. Streamlit is an Open Source (Apache License 2.0) Python framework that turns data or ML scripts into shareable web apps in minutes (no kidding). Python only: no front‑end experience required. To start with Streamlit, just install it through pip (it is available in Anaconda too): pip install streamlit and you are ready to execute the working de...
12 comments
Read more