Adding basic sharness tests

Author: AuHau

src/cli.js

@@ -0,0 +1,5 @@
+!/lib/
+bin/
+lib/sharness/
+test-results/
+trash directory.*.sh/

test/sharness/.gitignore

@@ -0,0 +1,53 @@
+# Run sharness tests
+#
+# Copyright (c) 2016 Christian Couder
+# MIT Licensed; see the LICENSE file in this repository.
+#
+# NOTE: run with TEST_VERBOSE=1 for verbose sharness tests.
+
+T = $(sort $(wildcard t[0-9][0-9][0-9][0-9]-*.sh))
+LIBDIR = lib
+SHARNESSDIR = sharness
+AGGREGATE = $(LIBDIR)/$(SHARNESSDIR)/aggregate-results.sh
+
+
+BINS = ../bin/jsipfs-migrations
+
+all: aggregate
+
+help:
+	@echo "- use 'make' or 'make all' to run all the tests"
+	@echo "- use 'make deps' to create an 'ipfs' executable in ../bin"
+	@echo "- to run tests manually, make sure to include ../bin in your PATH"
+
+clean: clean-test-results
+	@echo "*** $@ ***"
+	-rm -rf ../bin/ipfs
+
+clean-test-results:
+	@echo "*** $@ ***"
+	-rm -rf test-results
+
+$(T): clean-test-results deps
+	@echo "*** $@ ***"
+	./$@
+
+aggregate: clean-test-results $(T)
+	@echo "*** $@ ***"
+	ls test-results/t*-*.sh.*.counts | $(AGGREGATE)
+
+deps: sharness $(BINS) curl
+
+sharness:
+	@echo "*** checking $@ ***"
+	lib/install-sharness.sh
+
+../bin/jsipfs-migrations:
+	mkdir -p bin
+	-ln -s ../../../src/cli.js ./bin/jsipfs-migrations
+
+curl:
+	@which curl >/dev/null || (echo "Please install curl!" && false)
+
+.PHONY: all help clean clean-test-results $(T) aggregate deps sharness
+

test/sharness/Makefile

@@ -0,0 +1,60 @@
+#!/bin/sh
+# install-sharness.sh
+#
+# Copyright (c) 2014 Juan Batiz-Benet
+# Copyright (c) 2015 Christian Couder
+# MIT Licensed; see the LICENSE file in this repository.
+#
+# This script checks that Sharness is installed in:
+#
+# $(pwd)/$clonedir/$sharnessdir/
+#
+# where $clonedir and $sharnessdir are configured below.
+#
+# If Sharness is not installed, this script will clone it
+# from $urlprefix (defined below).
+#
+# If Sharness is not uptodate with $version (defined below),
+# this script will fetch and will update the installed
+# version to $version.
+#
+
+# settings
+version=ecba410b0b58400dd6517cfa6594fdac243d9056
+urlprefix=https://github.com/chriscool/sharness.git
+clonedir=lib
+sharnessdir=sharness
+
+if test -f "$clonedir/$sharnessdir/SHARNESS_VERSION_$version"
+then
+    # There is the right version file. Great, we are done!
+    exit 0
+fi
+
+die() {
+    echo >&2 "$@"
+    exit 1
+}
+
+checkout_version() {
+    git checkout "$version" || die "Could not checkout '$version'"
+    rm -f SHARNESS_VERSION_* || die "Could not remove 'SHARNESS_VERSION_*'"
+    touch "SHARNESS_VERSION_$version" || die "Could not create 'SHARNESS_VERSION_$version'"
+    echo "Sharness version $version is checked out!"
+}
+
+if test -d "$clonedir/$sharnessdir/.git"
+then
+    # We need to update sharness!
+    cd "$clonedir/$sharnessdir" || die "Could not cd into '$clonedir/$sharnessdir' directory"
+    git fetch || die "Could not fetch to update sharness"
+else
+    # We need to clone sharness!
+    mkdir -p "$clonedir" || die "Could not create '$clonedir' directory"
+    cd "$clonedir" || die "Could not cd into '$clonedir' directory"
+
+    git clone "$urlprefix" || die "Could not clone '$urlprefix'"
+    cd "$sharnessdir" || die "Could not cd into '$sharnessdir' directory"
+fi
+
+checkout_version

test/sharness/lib/install-sharness.sh

@@ -0,0 +1,34 @@
+# Test framework for go-ipfs
+#
+# Copyright (c) 2014 Christian Couder
+# MIT Licensed; see the LICENSE file in this repository.
+#
+# We are using sharness (https://github.com/chriscool/sharness)
+# which was extracted from the Git test framework.
+
+# add current directory to path.
+BIN=$(echo `pwd`/bin)
+PATH=${BIN}:${PATH}
+
+# assert the `jsipfs-migrations` we're using is the right one.
+if [[ $(which jsipfs-migrations) != ${BIN}/jsipfs-migrations ]]; then
+	echo >&2 "Cannot find the test's local jsipfs-migrations tool."
+	echo >&2 "Please check test and ipfs tool installation."
+	JS_BIN=$(dirname $(dirname "${BIN}"))"/src/cli.js"
+	echo >&2 "For jsipfs-migrations, look for a symlink from '${BIN}/jsipfs-migrations' to '${JS_BIN}'."
+	echo >&2 "Use 'make' or 'make deps' as it should install this symlink."
+	exit 1
+fi
+
+# set sharness verbosity. we set the env var directly as
+# it's too late to pass in --verbose, and --verbose is harder
+# to pass through in some cases.
+test "$TEST_VERBOSE" = 1 && verbose=t
+
+SHARNESS_LIB="lib/sharness/sharness.sh"
+
+. "$SHARNESS_LIB" || {
+	echo >&2 "Cannot source: $SHARNESS_LIB"
+	echo >&2 "Please check Sharness installation."
+	exit 1
+}

test/sharness/lib/test-lib.sh

@@ -0,0 +1,32 @@
+#!/bin/sh
+
+test_description="Show basic features of Sharness"
+
+. ./lib/sharness/sharness.sh
+
+test_expect_success "Success is reported like this" "
+    echo hello world | grep hello
+"
+
+test_expect_success "Commands are chained this way" "
+    test x = 'x' &&
+    test 2 -gt 1 &&
+    echo success
+"
+
+return_42() {
+    echo "Will return soon"
+    return 42
+}
+
+test_expect_success "You can test for a specific exit code" "
+    test_expect_code 42 return_42
+"
+
+test_expect_failure "We expect this to fail" "
+    test 1 = 2
+"
+
+test_done
+
+# vi: set ft=sh :

test/sharness/t0000-sharness.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+#
+# Copyright (c) 2014 Christian Couder
+# MIT Licensed; see the LICENSE file in this repository.
+#
+
+test_description="Test installation and some basic commands"
+
+. lib/test-lib.sh
+
+test_expect_success "current dir is writable" '
+	echo "It works!" > test.txt
+'
+
+test_expect_success "jsipfs-migrations version succeeds" '
+	jsipfs-migrations --version > version.txt
+'
+
+test_expect_success "jsipfs-migrations help succeeds" '
+	jsipfs-migrations --help > help.txt
+'
+
+test_done