Skip to content

Commit

Permalink
feat: add go version judge when print debug warning log (gin-gonic#1572)
Browse files Browse the repository at this point in the history
* feat: add go version judge when print debug warning log

* remove invalid statement

* use one const
  • Loading branch information
thinkerou authored and justinfx committed Nov 3, 2018
1 parent 425f80b commit d1b243d
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 2 deletions.
18 changes: 17 additions & 1 deletion debug.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,13 @@ import (
"bytes"
"fmt"
"html/template"
"runtime"
"strconv"
"strings"
)

const ginSupportMinGoVer = 6

// IsDebugging returns true if the framework is running in debug mode.
// Use SetMode(gin.ReleaseMode) to disable debug mode.
func IsDebugging() bool {
Expand Down Expand Up @@ -49,10 +54,21 @@ func debugPrint(format string, values ...interface{}) {
}
}

func getMinVer(v string) (uint64, error) {
first := strings.IndexByte(v, '.')
last := strings.LastIndexByte(v, '.')
if first == last {
return strconv.ParseUint(v[first+1:], 10, 64)
}
return strconv.ParseUint(v[first+1:last], 10, 64)
}

func debugPrintWARNINGDefault() {
debugPrint(`[WARNING] Now Gin requires Go 1.6 or later and Go 1.7 will be required soon.
if v, e := getMinVer(runtime.Version()); e == nil && v <= ginSupportMinGoVer {
debugPrint(`[WARNING] Now Gin requires Go 1.6 or later and Go 1.7 will be required soon.
`)
}
debugPrint(`[WARNING] Creating an Engine instance with the Logger and Recovery middleware already attached.
`)
Expand Down
24 changes: 23 additions & 1 deletion debug_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (
"io"
"log"
"os"
"runtime"
"sync"
"testing"

Expand Down Expand Up @@ -88,7 +89,13 @@ func TestDebugPrintWARNINGDefault(t *testing.T) {
debugPrintWARNINGDefault()
SetMode(TestMode)
})
assert.Equal(t, "[GIN-debug] [WARNING] Now Gin requires Go 1.6 or later and Go 1.7 will be required soon.\n\n[GIN-debug] [WARNING] Creating an Engine instance with the Logger and Recovery middleware already attached.\n\n", re)
m, e := getMinVer(runtime.Version())
assert.Nil(t, e)
if m <= ginSupportMinGoVer {
assert.Equal(t, "[GIN-debug] [WARNING] Now Gin requires Go 1.6 or later and Go 1.7 will be required soon.\n\n[GIN-debug] [WARNING] Creating an Engine instance with the Logger and Recovery middleware already attached.\n\n", re)
} else {
assert.Equal(t, "[GIN-debug] [WARNING] Creating an Engine instance with the Logger and Recovery middleware already attached.\n\n", re)
}
}

func TestDebugPrintWARNINGNew(t *testing.T) {
Expand Down Expand Up @@ -129,3 +136,18 @@ func captureOutput(f func()) string {
writer.Close()
return <-out
}

func TestGetMinVer(t *testing.T) {
var m uint64
var e error
_, e = getMinVer("go1")
assert.NotNil(t, e)
m, e = getMinVer("go1.1")
assert.Equal(t, uint64(1), m)
assert.Nil(t, e)
m, e = getMinVer("go1.1.1")
assert.Nil(t, e)
assert.Equal(t, uint64(1), m)
_, e = getMinVer("go1.1.1.1")
assert.NotNil(t, e)
}

0 comments on commit d1b243d

Please sign in to comment.