Skip to content

Commit ce37550

Browse files
vdemeestervdemeester
committed
Move debug functions to cli/debug package
Signed-off-by: Vincent Demeester <[email protected]>
1 parent 8c1ac81 commit ce37550

7 files changed

Lines changed: 31 additions & 31 deletions

File tree

‎cli/command/system/info.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ import (
1212
"github.com/docker/docker/api/types/swarm"
1313
"github.com/docker/docker/cli"
1414
"github.com/docker/docker/cli/command"
15+
"github.com/docker/docker/cli/debug"
1516
"github.com/docker/docker/pkg/ioutils"
16-
"github.com/docker/docker/utils"
1717
"github.com/docker/docker/utils/templates"
1818
"github.com/docker/go-units"
1919
"github.com/spf13/cobra"
@@ -206,7 +206,7 @@ func prettyPrintInfo(dockerCli *command.DockerCli, info types.Info) error {
206206
ioutils.FprintfIfNotEmpty(dockerCli.Out(), "Name: %s\n", info.Name)
207207
ioutils.FprintfIfNotEmpty(dockerCli.Out(), "ID: %s\n", info.ID)
208208
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())
210210
fmt.Fprintf(dockerCli.Out(), "Debug Mode (server): %v\n", info.Debug)
211211

212212
if info.Debug {

utils/debug.go renamed to cli/debug/debug.go

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
1-
package utils
1+
package debug
22

33
import (
44
"os"
55

66
"github.com/Sirupsen/logrus"
77
)
88

9-
// EnableDebug sets the DEBUG env var to true
9+
// Enable sets the DEBUG env var to true
1010
// and makes the logger to log at debug level.
11-
func EnableDebug() {
11+
func Enable() {
1212
os.Setenv("DEBUG", "1")
1313
logrus.SetLevel(logrus.DebugLevel)
1414
}
1515

16-
// DisableDebug sets the DEBUG env var to false
16+
// Disable sets the DEBUG env var to false
1717
// and makes the logger to log at info level.
18-
func DisableDebug() {
18+
func Disable() {
1919
os.Setenv("DEBUG", "")
2020
logrus.SetLevel(logrus.InfoLevel)
2121
}
2222

23-
// IsDebugEnabled checks whether the debug flag is set or not.
24-
func IsDebugEnabled() bool {
23+
// IsEnabled checks whether the debug flag is set or not.
24+
func IsEnabled() bool {
2525
return os.Getenv("DEBUG") != ""
2626
}

utils/debug_test.go renamed to cli/debug/debug_test.go

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package utils
1+
package debug
22

33
import (
44
"os"
@@ -7,12 +7,12 @@ import (
77
"github.com/Sirupsen/logrus"
88
)
99

10-
func TestEnableDebug(t *testing.T) {
10+
func TestEnable(t *testing.T) {
1111
defer func() {
1212
os.Setenv("DEBUG", "")
1313
logrus.SetLevel(logrus.InfoLevel)
1414
}()
15-
EnableDebug()
15+
Enable()
1616
if os.Getenv("DEBUG") != "1" {
1717
t.Fatalf("expected DEBUG=1, got %s\n", os.Getenv("DEBUG"))
1818
}
@@ -21,8 +21,8 @@ func TestEnableDebug(t *testing.T) {
2121
}
2222
}
2323

24-
func TestDisableDebug(t *testing.T) {
25-
DisableDebug()
24+
func TestDisable(t *testing.T) {
25+
Disable()
2626
if os.Getenv("DEBUG") != "" {
2727
t.Fatalf("expected DEBUG=\"\", got %s\n", os.Getenv("DEBUG"))
2828
}
@@ -31,13 +31,13 @@ func TestDisableDebug(t *testing.T) {
3131
}
3232
}
3333

34-
func TestDebugEnabled(t *testing.T) {
35-
EnableDebug()
36-
if !IsDebugEnabled() {
34+
func TestEnabled(t *testing.T) {
35+
Enable()
36+
if !IsEnabled() {
3737
t.Fatal("expected debug enabled, got false")
3838
}
39-
DisableDebug()
40-
if IsDebugEnabled() {
39+
Disable()
40+
if IsEnabled() {
4141
t.Fatal("expected debug disabled, got true")
4242
}
4343
}

‎cmd/docker/docker.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ import (
1010
"github.com/docker/docker/cli"
1111
"github.com/docker/docker/cli/command"
1212
"github.com/docker/docker/cli/command/commands"
13+
"github.com/docker/docker/cli/debug"
1314
cliflags "github.com/docker/docker/cli/flags"
1415
"github.com/docker/docker/cliconfig"
1516
"github.com/docker/docker/dockerversion"
1617
"github.com/docker/docker/pkg/term"
17-
"github.com/docker/docker/utils"
1818
"github.com/spf13/cobra"
1919
"github.com/spf13/pflag"
2020
)
@@ -130,7 +130,7 @@ func dockerPreRun(opts *cliflags.ClientOptions) {
130130
}
131131

132132
if opts.Common.Debug {
133-
utils.EnableDebug()
133+
debug.Enable()
134134
}
135135
}
136136

‎cmd/docker/docker_test.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ import (
77

88
"github.com/Sirupsen/logrus"
99
"github.com/docker/docker/cli/command"
10+
"github.com/docker/docker/cli/debug"
1011
"github.com/docker/docker/pkg/testutil/assert"
11-
"github.com/docker/docker/utils"
1212
)
1313

1414
func TestClientDebugEnabled(t *testing.T) {
15-
defer utils.DisableDebug()
15+
defer debug.Disable()
1616

1717
cmd := newDockerCommand(&command.DockerCli{})
1818
cmd.Flags().Set("debug", "true")

‎cmd/dockerd/daemon.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ import (
2626
systemrouter "github.com/docker/docker/api/server/router/system"
2727
"github.com/docker/docker/api/server/router/volume"
2828
"github.com/docker/docker/builder/dockerfile"
29+
"github.com/docker/docker/cli/debug"
2930
cliflags "github.com/docker/docker/cli/flags"
3031
"github.com/docker/docker/cliconfig"
3132
"github.com/docker/docker/daemon"
@@ -44,7 +45,6 @@ import (
4445
"github.com/docker/docker/plugin"
4546
"github.com/docker/docker/registry"
4647
"github.com/docker/docker/runconfig"
47-
"github.com/docker/docker/utils"
4848
"github.com/docker/go-connections/tlsconfig"
4949
"github.com/spf13/pflag"
5050
)
@@ -137,7 +137,7 @@ func (cli *DaemonCli) start(opts daemonOptions) (err error) {
137137
}
138138

139139
if cli.Config.Debug {
140-
utils.EnableDebug()
140+
debug.Enable()
141141
}
142142

143143
if cli.Config.Experimental {
@@ -351,13 +351,13 @@ func (cli *DaemonCli) reloadConfig() {
351351
}
352352

353353
if config.IsValueSet("debug") {
354-
debugEnabled := utils.IsDebugEnabled()
354+
debugEnabled := debug.IsEnabled()
355355
switch {
356356
case debugEnabled && !config.Debug: // disable debug
357-
utils.DisableDebug()
357+
debug.Disable()
358358
cli.api.DisableProfiler()
359359
case config.Debug && !debugEnabled: // enable debug
360-
utils.EnableDebug()
360+
debug.Enable()
361361
cli.api.EnableProfiler()
362362
}
363363

@@ -488,7 +488,7 @@ func initRouter(s *apiserver.Server, d *daemon.Daemon, c *cluster.Cluster) {
488488
}
489489
}
490490

491-
s.InitRouter(utils.IsDebugEnabled(), routers...)
491+
s.InitRouter(debug.IsEnabled(), routers...)
492492
}
493493

494494
func (cli *DaemonCli) initMiddlewares(s *apiserver.Server, cfg *apiserver.Config) error {

‎daemon/info.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import (
1010
"github.com/Sirupsen/logrus"
1111
"github.com/docker/docker/api"
1212
"github.com/docker/docker/api/types"
13+
"github.com/docker/docker/cli/debug"
1314
"github.com/docker/docker/container"
1415
"github.com/docker/docker/dockerversion"
1516
"github.com/docker/docker/pkg/fileutils"
@@ -19,7 +20,6 @@ import (
1920
"github.com/docker/docker/pkg/sysinfo"
2021
"github.com/docker/docker/pkg/system"
2122
"github.com/docker/docker/registry"
22-
"github.com/docker/docker/utils"
2323
"github.com/docker/docker/volume/drivers"
2424
"github.com/docker/go-connections/sockets"
2525
)
@@ -102,7 +102,7 @@ func (daemon *Daemon) SystemInfo() (*types.Info, error) {
102102
IPv4Forwarding: !sysInfo.IPv4ForwardingDisabled,
103103
BridgeNfIptables: !sysInfo.BridgeNFCallIPTablesDisabled,
104104
BridgeNfIP6tables: !sysInfo.BridgeNFCallIP6TablesDisabled,
105-
Debug: utils.IsDebugEnabled(),
105+
Debug: debug.IsEnabled(),
106106
NFd: fileutils.GetTotalUsedFds(),
107107
NGoroutines: runtime.NumGoroutine(),
108108
SystemTime: time.Now().Format(time.RFC3339Nano),

0 commit comments

Comments
 (0)