40a92a2aec
## Description The `io/ioutil` package has been deprecated in Go 1.16 (See https://golang.org/doc/go1.16#ioutil). Since cosmos-sdk has upgraded to Go 1.17 (#9987), this PR replaces the existing `io/ioutil` functions with their new definitions in `io` and `os` packages. --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [x] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [x] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [x] reviewed "Files changed" and left comments if necessary - [x] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
75 lines
1.6 KiB
Go
75 lines
1.6 KiB
Go
package testutil
|
|
|
|
import (
|
|
"bytes"
|
|
"io"
|
|
"os"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/spf13/cobra"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
// BufferReader is implemented by types that read from a string buffer.
|
|
type BufferReader interface {
|
|
io.Reader
|
|
Reset(string)
|
|
}
|
|
|
|
// BufferWriter is implemented by types that write to a buffer.
|
|
type BufferWriter interface {
|
|
io.Writer
|
|
Reset()
|
|
Bytes() []byte
|
|
String() string
|
|
}
|
|
|
|
// ApplyMockIO replaces stdin/out/err with buffers that can be used during testing.
|
|
// Returns an input BufferReader and an output BufferWriter.
|
|
func ApplyMockIO(c *cobra.Command) (BufferReader, BufferWriter) {
|
|
mockIn := strings.NewReader("")
|
|
mockOut := bytes.NewBufferString("")
|
|
|
|
c.SetIn(mockIn)
|
|
c.SetOut(mockOut)
|
|
c.SetErr(mockOut)
|
|
|
|
return mockIn, mockOut
|
|
}
|
|
|
|
// ApplyMockIODiscardOutputs replaces a cobra.Command output and error streams with a dummy io.Writer.
|
|
// Replaces and returns the io.Reader associated to the cobra.Command input stream.
|
|
func ApplyMockIODiscardOutErr(c *cobra.Command) BufferReader {
|
|
mockIn := strings.NewReader("")
|
|
|
|
c.SetIn(mockIn)
|
|
c.SetOut(io.Discard)
|
|
c.SetErr(io.Discard)
|
|
|
|
return mockIn
|
|
}
|
|
|
|
// Write the given string to a new temporary file.
|
|
// Returns an open file for the test to use.
|
|
func WriteToNewTempFile(t testing.TB, s string) *os.File {
|
|
t.Helper()
|
|
|
|
fp := TempFile(t)
|
|
_, err := fp.WriteString(s)
|
|
|
|
require.Nil(t, err)
|
|
|
|
return fp
|
|
}
|
|
|
|
// TempFile returns a writable temporary file for the test to use.
|
|
func TempFile(t testing.TB) *os.File {
|
|
t.Helper()
|
|
|
|
fp, err := os.CreateTemp(t.TempDir(), "")
|
|
require.NoError(t, err)
|
|
|
|
return fp
|
|
}
|