[Enhancement] Reintroduce the MapStore interface and SimpleMap and make the Badger a submodules

.github/codecov.yml

@@ -0,0 +1,9 @@
+# Only post coverage comments and not pass/fail reports in the CI checks
+coverage:
+  status:
+    project:
+      default:
+        informational: true
+    patch:
+      default:
+        informational: true

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-name: Test & Build
+name: Go Tests
 
 on:
   pull_request:
@@ -12,7 +12,7 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  TARGET_GOLANG_VERSION: "1.20.11"
+  TARGET_GOLANG_VERSION: "1.20.12"
 
 jobs:
   tests:
@@ -22,7 +22,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
         with:
-          fetch-depth: "0" # Per https://github.com/ignite/cli/issues/1674#issuecomment-1144619147
+          fetch-depth: "0"
 
       - name: Setup go
         uses: actions/setup-go@v4
@@ -37,20 +37,36 @@ jobs:
           skip-cache: true
           only-new-issues: true
 
+      - name: Install gocovmerge
+        run: go install github.com/wadey/gocovmerge@latest
+
       - name: Create coverage report and run tests
         run: |
+          # Run each of the tests (excluding benchmarks) outputting the JSON
+          # to the test_results.json file for usage in later steps.
           set -euo pipefail
-          GODEBUG=netdns=cgo go test -p 1 -json ./ -mod=readonly -timeout 8m -race -coverprofile=coverage.txt -covermode=atomic 2>&1 | tee test_results.json
+          go test -v -json -p 1 ./ -mod=readonly -race -coverprofile=coverage1.txt -covermode=atomic 2>&1 | tee test_results.json
+          go test -v -json -p 1 ./kvstore/simplemap/... -mod=readonly -race -coverprofile=coverage2.txt -covermode=atomic 2>&1 | tee -a test_results.json
+          go test -v -json -p 1 ./kvstore/badger/... -mod=readonly -race -coverprofile=coverage3.txt -covermode=atomic 2>&1 | tee -a test_results.json
+          # Combine coverage reports
+          gocovmerge coverage1.txt coverage2.txt coverage3.txt > coverage.txt
 
       - name: Sanitize test results
-        # We're utilizing `tee` above which can capture non-json stdout output so we need to remove non-json lines before additional parsing and submitting it to the external github action.
+        # We're utilizing `tee` above which can capture non-json stdout output
+        # so we need to remove non-json lines before additional parsing and
+        # submitting it to the external github action.
         run: cat test_results.json | jq -c -R 'fromjson? | select(type == "object")' > tmp.json && mv tmp.json test_results.json
 
       - name: Output test failures
-        # Makes it easier to find failed tests so no need to scroll through the whole log.
         if: ${{ failure() }}
         run: |
-          jq --argjson fail_tests "$(jq -c -r 'select(.Action == "fail") | select(.Test) | .Test' test_results.json | jq -R -s -c -r 'split("\n") | map(select(length>0))')" 'select(.Test as $t | ($fail_tests | arrays)[] | select($t == .)) | select(.Output) | .Output' test_results.json | jq -r | sed ':a;N;$!ba;s/\n\n/\n/g' > test_failures.json
+          jq --argjson fail_tests "$( \
+            jq -c -r 'select(.Action == "fail") | select(.Test) | .Test' test_results.json \
+            | jq -R -s -c 'split("\n") | map(select(length > 0))' \
+          )" \
+          'select(.Test as $t | ($fail_tests | arrays)[] | select($t == .)) | select(.Output) | .Output' test_results.json \
+          | jq -r \
+          | sed ':a;N;$!ba;s/\n\n/\n/g' > test_failures.json
           cat test_failures.json
           exit 1
 
@@ -62,7 +78,6 @@ jobs:
             test_*.json
 
       - name: Annotate tests on GitHub
-        # Only annotate if the test failed on target version to avoid duplicated annotations on GitHub.
         uses: guyarb/[email protected]
         with:
           test-results: test_results.json
@@ -71,30 +86,4 @@ jobs:
         uses: codecov/codecov-action@v3
         with:
           files: ./coverage.txt
-
-  build:
-    runs-on: ubuntu-latest
-    needs: tests
-    strategy:
-      fail-fast: false
-      matrix:
-        goarch: ["arm64", "amd64"]
-    timeout-minutes: 5
-    name: Build for ${{ matrix.goarch }}
-    steps:
-      - uses: actions/setup-go@v4
-        with:
-          go-version: ${{ env.TARGET_GOLANG_VERSION }}
-
-      - uses: actions/checkout@v3
-
-      - uses: technote-space/get-diff-action@v4
-        with:
-          PATTERNS: |
-            **/**.go
-            go.mod
-            go.sum
-
-      - name: Go build
-        run: GOOS=linux GOARCH=${{ matrix.goarch }} go build
-        if: env.GIT_DIFF
+          verbose: true

.gitignore

@@ -1,5 +1,8 @@
-# macos files
+# Ignore Mac OS X system files
 .DS_Store
 
-# goland
-.idea/
+# Ignore asdf local tool-versions file
+.tool-versions
+
+# Ignore Goland and JetBrains IDE files
+.idea/

Makefile

@@ -1,5 +1,3 @@
-SHELL := /bin/bash
-
 .SILENT:
 
 #####################
@@ -42,6 +40,21 @@ go_docs: check_godoc ## Generate documentation for the project
 .PHONY: test_all
 test_all:  ## runs the test suite
 	go test -v -p 1 ./ -mod=readonly -race
+	go test -v -p 1 ./kvstore/simplemap/... -mod=readonly -race
+
+.PHONY: test_badger
+test_badger: ## runs the badger KVStore submodule's test suite
+	go test -v -p 1 ./kvstore/badger/... -mod=readonly -race
+
+
+#####################
+###    go mod     ###
+#####################
+.PHONY: mod_tidy
+mod_tidy:  ## runs go mod tidy for all (sub)modules
+	go mod tidy
+	cd kvstore/simplemap && go mod tidy
+	cd kvstore/badger && go mod tidy
 
 #####################
 ###   Benchmark   ###