sharnessify.sh

#!/bin/sh
#
# Copyright (c) 2015 Christian Couder
# MIT Licensed; see the LICENSE file in this repository.
#
# Script to add sharness infrastructure to a project

SHARNESS_URL="https://github.com/chriscool/sharness.git"
LIB_BASE_DIR="lib"
SHARNESS_BASE_DIR="sharness"
INSTALL_NAME="install-sharness.sh"
MAKEFILE_NAME="Makefile"

USAGE="$0 [-h] [-v] [-l <local>] [<directory>]"

usage() {
    echo "$USAGE"
    echo "	Add sharness infrastructure to a project"
    echo "	Options:"
    echo "		-h|--help: print this usage message and exit"
    echo "		-v|--verbose: print logs of what happens"
    echo "		-l|--local: use local Sharness repo to clone from"
    exit 0
}

die() {
    echo >&2 "fatal: $@"
    exit 1
}

log() {
    test -z "$VERBOSE" || echo "->" "$@"
}

PROJ_DIR=""
VERBOSE=""

# get user options
while [ "$#" -gt "0" ]; do
    # get options
    arg="$1"
    shift

    case "$arg" in
	-h|--help)
	    usage ;;
	-v|--verbose)
	    VERBOSE=1 ;;
	-l|--local)
	    SHARNESS_URL="$(cd "$1" && pwd)" || die "could not cd into '$1'"
	    shift
	    test -n "$SHARNESS_URL" || die "invalid Sharness URL '$SHARNESS_URL'"
	    log "SHARNESS_URL is now set to '$SHARNESS_URL'"
	    ;;
	-*)
	    die "unrecognised option: '$arg'\n$USAGE" ;;
	*)
	    test -z "$PROJ_DIR" || die "too many arguments\n$USAGE"
	    PROJ_DIR="$arg"
	    ;;
    esac
done

# Setup PROJ_DIR properly
test -n "$PROJ_DIR" || PROJ_DIR="."
log "PROJ_DIR is set to '$PROJ_DIR'"
test -d "$PROJ_DIR" || echo >&2 "warning: '$PROJ_DIR' will be created"

# Get the directory that contains this script
PARENT_DIR=$(cd "$(dirname "$0")" && pwd) ||
die "could not get script parent directory from '$0'"
TEMPLATE_DIR="$PARENT_DIR/templates"
TEMPLATE_INSTALL="$TEMPLATE_DIR/$INSTALL_NAME"
TEMPLATE_MAKEFILE="$TEMPLATE_DIR/$MAKEFILE_NAME"
log "This script's parent directory is '$PARENT_DIR'"

# Create sharness directories
SHARNESS_DIR="$PROJ_DIR/$SHARNESS_BASE_DIR"
SHARNESS_LIB_DIR="$SHARNESS_DIR/$LIB_BASE_DIR"
mkdir -p "$SHARNESS_LIB_DIR" ||
die "could not create '$SHARNESS_LIB_DIR' directory"
log "SHARNESS_LIB_DIR ($SHARNESS_LIB_DIR) is ready"

# Copy sharness install script
cp "$TEMPLATE_INSTALL" "$SHARNESS_LIB_DIR/" ||
die "could not copy '$TEMPLATE_INSTALL' into '$SHARNESS_LIB_DIR/'"
INSTALL_SCRIPT="$SHARNESS_LIB_DIR/$INSTALL_NAME"
log "INSTALL_SCRIPT ($INSTALL_SCRIPT) has been copied from '$TEMPLATE_DIR'"

# Create temp directory
DATE=$(date +"%Y-%m-%dT%H:%M:%SZ")
TMPDIR=$(mktemp -d "/tmp/sharnessify.$DATE.XXXXXX") ||
die "could not 'mktemp -d /tmp/sharnessify.$DATE.XXXXXX'"
log "TMPDIR ($TMPDIR) created"

# Clone Sharness
(
    cd "$TMPDIR" || die "could not cd into '$TMPDIR'"
    git clone "$SHARNESS_URL" ||
    die "could not clone from '$SHARNESS_URL'"
) || exit
log "Sharness cloned from '$SHARNESS_URL'"

# Get Sharness version
SHARNESS_VERSION=$(cd "$TMPDIR/sharness" && git rev-parse HEAD)
test -n "$SHARNESS_VERSION" ||
die "could not get Sharness version from repo in '$TMPDIR/sharness'"
log "SHARNESS_VERSION is set to '$SHARNESS_VERSION'"

# Substitute variables in install script
ESCAPED_URL=$(echo "$SHARNESS_URL" | sed -e 's/[\/&]/\\&/g')
sed -i "s/XXX_SHARNESSIFY_VERSION_XXX/$SHARNESS_VERSION/" "$INSTALL_SCRIPT" ||
die "could not modify '$INSTALL_SCRIPT'"
sed -i "s/XXX_SHARNESSIFY_URL_XXX/$ESCAPED_URL/" "$INSTALL_SCRIPT" ||
die "could not modify '$INSTALL_SCRIPT'"
sed -i "s/XXX_SHARNESSIFY_LIB_XXX/$LIB_BASE_DIR/" "$INSTALL_SCRIPT" ||
die "could not modify '$INSTALL_SCRIPT'"
sed -i "s/XXX_SHARNESSIFY_SHARNESS_XXX/sharness/" "$INSTALL_SCRIPT" ||
die "could not modify '$INSTALL_SCRIPT'"
log "Variables substituted in '$INSTALL_SCRIPT'"

# Add .gitignore
GIT_IGNORE="$SHARNESS_DIR/.gitignore"
echo "$LIB_BASE_DIR/$SHARNESS_BASE_DIR/" >"$GIT_IGNORE"
echo "test-results/" >>"$GIT_IGNORE"
echo "trash directory.*.sh/" >>"$GIT_IGNORE"
log "'$GIT_IGNORE' created"

# Run install script
(
    cd "$SHARNESS_DIR"  || die "could not cd into '$SHARNESS_DIR'"
    "$LIB_BASE_DIR/$INSTALL_NAME" || die "installation script '$INSTALL_SCRIPT' failed"
) || exit
log "INSTALL_SCRIPT ($INSTALL_SCRIPT) ran in '$SHARNESS_DIR'"

# Copy a simple test into the test directory
SIMPLE_TEST_ORIG="$TMPDIR/sharness/test/simple.t"
SIMPLE_TEST_DEST="$SHARNESS_DIR/t0000-sharness.sh"
SHARNESS_TEST_LIB="$LIB_BASE_DIR/$SHARNESS_BASE_DIR/sharness.sh"
ESCAPED_TEST_LIB=$(echo "$SHARNESS_TEST_LIB" | sed -e 's/[\/&]/\\&/g')
cp "$SIMPLE_TEST_ORIG" "$SIMPLE_TEST_DEST" ||
die "could not copy '$SIMPLE_TEST_ORIG' to '$SIMPLE_TEST_DEST'"
sed -i "s/. .\/sharness.sh/. .\/$ESCAPED_TEST_LIB/" "$SIMPLE_TEST_DEST" ||
die "could not modify '$SIMPLE_TEST_DEST'"
log "Simple test ($SIMPLE_TEST_DEST) created"

# Cleanup temp directory
rm -rf "$TMPDIR"

# Copy Makefile
cp "$TEMPLATE_MAKEFILE" "$SHARNESS_DIR/" ||
die "could not copy '$TEMPLATE_MAKEFILE' into '$SHARNESS_DIR/'"
MAKEFILE_SCRIPT="$SHARNESS_DIR/$MAKEFILE_NAME"
log "MAKEFILE_SCRIPT ($MAKEFILE_SCRIPT) has been copied from '$TEMPLATE_DIR'"

# Substitute variables in Makefile
sed -i "s/XXX_SHARNESSIFY_LIB_XXX/$LIB_BASE_DIR/" "$MAKEFILE_SCRIPT" ||
die "could not modify '$MAKEFILE_SCRIPT'"
sed -i "s/XXX_SHARNESSIFY_SHARNESS_XXX/sharness/" "$MAKEFILE_SCRIPT" ||
die "could not modify '$MAKEFILE_SCRIPT'"
log "Variables substituted in '$MAKEFILE_SCRIPT'"

# Run make to verify that everything works
(
    cd "$SHARNESS_DIR"  || die "could not cd into '$SHARNESS_DIR'"
    make || die "make failed in '$SHARNESS_DIR'"
) || exit
log "'make' ran in '$SHARNESS_DIR'"

# Add everything into Git
git add "$GIT_IGNORE" "$MAKEFILE_SCRIPT" "$INSTALL_SCRIPT" "$SIMPLE_TEST_DEST" ||
die "could not add Sharness support files into Git"
log "'git add'ed Sharness support files"

echo "**************"
echo "* SUCCESS!!! *"
echo "**************"
echo
echo "You can now commit the generated support files into Git using for example:"
echo
echo "  git commit -m 'Add Sharness support files'"
echo