progressui: modify NewDisplay to accept io.Writer instead of console.File

The original intention of accepting `console.File` was that the current
uses of this function in the codebase were always files and it seemed
helpful to restrict the API to `console.File` to aid developers into
passing the correct output.

There are circumstances outside of the codebase where the `io.Writer`
versions are used so `NewDisplay` has now been adapted to take an
`io.Writer` to allow for those cases more easily.

Signed-off-by: Jonathan A. Sternberg <[email protected]>

Author: jsternberg

util/progress/progressui/display.go

@@ -137,14 +137,16 @@ const (
 	RawJSONMode DisplayMode = "rawjson"
 )
 
-// NewDisplay constructs a Display that outputs to the given console.File with the given DisplayMode.
+// NewDisplay constructs a Display that outputs to the given io.Writer with the given DisplayMode.
 //
-// This method will return an error when the DisplayMode is invalid or if TtyMode is used but the console.File
+// This method will return an error when the DisplayMode is invalid or if TtyMode is used but the io.Writer
 // does not refer to a tty. AutoMode will choose TtyMode or PlainMode depending on if the output is a tty or not.
-func NewDisplay(out console.File, mode DisplayMode, opts ...DisplayOpt) (Display, error) {
+//
+// For TtyMode to work, the io.Writer should also implement console.File.
+func NewDisplay(out io.Writer, mode DisplayMode, opts ...DisplayOpt) (Display, error) {
 	switch mode {
 	case AutoMode, TtyMode, DefaultMode:
-		if c, err := console.ConsoleFromFile(out); err == nil {
+		if c, err := consoleFromWriter(out); err == nil {
 			return newConsoleDisplay(c, opts...), nil
 		} else if mode == "tty" {
 			return Display{}, errors.Wrap(err, "failed to get console")
@@ -161,6 +163,15 @@ func NewDisplay(out console.File, mode DisplayMode, opts ...DisplayOpt) (Display
 	}
 }
 
+// consoleFromWriter retrieves a console.Console from an io.Writer.
+func consoleFromWriter(out io.Writer) (console.Console, error) {
+	f, ok := out.(console.File)
+	if !ok {
+		return nil, errors.New("output is not a file")
+	}
+	return console.ConsoleFromFile(f)
+}
+
 type discardDisplay struct{}
 
 func newDiscardDisplay() Display {