Merge pull request #209 from sourceryinstitute/small-tweaks

Increase coverage and git-hooks robustness

Author: zbeekman

Brewfile

@@ -0,0 +1,21 @@
+# Brewfile to install OpenCoarrays prerequisites with [Homebrew] or [Linuxbrew].
+#
+# TL;DR: `brew tap homebrew/bundle && brew bundle` to install prerequisites
+#
+# Homebrew for Mac OS X can be installed via:
+# `/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"`
+# Linux brew (lives in userland, no sudo required) can be installed with:
+# `ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Linuxbrew/linuxbrew/go/install)"`
+#
+# Once Homebrew/Linuxbrew is installed, execute the following commands to install the required prerequisites:
+# `brew tap homebrew/bundle && brew bundle`
+#
+# NOTE: Until Linuxbrew upgrades to GCC 6.1 or later, you will have to edit the `mpich` line to:
+#    `brew 'mpich', args: ['cc=gcc-5', 'cxx=g++-5']`
+
+brew 'cmake'
+brew 'gcc'
+brew 'mpich', args: ['cc=gcc-6', 'cxx=g++-6']
+
+# [Homebrew]: http://brew.sh
+# [Linuxbrew]: http://linuxbrew.sh

CMakeLists.txt

@@ -151,8 +151,30 @@ add_custom_target ( uninstall
 
 enable_testing()
 
+# Determine if we're using Open MPI
+execute_process(COMMAND ${MPIEXEC} --version
+  OUTPUT_VARIABLE mpi_version_out)
+if (mpi_version_out MATCHES "[Oo]pen[ -][Mm][Pp][Ii]")
+  message( STATUS "OpenMPI detected")
+  set ( openmpi true )
+endif ()
+
+include( ProcessorCount )
+ProcessorCount(N)
 function(add_mpi_test name num_mpi_proc path)
-   set(test_parameters ${MPIEXEC_NUMPROC_FLAG} ${num_mpi_proc} )
+   if ( ((N LESS num_mpi_proc) OR (N EQUAL 0)) )
+     message(STATUS "Test ${name} is oversubscribed: ${num_mpi_proc} ranks requested with ${N} system processor available.")
+     if ( openmpi )
+       if ( N LESS 2 )
+	 set( num_mpi_proc 2 )
+	 set (test_parameters --oversubscribed)
+       else()
+	 set ( num_mpi_proc ${N} )
+       endif()
+       message( STATUS "Open-MPI detected, over-riding oversubscribed test, ${name}, with ${num_mpi_proc} ranks." )
+     endif()
+   endif()
+   set(test_parameters ${test_parameters} ${MPIEXEC_NUMPROC_FLAG} ${num_mpi_proc} )
    add_test(NAME ${name} COMMAND ${MPIEXEC} ${test_parameters} "${path}")
    set_property(TEST ${name} PROPERTY PASS_REGULAR_EXPRESSION "Test passed.")
 endfunction(add_mpi_test)
@@ -180,7 +202,7 @@ if(opencoarrays_aware_compiler)
   add_mpi_test(syncimages 32 ${tests_root}/unit/sync/syncimages)
   add_mpi_test(duplicate_syncimages 8 ${tests_root}/unit/sync/duplicate_syncimages)
   add_mpi_test(co_reduce 4 ${tests_root}/unit/collectives/co_reduce_test)
-#  add_mpi_test(syncimages_status 32 ${tests_root}/unit/sync/syncimages_status)
+  add_mpi_test(syncimages_status 32 ${tests_root}/unit/sync/syncimages_status)
 
   # Integration tests verifying the use of libcaf_mpi in applications
   add_mpi_test(hello_multiverse 2 ${tests_root}/integration/coarrayHelloWorld/hello_multiverse)

developer-scripts/Vagrantfile

@@ -0,0 +1,98 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+VAGRANT_COMMAND = ARGV[0]
+
+# All Vagrant configuration is done below. The "2" in Vagrant.configure
+# configures the configuration version (we support older styles for
+# backwards compatibility). Please don't change it unless you know what
+# you're doing.
+Vagrant.configure(2) do |config|
+  # The most common configuration options are documented and commented below.
+  # For a complete reference, please see the online documentation at
+  # https://docs.vagrantup.com.
+
+  # Every Vagrant development environment requires a box. You can search for
+  # boxes at https://atlas.hashicorp.com/search.
+  config.vm.box = "hashicorp/precise64"
+
+  # Disable automatic box update checking. If you disable this, then
+  # boxes will only be checked for updates when the user runs
+  # `vagrant box outdated`. This is not recommended.
+  config.vm.box_check_update = true
+
+  # Create a forwarded port mapping which allows access to a specific port
+  # within the machine from a port on the host machine. In the example below,
+  # accessing "localhost:8080" will access port 80 on the guest machine.
+  # config.vm.network "forwarded_port", guest: 80, host: 8080
+
+  # Create a private network, which allows host-only access to the machine
+  # using a specific IP.
+  # config.vm.network "private_network", ip: "192.168.33.10"
+
+  # Create a public network, which generally matched to bridged network.
+  # Bridged networks make the machine appear as another physical device on
+  # your network.
+  # config.vm.network "public_network"
+
+  # Share an additional folder to the guest VM. The first argument is
+  # the path on the host to the actual folder. The second argument is
+  # the path on the guest to mount the folder. And the optional third
+  # argument is a set of non-required options.
+  config.vm.synced_folder "..", "/home/travis/build/sourceryinstitute/opencoarrays", mount_options: ["dmode=2770", "fmode=660"]
+
+
+  # Provider-specific configuration so you can fine-tune various
+  # backing providers for Vagrant. These expose provider-specific options.
+  # Example for VirtualBox:
+  #
+  # config.vm.provider "virtualbox" do |vb|
+  #   # Display the VirtualBox GUI when booting the machine
+  #   vb.gui = true
+  #
+  #   # Customize the amount of memory on the VM:
+  #   vb.memory = "1024"
+  # end
+  #
+  # View the documentation for the provider you are using for more
+  # information on available options.
+
+  # Define a Vagrant Push strategy for pushing to Atlas. Other push strategies
+  # such as FTP and Heroku are also available. See the documentation at
+  # https://docs.vagrantup.com/v2/push/atlas.html for more information.
+  # config.push.define "atlas" do |push|
+  #   push.app = "YOUR_ATLAS_USERNAME/YOUR_APPLICATION_NAME"
+  # end
+
+  config.ssh.insert_key = true
+  # try to set a different default user
+    if VAGRANT_COMMAND == "ssh"
+      config.ssh.username = 'travis'
+      config.ssh.insert_key = true
+    end
+
+  # config.ssh.username = "travis"
+  # config.ssh.insert_key = false
+
+  # Enable provisioning with a shell script. Additional provisioners such as
+  # Puppet, Chef, Ansible, Salt, and Docker are also available. Please see the
+  # documentation for more information about their specific syntax and use.
+  config.vm.provision "shell", inline: <<-SHELL
+    useradd -m -s /bin/bash travis
+    usermod -a -G vagrant travis
+    echo -e "travis\ntravis\n" | sudo passwd travis
+    [ -d /home/travis/.ssh ] || sudo mkdir -p /home/travis/.ssh
+    cp /home/vagrant/.ssh/authorized_keys /home/travis/.ssh/
+    sudo chown -R travis:travis /home/travis
+    sudo chmod 600 /home/travis/.ssh/authorized_keys
+    sudo chown travis:travis /home/travis/.ssh/authorized_keys
+    # sudo echo "AllowUsers travis" >> /etc/ssh/sshd_config
+    # echo 'linuxbrew ALL=(ALL) NOPASSWD:ALL' >>/etc/sudoers # emulate no sudo on travis
+    sudo apt-get update
+    sudo apt-get update --fix-missing -y
+    sudo apt-get install -y gawk build-essential ruby curl git jq python-pip python-setuptools
+    unset LD_LIBRARY_PATH PKG_CONFIG_PATH
+    echo 'sudo su -l travis' | cat >> /home/vagrant/.bash_profile
+    echo 'export PATH="${HOME}/.linuxbrew/bin:$PATH"' | cat >> /home/travis/.bash_profile
+    echo 'cd ${HOME}/build/sourceryinstitute/opencoarrays' | cat >> /home/travis/.bash_profile
+  SHELL
+end

developer-scripts/git-hooks/commit-msg

@@ -1,40 +1,52 @@
 #!/bin/bash
 #
-# An example hook script to check the commit log message.
+# A hook script to check the commit log message.
 # Called by "git commit" with one argument, the name of the file
 # that has the commit message.  The hook should exit with non-zero
 # status after issuing an appropriate message if it wants to stop the
 # commit.  The hook is allowed to edit the commit message file.
 #
-# To enable this hook, rename this file to "commit-msg".
+# This hook is inteded to be used by OpenCoarrays developers to ensure
+# that they conform to project standards.
 
-# Uncomment the below to add a Signed-off-by line to the message.
-# Doing this in a hook is a bad idea in general, but the prepare-commit-msg
-# hook is more suited to it.
-#
-# SOB=$(git var GIT_AUTHOR_IDENT | sed -n 's/^\(.*>\).*$/Signed-off-by: \1/p')
-# grep -qs "^$SOB" "$1" || echo "$SOB" >> "$1"
+
+
+set -o errexit
+set -o pipefail
+set -o nounset
+set -o errtrace
+
+__file=commit-msg
+
+err_report() {
+    error_code=$?
+    echo 2>&1 "Error in $__file in function $1 on line $2"
+    exit $error_code
+}
+
+trap 'err_report "${FUNCNAME:-.}" $LINENO' ERR
 
 # error message function for writing good commit messages
+# shellcheck disable=SC2006,SC2035
 error_message () {
-    cat <<\EOF >&2
+    cat <<-EOF
 Error: bad commit message format. A copy of your commit message is in:
-`.git/COMMIT_EDITMSG`. Please fix it or write a new one according to the
+'.git/COMMIT_EDITMSG'. Please fix it or write a new one according to the
 guidlines below.
 
 The first line of a commit message should start with a capitalized imperative
 verb used in a phrase to summarize the change. This first line must be less
 than 50 characters, followed by an additional blank line. Further detials are
 added after these first two lines, and may be up to 72 characters in length.
 
-This is so that `--oneline` formatted `git log`s will contain human readable,
+This is so that '--oneline' formatted 'git log's will contain human readable,
 meaningful information, and the summaries on Github.com will also contain
 this concise summary. The 72 line limit is to ensure propper formatting on
 all terminals.
 
 Here is an example of a good commit message:
 
-```
+"""
 Redirect user to the requested page after login
 
 https://github.com/sourceryinstitute/opencoarrays/Issues/29
@@ -46,11 +58,11 @@ being redirected to the login form.
 * Store requested path in a session variable
 * Redirect to the stored location after successfully logging in the user
 * Fixes #1
-```
+"""
 
 As opposed to doing something bad like this:
 
-`git commit -m "Fix login bug"`
+'git commit -m "Fix login bug"'
 
 For more information on writting good commit messages,
 and keeping a clean history, please see:
@@ -65,50 +77,41 @@ EOF
 
 }
 
-let status=0
-
-# This example catches duplicate Signed-off-by lines.
-
-test "" = "$(grep '^Signed-off-by: ' "$1" |
-	 sort | uniq -c | sed -e '/^[ 	]*1[ 	]/d')" || {
-	echo >&2 "Duplicate Signed-off-by lines."
-	let status=1
-}
+status=0
 
 # Check that the first line of the commit starts with a
 # capitalized letter.
-if ! (head -n 1 $1 | grep '^[A-Z]' &>/dev/null ); then
+if ! (head -n 1 "$1" | grep '^[A-Z]' &>/dev/null ); then
     echo >&2 "First word of commit message must be a capitalized imperative verb."
     echo ""
-    let status=1
+    status=1
 fi
 
 # Check each line for propper length
 ln=0
-cat $1 | \
-    while read line; do
-	let ln+=1
-	nchars=$(wc -c <<<$line)
-	if [[ "$ln" -eq "1" ]]; then
-	    if [[ "$nchars" -gt "51" ]]; then
-		echo >&2 "First line of commit message too long ($nchars > 50 chars)"
-		echo ""
-		let status=1
-	    fi
-	elif [[ "$ln" -eq "2" ]]; then
-	    if [[ "$nchars" -gt "1" ]] && ! grep '^#' <<<"$line" >/dev/null; then
-		echo >&2 "Second line of commit message not blank"
-		echo ""
-		let status=1
-	    fi
-	else
-	    if [[ "$nchars" -gt "72" ]]; then
-		echo >&2 "Line $ln of commit message too long ($nchars > 72 chars)"
-		echo ""
-		let status=1
-	    fi
-	fi
-    done
+while read -r line; do
+    ln+=1
+    nchars=$(wc -c <<<"$line")
+    if [[ "$ln" -eq "1" ]]; then
+      if [[ "$nchars" -gt "51" ]]; then
+	echo >&2 "First line of commit message too long ($nchars > 50 chars)"
+	echo ""
+	status=1
+      fi
+    elif [[ "$ln" -eq "2" ]]; then
+      if [[ "$nchars" -gt "1" ]] && ! grep '^#' <<<"$line" >/dev/null; then
+	echo >&2 "Second line of commit message not blank"
+	echo ""
+	status=1
+      fi
+    else
+      if [[ "$nchars" -gt "72" ]]; then
+	echo >&2 "Line $ln of commit message too long ($nchars > 72 chars)"
+	echo ""
+	status=1
+      fi
+    fi
+done < "$1"
 
 if [[ $status = 0 ]]; then
     exit 0