output_test.go

/*
 * Copyright (c) 2021-present Fabien Potencier <fabien@symfony.com>
 *
 * This file is part of Symfony CLI project
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

package terminal

import (
	"bytes"

	"github.com/pkg/errors"
	. "gopkg.in/check.v1"
)

type ConsoleOutputSuite struct{}

var _ = Suite(&ConsoleOutputSuite{})

type fakeWriteCloser struct {
	*bytes.Buffer

	hasBeenClosed bool
}

func (wc *fakeWriteCloser) Close() error {
	wc.hasBeenClosed = true

	return errors.New("called")
}

func (ts *ConsoleOutputSuite) TestConsoleOutput(c *C) {
	buffer := new(bytes.Buffer)
	output := NewBufferedConsoleOutput(buffer, buffer)

	output.Write([]byte("test"))
	c.Assert(buffer.String(), Equals, "test")

	formatter := NewFormatter()
	c.Assert(output.GetFormatter(), Not(Equals), formatter)

	output.SetFormatter(formatter)
	c.Assert(output.GetFormatter(), Equals, formatter)
}

func (ts *ConsoleOutputSuite) TestClose(c *C) {
	buffer := new(bytes.Buffer)
	wc := new(fakeWriteCloser)
	output := NewBufferedConsoleOutput(wc, buffer)

	err := output.Stderr.Close()
	c.Assert(err, IsNil)

	c.Assert(wc.hasBeenClosed, Equals, false)
	err = output.Stdout.Close()
	c.Assert(wc.hasBeenClosed, Equals, true)
	c.Assert(err, ErrorMatches, "called")
}

func (ts *ConsoleOutputSuite) TestWrappers(c *C) {
	previousStdout, previousStderr := Stdout, Stderr
	defer func() {
		Stdout, Stderr = previousStdout, previousStderr
	}()

	bufferStdout := new(bytes.Buffer)
	bufferStderr := new(bytes.Buffer)
	Stdout = NewBufferedConsoleOutput(bufferStdout, bufferStderr)
	Stderr = Stdout.Stderr

	bufferStdout.Reset()
	Print("test")
	c.Check(bufferStdout.String(), Equals, "test")

	bufferStdout.Reset()
	Println("test")
	c.Check(bufferStdout.String(), Equals, "test\n")

	bufferStdout.Reset()
	Printf("test %d", 2)
	c.Check(bufferStdout.String(), Equals, "test 2")

	bufferStdout.Reset()
	Printfln("test %d", 3)
	c.Check(bufferStdout.String(), Equals, "test 3\n")

	bufferStderr.Reset()
	Eprint("test")
	c.Check(bufferStderr.String(), Equals, "test")

	bufferStderr.Reset()
	Eprintln("test")
	c.Check(bufferStderr.String(), Equals, "test\n")

	bufferStderr.Reset()
	Eprintf("test %d", 2)
	c.Check(bufferStderr.String(), Equals, "test 2")

	bufferStderr.Reset()
	Eprintfln("test %d", 3)
	c.Check(bufferStderr.String(), Equals, "test 3\n")
}