Skip to content

Latest commit

 

History

History
109 lines (80 loc) · 4.7 KB

TUTORIAL_eng.md

File metadata and controls

109 lines (80 loc) · 4.7 KB
Raw

JNose - Tutorial

Java TestSmells Detection

JNose Test is a tool developed to automatically detect test smells in test code, and to collect coverage metrics. The Jnose was basead on TsDetecet. Besides presentig the test smells numbers detected by class, our toll shows:

  • The collection of code metrics and test coverage using the JaCoCo library
  • An unified result for all projects under analysis
  • And a graphical interface. In addition, the project uses Apache Maven to manage all library dependencies and offer support to the build and run of the JNose test tool.

Prerequisites

Dependence on Project (JNose-Core)

It is necessary to install the "jnose-core" dependency for JNose to work. Below is the step by step to install, before installing Jnose.

git clone https://github.com/arieslab/jnose-core
cd jnose-core
mvn install
  • JDK 11
  • Maven 3
  • GIT

Download and Run

Home Screen

On the home screen we have the description of each search option and the configuration option:

  • by ClassTest: Performs the search based on the test class, returning the quantity of each type of test smells found in each class.
  • by TestSmells: performs the search based on the smell of the test, displaying in which class and in which line that it was found.
  • Evolution: Search in the project repository(git) looking for test smells in each commit/tag done.
  • Configuration: We have the option to choose which test smells we want to perform the research, by default all are selected.

Initially we paste the repository link on the project screen E.g: https://github.com/tassiovirginio/jnose

After paste the address of the repository, you can see that the project on the page and you can update this project for the latest version by using git pull function any time. In the box below, all projects will be displayed.

Then you can choise display the tests smells by ClassTest or By TestSmells on the Menu bar

By ClassTest

on ByClassTest screen we can select all the projects that are in the list, or select only a few of them, with the checkbox option that each project has on the side of its name.

Then we will have the search for test smells being executed by clicking on the "Analyse" button.

The Search will start and we will be able to follow through the progress bar in each project and in the general progress bar.

At the end of the process, you can click on the "result" button to see the result on the page

You also can export the CSV file, by clicking on the button "export csv" on this screen The result will display the following return: Project Name, Test Class, Production Class, LOC, Number of Methods and the number of each of the 21 test_smells found per test class.

By TestSmells

In this option, the search by test smells will display the following return: Project Name, Test Class, Production Class, name of test smells, method name, occurrence line, initial occurrence line, final occurrence line.

Evolution

Using GIT version control, we can perform a search for test smell on each commit performed or tag existing in the project history. The return is the same as ByClassTest, with additional commit information:

  • commit ID
  • commit name
  • commit date
  • commit message

To use this option the project must be cloned: git clone https: //address.do.project

Configuration

On this screen we can select which types of test smells you want to search in your project.

Contact email: