DRAT Sequential

DRAT (Distributed Release Audit Tool) Sequential

What

This is a simple utility which uses DRAT to scan multiple code repositories sequentially and dump its output to user defined directory.

---

Why

As we know that DRAT runs on single code repository and generates the output. But what if we have large number of repositories to be scanned and record their individual statistics. This utility can be leveraged to such large-scale tasks.

---

How to use

Presently, script ‘dratseq’ has two actions defined in it – run and help.

run – This command takes two arguments:

• Path to a flat file containing a list of repositories to traverse. Each line in the file represents the absolute path to one source code repository containing code we wish to analyze. Eg: the entries below provide examples of paths referencing Apache Tika and Apache Nutch codebases on a local file system.

/apacheSvn/tika
/apacheSvn/nutch

• Path to the output directory where the contents of ${DRAT_HOME}/data will be copied to, for each repository. Each folder in the output directory follow standard naming conventions i.e.
  • Remove the first character which will always start with ‘/’
  • All ‘/’ will be replaced with ‘_’
  • And it will be appended with current timestamp in the format YYYYmmddHHMMSS (YearMonthDateHourMinuteSeconds) Example - An output directory of ‘/apacheSvn/tika’ repository can be written as apacheSvn_tika_20150919090532

help – This command takes no arguments and returns usage of the command ‘dratseq’. A sample output of the same is as below:

  Usage: dratseq [run] in order to analyze multiple repositories.
  
  run <path to list of repository URLs> <path to data directory>  | start OODT and analyze the repositories
  
  help                  | print this message

---

How it Works

The script follows below steps in sequence:

1. Check for correct number of arguments passed to run command. If false, exit.
2. Check if the first argument is file and second is a directory. If false, exit.
3. Check if environment variables (JAVA_HOME and DRAT_HOME) are set. If false, exit.
4. While read each repository from the list:

• Check if the repository path exists. If false, continue to next repository.
• Start OODT. If failed to start, exit.
• Run DRAT on the repository.
• Check if DRAT was successful. Prints error message.
• Stop OODT. If failed to stop, exit.
• Creates a sub-directory in the output directory to records DRAT statistics.
• Copy ${DRAT_HOME}/data to the user-defined output directory.
• Reset DRAT.

5. Endwhile.