Merge pull request #1 from GrantBirki/code-coverage

Code coverage

Author: GrantBirki

.gitignore

@@ -21,3 +21,5 @@ lib/**/spec/
 # secrets
 creds.env
 *.pem
+
+coverage/

CONTRIBUTING.md

@@ -9,6 +9,12 @@ This project uses a highly opinionated dependency vendoring strategy. This strat
 3. The `script/bootstrap` command installs vendored dependencies with `SHARDS_CACHE_PATH="vendor/.cache/shards" shards install ...` to ensure that each project has its own cache and does not interfere with other crystal projects
 4. The `script/update` command will re-vendor all dependencies and update the vendored dependencies in the repository. This will always result is changes to all dependencies, even if the version has not changed. This is to ensure that the vendored dependencies are always up to date and can be used to build the project.
 
+## Testing 🧪
+
+- All code must have unit tests
+- 100% code coverage is enforced
+- Acceptance tests are used to test the application as a whole
+
 ## Development Commands 💻
 
 ### Setup

README.md

@@ -1,5 +1,5 @@
 # kemal-hmac
 
-[![test](https://github.com/GrantBirki/kemal-hmac/actions/workflows/test.yml/badge.svg)](https://github.com/GrantBirki/kemal-hmac/actions/workflows/test.yml) [![build](https://github.com/GrantBirki/kemal-hmac/actions/workflows/build.yml/badge.svg)](https://github.com/GrantBirki/kemal-hmac/actions/workflows/build.yml) [![lint](https://github.com/GrantBirki/kemal-hmac/actions/workflows/lint.yml/badge.svg)](https://github.com/GrantBirki/kemal-hmac/actions/workflows/lint.yml) [![acceptance](https://github.com/GrantBirki/kemal-hmac/actions/workflows/acceptance.yml/badge.svg)](https://github.com/GrantBirki/kemal-hmac/actions/workflows/acceptance.yml)
+[![test](https://github.com/GrantBirki/kemal-hmac/actions/workflows/test.yml/badge.svg)](https://github.com/GrantBirki/kemal-hmac/actions/workflows/test.yml) [![build](https://github.com/GrantBirki/kemal-hmac/actions/workflows/build.yml/badge.svg)](https://github.com/GrantBirki/kemal-hmac/actions/workflows/build.yml) [![lint](https://github.com/GrantBirki/kemal-hmac/actions/workflows/lint.yml/badge.svg)](https://github.com/GrantBirki/kemal-hmac/actions/workflows/lint.yml) [![acceptance](https://github.com/GrantBirki/kemal-hmac/actions/workflows/acceptance.yml/badge.svg)](https://github.com/GrantBirki/kemal-hmac/actions/workflows/acceptance.yml) [![coverage](./docs/assets/coverage.svg)](./docs/assets/coverage.svg)
 
 HMAC middleware for Crystal's [kemal](https://github.com/kemalcr/kemal) framework

docs/assets/coverage.svg

@@ -0,0 +1 @@
+require "../spec/**"

script/require_spec.cr

@@ -6,6 +6,13 @@ source script/setup-env $@
 
 echo -e "🧪 ${BLUE}running unit tests...${OFF}"
 
-crystal spec
+# if -s is passed anywhere in the arguments, run without code coverage checks
+if [[ $@ == *"-s"* || "$CI" == "true" && "$OSTYPE" == "darwin"* ]]; then
+  echo "skipping code coverage checks"
+  crystal spec --exclude-warnings $SHARDS_INSTALL_PATH
+else
+  script/test_with_coverage $@
+  echo -e "\n"
+fi
 
 echo -e "✅ ${GREEN}tests complete!${OFF}"

script/test

@@ -0,0 +1,30 @@
+#!/bin/bash
+
+set -e
+
+source script/setup-env $@
+
+KCOV_BIN="kcov"
+
+if [[ -f "$DIR/bin/kcov" && "$CI" == "true" ]]; then
+  KCOV_BIN="$DIR/bin/kcov"
+fi
+
+# check to ensure both crystal and shards are installed
+if ! [ -x "$(command -v $KCOV_BIN)" ]; then
+  echo -e "❌ ${RED}Error${OFF}: kcov is not installed"
+  echo "Please install kcov to use code coverage reports:"
+  echo " - macOS: https://formulae.brew.sh/formula/kcov"
+  echo " - other: https://github.com/SimonKagstrom/kcov/blob/c71d42f1cadddbd2da38c1101d71ef2b84065c7b/INSTALL.md"
+  exit 1
+fi
+
+# only build the require_spec binary if it's not already built
+if [ ! -f "$DIR/bin/require_spec" ]; then
+  echo "building require_spec binary..."
+  crystal build "$DIR/script/require_spec.cr" -D skip-integration -o "$DIR/bin/require_spec" --exclude-warnings $SHARDS_INSTALL_PATH
+fi
+
+$KCOV_BIN --clean --include-path=$DIR/src "$DIR/coverage" "$DIR/bin/require_spec"
+
+CRYSTAL_OPTS="" crystal tool unreachable "$DIR/script/require_spec.cr" --check

script/test_with_coverage

@@ -2,7 +2,7 @@ version: 2.0
 shards:
   ameba:
     git: https://github.com/crystal-ameba/ameba.git
-    version: 1.6.2
+    version: 1.6.3
 
   backtracer:
     git: https://github.com/sija/backtracer.cr.git

shard.lock

@@ -1,19 +1,22 @@
 require "../spec_helper"
 
 describe "Kemal::Hmac" do
-  #   it "goes to next handler with correct credentials" do
-  #     hmac_handler = Kemal::Hmac::Handler.new()
-  #     request = HTTP::Request.new(
-  #       "GET",
-  #       "/",
-  #       headers: HTTP::Headers{"foo" => "bar"},
-  #     )
+  it "uses a custom handler with path matching and sends a request to an endpoint that does not require hmac auth" do
+    hmac_handler = SpecAuthHandler.new
+    request = HTTP::Request.new(
+      "GET",
+      "/health"
+    )
+
+    io, context = create_request_and_return_io_and_context(hmac_handler, request)
+    response = HTTP::Client::Response.from_io(io, decompress: false)
+    response.status_code.should eq 404
+    context.kemal_authorized_client?.should be nil
+  end
 
-  #     io, context = create_request_and_return_io_and_context(hmac_handler, request)
-  #     response = HTTP::Client::Response.from_io(io, decompress: false)
-  #     response.status_code.should eq 404
-  #     context.kemal_authorized_client?.should eq("serdar")
-  #   end
+  it "calls the hmac_auth helper method without errors" do
+    hmac_auth[0].to_s.should contain "Kemal::Hmac::Handler"
+  end
 
   it "returns 401 when a header is provided but it is not for hmac auth" do
     hmac_handler = Kemal::Hmac::Handler.new

spec/kemal-hmac/kemal-hmac_spec.cr

@@ -94,10 +94,5 @@ module Kemal::Hmac
     def missing_hmac_headers(headers : Hash(String, String?)) : Array(String)
       headers.select { |_, v| v.nil? }.keys
     end
-
-    def authorize?(value) : String?
-      username, password = Base64.decode_string(value[BASIC.size + 1..-1]).split(":")
-      @credentials.authorize?(username, password)
-    end
   end
 end