News

This week The apache Ignite book becomes one of the top books of leanpub

This week The apache Ignite book becomes one of the top books of leanpub.

Saturday

Code review with Sonar

Last week Sonar announced their new version 2.8 with a few new features and bug fixes. The main new feature is the support of custom code review. Crucible and Review board are another alternative code review system. Sonar come across with code coverage and review in one system, which is easy to maintain with small effort.
As usual sonar administrator must create users to assign tasks and collaborations. Sonar provide LDAP plugin which enables the delegation of Sonar authentication to an external system. Currently LDAP plugin supports LDAP and Active directory. In our corporation we are using active directory and first of all i tried to configure the LADP plugin. LDAP plugin wiki fully describes the installation of the plugin with LDAP system but poorly with AD. With some effort with my boss we were able to configure the plugin with our AD system. Follows i am sharing the configuration:
#-------------------
# Sonar LDAP Plugin
#-------------------

# IMPORTANT : before activation, make sure that one Sonar administrator is defined in the external system
# Activates the plugin. Leave blank or comment out to use default sonar authentication.
sonar.authenticator.class: org.sonar.plugins.ldap.LdapAuthenticator

# Ignore failure at startup if the connection to external system is refused.
# Users can browse sonar but not log in as long as the connection fails.
# When set to true, Sonar will not start if connection to external system fails.
# Default is false.
#sonar.authenticator.ignoreStartupFailure: true

# Automatically create users (available since Sonar 2.0).
# When set to true, user will be created after successful authentication, if doesn't exists.
# The default group affected to new users can be defined online, in Sonar general settings. The default value is "sonar-users".
# Default is false.
#sonar.authenticator.createUsers: true

# (omit if you use autodiscovery) URL of the LDAP server.
# If you are using ldaps, then you should install server certificate into java truststore.
# eg. ldap://localhost:10389
ldap.url: ldap://mycompany.com

# (optional) Distinguished Name (DN) of the root node in LDAP from which to search for users,
# eg. “ou=users,o=mycompany”
ldap.baseDn: dc=mycompany,dc=com

# (optional) Bind DN is the username of an LDAP user to connect (or bind) with.
# This is a Distinguished Name of a user who has administrative rights,
# eg. “cn=sonar,ou=users,o=mycompany”. Leave blank for anonymous access to the LDAP directory.
ldap.bindDn: ADADMIN

# (optional) Bind Password is the password of the user to connect with.
# Leave blank for anonymous access to the LDAP directory.
ldap.bindPassword: ADADMIN_PASSWORD

# Login Attribute is the attribute in LDAP holding the user’s login.
# Default is ‘uid’. Set ’sAMAccountName’ for Microsoft Active Directory
ldap.loginAttribute: sAMAccountName

# Object class of LDAP users.
# Default is 'inetOrgPerson'. Set ‘user’ for Microsoft Active Directory.
ldap.userObjectClass: user

# (advanced option) See http://java.sun.com/products/jndi/tutorial/ldap/security/auth.html
# Default is 'simple'. Possible values: 'simple', 'CRAM-MD5', 'DIGEST-MD5', 'GSSAPI'.
ldap.authentication: simple

# (advanced option)
# See
# http://java.sun.com/products/jndi/tutorial/ldap/security/digest.html
# http://java.sun.com/products/jndi/tutorial/ldap/security/crammd5.html
# eg. example.org
#ldap.realm:

# (advanced option) Context factory class.
# Default is 'com.sun.jndi.ldap.LdapCtxFactory'.
#ldap.contextFactoryClass: com.sun.jndi.ldap.LdapCtxFactory
Configuration may vary on your AD system, strongly guess system administrator may help in this issue.
For now in the time of the authentication, Sonar will ignore the password from it's own system and delegate the username and password to the active directory for authentication. Also sonar administrator must configure the role for each user independently.
After installing plugin we are ready to go for code review. On the violations tab we should see the review link as follows:
Now we can add comments on violations, by default task will assign to the author of the comment:
After creating the task we also can reassign the task to another user as follows:
All the reviews you can get from the dash board
For more screen shots you should visit this link (sonar-2-8-in-screenshots).
One shortage of the sonar code review is the lack of notification, when any comment or task assign to the users. I believe that, in future release sonar will add this notification functionality in code review.

6 comments :

Javin Paul said...

Sonar is such a great tool not just for code review but for code coverage also. we are in the process of setting up sonar for our project to get full benefit of it. By the way nice article , thanks .

Javin
How HashMap works in Java

Amit said...

Nice article. Coincidentally I am struggling with sonar installation with Oracle 11g as the database. Which database do you use for sonar setup?

Shamim Ahmed Bhuiyan said...

@Amit,
We are using Oracle 10g XE for sonar. There are a problem with UTF-8 encoding with Oracle 10g DB.

Amit said...

Strange. I tried installing sonar 2.8 as a standalone application with Oracle Database 11g Release 11.2.0.2.0 (Standard Edition) and I get the below error where the insert query on users table fails.

ActiveRecord::ActiveRecordError: ORA-00904: "ENABLED": invalid identifier
: INSERT INTO users (row_identifier, login_id, full_name, email, row_version, user_id, enabled, login, name, crypted_password, salt, created_at, updated_at, remember_token, remember_token_expires_at, id) VALUES(null, null, null, '', null, null, 0, 'admin', 'Administrator', 'fdf038c3d9a8f1a260c7fe3c6657e91dc46ca448', '43b15bc57d3bd82b408970c550c03fdd8f29d95e', TIMESTAMP'2011-06-03 21:42:54', TIMESTAMP'2011-06-03 21:42:54', null, null, ?)

The insert query syntax does not match with the physical table structure of the users table. Looks like something basic is missing.

Any idea?

Shamim Ahmed Bhuiyan said...

@Amit,
First check your oracle jdbc driver version. Next you can investigate the users table, seems column name ENABLED is not there or you should rename the column with proper data type.
You can also get a few interesting information's from the following blog
http://javamicrosurgery.blogspot.com/2011/03/installing-sonar-to-work-with-oracle.html

I had such problem's with Apache archiva and fixed by editing jpox files in the source code. You can the story here:
http://frommyworkshop.blogspot.com/2010/12/deploy-apache-archiva-133-on-oracle.html

Amit said...

Thanks for sharing the "install sonar to work with Oracle" blog link. The queries to be executed for creating the oracle schema (user) were different from the ones which I had used. Strange but works.

Thanks again.