This is an old revision of the document!
This page shows a guideline for installing FINDER.
Prerequisites:
You need to have Javex, Grok, and QL installed before running FINDER. These tools are developed by the Software Architecture Group (SWAG) at the University of Waterloo, and they can be found at SWAG site.
samples?
Make sure you have set up certain environment variables for using all these tools, so that FINDER knows where they are.
samples?
Installation:
Download and extract FINDER.
In order to detect patterns by FINDER, you will need to edit the following files in the conf directory:
- software.xml
- directory – path to the software java class files
- name – software system name
- source_directory – path to the software source code.
(Note: FINDER relies on both class files and source code of the target system.)
- scripts.xml
- scriptsDirectory – path to FINDER scripts, which refer to FINDER/scripts
- candidateInstancesDirectory – path to detection results output directory
- designpatterns.xml
- designpattern – By commenting in/out each “designpattern” tag, you can choose certain design patterns to be included during the detection stage.
- ql_script – path to the specific FINDER script for the related design pattern. They are located at FINDER/scripts/ql/ .
- run.properties
- input.design.patterns.xml.file – path to the above designpatterns.xml file
- input.software.xml.file – path to the above software.xml file
- input.scripts.xml.file – path to the above scripts.xml file
- output.exception.txt.file – path to exception output file
To run FINDER, go to FINDER/bin and run the following commands:
java -Xms1024M -XmX1024M -Xss5000K ca.yorku.cse.FINDER.Engine “path to run.properties file”
This page shows a guideline for using the MoRe application suite.
First, download the MoRe application suite.
- Detection raw results converters
- FINDER converter