Bails - Bash script extensions for Grails

Introduction

Bails is a set of bash scripts aimed at making grails development simpler.

Bails makes some assumptions about the tools and libraries you have available, and should make life easier if you're using them.

Motivation

• grails scripts don't exist for some common tasks
• running grails scripts is slow
• writing codenarc rules is beyond me

Installation

Add the following to your grails-app/conf/BuildConfig's plugins closure:

build ':bails:0.3.1'

and then run the following:

grails compile && grails bails-init

This will set up the bails directory in your project. You can then run bails scripts like so:

bails/plugin/release

N.B. this will need some tweaking if your plugins temp directory is not target/. Pull requests to fix this are welcome!

Stack

Bails assumes you are using the following frameworks/tools/languages and will help you to integrate with them:

• Git
• Jenkins
• Jenkins Violations Plugin

Requirements

Bails requires the following tools/frameworks/languages for some or all of its functionality:

• bash
• GNU-compatible tools (inc. sed and grep) (requires special setup on OSX)
• nodejs

Installation

symlink

1. download bails onto your computer: git clone ____
2. set up the BAILS_HOME environment variable
3. link to bails inside your grails project: ln -s bails $BAILS_HOME/scripts

as git submodule

This approach is probably more suitable... TODO document it

Use

To execute a bails script, just call bails/$scriptName from your grails project's root directory.

The scripts

Hopefully the script names are intuitive. Here is a summary of those available:

check_for/..

These are similar to codenarc rules - static 'analysis' (usually grepping) for antipatterns in source code.

test/..

These scripts help repeat common and less common test functionality.

report/..

These scripts run some kind of metrics on your code and produce reports for these metrics.

violations

These scripts are for integration with the Jenkins Violations Plugin.

Scripts TODO

build_deploy
optimise_images
release
run_with_updated_snapshots
test_and_backup
test_functional
test_migrations

plugin/build
plugin/rm_excluded_files

jsunit/test
jsunit/xunit_report

Release Notes

0.7

• added jenkin's safe-merge of feature branch script

0.4.1

• fixed test/this_branch for machines which require Spec to be appended to each spec name when running grails test-app

0.4

• Updated bails-init script to automatically detect the bails version

0.1

• added lots of scripts, including plugin build_deploy and release
• added grails plugin setup script

TODO

• move execution permission change into Install script - it's a bit inconvenient in shared environments otherwise
• add all the scripts
• document git submodule setup

BUGS

• csslint does not fail if csslint package is unavailable
• nodejs "check for lib" doesn't actually work