From be6b042039b3024426f800f36e1355252fe78d46 Mon Sep 17 00:00:00 2001 From: Meredith Lancaster Date: Tue, 12 Mar 2024 14:48:00 -0600 Subject: [PATCH] use the iostreams.Test helper func Signed-off-by: Meredith Lancaster --- pkg/cmd/attestation/api/client_test.go | 6 +++--- pkg/cmd/attestation/download/download_test.go | 6 +----- pkg/cmd/attestation/inspect/inspect_test.go | 7 +------ pkg/cmd/attestation/logging/logger.go | 5 +++-- pkg/cmd/attestation/test/output.go | 16 ---------------- pkg/cmd/attestation/verify/verify_test.go | 7 ++----- 6 files changed, 10 insertions(+), 37 deletions(-) delete mode 100644 pkg/cmd/attestation/test/output.go diff --git a/pkg/cmd/attestation/api/client_test.go b/pkg/cmd/attestation/api/client_test.go index 8f09f8967..bf7791b81 100644 --- a/pkg/cmd/attestation/api/client_test.go +++ b/pkg/cmd/attestation/api/client_test.go @@ -18,7 +18,7 @@ func NewClientWithMockGHClient(hasNextPage bool) Client { fetcher := mockDataGenerator{ NumAttestations: 5, } - l := logging.NewSystemLogger() + l := logging.NewTestLogger() if hasNextPage { return &LiveClient{ @@ -138,7 +138,7 @@ func TestGetByDigest_NoAttestationsFound(t *testing.T) { api: mockAPIClient{ OnRESTWithNext: fetcher.OnRESTWithNextNoAttestations, }, - logger: logging.NewSystemLogger(), + logger: logging.NewTestLogger(), } attestations, err := c.GetByRepoAndDigest(testRepo, testDigest, DefaultLimit) @@ -161,7 +161,7 @@ func TestGetByDigest_Error(t *testing.T) { api: mockAPIClient{ OnRESTWithNext: fetcher.OnRESTWithNextError, }, - logger: logging.NewSystemLogger(), + logger: logging.NewTestLogger(), } attestations, err := c.GetByRepoAndDigest(testRepo, testDigest, DefaultLimit) diff --git a/pkg/cmd/attestation/download/download_test.go b/pkg/cmd/attestation/download/download_test.go index 2cca10973..1b1adbcb6 100644 --- a/pkg/cmd/attestation/download/download_test.go +++ b/pkg/cmd/attestation/download/download_test.go @@ -10,15 +10,11 @@ import ( "github.com/cli/cli/v2/pkg/cmd/attestation/artifact" "github.com/cli/cli/v2/pkg/cmd/attestation/artifact/oci" "github.com/cli/cli/v2/pkg/cmd/attestation/logging" - "github.com/cli/cli/v2/pkg/cmd/attestation/test" "github.com/stretchr/testify/require" ) func TestRunDownload(t *testing.T) { - res := test.SuppressAndRestoreOutput() - defer res() - tempDir, err := os.MkdirTemp("", "gh-attestation-test") require.NoError(t, err) defer os.RemoveAll(tempDir) @@ -30,7 +26,7 @@ func TestRunDownload(t *testing.T) { DigestAlgorithm: "sha512", OutputPath: tempDir, Limit: 30, - Logger: logging.NewSystemLogger(), + Logger: logging.NewTestLogger(), } t.Run("fetch and store attestations successfully", func(t *testing.T) { diff --git a/pkg/cmd/attestation/inspect/inspect_test.go b/pkg/cmd/attestation/inspect/inspect_test.go index e5bd8a782..34249452e 100644 --- a/pkg/cmd/attestation/inspect/inspect_test.go +++ b/pkg/cmd/attestation/inspect/inspect_test.go @@ -21,16 +21,11 @@ var ( ) func TestRunInspect(t *testing.T) { - res := test.SuppressAndRestoreOutput() - defer res() - - logger := logging.NewSystemLogger() - opts := Options{ ArtifactPath: artifactPath, BundlePath: bundlePath, DigestAlgorithm: "sha512", - Logger: logger, + Logger: logging.NewTestLogger(), OCIClient: oci.NewMockClient(), } diff --git a/pkg/cmd/attestation/logging/logger.go b/pkg/cmd/attestation/logging/logger.go index 3afd41a4f..aaae86215 100644 --- a/pkg/cmd/attestation/logging/logger.go +++ b/pkg/cmd/attestation/logging/logger.go @@ -32,8 +32,9 @@ func NewDefaultLogger(io *iostreams.IOStreams) *Logger { return NewLogger(io, isQuiet, isVerbose) } -func NewSystemLogger() *Logger { - return NewDefaultLogger(iostreams.System()) +func NewTestLogger() *Logger { + testIO, _, _, _ := iostreams.Test() + return NewDefaultLogger(testIO) } // Printf writes the formatted arguments to the stderr writer. diff --git a/pkg/cmd/attestation/test/output.go b/pkg/cmd/attestation/test/output.go deleted file mode 100644 index fff3decd3..000000000 --- a/pkg/cmd/attestation/test/output.go +++ /dev/null @@ -1,16 +0,0 @@ -package test - -import "os" - -func SuppressAndRestoreOutput() func() { - null, _ := os.Open(os.DevNull) - stdOut := os.Stdout - stdErr := os.Stderr - os.Stdout = null - os.Stderr = null - return func() { - defer null.Close() - os.Stdout = stdOut - os.Stderr = stdErr - } -} diff --git a/pkg/cmd/attestation/verify/verify_test.go b/pkg/cmd/attestation/verify/verify_test.go index 7ca867891..4f1c5a5f9 100644 --- a/pkg/cmd/attestation/verify/verify_test.go +++ b/pkg/cmd/attestation/verify/verify_test.go @@ -21,10 +21,7 @@ const ( ) func TestRunVerify(t *testing.T) { - res := test.SuppressAndRestoreOutput() - defer res() - - logger := logging.NewSystemLogger() + logger := logging.NewTestLogger() publicGoodOpts := Options{ ArtifactPath: test.NormalizeRelativePath("../test/data/sigstore-js-2.1.0.tgz"), @@ -190,7 +187,7 @@ func TestVerifySLSAPredicateType_InvalidPredicate(t *testing.T) { }, } - err := verifySLSAPredicateType(logging.NewSystemLogger(), apr) + err := verifySLSAPredicateType(logging.NewTestLogger(), apr) require.Error(t, err) require.ErrorIs(t, err, ErrNoMatchingSLSAPredicate) }