Moose-CI

Moose-CI runs automatic Moose analyses on software projects.

Disclaimer: This project is at a very early stage. It only has a few features and may contain bugs.

You can request features in the issues tab.

Table of Contents

• Features
• For users
  • Usage with Docker
  • Available commands
  • Configuration
  • Available rules
• For developers
  • Installation

Features

Some of features it should offer:

• run alone ("headless" mode)
• load a project (either from command line or in a configuration file)
• accept projects inany programming language that Moose can handle (C, Java, Pharo, Python, Typescript,...)
• run a list of analyses (either "standard" ones, or some specified in a configuration file)
• output the results as JSON and console text
• output the results in other formats (XML, CSV, HTML,...)

Some metrics and analyses that are envisionned:

• size (LOC, # of classes,...)
• report number of entities that fail the rules
• list too big classes (based on LOC or # members)
• list too big methods/functions (based on LOC)
• list of too complex methods/functions (based on cyclomatic complexity)
• list of too large method/function APIs (# number of parameters)
• packages/modules in cyclic dependencies
• list of code clones

In would be good to be able to output some visualizations already available in Moose:

• DSM (Dependency Structure Matrix)
• Architectural view
• System complexity
• Distribution map

For users

Usage with Docker

The easiest way to run Moose-CI is with Docker. You do not need Pharo or any other dependency.

First, pull the image:

docker pull ghcr.io/moosetechnology/moose-ci:latest

Moose-CI runs in an isolated container. Mount your project to /src:

docker run -v /path/to/your/project:/src ghcr.io/moosetechnology/moose-ci:latest analyze /src

For the current directory:

docker run -v "$(pwd):/src" ghcr.io/moosetechnology/moose-ci:latest analyze /src

Available commands

• init — create a new moose-ci config file.
• analyze — analyze the current directory using the existing config file.
• analyze <project-path> — analyze the project.

Report output

Running analyze prints the report to the console and writes it to files in the output directory (.moose-ci/report/ by default, relative to the analyzed project).

By default a JSON report is written to report.json:

{
  "metrics" : {
    "files" : 8,
    "loc" : 5,
    "packages" : 2,
    "classes" : 3
  },
  "violations" : [
    {
      "rule" : "No docstring",
      "severity" : "Hint",
      "count" : 3,
      "entities" : [
        {
          "entity" : "DummyClass",
          "file" : "relative/path/to/no_docstring.py",
          "startLine" : 1,
          "endLine" : 2
        }
      ]
    }
  ]
}

Violations are grouped by rule. Each group contains the rule name, its severity, the number of violating entities and the details of each entity (name, file and source lines).

You can configure the output in moose-ci.ston:

#outputFormats : [
		#json
],
#outputPath : '.moose-ci/report'

• #outputFormats — list of formats to write. #json is the only format available for now.
• #outputPath — directory (relative to the project) where the report files are written.

Configuration

Moose-CI uses a moose-ci.ston config file. Run moose-ci init to create one.

You can configure the report output formats and location here too (see Report output).

You can update the rules list and customize each rule's threshold:

...
#rules : [
		#long_file: 1000,
		#no_docstring,
		#too_many_parameters: 10
]
...

Available rules

Key	Threshold	Description
#long_file	1000	Reports files whose number of lines of code exceeds the threshold.
#no_docstring	N/A	Reports functions, methods and classes that are missing a docstring.
#too_many_parameters	10	Reports methods whose number of parameters exceeds the threshold.
#large_class	20	Reports classes that have too many methods or attributes.
#local_var_naming	N/A	Reports local variables and parameters whose names do not respect the naming convention.
#unused_local_variable	N/A	Reports local variables that are written but never read.
#unused_parameter	N/A	Reports function and method parameters that are never used.
#unused_private_method	N/A	Reports class-private methods that are never invoked.
#shadowed_attribute	N/A	Reports attributes whose name duplicates their containing class name.
#function_naming	N/A	Reports functions whose names do not comply with the naming convention.

For developers

Installation

Load MooseCI in a Moose image with Metacello:

Metacello new
  baseline: 'MooseCI';
  repository: 'github://moosetechnology/MooseCI:master/src';
  load.