test improvements

Author: GrantBirki

.github/copilot-instructions.md

@@ -17,17 +17,21 @@ script/bootstrap
 Ensure all unit tests pass by running the following:
 
 ```bash
-script/test
+script/test # needs to pass and meet the coverage requirements
+script/integration # just needs to pass
+script/acceptance # just needs to pass
 ```
 
-This project **requires 100% test coverage** of code, not including:
+This project **requires X% test coverage** of code, not including:
 
 - dependencies or their bin scripts
 - tests
 - scripts in `script/`
 - contents of directories that begin with a dot (`.`)
 
-Tests are powered by Ruby's `rspec`. By running `script/test`, the tool `simplecov` will be automatically used and will exit with a non-zero code if the coverage is below 100%.
+Tests are powered by Ruby's `rspec`. By running `script/test`, the tool `simplecov` will be automatically used and will exit with a non-zero code if the coverage is below X%.
+
+> The percent coverage required is defined in the `spec/unit/spec_helper.rb` file.
 
 ## Linting
 
@@ -95,5 +99,8 @@ The linter is powered by `rubocop` with its config file located at `.rubocop.yml
 - `config/` - Configuration files for the project.
 - `lib/` - Main code for the project. This is where the main application/service code lives.
 - `spec/` - Tests for the project. This is where the unit tests and acceptance tests live.
+  - `spec/acceptance/` - Acceptance tests for the project.
+  - `spec/unit/` - Unit tests for the project.
+  - `spec/integration/` - Integration tests for the project.
 - `vendor/cache` - Vendored dependencies (Ruby Gems).
 - `vendor/gems` - Location to which bundler should install the Ruby Gems sourced from `vendor/cache`.

script/integration

@@ -0,0 +1,23 @@
+#! /usr/bin/env bash
+
+set -e # prevent any kind of script failures
+
+source script/env "$@"
+
+echo -e "${PURPLE}[#]${OFF} ${BLUE}Running acceptance tests${OFF}"
+bundle exec bin/rspec spec/integration && rspec_exit=$? || rspec_exit=$?
+echo ""
+echo "---------------------------------------"
+echo "📊 Summary Results"
+echo "---------------------------------------"
+echo ""
+
+if [[ $rspec_exit == 0 ]]; then
+  echo -e "✅ ${GREEN}rspec:    exitcode=${rspec_exit}${OFF}"
+else
+  echo -e "❌ ${RED}rspec:    exitcode=${rspec_exit}${OFF}"
+fi
+
+[ "$rspec_exit" -gt 0 ] && exit 1
+
+exit 0

script/test

@@ -7,16 +7,23 @@ source script/env "$@"
 # run tests
 echo -e "\n🧪 ${BLUE}Running tests: $(date "+%H:%M:%S")${OFF}\n"
 
-bundle exec bin/rspec spec && rspec_exit=$? || rspec_exit=$?
+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
+# Extract required coverage percentage from the Ruby file
+required_coverage=$(grep "REQUIRED_COVERAGE_PERCENTAGE" "$DIR/spec/unit/required_coverage_percentage.rb" | grep -o '[0-9]\+')
+
+# Extract current coverage percentage (remove % sign if present)
+current_coverage=$(echo "$total_coverage" | grep -o '[0-9]\+\(\.[0-9]\+\)\?')
+
+# Compare coverage percentages
+if (( $(echo "$current_coverage >= $required_coverage" | bc -l) )); then
   cov_exit=0
-  echo -e "\n✅ Total Coverage: ${GREEN}$total_coverage${OFF}"
+  echo -e "\n✅ Total Coverage: ${GREEN}$total_coverage${OFF} (required: ${required_coverage}%)"
 else
   cov_exit=1
-  echo -e "\n❌ Total Coverage: ${RED}$total_coverage${OFF}"
+  echo -e "\n❌ Total Coverage: ${RED}$total_coverage${OFF} (required: ${required_coverage}%)"
 fi
 
 echo ""

spec/hooks_spec.rb spec/unit/hooks_spec.rbspec/hooks_spec.rb renamed to spec/unit/hooks_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+REQUIRED_COVERAGE_PERCENTAGE = 46

…s/plugins/request_validator/hmac_spec.rb …s/plugins/request_validator/hmac_spec.rbspec/lib/hooks/plugins/request_validator/hmac_spec.rb renamed to spec/unit/lib/hooks/plugins/request_validator/hmac_spec.rb spec/lib/hooks/plugins/request_validator/hmac_spec.rb renamed to spec/unit/lib/hooks/plugins/request_validator/hmac_spec.rb

@@ -4,6 +4,7 @@
 require "simplecov-erb"
 require "rspec"
 require "time"
+require_relative "required_coverage_percentage"
 
 TIME_MOCK = "2025-01-01T00:00:00Z"
 FAKE_HMAC_SECRET = "octoawesome-secret"
@@ -12,12 +13,12 @@
 ENV["GITHUB_WEBHOOK_SECRET"] = FAKE_HMAC_SECRET
 ENV["ALT_WEBHOOK_SECRET"] = FAKE_ALT_HMAC_SECRET
 
-COV_DIR = File.expand_path("../coverage", File.dirname(__FILE__))
+COV_DIR = File.expand_path("../../coverage", File.dirname(__FILE__))
 
-SimpleCov.root File.expand_path("..", File.dirname(__FILE__))
+SimpleCov.root File.expand_path("../..", File.dirname(__FILE__))
 SimpleCov.coverage_dir COV_DIR
 
-SimpleCov.minimum_coverage 100
+SimpleCov.minimum_coverage REQUIRED_COVERAGE_PERCENTAGE
 
 SimpleCov.at_exit do
   File.write("#{COV_DIR}/total-coverage.txt", SimpleCov.result.covered_percent)
@@ -31,7 +32,7 @@
 end
 
 # Require all Ruby files in the lib directory
-Dir.glob(File.expand_path("../lib/**/*.rb", __dir__)).each do |file|
+Dir.glob(File.expand_path("../../lib/**/*.rb", __dir__)).each do |file|
   require file
 end