MSUSEL Pattern

Introduction

Basic Process

1. Select Projects
   • Uses the rubysf extractor
2. For each project
   • Execute cloning operation
   • Select correct branch/tag
   • Detect build system
   • Build Project
   • Detect location of class files
   • Store project info into a properties file
3. For each project
   • Execute FindBugs and PMD Anslyses
   • Collect results from both into Issues and store in Db
   • Execute Metrics Analysis and store into Db
   • Execute Pattern Analysis and store into Db
   • Construct TD and Quality Models
   • Conduct Quality and TD analyses using info from Db and store to Db
     • This needs to be filtered using the patterns identified

MSUSEL Project dependencies

This project depends on the following other MSUSEL subprojects:

1. msusel-parent
2. msusel-codetree

Building

There are two options:

1. You can use your own version of Maven and run the following commands at the command line, from the project root directory:

   • Compiling:

       $ mvn clean compile -Dmaven.test.skip=true

   • Packaging into a Jar with dependencies

       $ mvn clean package -Dmaven.test.skip=true

   • Packaging into a Jar and deploying to the maven repo:

       $ mvn clean deploy -Dmaven.test.skip=true

2. You can use the Maven wrapper which comes with the project:

   • On Mac and Linux:
     • Compiling:

       $ ./mvnw clean compile -Dmaven.test.skip=true

     • Packaging into a Jar with Dependencies:

       $ ./mvnw clean package -Dmaven.test.skip=true

     • Packaging into a Jar and deploying to the maven repo:

       $ ./mvnw clean deploy -Dmaven.test.skip=true

   • Windows:
     • Compiling:

       $ .\mvnw.cmd clean compile -Dmaven.test.skip=true

     • Packaging into a Jar with Dependencies:

       $ .\mvnw.cmd clean package -Dmaven.test.skip=true

     • Packaging into a Jar and deploying to the maven repo:

       $ .\mvnw.cmd clean deploy -Dmaven.test.skip=true

License

As will all projects from MSUSEL this project is licensed under the MIT open source license. All source files associated with this project should have a copy of the license at the top of the file.

If a build fails due to license header issues, this can be remedied using the following command sequence at the command line:

• With an independently installed Maven system:
  • Linux, Mac, Windows:

   $ mvn license:format

• Using the Maven Wrapper:
  • Linux and Mac:

   $ ./mvnw license:format

  • Windows:

   $ .\mvnw.cmd license:format