feat: Incorporate GitHub Actions CI (#53)

* feat: Incorporate GitHub Actions CI

Author: zfields

.github/actions/run-tests-in-container/Dockerfile

@@ -0,0 +1,20 @@
+# Container with dependencies necessary to run unit-tests and code coverage
+
+# Build development environment
+# $ docker build . --tag note-arduino-test
+
+# Launch development environment (mount source root as /note-arduino/)
+# $ docker run --rm --volume $(pwd)/../../../:/note-arduino/ --workdir /note-arduino/ note-arduino-test
+
+# Base Image
+FROM alpine
+
+# Testing Dependencies
+RUN ["ash", "-c", "\
+    apk add --no-cache \
+      gcovr \
+      g++ \
+      valgrind \
+"]
+
+ENTRYPOINT ["./test/run_all_tests.sh"]

.github/actions/run-tests-in-container/action.yml

@@ -0,0 +1,6 @@
+name: 'Containerized Test'
+author: 'Zachary J. Fields'
+description: 'Perform unit-test in containerized environment'
+runs:
+  using: 'docker'
+  image: 'Dockerfile'

.github/workflows/note-arduino-ci.yml

@@ -0,0 +1,20 @@
+name: Note Arduino CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  validate_code: # job id
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        id: checkout
+        uses: actions/checkout@v2
+        with:
+          submodules: true
+      - name: Run Tests In Container
+        id: containerized_tests
+        uses: ./.github/actions/run-tests-in-container

README.md

@@ -123,12 +123,33 @@ For details on contributions we accept and the process for contributing, see our
 
 ## Note Arduino Tests
 
-From the `test` directory, execute the `run_tests.sh` script.
-
 ### Dependencies
 
-`bash` - the tests scripts are written in `bash` syntax
-`valgrind` - required to identify and protect against memory leaks.
+The tests are designed to be executed using Docker, and the environment required
+by the tests is defined in .github/actions/run-tests-in-container/Dockerfile.
+The following directions are provided to aid in executing the tests in
+a container.
+
+> _**NOTE:** If you are uncomfortable using Docker, then you may wish to use
+the Dockerfile as a guide to install the necessary dependencies and execute
+`run_all_tests.sh` locally._
+
+### Invocation
+
+1. From the `note-arduino` folder, build the container with the
+following command:
+
+```none
+docker build .github/actions/run-tests-in-container/ --tag note-arduino-test
+```
+
+1. Execute the tests inside the container using the following command:
+
+```none
+docker run --rm --volume $(pwd):/note-arduino/ --workdir /note-arduino/ note-arduino-test
+```
+
+1. Similar test results should print to your terminal for review.
 
 ### Success
 

test/run_tests.sh renamed to test/run_all_tests.sh

@@ -1,8 +1,8 @@
-#!/bin/bash
+#!/bin/sh
 
 all_tests_result=0
 
-g++ -Wall -Wextra -Wpedantic mock/mock-arduino.cpp mock/mock-note-c-note.c ../src/Notecard.cpp ../src/NoteI2c_Arduino.cpp ../src/NoteLog_Arduino.cpp ../src/NoteSerial_Arduino.cpp Notecard.test.cpp -std=c++11 -I. -I../src -DNOTE_MOCK
+g++ -Wall -Wextra -Wpedantic src/Notecard.cpp src/NoteI2c_Arduino.cpp src/NoteLog_Arduino.cpp src/NoteSerial_Arduino.cpp test/Notecard.test.cpp test/mock/mock-arduino.cpp test/mock/mock-note-c-note.c -std=c++11 -Isrc -Itest -DNOTE_MOCK
 if [ 0 -eq $? ] && [ 0 -eq $all_tests_result ]; then
   echo
   valgrind --leak-check=full --error-exitcode=66 ./a.out
@@ -17,7 +17,7 @@ else
   all_tests_result=999
 fi
 
-g++ -Wall -Wextra -Wpedantic mock/mock-arduino.cpp mock/mock-note-c-note.c ../src/NoteI2c_Arduino.cpp NoteI2c_Arduino.test.cpp -std=c++11 -I. -I../src -DNOTE_MOCK
+g++ -Wall -Wextra -Wpedantic src/NoteI2c_Arduino.cpp test/NoteI2c_Arduino.test.cpp test/mock/mock-arduino.cpp test/mock/mock-note-c-note.c -std=c++11 -Isrc -Itest -DNOTE_MOCK
 if [ 0 -eq $? ] && [ 0 -eq $all_tests_result ]; then
   echo
   valgrind --leak-check=full --error-exitcode=66 ./a.out
@@ -32,7 +32,7 @@ else
   all_tests_result=999
 fi
 
-g++ -Wall -Wextra -Wpedantic mock/mock-arduino.cpp mock/mock-note-c-note.c ../src/NoteI2c_Arduino.cpp NoteI2c_Arduino.test.cpp -std=c++11 -I. -I../src -DNOTE_MOCK -DWIRE_HAS_END
+g++ -Wall -Wextra -Wpedantic src/NoteI2c_Arduino.cpp test/NoteI2c_Arduino.test.cpp test/mock/mock-arduino.cpp test/mock/mock-note-c-note.c -std=c++11 -Isrc -Itest -DNOTE_MOCK -DWIRE_HAS_END
 if [ 0 -eq $? ] && [ 0 -eq $all_tests_result ]; then
   echo
   valgrind --leak-check=full --error-exitcode=66 ./a.out
@@ -47,7 +47,7 @@ else
   all_tests_result=999
 fi
 
-g++ -Wall -Wextra -Wpedantic mock/mock-arduino.cpp ../src/NoteLog_Arduino.cpp NoteLog_Arduino.test.cpp -std=c++11 -I. -I../src -DNOTE_MOCK
+g++ -Wall -Wextra -Wpedantic src/NoteLog_Arduino.cpp test/NoteLog_Arduino.test.cpp test/mock/mock-arduino.cpp -std=c++11 -Isrc -Itest -DNOTE_MOCK
 if [ 0 -eq $? ] && [ 0 -eq $all_tests_result ]; then
   echo
   valgrind --leak-check=full --error-exitcode=66 ./a.out
@@ -62,7 +62,7 @@ else
   all_tests_result=999
 fi
 
-g++ -Wall -Wextra -Wpedantic mock/mock-arduino.cpp ../src/NoteSerial_Arduino.cpp NoteSerial_Arduino.test.cpp -std=c++11 -I. -I../src -DNOTE_MOCK
+g++ -Wall -Wextra -Wpedantic src/NoteSerial_Arduino.cpp test/NoteSerial_Arduino.test.cpp test/mock/mock-arduino.cpp -std=c++11 -Isrc -Itest -DNOTE_MOCK
 if [ 0 -eq $? ] && [ 0 -eq $all_tests_result ]; then
   echo
   valgrind --leak-check=full --error-exitcode=66 ./a.out