Skip to content

Commit

Permalink
refactor: No error return for print (oras-project#1375)
Browse files Browse the repository at this point in the history
Signed-off-by: Terry Howe <[email protected]>
  • Loading branch information
Terry Howe authored and FeynmanZhou committed May 11, 2024
1 parent efd13fe commit 4c6933b
Show file tree
Hide file tree
Showing 2 changed files with 72 additions and 1 deletion.
8 changes: 7 additions & 1 deletion cmd/oras/internal/display/status/print.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (
"fmt"
"io"
"oras.land/oras/internal/descriptor"
"os"
"sync"

ocispec "github.com/opencontainers/image-spec/specs-go/v1"
Expand All @@ -45,7 +46,12 @@ func (p *Printer) Println(a ...any) error {
p.lock.Lock()
defer p.lock.Unlock()
_, err := fmt.Fprintln(p.out, a...)
return err
if err != nil {
err = fmt.Errorf("display output error: %w", err)
_, _ = fmt.Fprint(os.Stderr, err)
}
// Errors are handled above, so return nil
return nil
}

// PrintStatus prints transfer status.
Expand Down
65 changes: 65 additions & 0 deletions cmd/oras/internal/display/status/print_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
/*
Copyright The ORAS Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package status

import (
"fmt"
"strconv"
"strings"
"testing"
)

type mockWriter struct {
errorCount int
written string
}

func (mw *mockWriter) Write(p []byte) (n int, err error) {
mw.written += string(p)
if strings.TrimSpace(string(p)) != "boom" {
return len(string(p)), nil
}
mw.errorCount++
return 0, fmt.Errorf("Boom: " + string(p))
}

func (mw *mockWriter) String() string {
return mw.written
}

func TestPrint_Error(t *testing.T) {
mockWriter := &mockWriter{}
printer := NewPrinter(mockWriter)
printer.Println("boom")
if mockWriter.errorCount != 1 {
t.Error("Expected one errors actual <" + strconv.Itoa(mockWriter.errorCount) + ">")
}
}

func TestPrint_NoError(t *testing.T) {
mockWriter := &mockWriter{}
printer := NewPrinter(mockWriter)

expected := "blah blah"
printer.Println(expected)
actual := strings.TrimSpace(mockWriter.String())
if expected != actual {
t.Error("Expected <" + expected + "> not equal to actual <" + actual + ">")
}
if mockWriter.errorCount != 0 {
t.Error("Expected no errors actual <" + strconv.Itoa(mockWriter.errorCount) + ">")
}
}

0 comments on commit 4c6933b

Please sign in to comment.