adding coverage report

.github/workflows/build.yml

@@ -99,6 +99,13 @@ jobs:
         run: |
           # make integration
           make gen && make && make integration
+      - name: Run Code Coverage
+        run: |
+          make coverage
+      - uses: PaloAltoNetworks/cov@3.0.0
+        with:
+          cov_mode: coverage
+          main_branch: master
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v6
         with:

.gitignore

@@ -20,6 +20,7 @@ internal/generated.out
 
 # Ignore Coverage Files
 coverage*
+cov.report
 
 # Ignore IDE files
 .idea/
@@ -31,4 +32,4 @@ cmd/spark-connect-example-spark-session/spark-connect-example-spark-session
 target
 lib
 
-deps
+deps

CONTRIBUTING.md

@@ -31,6 +31,28 @@ This requires the following tools to be present in your PATH:
 2. `gofumpt` for formatting Go code
 3. `golangci-lint` for linting Go code
 
+### Running Tests
+
+To run the tests locally, you can run:
+
+```bash
+make test
+```
+
+This will run the unit tests. If you want to run the integration tests, you can run:
+
+```bash
+make integration
+```
+
+Lastly, if you want to run all tests and generate the coverage analysis, you can run:
+
+```bash
+make fulltest
+```
+
+The output of the coverage analysis will be in the `coverage.out` file. An HTML version of
+the coverage report is generated and accessible at `coverage.html`.
 
 ### How to write tests
 

Makefile

@@ -92,10 +92,10 @@ test: $(BUILD_OUTPUT)
 	    @echo -n "     ";\
 		$(GO) test -v -run '(Test|Example)' $(BUILDFLAGS) $(TESTFLAGS) $(pkg) || exit 1)
 
-fulltest: $(BUILD_OUTPUT)
+coverage: $(BUILD_OUTPUT)
 	@echo ">> TEST, \"coverage\""
 	@$(GO) test -cover -coverprofile=coverage.out -covermode=atomic -coverpkg=./spark/...,./internal/tests/... ./spark/... ./internal/tests/...
-	@$(GO) tool cover -html=coverage.out -o coverage-all.html
+	@$(GO) tool cover -html=coverage.out -o coverage.html
 
 integration: $(BUILD_OUTPUT)
 	@echo ">> TEST, \"integration\""