refactor: Do not return print errors

Signed-off-by: Terry Howe <[email protected]>

cmd/oras/internal/display/status/deprecated.go

@@ -58,7 +58,9 @@ var printer = NewPrinter(os.Stdout)
 
 // Print objects to display concurrent-safely.
 func Print(a ...any) error {
-	return printer.Println(a...)
+	printer.Println(a...)
+	// Printer handles the error
+	return nil
 }
 
 // StatusPrinter returns a tracking function for transfer status.

cmd/oras/internal/display/status/print.go

@@ -20,6 +20,7 @@ import (
 	"fmt"
 	"io"
 	"oras.land/oras/internal/descriptor"
+	"os"
 	"sync"
 
 	ocispec "github.com/opencontainers/image-spec/specs-go/v1"
@@ -41,11 +42,14 @@ func NewPrinter(out io.Writer) *Printer {
 }
 
 // Println prints objects concurrent-safely with newline.
-func (p *Printer) Println(a ...any) error {
+func (p *Printer) Println(a ...any) {
 	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)
+	}
 }
 
 // PrintStatus prints transfer status.
@@ -58,7 +62,8 @@ func (p *Printer) PrintStatus(desc ocispec.Descriptor, status string, verbose bo
 		}
 		name = desc.MediaType
 	}
-	return p.Println(status, descriptor.ShortDigest(desc), name)
+	p.Println(status, descriptor.ShortDigest(desc), name)
+	return nil
 }
 
 // StatusPrinter returns a tracking function for transfer status.

cmd/oras/internal/display/status/print_test.go

@@ -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) + ">")
+	}
+}

cmd/oras/internal/display/status/text.go

@@ -44,12 +44,14 @@ func (ph *TextPushHandler) OnFileLoading(name string) error {
 	if !ph.verbose {
 		return nil
 	}
-	return ph.printer.Println("Preparing", name)
+	ph.printer.Println("Preparing", name)
+	return nil
 }
 
 // OnEmptyArtifact is called when an empty artifact is being uploaded.
 func (ph *TextPushHandler) OnEmptyArtifact() error {
-	return ph.printer.Println("Uploading empty artifact")
+	ph.printer.Println("Uploading empty artifact")
+	return nil
 }
 
 // TrackTarget returns a tracked target.