add test converage configuration

Author: qdriven

.github/workflows/go.yml

@@ -1,7 +1,7 @@
 # This workflow will build a golang project
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
 
-name: Go
+name: Go CI Worflow with test coverage check
 
 on:
   push:
@@ -19,10 +19,26 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v4
       with:
-        go-version: '1.20'
+        go-version: '1.21'
 
-    - name: Build
-      run: go build -v ./...
 
-    - name: Test
-      run: go test -v ./...
+    - name: generate test coverage
+      run: go test ./... -coverprofile=./cover.out -covermode=atomic -coverpkg=./...
+    
+    - name: check test coverage
+      uses: vladopajic/go-test-coverage@v2
+      with:
+        # Configure action using config file (option 1)
+        config: ./.testcoverage.yml
+        
+        # Configure action by specifying input parameters individually (option 2).
+        # If you are using config file (option 1) you shouldn't use these parameters, however
+        # specifing these action parameters will override appropriate config values.
+        profile: cover.out
+        local-prefix: github.com/org/project
+        threshold-file: 70
+        threshold-package: 70
+        threshold-total: 70
+
+    - name: Build
+      run: go build -v ./...

.gitignore

@@ -1 +1,2 @@
-.idea/
+.idea/
+cover.out

.testcoverage.yml

@@ -0,0 +1,51 @@
+# (mandatory) 
+# Path to coverprofile file (output of `go test -coverprofile` command).
+#
+# For cases where there are many coverage profiles, such as when running 
+# unit tests and integration tests separately, you can combine all those
+# profiles into one. In this case, the profile should have a comma-separated list 
+# of profile files, e.g., 'cover_unit.out,cover_integration.out'.
+profile: cover.out
+
+# (optional; but recommended to set) 
+# When specified reported file paths will not contain local prefix in the output
+local-prefix: "github.com/org/project"
+
+# Holds coverage thresholds percentages, values should be in range [0-100]
+threshold:
+  # (optional; default 0) 
+  # The minimum coverage that each file should have
+  file: 65
+
+  # (optional; default 0) 
+  # The minimum coverage that each package should have
+  package: 65
+
+  # (optional; default 0) 
+  # The minimum total coverage project should have
+  total: 65
+
+# Holds regexp rules which will override thresholds for matched files or packages 
+# using their paths.
+#
+# First rule from this list that matches file or package is going to apply 
+# new threshold to it. If project has multiple rules that match same path, 
+# override rules should be listed in order from specific to more general rules.
+override:
+  # Increase coverage threshold to 100% for `foo` package 
+  # (default is 80, as configured above in this example)
+  - threshold: 65 
+    path: .
+    # path: ^pkg/lib/foo$
+
+# Holds regexp rules which will exclude matched files or packages 
+# from coverage statistics
+exclude:
+  # Exclude files or packages matching their paths
+  paths:
+    - \.pb\.go$    # excludes all protobuf generated files
+    - ^pkg/bar     # exclude package `pkg/bar`
+ 
+# NOTES:
+# - symbol `/` in all path regexps will be replaced by current OS file path separator
+#   to properly work on Windows

Makefile

@@ -0,0 +1,20 @@
+#include .env.example
+#export
+
+LOCAL_BIN:=$(CURDIR)/bin
+PATH:=$(LOCAL_BIN):$(PATH)
+GOBIN ?= $$(go env GOPATH)/bin
+
+.PHONY: install-go-test-coverage
+install-go-test-coverage:
+	go install github.com/vladopajic/go-test-coverage/v2@latest
+
+.PHONY: check-coverage
+check-coverage: install-go-test-coverage
+	go test ./... -coverprofile=./cover.out -covermode=atomic -coverpkg=./...
+	${GOBIN}/go-test-coverage --config=./.testcoverage.yml
+
+
+.PHONY: format
+format:
+	gofmt -l -w .

README.md

@@ -1,8 +1,10 @@
-# GO-Lib: Configurations
+# Go Configurations
 
 ## How to Use
 
 - Read Configuration from file
+- Configuration to Struct
+- Configuration to Struct by Key:nested configuration
 
 ```shell
     appconfig, _ := NewYamlConfig("config.yaml")

go.mod

@@ -1,6 +1,6 @@
 module github.com/fluent-qa/qfluentconf
 
-go 1.21.4
+go 1.22.6
 
 require (
 	github.com/fsnotify/fsnotify v1.7.0