mariazevedo88 / o3smeasures-tool

Eclipse plug-in to evaluate software internal quality of Java projects.

o3smeasures

Plug-in for Eclipse to measure software internal quality. It was developed as part of my dissertation entitled "A Quantitative Study to Characterize the Internal Quality of Open-Source Object-Oriented Software Systems".

About o3smeasures

This is a plug-in for Eclipse to measure software internal quality in Java projects. In the plug-in development, we used the Eclipse IDE (Oxygen), the Java Development Tools (JDT), the Plug-in Development Environment (PDE), and Abstract Syntax Tree (AST). In JDT, there are tools for manipulating Java code. In PDE, there are tools to develop and test plug-ins in the Eclipse IDE.

Dependencies

• Java 8 or higher
• Eclipse IDE Oxygen or higher
• jUnit 5 (org.junit.jupiter.api, org.junit.jupiter.engine and org.junit.jupiter.params - 5.0.0)
• org.eclipse.ui (3.109.0 or higher)
• org.eclipse.core.resources (3.12.0 or higher)
• org.eclipse.jdt.core (3.13.102 or higher)
• org.eclipse.core.runtime (3.13.0 or higher)
• org.eclipse.jface.text (3.12.2 or higher)

How to use as an Eclipse Application

o3smeasures can be used as an Eclipse Application, importing the project into your workspace. After import the o3smeasures project, with the right mouse button you need select the option Run as -> Eclipse Application. In the runtime eclipse application, select a Java project to be measured and with the right mouse button, go to O3SMeasures -> Analyze Java project.

Executing tests

After import the o3smeasures project, with the right mouse button you need select the option Run as -> JUnit Plug-in Test.

How to install

On dropins directory

o3smeasures plug-in is installed in the Eclipse directory. You need to paste the .jar on the dropins directory (eclipse -> dropins). After installed the o3smeasures project into your workspace, select a Java project to be measured and with the right mouse button, go to O3SMeasures -> Analyze Java project.

Install new Software interface

Run Eclipse, go to Help menu -> Install New Software... On the opening dialog add a new Remote site named o3smeasures with the following url https://raw.githubusercontent.com/mariazevedo88/o3smeasures-plugin/master/site.xml and follow the instructions.

On Eclipse Marketplace

Run Eclipse, go to Help menu -> Eclipse Marketplace... On the opening dialog, search for o3smeasures. Finding the plugin, click on the Install button and follow the instructions.

Displaying the views

The o3smeasures views can be enabled by the eclipse menu Window -> Show View -> Other ... -> o3smeasures.

Exporting files

To export the measurement results in the O3SMeasures Diagnostic view, with the right mouse button in the view, select the option Export to CSV file to export in the .csv format or Export to XML file to export in the .xml format.

Uploading files

In version 2.1.0 or above, it is possible to upload measurement diagnostic reports to an s3 bucket on Amazon (AWS). With the right mouse button in the view, select the option Upload to AWS S3 Bucket to export in the .csv or .xml format.

The formating options and the bucket configurations has to be defined on the Preferences Page, that can be access by the eclipse menu Window -> Preferences -> o3smeasures Preferences.

Contributing

o3smeasures-tool's Issues

Create automation project in Github Action

Create the automation workflow of the project in Github Actions.

CyclomaticComplexity calculation

The Cyclomatic Complexity calculation is not considering MethodInvocation expressions.

LackCohesionMethodsTwo calculation

The LackCohesionMethodsTwo calculation it's wrong. The correct formula is:

(avg(m(a)) - m)/(1 - m)

Atualizar testes unitários para JUnit5

Os testes unitários do projeto atualmente estão desenvolvidos com JUnit4. Atualizar o framework para a versão 5.

Files backup option in an AWS S3 bucket

In addition to the options to export the measurement file (.csv or .xml) to the local device, create an option to export them to an AWS (Amazon Cloud) S3 bucket.

NumberOfChildren calculation

The calculation of the Number of Children measure is considering the relationship implements and should not.

Plugin is allowing multiple projects to be selected, but measuring one at a time

A plugin bug was noticed after email feedback requesting help in understanding the evaluation of multiple projects.

The plugin was designed to evaluate only one project at time, but was allowing multiple projects to be selected.

Create a menu separation between export and upload options

Correct project's configuration for Eclipse Oxygen or above

Adjust project's configuration so that it can be run from at least Eclipse Oxygen to the latest Eclipse release

[enhancement] Ability to export full results, not only summarized.

It would be great if you can export every data in the results and not only the summarized/collapsed view.

Show reference values of measures

Show if the measurements are below, average or above the reference values suggested in the literature/specialists.

[discussion] Possibility of headless (no-GUI) execution.

It is great the ability to measure and have all the metrics directly in Eclipse IDE. Anyway, it would be great if you can have the results without the graphic interface, so you can use this measures as part of, for example, a Continuous Integration (CI) pipeline or execute it for a group of projects in an unattended way.

No menu item to run analyzer

I've installed Eclipse 2020-09 and used the Marketplace client to install O3SMeasures. I opened a workspace that has some projects from various Git repos. I opened the 5 views in Window > Show Views > Other... > o3smeasures. When I right click a Java based project, there is no "O3SMeasures -> Analyze Java project" on the context menu. How do I analyze my code? There's nothing that shows up in the workspace's .log file that relevant; only some key binding stuff.

!SESSION 2020-12-01 11:38:49.326 -----------------------------------------------
eclipse.buildId=4.17.0.I20200902-1800
java.version=11.0.8
java.vendor=Red Hat, Inc.
BootLoader constants: OS=win32, ARCH=x86_64, WS=win32, NL=en_US
Framework arguments: -product org.eclipse.epp.package.jee.product
Command-line arguments: -os win32 -ws win32 -arch x86_64 -product org.eclipse.epp.package.jee.product

WeightMethodsPerClass calculation

The WeightMethodsPerClass calculation is not considering MethodInvocation, Finally blocks and Java 8 expressions, such as Lambda and Method Reference.