Merge pull request #26 from rizalgowandy/arwego/feat/fn

Add fn package

Author: Rizal Widyarta Gowandy

.github/scripts/gotool.js

@@ -0,0 +1,15 @@
+const util = require("util");
+const exec = util.promisify(require("child_process").exec);
+
+async function goTool(file) {
+  const { stdout } = await exec(
+      `go tool cover -func ${file} | grep total | awk '{printf("%s",$3);}'`
+  );
+
+  console.log(`${file} Code Coverage:`, stdout);
+  return stdout;
+}
+
+module.exports = async ({ file }) => {
+  return await goTool(file);
+};

.github/workflows/go.yml

@@ -5,6 +5,7 @@ on:
     branches: [ main ]
   pull_request:
     branches: [ main ]
+  workflow_dispatch:
 
 jobs:
 

.github/workflows/test-coverage.yml

@@ -0,0 +1,86 @@
+name: Coverage
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+    - name: Set up Go 1.x
+      uses: actions/setup-go@v2
+      with:
+        go-version: ^1.13
+
+    - name: Check out code into the Go module directory
+      uses: actions/checkout@v2
+
+    - name: Get dependencies
+      run: go mod vendor -v
+
+    - name: Test
+      run: |
+        go test ./... -cover -count=1 -race -coverprofile ../main.out
+
+    - name: Set main branch code coverage
+      id: codecov-main-branch
+      uses: actions/github-script@v3
+      with:
+        github-token: ${{secrets.GITHUB_TOKEN}}
+        result-encoding: string
+        script: |
+          const goTool = require(`${process.env.GITHUB_WORKSPACE}/.github/scripts/gotool.js`)
+          return await goTool({file: "../main.out"})
+
+    - name: Checkout PR branch
+      uses: actions/checkout@v2
+
+    - name: Test PR branch
+      run: |
+        go test ./... -cover -count=1 -race -coverprofile ../pr.out
+
+    - name: Set PR branch code coverage
+      id: codecov-pr-branch
+      uses: actions/github-script@v3
+      with:
+        github-token: ${{secrets.GITHUB_TOKEN}}
+        result-encoding: string
+        script: |
+          const goTool = require(`${process.env.GITHUB_WORKSPACE}/.github/scripts/gotool.js`)
+          return await goTool({file: "../pr.out"})
+
+    - name: Create comment
+      uses: actions/github-script@v3
+      env:
+        main_code_cov: ${{steps.codecov-main-branch.outputs.result}}
+        pr_code_cov: ${{steps.codecov-pr-branch.outputs.result}}
+      with:
+        github-token: ${{secrets.GITHUB_TOKEN}}
+        script: |
+          const runID = ${{github.run_id}}
+          mainCodeCov =  process.env.main_code_cov.replace(/[\n\t\r]/g,"")
+          prCodeCov =  process.env.pr_code_cov.replace(/[\n\t\r]/g,"")
+
+          const body = `
+          ### Test Coverage Result
+          Success! :confetti_ball::confetti_ball::confetti_ball:
+
+          **Code Coverage**
+          Main: ${mainCodeCov}
+          PR  : ${prCodeCov}
+
+          Check Detail: [Here](https://github.com/${context.issue.owner}/${context.issue.repo}/actions/runs/${runID})
+          `
+
+          github.issues.createComment({
+            issue_number: context.issue.number,
+            owner: context.repo.owner,
+            repo: context.repo.repo,
+            body: body
+          })

.golangci.yaml

@@ -72,7 +72,6 @@ linters:
     - bodyclose
     - deadcode
     - depguard
-    - dogsled
     - dupl
     - errcheck
     - exhaustive
@@ -109,6 +108,7 @@ linters:
     - whitespace
 
   # don't enable:
+  # - dogsled
   # - asciicheck
   # - gochecknoglobals
   # - gocognit

pkg/errorx/v2/errorx.go

@@ -3,21 +3,18 @@ package errorx
 import (
 	"errors"
 	"fmt"
-	"runtime"
-	"strings"
 
 	"github.com/imdario/mergo"
+	"github.com/rizalgowandy/gdk/pkg/fn"
 )
 
-var ServiceName = "rizalgowandy"
+const callerSkip = 2
 
 // E for creating new error.
 // error should always be the first param.
 func E(args ...interface{}) error {
 	if len(args) == 0 {
-		_, file, line, _ := runtime.Caller(1)
-		file = file[strings.Index(file, ServiceName)+len(ServiceName):]
-		return Errorf("errorx.E: bad call without args from file=%s:%d", file, line)
+		return Errorf("errorx.E: bad call without args from file=%s", fn.Line(callerSkip))
 	}
 
 	e := &Error{}
@@ -27,18 +24,17 @@ func E(args ...interface{}) error {
 			// Copy and put the errors back.
 			errCopy := *arg
 			e = &errCopy
+			e.OpTraces = append([]Op{Op(fn.Name(callerSkip))}, e.OpTraces...)
 
 		case error:
 			e.Err = arg
-			_, file, line, _ := runtime.Caller(1)
-			file = file[strings.Index(file, ServiceName)+len(ServiceName):]
-			e.Line = Line(fmt.Sprintf("%s:%d", file, line))
+			e.Line = Line(fn.Line(callerSkip))
+			e.OpTraces = append([]Op{Op(fn.Name(callerSkip))}, e.OpTraces...)
 
 		case string:
 			e.Err = Errorf(arg)
-			_, file, line, _ := runtime.Caller(1)
-			file = file[strings.Index(file, ServiceName)+len(ServiceName):]
-			e.Line = Line(fmt.Sprintf("%s:%d", file, line))
+			e.Line = Line(fn.Line(callerSkip))
+			e.OpTraces = append([]Op{Op(fn.Name(callerSkip))}, e.OpTraces...)
 
 		case Code:
 			// New code will always replace the old code.
@@ -60,7 +56,8 @@ func E(args ...interface{}) error {
 			}
 
 		case Op:
-			e.OpTraces = append([]Op{arg}, e.OpTraces...)
+			// For backward compatibility.
+			// Client is no longer to pass Op manually as an argument but will be filled automatically.
 
 		case Message:
 			e.Message = arg
@@ -70,9 +67,7 @@ func E(args ...interface{}) error {
 
 		default:
 			// The default error is unknown.
-			_, file, line, _ := runtime.Caller(1)
-			file = file[strings.Index(file, ServiceName)+len(ServiceName):]
-			msg := fmt.Sprintf("errorx.E: bad call from file=%s:%d args=%v", file, line, args)
+			msg := fmt.Sprintf("errorx.E: bad call from file=%s args=%v", fn.Line(callerSkip), args)
 			return Errorf(msg+"; unknown_type=%T value=%v", arg, arg)
 		}
 	}
@@ -118,7 +113,7 @@ func Match(errs1, errs2 error) bool {
 
 // Is reports whether err is an *Error of the given Code.
 // If err is nil then Is returns false.
-func Is(code Code, err error) bool {
+func Is(err error, code Code) bool {
 	if err == nil {
 		return false
 	}
@@ -133,7 +128,7 @@ func Is(code Code, err error) bool {
 	}
 
 	if e.Err != nil {
-		return Is(code, e.Err)
+		return Is(e.Err, code)
 	}
 
 	return false

pkg/errorx/v2/errorx_test.go

@@ -228,7 +228,7 @@ func TestIs(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			got := Is(tt.args.code, tt.args.err)
+			got := Is(tt.args.err, tt.args.code)
 			if !reflect.DeepEqual(tt.want, got) {
 				msg := "\nwant = %#v" + "\ngot  = %#v"
 				t.Errorf(msg, tt.want, got)

pkg/fn/fn.go

@@ -0,0 +1,33 @@
+package fn
+
+import (
+	"fmt"
+	"path/filepath"
+	"runtime"
+	"strings"
+)
+
+const Company = "rizalgowandy"
+
+// Name return the caller function name automatically.
+// Format: package.struct.method
+func Name(skips ...int) string {
+	skip := 1
+	if len(skips) > 0 {
+		skip = skips[0]
+	}
+	pc, _, _, _ := runtime.Caller(skip)
+	return filepath.Base(runtime.FuncForPC(pc).Name())
+}
+
+// Line return the caller code line automatically.
+// Format: /path/filename:line
+func Line(skips ...int) string {
+	skip := 1
+	if len(skips) > 0 {
+		skip = skips[0]
+	}
+	_, file, line, _ := runtime.Caller(skip)
+	file = file[strings.Index(file, Company)+len(Company):]
+	return fmt.Sprintf("%s:%d", file, line)
+}

pkg/logx/metadata_test.go

@@ -47,7 +47,7 @@ func TestErrMetadata(t *testing.T) {
 					tags.Message:      errorx.Message("qwerty"),
 					tags.MetricStatus: errorx.MetricStatusExpectedErr,
 					tags.Ops: []errorx.Op{
-						errorx.Op("abc"),
+						errorx.Op("logx.TestErrMetadata"),
 					},
 					tags.ErrorLine: "",
 				},
@@ -69,7 +69,7 @@ func TestErrMetadata(t *testing.T) {
 				}
 			}
 
-			assert.Equal(t, got, tt.want)
+			assert.Equal(t, tt.want, got)
 		})
 	}
 }