Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/notation/internal/flag/options.go
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ func withExecutableTrace(ctx context.Context) context.Context {
},
ExecuteDone: func(executableName, action string, err error) {
if err != nil {
logger.Errorf("finished executing credential helper program %s with action %s and got error %w", executableName, action, err)
logger.Errorf("finished executing credential helper program %s with action %s and got error %v", executableName, action, err)
} else {
logger.Debugf("successfully finished executing credential helper program %s with action %s", executableName, action)
}
Expand Down
26 changes: 26 additions & 0 deletions cmd/notation/internal/flag/options_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,18 @@
package flag

import (
"bytes"
"context"
"errors"
"reflect"
"strings"
"testing"

"github.com/sirupsen/logrus"
"oras.land/oras-go/v2/registry/remote/auth"
credentialstrace "oras.land/oras-go/v2/registry/remote/credentials/trace"

"github.com/notaryproject/notation-go/log"
)

func TestSecureFlagOpts_Credential(t *testing.T) {
Expand Down Expand Up @@ -72,3 +80,21 @@ func TestSecureFlagOpts_Credential(t *testing.T) {
})
}
}

func TestWithExecutableTrace_ExecuteDoneLogsError(t *testing.T) {
var out bytes.Buffer
logger := logrus.New()
logger.SetOutput(&out)
logger.SetLevel(logrus.DebugLevel)

ctx := withExecutableTrace(log.WithLogger(context.Background(), logger))
credentialstrace.ContextExecutableTrace(ctx).ExecuteDone("docker-credential-test", "get", errors.New("boom"))

got := out.String()
if !strings.Contains(got, "and got error boom") {
t.Errorf("the logged error is missing the error message, got %q", got)
}
if strings.Contains(got, "%!") {
t.Errorf("the logged error contains a formatting error, got %q", got)
}
}
2 changes: 1 addition & 1 deletion internal/trace/transport.go
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ func (t *Transport) RoundTrip(req *http.Request) (resp *http.Response, err error
// log the response
resp, err = t.RoundTripper.RoundTrip(req)
if err != nil {
e.Errorf("Error in getting response: %w", err)
e.Errorf("Error in getting response: %v", err)
} else if resp == nil {
e.Errorf("No response obtained for request %s %q", req.Method, req.URL)
} else {
Expand Down
35 changes: 35 additions & 0 deletions internal/trace/transport_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,16 @@ limitations under the License.
package trace

import (
"bytes"
"context"
"errors"
"net/http"
"strings"
"testing"

"github.com/sirupsen/logrus"

"github.com/notaryproject/notation-go/log"
)

type TransportMock struct {
Expand Down Expand Up @@ -87,3 +94,31 @@ func TestTransport_RoundTrip(t *testing.T) {
}
})
}

func TestTransport_RoundTrip_LogsResponseError(t *testing.T) {
var out bytes.Buffer
logger := logrus.New()
logger.SetOutput(&out)
logger.SetLevel(logrus.DebugLevel)

ctx := log.WithLogger(context.Background(), logger)
req, err := http.NewRequestWithContext(ctx, http.MethodGet, "https://example.com", nil)
if err != nil {
t.Fatal(err)
}
transport := NewTransport(&TransportMock{respErr: errors.New("boom")})
resp, err := transport.RoundTrip(req)
if resp != nil {
resp.Body.Close()
}
if err == nil {
t.Fatal("expected an error")
}

if got := out.String(); !strings.Contains(got, "Error in getting response: boom") {
t.Errorf("the logged error is missing the error message, got %q", got)
}
if got := out.String(); strings.Contains(got, "%!") {
t.Errorf("the logged error contains a formatting error, got %q", got)
}
}
Loading