[HACKYSTAT-DEV-L] HackyInstaller PreMigration Code Review

Julie Ann Sakuda Fri, 01 Jul 2005 18:42:09 -0700

Greetings, folks:

This Wednesday (07.06.2005) at 12:30PM in POST 307, we will be reviewing the six classes in HackyInstaller. To perform this review:

0. Install and/or update (a) the Eclipse Jupiter plug-in and (b) The Hackystat Jupiter sensor.

1. Download the hackyInstaller module from CVS. Please note that this is pre-migration so the hackyInstaller module is located on katrina.

2. Select "PreMigrationCSDL" as the ReviewID.

Please review the following files:

These are located in src folder of hackyInstaller:

* org.hackystat.kernel.installer.view.cli.SensorControl

* org.hackystat.kernel.installer.util.thread.SaveThread

* org.hackystat.kernel.installer.util.HackyInstallerLogger

* org.hackystat.kernel.installer.sensor.SensorXmlParser

These are located in the sensor folder of hackyInstaller:

* org.hackystat.sensor.installer.build.BuildSensorInstaller

* org.hackystat.sensor.installer.eclipse.EclispeSensorInstaller

We would like you to focus on the following:

1. In SensorControl please consider the way that it is structured and they was that the class handles the command-line arguments. Is there a better way to structure things?

2. In SaveThread look at the way validation occurs before the saving of the properties. Any comments about how it is done?

3. HackyInstallerLogger logs all messages in the HackyInstaller console window and logs exceptions. The logger works properly and writes to hackyinstaller.log. However, everything being logged is also being shown on the command prompt window. Is there a missing property or line of the code that should be changed to stop the printing out to the prompt?

4. In SensorXmlParser there is one particularly long method called "parseFiles." It parses all the sensor definitions (xml files). Should/could we shorten this method? Keep in mind that we are using JDOM.

5. For BuildSensorInstaller and EclipseSensorInstaller we aren't looking for anything in particular. Just rate the understandability and if the way things are being done makes sense.

-------------------------------------------------------------

Supplemental Links and Resources:

The Hackystat Code Review Guidelines:

* http://hackydev.ics.hawaii.edu/hackyDevSite/doc/Review.html

The Elements of Hacky Style:

* http://hackydev.ics.hawaii.edu/hackyDevSite/doc/EHS.html

Jupiter Code Review Tool documentation:

* http://csdl.ics.hawaii.edu/Tools/Jupiter/Core/doc/UsersGuide.html

Hackystat Jupiter Sensor documentation:

* http://hackystat.ics.hawaii.edu/hackystat/controller?Page=help&Subpage=install&Sensor=Eclipse-Jupiter

Thanks for reviewing the code!

In case you have questions here is who you should contact: