Getting started

Setup is easy! In just two simple steps, you can be running tests on your Drupal module. But first...

Provide read only access

In addition to the steps below, if your code is in a private repository, then we recommend you have ReviewDriven access your project code with a user account that has read only access. Input of secure account information (including a private key) is covered in detail on Base Properties and Common Scenarios.

To begin using ReviewDriven, you need to establish an account.

Register an account

  • You will receive an email confirmation with a one-time login link.
  • Click on that link to login.
  • Change your password.

Register account

After registering your account, to run tests on a Drupal module requires two simple steps.

1. Define a group of reviews
2. Define a job

These two steps are illustrated below. [For more details on a particular item, click on links in the text.]

Define a group

A group is a hierarchical container whose children may be other groups or jobs. Because of the property inheritance feature of ReviewDriven, the parent group of a set of jobs will often define a common set of code to review for the child jobs. A review may consist of a syntax or coding style check, or a functional test suite.

  • Login to your account.
  • Click on the "Groups" tab.

No groups found

  • Click on the "Group" link beneath the General heading.

No groups found

  • Enter a title for your group.
  • Enter the properties that specify the code to be reviewed (see below).
  • Click the Save button.

Add group

  • Copy and paste the lines below (omitting the PHP open and close tags).
  • The syntax is standard PHP array.
  • The "vcs" item defines the version control repositories for Drupal core and Weather.
  • ReviewDriven defaults the "path" item (not shown) indicating the code to be reviewed is the Weather module.

<?php
  
'vcs' => array(
    
'' => 'git://http://git.drupal.org/project/drupal.git/7.x',
    
'sites/all/modules/weather' => 'git://http://git.drupal.org/project/weather.git/7.x-1.x',
  ),
?>

  • ReviewDriven confirms your group has been created.

Group created

Define a "scan" job

A scan job reviews the code (defined in your group) to confirm no syntax errors and collects a list of test classes contained in the code.

  • Click on the "Scan" link beneath the Drupal heading (see preceding image).
  • Enter a title for your job.
  • Click the Save button.

No groups found

  • ReviewDriven confirms your job has been created.
  • ReviewDriven indicates your job is queued.

Add group

Define a "test" job

A test job reviews the code (defined in your group) by executing a test suite against the code. The test suite may include unit and functional tests.

  • Click on the "Test (from scan)" link beneath the Drupal heading (see preceding image).
  • Enter a title for your job.
  • ReviewDriven automatically enters the "scan" key with the ID of the scan job.
  • Click the Save button.

No groups found

  • ReviewDriven confirms your job has been created.
  • ReviewDriven indicates your job is queued.

Add group