Browse code

Move debug functions to cli/debug package

Signed-off-by: Vincent Demeester <vincent@sbr.pm>

Vincent Demeester authored on 2016/12/12 17:33:58
Showing 9 changed files
... ...
@@ -12,8 +12,8 @@ import (
12 12
 	"github.com/docker/docker/api/types/swarm"
13 13
 	"github.com/docker/docker/cli"
14 14
 	"github.com/docker/docker/cli/command"
15
+	"github.com/docker/docker/cli/debug"
15 16
 	"github.com/docker/docker/pkg/ioutils"
16
-	"github.com/docker/docker/utils"
17 17
 	"github.com/docker/docker/utils/templates"
18 18
 	"github.com/docker/go-units"
19 19
 	"github.com/spf13/cobra"
... ...
@@ -206,7 +206,7 @@ func prettyPrintInfo(dockerCli *command.DockerCli, info types.Info) error {
206 206
 	ioutils.FprintfIfNotEmpty(dockerCli.Out(), "Name: %s\n", info.Name)
207 207
 	ioutils.FprintfIfNotEmpty(dockerCli.Out(), "ID: %s\n", info.ID)
208 208
 	fmt.Fprintf(dockerCli.Out(), "Docker Root Dir: %s\n", info.DockerRootDir)
209
-	fmt.Fprintf(dockerCli.Out(), "Debug Mode (client): %v\n", utils.IsDebugEnabled())
209
+	fmt.Fprintf(dockerCli.Out(), "Debug Mode (client): %v\n", debug.IsEnabled())
210 210
 	fmt.Fprintf(dockerCli.Out(), "Debug Mode (server): %v\n", info.Debug)
211 211
 
212 212
 	if info.Debug {
213 213
new file mode 100644
... ...
@@ -0,0 +1,26 @@
0
+package debug
1
+
2
+import (
3
+	"os"
4
+
5
+	"github.com/Sirupsen/logrus"
6
+)
7
+
8
+// Enable sets the DEBUG env var to true
9
+// and makes the logger to log at debug level.
10
+func Enable() {
11
+	os.Setenv("DEBUG", "1")
12
+	logrus.SetLevel(logrus.DebugLevel)
13
+}
14
+
15
+// Disable sets the DEBUG env var to false
16
+// and makes the logger to log at info level.
17
+func Disable() {
18
+	os.Setenv("DEBUG", "")
19
+	logrus.SetLevel(logrus.InfoLevel)
20
+}
21
+
22
+// IsEnabled checks whether the debug flag is set or not.
23
+func IsEnabled() bool {
24
+	return os.Getenv("DEBUG") != ""
25
+}
0 26
new file mode 100644
... ...
@@ -0,0 +1,43 @@
0
+package debug
1
+
2
+import (
3
+	"os"
4
+	"testing"
5
+
6
+	"github.com/Sirupsen/logrus"
7
+)
8
+
9
+func TestEnable(t *testing.T) {
10
+	defer func() {
11
+		os.Setenv("DEBUG", "")
12
+		logrus.SetLevel(logrus.InfoLevel)
13
+	}()
14
+	Enable()
15
+	if os.Getenv("DEBUG") != "1" {
16
+		t.Fatalf("expected DEBUG=1, got %s\n", os.Getenv("DEBUG"))
17
+	}
18
+	if logrus.GetLevel() != logrus.DebugLevel {
19
+		t.Fatalf("expected log level %v, got %v\n", logrus.DebugLevel, logrus.GetLevel())
20
+	}
21
+}
22
+
23
+func TestDisable(t *testing.T) {
24
+	Disable()
25
+	if os.Getenv("DEBUG") != "" {
26
+		t.Fatalf("expected DEBUG=\"\", got %s\n", os.Getenv("DEBUG"))
27
+	}
28
+	if logrus.GetLevel() != logrus.InfoLevel {
29
+		t.Fatalf("expected log level %v, got %v\n", logrus.InfoLevel, logrus.GetLevel())
30
+	}
31
+}
32
+
33
+func TestEnabled(t *testing.T) {
34
+	Enable()
35
+	if !IsEnabled() {
36
+		t.Fatal("expected debug enabled, got false")
37
+	}
38
+	Disable()
39
+	if IsEnabled() {
40
+		t.Fatal("expected debug disabled, got true")
41
+	}
42
+}
... ...
@@ -10,11 +10,11 @@ import (
10 10
 	"github.com/docker/docker/cli"
11 11
 	"github.com/docker/docker/cli/command"
12 12
 	"github.com/docker/docker/cli/command/commands"
13
+	"github.com/docker/docker/cli/debug"
13 14
 	cliflags "github.com/docker/docker/cli/flags"
14 15
 	"github.com/docker/docker/cliconfig"
15 16
 	"github.com/docker/docker/dockerversion"
16 17
 	"github.com/docker/docker/pkg/term"
17
-	"github.com/docker/docker/utils"
18 18
 	"github.com/spf13/cobra"
19 19
 	"github.com/spf13/pflag"
20 20
 )
... ...
@@ -130,7 +130,7 @@ func dockerPreRun(opts *cliflags.ClientOptions) {
130 130
 	}
131 131
 
132 132
 	if opts.Common.Debug {
133
-		utils.EnableDebug()
133
+		debug.Enable()
134 134
 	}
135 135
 }
136 136
 
... ...
@@ -7,12 +7,12 @@ import (
7 7
 
8 8
 	"github.com/Sirupsen/logrus"
9 9
 	"github.com/docker/docker/cli/command"
10
+	"github.com/docker/docker/cli/debug"
10 11
 	"github.com/docker/docker/pkg/testutil/assert"
11
-	"github.com/docker/docker/utils"
12 12
 )
13 13
 
14 14
 func TestClientDebugEnabled(t *testing.T) {
15
-	defer utils.DisableDebug()
15
+	defer debug.Disable()
16 16
 
17 17
 	cmd := newDockerCommand(&command.DockerCli{})
18 18
 	cmd.Flags().Set("debug", "true")
... ...
@@ -26,6 +26,7 @@ import (
26 26
 	systemrouter "github.com/docker/docker/api/server/router/system"
27 27
 	"github.com/docker/docker/api/server/router/volume"
28 28
 	"github.com/docker/docker/builder/dockerfile"
29
+	"github.com/docker/docker/cli/debug"
29 30
 	cliflags "github.com/docker/docker/cli/flags"
30 31
 	"github.com/docker/docker/cliconfig"
31 32
 	"github.com/docker/docker/daemon"
... ...
@@ -44,7 +45,6 @@ import (
44 44
 	"github.com/docker/docker/plugin"
45 45
 	"github.com/docker/docker/registry"
46 46
 	"github.com/docker/docker/runconfig"
47
-	"github.com/docker/docker/utils"
48 47
 	"github.com/docker/go-connections/tlsconfig"
49 48
 	"github.com/spf13/pflag"
50 49
 )
... ...
@@ -137,7 +137,7 @@ func (cli *DaemonCli) start(opts daemonOptions) (err error) {
137 137
 	}
138 138
 
139 139
 	if cli.Config.Debug {
140
-		utils.EnableDebug()
140
+		debug.Enable()
141 141
 	}
142 142
 
143 143
 	if cli.Config.Experimental {
... ...
@@ -351,13 +351,13 @@ func (cli *DaemonCli) reloadConfig() {
351 351
 		}
352 352
 
353 353
 		if config.IsValueSet("debug") {
354
-			debugEnabled := utils.IsDebugEnabled()
354
+			debugEnabled := debug.IsEnabled()
355 355
 			switch {
356 356
 			case debugEnabled && !config.Debug: // disable debug
357
-				utils.DisableDebug()
357
+				debug.Disable()
358 358
 				cli.api.DisableProfiler()
359 359
 			case config.Debug && !debugEnabled: // enable debug
360
-				utils.EnableDebug()
360
+				debug.Enable()
361 361
 				cli.api.EnableProfiler()
362 362
 			}
363 363
 
... ...
@@ -488,7 +488,7 @@ func initRouter(s *apiserver.Server, d *daemon.Daemon, c *cluster.Cluster) {
488 488
 		}
489 489
 	}
490 490
 
491
-	s.InitRouter(utils.IsDebugEnabled(), routers...)
491
+	s.InitRouter(debug.IsEnabled(), routers...)
492 492
 }
493 493
 
494 494
 func (cli *DaemonCli) initMiddlewares(s *apiserver.Server, cfg *apiserver.Config) error {
... ...
@@ -10,6 +10,7 @@ import (
10 10
 	"github.com/Sirupsen/logrus"
11 11
 	"github.com/docker/docker/api"
12 12
 	"github.com/docker/docker/api/types"
13
+	"github.com/docker/docker/cli/debug"
13 14
 	"github.com/docker/docker/container"
14 15
 	"github.com/docker/docker/dockerversion"
15 16
 	"github.com/docker/docker/pkg/fileutils"
... ...
@@ -19,7 +20,6 @@ import (
19 19
 	"github.com/docker/docker/pkg/sysinfo"
20 20
 	"github.com/docker/docker/pkg/system"
21 21
 	"github.com/docker/docker/registry"
22
-	"github.com/docker/docker/utils"
23 22
 	"github.com/docker/docker/volume/drivers"
24 23
 	"github.com/docker/go-connections/sockets"
25 24
 )
... ...
@@ -102,7 +102,7 @@ func (daemon *Daemon) SystemInfo() (*types.Info, error) {
102 102
 		IPv4Forwarding:     !sysInfo.IPv4ForwardingDisabled,
103 103
 		BridgeNfIptables:   !sysInfo.BridgeNFCallIPTablesDisabled,
104 104
 		BridgeNfIP6tables:  !sysInfo.BridgeNFCallIP6TablesDisabled,
105
-		Debug:              utils.IsDebugEnabled(),
105
+		Debug:              debug.IsEnabled(),
106 106
 		NFd:                fileutils.GetTotalUsedFds(),
107 107
 		NGoroutines:        runtime.NumGoroutine(),
108 108
 		SystemTime:         time.Now().Format(time.RFC3339Nano),
109 109
deleted file mode 100644
... ...
@@ -1,26 +0,0 @@
1
-package utils
2
-
3
-import (
4
-	"os"
5
-
6
-	"github.com/Sirupsen/logrus"
7
-)
8
-
9
-// EnableDebug sets the DEBUG env var to true
10
-// and makes the logger to log at debug level.
11
-func EnableDebug() {
12
-	os.Setenv("DEBUG", "1")
13
-	logrus.SetLevel(logrus.DebugLevel)
14
-}
15
-
16
-// DisableDebug sets the DEBUG env var to false
17
-// and makes the logger to log at info level.
18
-func DisableDebug() {
19
-	os.Setenv("DEBUG", "")
20
-	logrus.SetLevel(logrus.InfoLevel)
21
-}
22
-
23
-// IsDebugEnabled checks whether the debug flag is set or not.
24
-func IsDebugEnabled() bool {
25
-	return os.Getenv("DEBUG") != ""
26
-}
27 1
deleted file mode 100644
... ...
@@ -1,43 +0,0 @@
1
-package utils
2
-
3
-import (
4
-	"os"
5
-	"testing"
6
-
7
-	"github.com/Sirupsen/logrus"
8
-)
9
-
10
-func TestEnableDebug(t *testing.T) {
11
-	defer func() {
12
-		os.Setenv("DEBUG", "")
13
-		logrus.SetLevel(logrus.InfoLevel)
14
-	}()
15
-	EnableDebug()
16
-	if os.Getenv("DEBUG") != "1" {
17
-		t.Fatalf("expected DEBUG=1, got %s\n", os.Getenv("DEBUG"))
18
-	}
19
-	if logrus.GetLevel() != logrus.DebugLevel {
20
-		t.Fatalf("expected log level %v, got %v\n", logrus.DebugLevel, logrus.GetLevel())
21
-	}
22
-}
23
-
24
-func TestDisableDebug(t *testing.T) {
25
-	DisableDebug()
26
-	if os.Getenv("DEBUG") != "" {
27
-		t.Fatalf("expected DEBUG=\"\", got %s\n", os.Getenv("DEBUG"))
28
-	}
29
-	if logrus.GetLevel() != logrus.InfoLevel {
30
-		t.Fatalf("expected log level %v, got %v\n", logrus.InfoLevel, logrus.GetLevel())
31
-	}
32
-}
33
-
34
-func TestDebugEnabled(t *testing.T) {
35
-	EnableDebug()
36
-	if !IsDebugEnabled() {
37
-		t.Fatal("expected debug enabled, got false")
38
-	}
39
-	DisableDebug()
40
-	if IsDebugEnabled() {
41
-		t.Fatal("expected debug disabled, got true")
42
-	}
43
-}