Renaming and aliasing old types

silvin-lubecki · silvin-lubecki · commit 45fbbc08032b · 2019-01-25T16:06:40.000+01:00
* streams.InStream -&gt; streams.In
* streams.NewInStream -&gt; streams.NewIn
* streams.OutStream -&gt; streams.Out
* streams.NewOutStream -&gt; streams.NewOut

Signed-off-by: Silvin Lubecki &lt;silvin.lubecki@docker.com&gt;
diff --git a/cli/command/cli.go b/cli/command/cli.go
@@ -38,18 +38,18 @@ import (
 
 // Streams is an interface which exposes the standard input and output streams
 type Streams interface {
-	In() *streams.InStream
-	Out() *streams.OutStream
+	In() *streams.In
+	Out() *streams.Out
 	Err() io.Writer
 }
 
 // Cli represents the docker command line client.
 type Cli interface {
 	Client() client.APIClient
-	Out() *streams.OutStream
+	Out() *streams.Out
 	Err() io.Writer
-	In() *streams.InStream
-	SetIn(in *streams.InStream)
+	In() *streams.In
+	SetIn(in *streams.In)
 	Apply(ops ...DockerCliOption) error
 	ConfigFile() *configfile.ConfigFile
 	ServerInfo() ServerInfo
@@ -70,8 +70,8 @@ type Cli interface {
 // Instances of the client can be returned from NewDockerCli.
 type DockerCli struct {
 	configFile            *configfile.ConfigFile
-	in                    *streams.InStream
-	out                   *streams.OutStream
+	in                    *streams.In
+	out                   *streams.Out
 	err                   io.Writer
 	client                client.APIClient
 	serverInfo            ServerInfo
@@ -100,7 +100,7 @@ func (cli *DockerCli) Client() client.APIClient {
 }
 
 // Out returns the writer used for stdout
-func (cli *DockerCli) Out() *streams.OutStream {
+func (cli *DockerCli) Out() *streams.Out {
 	return cli.out
 }
 
@@ -110,12 +110,12 @@ func (cli *DockerCli) Err() io.Writer {
 }
 
 // SetIn sets the reader used for stdin
-func (cli *DockerCli) SetIn(in *streams.InStream) {
+func (cli *DockerCli) SetIn(in *streams.In) {
 	cli.in = in
 }
 
 // In returns the reader used for stdin
-func (cli *DockerCli) In() *streams.InStream {
+func (cli *DockerCli) In() *streams.In {
 	return cli.in
 }
 
diff --git a/cli/command/cli_options.go b/cli/command/cli_options.go
@@ -18,8 +18,8 @@ func WithStandardStreams() DockerCliOption {
 	return func(cli *DockerCli) error {
 		// Set terminal emulation based on platform as required.
 		stdin, stdout, stderr := term.StdStreams()
-		cli.in = streams.NewInStream(stdin)
-		cli.out = streams.NewOutStream(stdout)
+		cli.in = streams.NewIn(stdin)
+		cli.out = streams.NewOut(stdout)
 		cli.err = stderr
 		return nil
 	}
@@ -28,7 +28,7 @@ func WithStandardStreams() DockerCliOption {
 // WithCombinedStreams uses the same stream for the output and error streams.
 func WithCombinedStreams(combined io.Writer) DockerCliOption {
 	return func(cli *DockerCli) error {
-		cli.out = streams.NewOutStream(combined)
+		cli.out = streams.NewOut(combined)
 		cli.err = combined
 		return nil
 	}
@@ -37,15 +37,15 @@ func WithCombinedStreams(combined io.Writer) DockerCliOption {
 // WithInputStream sets a cli input stream.
 func WithInputStream(in io.ReadCloser) DockerCliOption {
 	return func(cli *DockerCli) error {
-		cli.in = streams.NewInStream(in)
+		cli.in = streams.NewIn(in)
 		return nil
 	}
 }
 
 // WithOutputStream sets a cli output stream.
 func WithOutputStream(out io.Writer) DockerCliOption {
 	return func(cli *DockerCli) error {
-		cli.out = streams.NewOutStream(out)
+		cli.out = streams.NewOut(out)
 		return nil
 	}
 }
diff --git a/cli/command/context/export-import_test.go b/cli/command/context/export-import_test.go
@@ -53,7 +53,7 @@ func TestExportImportPipe(t *testing.T) {
 		dest:        "-",
 	}))
 	assert.Equal(t, cli.ErrBuffer().String(), "")
-	cli.SetIn(streams.NewInStream(ioutil.NopCloser(bytes.NewBuffer(cli.OutBuffer().Bytes()))))
+	cli.SetIn(streams.NewIn(ioutil.NopCloser(bytes.NewBuffer(cli.OutBuffer().Bytes()))))
 	cli.OutBuffer().Reset()
 	cli.ErrBuffer().Reset()
 	assert.NilError(t, runImport(cli, "test2", "-"))
diff --git a/cli/command/image/build_test.go b/cli/command/image/build_test.go
@@ -39,7 +39,7 @@ func TestRunBuildDockerfileFromStdinWithCompress(t *testing.T) {
 		FROM alpine:3.6
 		COPY foo /
 	`)
-	cli.SetIn(streams.NewInStream(ioutil.NopCloser(dockerfile)))
+	cli.SetIn(streams.NewIn(ioutil.NopCloser(dockerfile)))
 
 	dir := fs.NewDir(t, t.Name(),
 		fs.WithFile("foo", "some content"))
diff --git a/cli/command/image/trust.go b/cli/command/image/trust.go
@@ -297,7 +297,7 @@ func imagePullPrivileged(ctx context.Context, cli command.Cli, imgRefAndAuth tru
 
 	out := cli.Out()
 	if opts.quiet {
-		out = streams.NewOutStream(ioutil.Discard)
+		out = streams.NewOut(ioutil.Discard)
 	}
 	return jsonmessage.DisplayJSONMessagesToStream(responseBody, out, nil)
 }
diff --git a/cli/command/registry.go b/cli/command/registry.go
@@ -102,7 +102,7 @@ func GetDefaultAuthConfig(cli Cli, checkCredStore bool, serverAddress string, is
 func ConfigureAuth(cli Cli, flUser, flPassword string, authconfig *types.AuthConfig, isDefaultRegistry bool) error {
 	// On Windows, force the use of the regular OS stdin stream. Fixes #14336/#14210
 	if runtime.GOOS == "windows" {
-		cli.SetIn(streams.NewInStream(os.Stdin))
+		cli.SetIn(streams.NewIn(os.Stdin))
 	}
 
 	// Some links documenting this:
diff --git a/cli/command/stack/kubernetes/deploy.go b/cli/command/stack/kubernetes/deploy.go
@@ -104,7 +104,7 @@ func metaStateFromStatus(status serviceStatus) metaServiceState {
 }
 
 type forwardOnlyStatusDisplay struct {
-	o      *streams.OutStream
+	o      *streams.Out
 	states map[string]metaServiceState
 }
 
@@ -117,7 +117,7 @@ func (d *forwardOnlyStatusDisplay) OnStatus(status serviceStatus) {
 }
 
 type interactiveStatusDisplay struct {
-	o        *streams.OutStream
+	o        *streams.Out
 	statuses []serviceStatus
 }
 
@@ -150,7 +150,7 @@ func displayInteractiveServiceStatus(status serviceStatus, o io.Writer) {
 		status.podsReady, status.podsPending, totalFailed, status.podsTotal)
 }
 
-func newStatusDisplay(o *streams.OutStream) statusDisplay {
+func newStatusDisplay(o *streams.Out) statusDisplay {
 	if !o.IsTerminal() {
 		return &forwardOnlyStatusDisplay{o: o, states: map[string]metaServiceState{}}
 	}
diff --git a/cli/command/streams.go b/cli/command/streams.go
@@ -0,0 +1,23 @@
+package command
+
+import (
+	"github.com/docker/cli/cli/streams"
+)
+
+// InStream is an input stream used by the DockerCli to read user input
+// Deprecated: Use github.com/docker/cli/cli/streams.In instead
+type InStream = streams.In
+
+// OutStream is an output stream used by the DockerCli to write normal program
+// output.
+// Deprecated: Use github.com/docker/cli/cli/streams.Out instead
+type OutStream = streams.Out
+
+var (
+	// NewInStream returns a new InStream object from a ReadCloser
+	// Deprecated: Use github.com/docker/cli/cli/streams.NewIn instead
+	NewInStream = streams.NewIn
+	// NewOutStream returns a new OutStream object from a Writer
+	// Deprecated: Use github.com/docker/cli/cli/streams.NewOut instead
+	NewOutStream = streams.NewOut
+)
diff --git a/cli/command/swarm/unlock.go b/cli/command/swarm/unlock.go
@@ -60,7 +60,7 @@ func runUnlock(dockerCli command.Cli) error {
 	return client.SwarmUnlock(ctx, req)
 }
 
-func readKey(in *streams.InStream, prompt string) (string, error) {
+func readKey(in *streams.In, prompt string) (string, error) {
 	if in.IsTerminal() {
 		fmt.Print(prompt)
 		dt, err := terminal.ReadPassword(int(in.FD()))
diff --git a/cli/command/swarm/unlock_test.go b/cli/command/swarm/unlock_test.go
@@ -92,7 +92,7 @@ func TestSwarmUnlock(t *testing.T) {
 			return nil
 		},
 	})
-	dockerCli.SetIn(streams.NewInStream(ioutil.NopCloser(strings.NewReader(input))))
+	dockerCli.SetIn(streams.NewIn(ioutil.NopCloser(strings.NewReader(input))))
 	cmd := newUnlockCommand(dockerCli)
 	assert.NilError(t, cmd.Execute())
 }
diff --git a/cli/command/utils.go b/cli/command/utils.go
@@ -81,7 +81,7 @@ func PromptForConfirmation(ins io.Reader, outs io.Writer, message string) bool {
 
 	// On Windows, force the use of the regular OS stdin stream.
 	if runtime.GOOS == "windows" {
-		ins = streams.NewInStream(os.Stdin)
+		ins = streams.NewIn(os.Stdin)
 	}
 
 	reader := bufio.NewReader(ins)
diff --git a/cli/command/volume/prune_test.go b/cli/command/volume/prune_test.go
@@ -86,7 +86,7 @@ func TestVolumePrunePromptYes(t *testing.T) {
 			volumePruneFunc: simplePruneFunc,
 		})
 
-		cli.SetIn(streams.NewInStream(ioutil.NopCloser(strings.NewReader(input))))
+		cli.SetIn(streams.NewIn(ioutil.NopCloser(strings.NewReader(input))))
 		cmd := NewPruneCommand(cli)
 		assert.NilError(t, cmd.Execute())
 		golden.Assert(t, cli.OutBuffer().String(), "volume-prune-yes.golden")
@@ -102,7 +102,7 @@ func TestVolumePrunePromptNo(t *testing.T) {
 			volumePruneFunc: simplePruneFunc,
 		})
 
-		cli.SetIn(streams.NewInStream(ioutil.NopCloser(strings.NewReader(input))))
+		cli.SetIn(streams.NewIn(ioutil.NopCloser(strings.NewReader(input))))
 		cmd := NewPruneCommand(cli)
 		assert.NilError(t, cmd.Execute())
 		golden.Assert(t, cli.OutBuffer().String(), "volume-prune-no.golden")
diff --git a/cli/streams/in.go b/cli/streams/in.go
@@ -9,33 +9,33 @@ import (
 	"github.com/docker/docker/pkg/term"
 )
 
-// InStream is an input stream used by the DockerCli to read user input
-type InStream struct {
-	CommonStream
+// In is an input stream used by the DockerCli to read user input
+type In struct {
+	commonStream
 	in io.ReadCloser
 }
 
-func (i *InStream) Read(p []byte) (int, error) {
+func (i *In) Read(p []byte) (int, error) {
 	return i.in.Read(p)
 }
 
 // Close implements the Closer interface
-func (i *InStream) Close() error {
+func (i *In) Close() error {
 	return i.in.Close()
 }
 
 // SetRawTerminal sets raw mode on the input terminal
-func (i *InStream) SetRawTerminal() (err error) {
-	if os.Getenv("NORAW") != "" || !i.CommonStream.isTerminal {
+func (i *In) SetRawTerminal() (err error) {
+	if os.Getenv("NORAW") != "" || !i.commonStream.isTerminal {
 		return nil
 	}
-	i.CommonStream.state, err = term.SetRawTerminal(i.CommonStream.fd)
+	i.commonStream.state, err = term.SetRawTerminal(i.commonStream.fd)
 	return err
 }
 
 // CheckTty checks if we are trying to attach to a container tty
 // from a non-tty client input stream, and if so, returns an error.
-func (i *InStream) CheckTty(attachStdin, ttyMode bool) error {
+func (i *In) CheckTty(attachStdin, ttyMode bool) error {
 	// In order to attach to a container tty, input stream for the client must
 	// be a tty itself: redirecting or piping the client standard input is
 	// incompatible with `docker run -t`, `docker exec -t` or `docker attach`.
@@ -49,8 +49,8 @@ func (i *InStream) CheckTty(attachStdin, ttyMode bool) error {
 	return nil
 }
 
-// NewInStream returns a new InStream object from a ReadCloser
-func NewInStream(in io.ReadCloser) *InStream {
+// NewIn returns a new In object from a ReadCloser
+func NewIn(in io.ReadCloser) *In {
 	fd, isTerminal := term.GetFdInfo(in)
-	return &InStream{CommonStream: CommonStream{fd: fd, isTerminal: isTerminal}, in: in}
+	return &In{commonStream: commonStream{fd: fd, isTerminal: isTerminal}, in: in}
 }
diff --git a/cli/streams/out.go b/cli/streams/out.go
@@ -8,28 +8,28 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
-// OutStream is an output stream used by the DockerCli to write normal program
+// Out is an output stream used by the DockerCli to write normal program
 // output.
-type OutStream struct {
-	CommonStream
+type Out struct {
+	commonStream
 	out io.Writer
 }
 
-func (o *OutStream) Write(p []byte) (int, error) {
+func (o *Out) Write(p []byte) (int, error) {
 	return o.out.Write(p)
 }
 
 // SetRawTerminal sets raw mode on the input terminal
-func (o *OutStream) SetRawTerminal() (err error) {
-	if os.Getenv("NORAW") != "" || !o.CommonStream.isTerminal {
+func (o *Out) SetRawTerminal() (err error) {
+	if os.Getenv("NORAW") != "" || !o.commonStream.isTerminal {
 		return nil
 	}
-	o.CommonStream.state, err = term.SetRawTerminalOutput(o.CommonStream.fd)
+	o.commonStream.state, err = term.SetRawTerminalOutput(o.commonStream.fd)
 	return err
 }
 
 // GetTtySize returns the height and width in characters of the tty
-func (o *OutStream) GetTtySize() (uint, uint) {
+func (o *Out) GetTtySize() (uint, uint) {
 	if !o.isTerminal {
 		return 0, 0
 	}
@@ -43,8 +43,8 @@ func (o *OutStream) GetTtySize() (uint, uint) {
 	return uint(ws.Height), uint(ws.Width)
 }
 
-// NewOutStream returns a new OutStream object from a Writer
-func NewOutStream(out io.Writer) *OutStream {
+// NewOut returns a new Out object from a Writer
+func NewOut(out io.Writer) *Out {
 	fd, isTerminal := term.GetFdInfo(out)
-	return &OutStream{CommonStream: CommonStream{fd: fd, isTerminal: isTerminal}, out: out}
+	return &Out{commonStream: commonStream{fd: fd, isTerminal: isTerminal}, out: out}
 }
diff --git a/cli/streams/stream.go b/cli/streams/stream.go
@@ -4,31 +4,31 @@ import (
 	"github.com/docker/docker/pkg/term"
 )
 
-// CommonStream is an input stream used by the DockerCli to read user input
-type CommonStream struct {
+// commonStream is an input stream used by the DockerCli to read user input
+type commonStream struct {
 	fd         uintptr
 	isTerminal bool
 	state      *term.State
 }
 
 // FD returns the file descriptor number for this stream
-func (s *CommonStream) FD() uintptr {
+func (s *commonStream) FD() uintptr {
 	return s.fd
 }
 
 // IsTerminal returns true if this stream is connected to a terminal
-func (s *CommonStream) IsTerminal() bool {
+func (s *commonStream) IsTerminal() bool {
 	return s.isTerminal
 }
 
 // RestoreTerminal restores normal mode to the terminal
-func (s *CommonStream) RestoreTerminal() {
+func (s *commonStream) RestoreTerminal() {
 	if s.state != nil {
 		term.RestoreTerminal(s.fd, s.state)
 	}
 }
 
 // SetIsTerminal sets the boolean used for isTerminal
-func (s *CommonStream) SetIsTerminal(isTerminal bool) {
+func (s *commonStream) SetIsTerminal(isTerminal bool) {
 	s.isTerminal = isTerminal
 }
diff --git a/internal/containerizedengine/containerd_test.go b/internal/containerizedengine/containerd_test.go
@@ -24,7 +24,7 @@ func TestPullWithAuthPullFail(t *testing.T) {
 	}
 	imageName := "testnamegoeshere"
 
-	_, err := client.pullWithAuth(ctx, imageName, streams.NewOutStream(&bytes.Buffer{}), &types.AuthConfig{})
+	_, err := client.pullWithAuth(ctx, imageName, streams.NewOut(&bytes.Buffer{}), &types.AuthConfig{})
 	assert.ErrorContains(t, err, "pull failure")
 }
 
@@ -40,6 +40,6 @@ func TestPullWithAuthPullPass(t *testing.T) {
 	}
 	imageName := "testnamegoeshere"
 
-	_, err := client.pullWithAuth(ctx, imageName, streams.NewOutStream(&bytes.Buffer{}), &types.AuthConfig{})
+	_, err := client.pullWithAuth(ctx, imageName, streams.NewOut(&bytes.Buffer{}), &types.AuthConfig{})
 	assert.NilError(t, err)
 }
diff --git a/internal/containerizedengine/update_test.go b/internal/containerizedengine/update_test.go
diff --git a/internal/test/cli.go b/internal/test/cli.go

Original file line number	Diff line number	Diff line change
`@@ -297,7 +297,7 @@ func imagePullPrivileged(ctx context.Context, cli command.Cli, imgRefAndAuth tru`
`297`	`297`
`298`	`298`	`out := cli.Out()`
`299`	`299`	`if opts.quiet {`
`300`		`- out = streams.NewOutStream(ioutil.Discard)`
	`300`	`+ out = streams.NewOut(ioutil.Discard)`
`301`	`301`	`}`
`302`	`302`	`return jsonmessage.DisplayJSONMessagesToStream(responseBody, out, nil)`
`303`	`303`	`}`
Original file line number	Diff line number	Diff line change
`@@ -102,7 +102,7 @@ func GetDefaultAuthConfig(cli Cli, checkCredStore bool, serverAddress string, is`
`102`	`102`	`func ConfigureAuth(cli Cli, flUser, flPassword string, authconfig *types.AuthConfig, isDefaultRegistry bool) error {`
`103`	`103`	`// On Windows, force the use of the regular OS stdin stream. Fixes #14336/#14210`
`104`	`104`	`if runtime.GOOS == "windows" {`
`105`		`- cli.SetIn(streams.NewInStream(os.Stdin))`
	`105`	`+ cli.SetIn(streams.NewIn(os.Stdin))`
`106`	`106`	`}`
`107`	`107`
`108`	`108`	`// Some links documenting this:`
Original file line number	Diff line number	Diff line change
`@@ -104,7 +104,7 @@ func metaStateFromStatus(status serviceStatus) metaServiceState {`
`104`	`104`	`}`
`105`	`105`
`106`	`106`	`type forwardOnlyStatusDisplay struct {`
`107`		`- o *streams.OutStream`
	`107`	`+ o *streams.Out`
`108`	`108`	`states map[string]metaServiceState`
`109`	`109`	`}`
`110`	`110`
`@@ -117,7 +117,7 @@ func (d *forwardOnlyStatusDisplay) OnStatus(status serviceStatus) {`
`117`	`117`	`}`
`118`	`118`
`119`	`119`	`type interactiveStatusDisplay struct {`
`120`		`- o *streams.OutStream`
	`120`	`+ o *streams.Out`
`121`	`121`	`statuses []serviceStatus`
`122`	`122`	`}`
`123`	`123`
`@@ -150,7 +150,7 @@ func displayInteractiveServiceStatus(status serviceStatus, o io.Writer) {`
`150`	`150`	`status.podsReady, status.podsPending, totalFailed, status.podsTotal)`
`151`	`151`	`}`
`152`	`152`
`153`		`-func newStatusDisplay(o *streams.OutStream) statusDisplay {`
	`153`	`+func newStatusDisplay(o *streams.Out) statusDisplay {`
`154`	`154`	`if !o.IsTerminal() {`
`155`	`155`	`return &forwardOnlyStatusDisplay{o: o, states: map[string]metaServiceState{}}`
`156`	`156`	`}`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ func runUnlock(dockerCli command.Cli) error {`
`60`	`60`	`return client.SwarmUnlock(ctx, req)`
`61`	`61`	`}`
`62`	`62`
`63`		`-func readKey(in *streams.InStream, prompt string) (string, error) {`
	`63`	`+func readKey(in *streams.In, prompt string) (string, error) {`
`64`	`64`	`if in.IsTerminal() {`
`65`	`65`	`fmt.Print(prompt)`
`66`	`66`	`dt, err := terminal.ReadPassword(int(in.FD()))`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ func TestSwarmUnlock(t *testing.T) {`
`92`	`92`	`return nil`
`93`	`93`	`},`
`94`	`94`	`})`
`95`		`- dockerCli.SetIn(streams.NewInStream(ioutil.NopCloser(strings.NewReader(input))))`
	`95`	`+ dockerCli.SetIn(streams.NewIn(ioutil.NopCloser(strings.NewReader(input))))`
`96`	`96`	`cmd := newUnlockCommand(dockerCli)`
`97`	`97`	`assert.NilError(t, cmd.Execute())`
`98`	`98`	`}`