modernize script/test and script/bootstrap and also update ci workflows to match

Author: GrantBirki

.github/workflows/acceptance.yml

@@ -17,7 +17,7 @@ jobs:
       has_change: ${{ steps.diff.outputs.has_change}}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - id: fetch-base
         if: github.event_name == 'pull_request'
@@ -50,10 +50,10 @@ jobs:
         if: github.event_name == 'push'
         run: echo "::set-output name=has_change::true"
 
-  acceptance-suite:
+  acceptance:
     needs: changes
     runs-on: ubuntu-latest-xl
-    name: runner / acceptance-tests
+    name: acceptance
     permissions:
       contents: read
 
@@ -67,7 +67,7 @@ jobs:
 
       - name: checkout
         if: ${{ needs.changes.outputs.has_change == 'true' }}
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       # Use Docker layer caching for 'docker build' and 'docker-compose build' commands.
       # https://github.com/satackey/action-docker-layer-caching/releases/tag/v0.0.11

.github/workflows/build.yml

@@ -15,13 +15,17 @@ permissions:
 jobs:
   build:
     name: build
-    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+    runs-on: ${{ matrix.os }}
 
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - uses: ruby/setup-ruby@250fcd6a742febb1123a77a841497ccaa8b9e939 # pin@v1.152.0
+      - uses: ruby/setup-ruby@5f19ec79cedfadb78ab837f95b87734d0003c899 # pin@v1.173.0
         with:
           bundler-cache: true
 

.github/workflows/gem.yml

@@ -18,9 +18,9 @@ jobs:
 
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - uses: ruby/setup-ruby@250fcd6a742febb1123a77a841497ccaa8b9e939 # pin@v1.152.0
+      - uses: ruby/setup-ruby@5f19ec79cedfadb78ab837f95b87734d0003c899 # pin@v1.173.0
         with:
           bundler-cache: true
 
@@ -31,7 +31,7 @@ jobs:
         run: bundle exec rubocop -c .rubocop.yml lib/ spec/
 
       - name: test
-        run: script/test
+        run: script/test -d -k
 
       - name: set GEM_NAME from gemspec
         run: echo "GEM_NAME=$(ls | grep gemspec | cut -d. -f1)" >> $GITHUB_ENV

.github/workflows/lint.yml

@@ -6,20 +6,24 @@ on:
       - main
   pull_request:
 
+permissions:
+  contents: read
+
 jobs:
-  rubocop:
-    name: runner / rubocop
+  lint:
+    name: lint
     runs-on: ubuntu-latest
-    permissions:
-      contents: read
 
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - uses: ruby/setup-ruby@250fcd6a742febb1123a77a841497ccaa8b9e939 # pin@v1.152.0
+      - uses: ruby/setup-ruby@5f19ec79cedfadb78ab837f95b87734d0003c899 # pin@v1.173.0
         with:
           bundler-cache: true
 
+      - name: bootstrap
+        run: script/bootstrap
+
       - name: rubocop
         run: bundle exec rubocop -c .rubocop.yml lib/ spec/

.github/workflows/test.yml

@@ -6,20 +6,29 @@ on:
       - main
   pull_request:
 
+permissions:
+  contents: read
+
 jobs:
-  rubocop:
-    name: runner / rspec
+  test:
+    name: test
     runs-on: ubuntu-latest
-    permissions:
-      contents: read
+
+    strategy:
+      matrix:
+        ruby: [ '3.1.2', '3.1.4', '3.2.2', '3.2.3', '3.3.0' ]
 
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - uses: ruby/setup-ruby@250fcd6a742febb1123a77a841497ccaa8b9e939 # pin@v1.152.0
+      - uses: ruby/setup-ruby@5f19ec79cedfadb78ab837f95b87734d0003c899 # pin@v1.173.0
         with:
           bundler-cache: true
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: bootstrap
+        run: script/bootstrap
 
       - name: rspec tests
-        run: script/test -d
+        run: script/test -d -k

script/bootstrap

@@ -1,15 +1,54 @@
-#!/bin/bash
+#! /usr/bin/env bash
 
-set -e
-set -x
+# COLORS
+OFF='\033[0m'
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+BLUE='\033[0;34m'
+PURPLE='\033[0;35m'
+
+set -e # Prevent any kind of script failures
+
+# if any of the following env vars are set, use them for the APP_ENV value
+if [ -n "$APP_ENV" ]; then
+  export APP_ENV="$APP_ENV"
+elif [ -n "$ENV" ]; then
+  export APP_ENV="$ENV"
+elif [ -n "$ENVIRONMENT" ]; then
+  export APP_ENV="$ENVIRONMENT"
+elif [ -n "$RAILS_ENV" ]; then
+  export APP_ENV="$RAILS_ENV"
+elif [ -n "$RACK_ENV" ]; then
+  export APP_ENV="$RACK_ENV"
+fi
+
+# set the working directory to the root of the project
 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && cd .. && pwd )"
-cd "$DIR"
 
-export PATH=/usr/share/rbenv/shims:$PATH
-export RBENV_VERSION="$(cat .ruby-version)"
-rm -rf "${DIR}/.bundle"
+# set the ruby version to the one specified in the .ruby-version file
+[ -z "$RBENV_VERSION" ] && export RBENV_VERSION=$(cat "$DIR/.ruby-version")
+
+# set the app environment to development if it's not set
+[ -z "$APP_ENV" ] && export APP_ENV="development"
+
+# set the path to include the rbenv shims if they exist
+[ -d "/usr/share/rbenv/shims" ] && export PATH=/usr/share/rbenv/shims:$PATH
 
-# Using Deprecated Flags to avoid pulling from upstream
-bundle install --path vendor/gems --local --clean
+TRASHDIR=$(mktemp -d /tmp/bootstrap.XXXXXXXXXXXXXXXXX)
+cleanup() {
+  rm -rf "$TRASHDIR"
+  # Remove empty directory
+  rmdir "$DIR/vendor/cache" 2>/dev/null || true
+}
+trap cleanup EXIT
 
-bundle binstubs rake rspec-core rubocop
+# Bootstrap gem dependencies.
+if [ "$APP_ENV" == "production" ]; then
+  echo -e "💎 ${BLUE}Installing Gems for ${GREEN}production${BLUE}...${OFF}"
+  BUNDLE_WITHOUT=development bundle install --local
+  BUNDLE_WITHOUT=development bundle binstubs --all
+else
+  echo -e "💎 ${BLUE}Installing Gems for ${PURPLE}development${BLUE}...${OFF}"
+  bundle install --local
+  bundle binstubs --all
+fi

script/test

@@ -1,15 +1,22 @@
-#!/bin/bash
+#! /usr/bin/env bash
 
 # run script/test -h for help
 
+# COLORS
+OFF='\033[0m'
+RED='\033[0;31m'
+GREEN='\033[0;32m'
+BLUE='\033[0;34m'
+
 set -e
 
 function usage()
 {
     echo -e "\t ================== script/test usage =================="
     echo -e "\t-h --help               : displays help message"
+    echo -e "\t-k --no-linter          : disables linting tests"
     echo -e "\t-d --disable-bootstrap  : disables bootstrap"
-    echo -e "\n\t Suggested flags for development: script/test -d"
+    echo -e "\n\t Suggested flags for development: script/test -d -s"
 }
 
 while [ "$1" != "" ]; do
@@ -35,42 +42,64 @@ while [ "$1" != "" ]; do
     shift
 done
 
-DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && cd .. && pwd )"
-
-export PATH=/usr/share/rbenv/shims:$PATH
-export RBENV_VERSION="$(cat "${DIR}/.ruby-version")"
-
-TRASHDIR=$(mktemp -d /tmp/cibuild.XXXXXXXXXXXXXXXXXX)
-cleanup() {
-  rm -rf "$TRASHDIR"
-}
-trap cleanup EXIT
-
-cd "$DIR"
-. "${DIR}/script/lib/fold.sh"
+# setup
+export DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && cd .. && pwd )"
+[ -z "$RBENV_VERSION" ] && export RBENV_VERSION=$(cat "$DIR/.ruby-version")
 
 if [[ -z $no_bootstrap ]]; then
   # bootstrap
-  begin_fold "Bootstrapping"
-  ./script/bootstrap
-  end_fold
+  echo -e "\n🥾 ${BLUE}Bootstrapping: $(date "+%H:%M:%S")${OFF}\n"
+  echo "%%%FOLD {bootstrap}%%%"
+  cd "$DIR"
+  script/bootstrap
+  echo "%%%END FOLD%%%"
 else
-  echo -e "\nBypass Bootstrap"
+  echo -e "\n⏩ ${BLUE}Skipping Bootstrap${OFF}"
 fi
 
-bundle exec rspec spec/unit && rspec_exit=$? || rspec_exit=$?
+# Run Rubocop
+if [[ -z $no_linter ]]; then
+  echo -e "\n🤖 ${BLUE}Running Rubocop: $(date "+%H:%M:%S")${OFF}\n"
+  bundle exec bin/rubocop
+else
+  echo -e "\n⏩ ${BLUE}Skipping Rubocop${OFF}"
+fi
+
+# run tests
+echo -e "\n🧪 ${BLUE}Running tests: $(date "+%H:%M:%S")${OFF}\n"
+cd "$(dirname $0)/.."
 
-cat "$DIR/coverage/coverage.txt"
-grep -q "You're all set, friend" "$DIR/coverage/coverage.txt" && cov_exit=0 || cov_exit=1
+bundle exec bin/rspec spec/unit && rspec_exit=$? || rspec_exit=$?
+
+total_coverage=$(cat "$DIR/coverage/total-coverage.txt")
+
+if grep -q "100.0" "$DIR/coverage/total-coverage.txt"; then
+  cov_exit=0
+  echo -e "\n✅ Total Coverage: ${GREEN}$total_coverage${OFF}"
+else
+  cov_exit=1
+  echo -e "\n❌ Total Coverage: ${RED}$total_coverage${OFF}"
+fi
 
 echo ""
 echo "---------------------------------------"
-echo "Summary Results"
+echo "📊 Summary Results"
 echo "---------------------------------------"
 echo ""
-echo "rspec:       exitcode=${rspec_exit}"
-echo "coverage:    exitcode=${cov_exit}"
+
+if [[ $rspec_exit == 0 ]]; then
+  echo -e "✅ ${GREEN}rspec:    exitcode=${rspec_exit}${OFF}"
+else
+  echo -e "❌ ${RED}rspec:    exitcode=${rspec_exit}${OFF}"
+fi
+
+if [[ $cov_exit == 0 ]]; then
+  echo -e "✅ \033[0;32mcoverage: exitcode=${cov_exit}\033[0m"
+else
+  echo -e "❌ \033[0;31mcoverage: exitcode=${cov_exit}\033[0m"
+fi
 
 [ $rspec_exit -gt 0 ] && exit 1
 [ $cov_exit -gt 0 ] && exit 1
+
 exit 0

spec/unit/spec_helper.rb

@@ -6,10 +6,22 @@
 require "simplecov"
 require "simplecov-erb"
 
+COV_DIR = File.expand_path("../../coverage", File.dirname(__FILE__))
+
+SimpleCov.root File.expand_path("..", File.dirname(__FILE__))
+SimpleCov.coverage_dir COV_DIR
+
 SimpleCov.formatters = [
   SimpleCov::Formatter::HTMLFormatter,
   SimpleCov::Formatter::ERBFormatter
 ]
+
+SimpleCov.minimum_coverage 100
+
+SimpleCov.at_exit do
+  File.write("#{COV_DIR}/total-coverage.txt", SimpleCov.result.covered_percent)
+  SimpleCov.result.format!
+end
 SimpleCov.start do
   # don't show specs as missing coverage for themselves
   add_filter "/spec/"