tests: add test suite and GitHub action to run it with coverage

tgamblin · tgamblin · commit d4c992317d2f · 2020-10-27T23:44:40.000-07:00
- [x] add test subdirectory with a suite of tests for sbang
- [x] add workflow for linux tests
- [x] add workflow for macos tests
- [x] add workflow for shellcheck
- [x] add codecov to macos tests

TODO: It seems like kcov doesn't work on linux tests for some reason.
Will need to debug later.
diff --git a/.codecov.yml b/.codecov.yml
@@ -0,0 +1,13 @@
+coverage:
+  precision: 2
+  round: nearest
+  range: 60...90
+  status:
+    project:
+      default:
+        threshold: 0.2%
+
+ignore:
+  - test/.*
+
+comment: off
diff --git a/.github/workflows/linux-test.yaml b/.github/workflows/linux-test.yaml
@@ -0,0 +1,19 @@
+name: linux
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  unit-tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - name: run unit tests
+      run: |
+          make -C test test
diff --git a/.github/workflows/macos-tests.yaml b/.github/workflows/macos-tests.yaml
@@ -0,0 +1,27 @@
+name: macos
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  unit-tests:
+    runs-on: macos-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - name: Setup Homebrew packages
+      run: |
+        brew install kcov
+    - name: Run unit tests
+      env:
+        COVERAGE: true
+      run: make -C test test
+    - uses: codecov/codecov-action@v1
+      with:
+        directory: ./coverage
+        flags: unittests
diff --git a/.github/workflows/shellcheck.yaml b/.github/workflows/shellcheck.yaml
@@ -0,0 +1,22 @@
+name: shellcheck
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+jobs:
+  shellcheck:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+    - name: install shellcheck
+      run: |
+        sudo apt-get update
+        sudo apt-get install shellcheck
+    - name: run unit tests
+      run: make -C test shellcheck
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+coverage
diff --git a/README.md b/README.md
@@ -1,4 +1,8 @@
 # sbang
+![linux](https://github.com/spack/sbang/workflows/linux/badge.svg)
+![macos](https://github.com/spack/sbang/workflows/macos/badge.svg)
+![shellcheck](https://github.com/spack/sbang/workflows/shellcheck/badge.svg)
+[![codecov](https://codecov.io/gh/spack/sbang/branch/main/graph/badge.svg?token=IKH7mB5qq7)](undefined)
 
 `sbang` lets you run scripts with very long shebang (`#!`) lines.
 
diff --git a/sbang b/sbang
@@ -1,7 +1,7 @@
 #!/bin/sh
 #
 # Copyright 2013-2020 Lawrence Livermore National Security, LLC and other
-# sbang Project Developers. See the top-level COPYRIGHT file for details.
+# sbang project developers. See the top-level COPYRIGHT file for details.
 #
 # SPDX-License-Identifier: (Apache-2.0 OR MIT)
 
@@ -67,6 +67,11 @@ done < "$script"
 # this saves arguments for later and intentionally assigns as an array
 args="$@"
 
+# error if we did not find any interpreter
+if [ -z "$shebang_line"  ]; then
+    die "error: sbang found no interpreter in $script"
+fi
+
 # handle scripts with sbang parameters, e.g.:
 #
 #   #!/<some-long-path>/perl -w
@@ -79,11 +84,6 @@ set -- "$@"
 interpreter="$1"
 arg1="$2"
 
-# error if we did not find any interpreter
-if [ -z "$interpreter" ]; then
-    die "error: sbang found no interpreter in $script"
-fi
-
 # Determine if the interpreter is a particular program, accounting for the
 # '#!/usr/bin/env PROGRAM' convention. So:
 #
diff --git a/test/Makefile b/test/Makefile
@@ -0,0 +1,17 @@
+# Copyright 2013-2020 Lawrence Livermore National Security, LLC and other
+# sbang project developers. See the top-level COPYRIGHT file for details.
+#
+# SPDX-License-Identifier: (Apache-2.0 OR MIT)
+
+# Run make to run the test suite with just sbang.
+# Run make COVERAGE=TRUE to run with kcov
+COVERAGE_DIR = ../coverage
+SBANG_SCRIPT = ../sbang
+SBANG = $(if $(COVERAGE),kcov $(COVERAGE_DIR) ,)$(SBANG_SCRIPT)
+
+test:
+	echo $(SBANG)
+	SBANG="$(SBANG)" ./test-suite.sh
+
+shellcheck:
+	shellcheck $(SBANG_SCRIPT)
diff --git a/test/shebangs/bash.bash b/test/shebangs/bash.bash
@@ -0,0 +1,2 @@
+#!/usr/bin/env sbang
+#!/bin/bash
diff --git a/test/shebangs/lua.lua b/test/shebangs/lua.lua
@@ -0,0 +1,2 @@
+#!/usr/bin/env sbang
+--!/path/to/lua
diff --git a/test/shebangs/no-interpreter b/test/shebangs/no-interpreter
@@ -0,0 +1,2 @@
+This is a simple file.
+It has no shebang and no interpreter.
diff --git a/test/shebangs/node.js b/test/shebangs/node.js
@@ -0,0 +1,2 @@
+#!/usr/bin/env sbang
+//!/path/to/node
diff --git a/test/shebangs/perl-env.pl b/test/shebangs/perl-env.pl
@@ -0,0 +1,2 @@
+#!/usr/bin/env sbang
+#!/usr/bin/env perl
diff --git a/test/shebangs/perl-w-env.pl b/test/shebangs/perl-w-env.pl
@@ -0,0 +1,2 @@
+#!/usr/bin/env sbang
+#!/usr/bin/env perl -w
diff --git a/test/shebangs/perl-w.pl b/test/shebangs/perl-w.pl
@@ -0,0 +1,2 @@
+#!/usr/bin/env sbang
+#!/usr/bin/perl -w
diff --git a/test/shebangs/perl.pl b/test/shebangs/perl.pl
@@ -0,0 +1,2 @@
+#!/usr/bin/env sbang
+#!/usr/bin/perl
diff --git a/test/shebangs/php.php b/test/shebangs/php.php
@@ -0,0 +1,3 @@
+#!/usr/bin/env sbang
+<?php #!/usr/bin/php ?>
+<?php echo "hello\n" ?>
diff --git a/test/shebangs/python-env.py b/test/shebangs/python-env.py
@@ -0,0 +1,6 @@
+#!/usr/bin/env sbang
+#!/usr/bin/env python
+
+from __future__ import print_function
+
+print("python")
diff --git a/test/shebangs/python.py b/test/shebangs/python.py
@@ -0,0 +1,6 @@
+#!/usr/bin/env sbang
+#!/usr/bin/python
+
+from __future__ import print_function
+
+print("python")
diff --git a/test/shebangs/ruby-env.rb b/test/shebangs/ruby-env.rb
@@ -0,0 +1,4 @@
+#!/usr/bin/env sbang
+#!/usr/bin/env ruby
+
+puts "ruby"
diff --git a/test/shebangs/ruby.rb b/test/shebangs/ruby.rb
@@ -0,0 +1,4 @@
+#!/usr/bin/env sbang
+#!/usr/bin/ruby
+
+puts "ruby"
diff --git a/test/shebangs/sbang b/test/shebangs/sbang
@@ -0,0 +1,2 @@
+#!/usr/bin/env sbang
+#!/path/to/sbang
diff --git a/test/shebangs/sbang-env b/test/shebangs/sbang-env
@@ -0,0 +1,2 @@
+#!/usr/bin/env sbang
+#!/usr/bin/env sbang
diff --git a/test/shebangs/sh.sh b/test/shebangs/sh.sh
@@ -0,0 +1,2 @@
+#!/usr/bin/env sbang
+#!/bin/sh
diff --git a/test/test-framework.sh b/test/test-framework.sh
diff --git a/test/test-suite.sh b/test/test-suite.sh

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+#!/usr/bin/env sbang`
	`2`	`+#!/bin/bash`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+#!/usr/bin/env sbang`
	`2`	`+--!/path/to/lua`