Skip to content

quafzi/judge

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Judge

Judge is a tool to examine Magento extensions regarding their qualitiy and compatibility.

Installation

Install judge with Composer:

git clone git://github.com/NetresearchAppFactory/judge.git && cd judge && curl -s https://getcomposer.org/installer | php; php composer.phar install --prefer-source

That's all. Happy judging :)

Usage

To evaluate an extension, you simply call

judge evaluate /path/to/extension

and you will get a summary report after a while.

There are some command line options available:

Judge command line parameters
parameter description
--config (-c) provide a configuration file (default: 'ini/sample.judge.ini')
--verbose (-v) Increase output verbosity

Prerequisites

Judge obtains information on various Magento versions from a database that needs to be created before running the tool. Restore the database dump from judge.sql.zip (included in the root directory) and set your database credentials via Configuration.

Configuration

Judge comes with a sample configuration file, which resides at ini/sample.judge.ini. The most relevant configuration part is [plugins], where you can adjust tools, measures and other special settings for all evaluations.

Quality Checks

CheckComments

This check evaluates the extension's code comment ratio.

CheckStyle

Checks, if the extension follows the Magento coding guidelines.

CodeCoverage

Runs unit tests (if available) and calculates their coverage.

CodeRuin

Detect unfinished parts of code.

CoreHacks

Detect if the extension uses include hacks to override Magento core components.

MageCompatibility

Try to find compatible Magento version. This is a very tricky task, since Magento uses a lot of Magic.

The extension gets parsed and all class dependencies, method calls and constants usage will be compared to all Magento versions (although we currently check only CE 1.3.2.4-1.7.0.2 and EE 1.8.0.0-1.10.1.1). We extracted all these tokens from the different Magento versions and inserted them in the database shipped with Judge. The tokens represent * existing classes * existing constants * existing methods * magic get/set/has/uns for database fields (although we may not detect them all).

We know, that there are a lot of false alarms, especially due to magic get/set/has/uns that also exist in code in some Magento versions. So here is a lot of work to do.

There are some very hard nuts: For instance, Varien_Data_Form_Element_Abstract supports calling getOriginalData, but that is done by a magic getter. Since it is a form element, there is no database representation for this property and so our scripts did not recognize that. That's why we introduced a JSON file (plugins/MageCompatibility/var/fixedVersions.json), where you can add tokens you know to be supported by some specific version.

PerformanceCheck

Try to find some well-known performance killers.

PhpCompatibility

Detect the minimum required PHP version to run the extension.

Rewrites

Count rewrites of the extension. The more rewrites an extension includes, the less compatibility to other extensions can be expected.

SecurityCheck

Try to find some well-known security leaks.

SourceCodeComplexity

Calculates the source code complexity.

Architecture

Judge is based on the Jumpstorm architecture, which is very flexible, so that every component could be replaced by another one. So it should be no problem to use another Logger or even to provide a web interface (although the least should not be possible for Jumpstorm that easy...).

Every single check is made by a Judge plugin, which in most cases calls an external tool via exec().

About

Evaluate Magento extension quality

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published