Deprecate transport.New (#1337)

google · Jul 19, 2022 · f79ec21 · f79ec21
1 parent 53e6bea
commit f79ec21
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 22 deletions.
diff --git a/pkg/v1/remote/check.go b/pkg/v1/remote/check.go
@@ -24,7 +24,7 @@ func CheckPushPermission(ref name.Reference, kc authn.Keychain, t http.RoundTrip
 	}
 
 	scopes := []string{ref.Scope(transport.PushScope)}
-	tr, err := transport.New(ref.Context().Registry, auth, t, scopes)
+	tr, err := transport.NewWithContext(context.TODO(), ref.Context().Registry, auth, t, scopes)
 	if err != nil {
 		return fmt.Errorf("creating push check transport for %v failed: %w", ref.Context().Registry, err)
 	}

diff --git a/pkg/v1/remote/transport/transport.go b/pkg/v1/remote/transport/transport.go
@@ -27,7 +27,7 @@ import (
 // setup to authenticate with the remote registry "reg", in the capacity
 // laid out by the specified scopes.
 //
-// TODO(jonjohnsonjr): Deprecate this.
+// Deprecated: Use NewWithContext.
 func New(reg name.Registry, auth authn.Authenticator, t http.RoundTripper, scopes []string) (http.RoundTripper, error) {
 	return NewWithContext(context.Background(), reg, auth, t, scopes)
 }

diff --git a/pkg/v1/remote/transport/transport_test.go b/pkg/v1/remote/transport/transport_test.go
@@ -65,9 +65,9 @@ func TestTransportSelectionAnonymous(t *testing.T) {
 	basic := &authn.Basic{Username: "foo", Password: "bar"}
 	reg := testReference.Context().Registry
 
-	tp, err := New(reg, basic, recorder, []string{testReference.Scope(PullScope)})
+	tp, err := NewWithContext(context.Background(), reg, basic, recorder, []string{testReference.Scope(PullScope)})
 	if err != nil {
-		t.Errorf("New() = %v", err)
+		t.Errorf("NewWithContext() = %v", err)
 	}
 
 	req, err := http.NewRequest("GET", fmt.Sprintf("http://%s/v2/anything", reg), nil)
@@ -102,14 +102,14 @@ func TestTransportSelectionBasic(t *testing.T) {
 
 	basic := &authn.Basic{Username: "foo", Password: "bar"}
 
-	tp, err := New(testReference.Context().Registry, basic, tprt, []string{testReference.Scope(PullScope)})
+	tp, err := NewWithContext(context.Background(), testReference.Context().Registry, basic, tprt, []string{testReference.Scope(PullScope)})
 	if err != nil {
-		t.Errorf("New() = %v", err)
+		t.Errorf("NewWithContext() = %v", err)
 	}
 	if tpw, ok := tp.(*Wrapper); !ok {
-		t.Errorf("New(); got %T, want *Wrapper", tp)
+		t.Errorf("NewWithContext(); got %T, want *Wrapper", tp)
 	} else if _, ok := tpw.inner.(*basicTransport); !ok {
-		t.Errorf("New(); got %T, want *basicTransport", tp)
+		t.Errorf("NewWithContext(); got %T, want *basicTransport", tp)
 	}
 }
 
@@ -132,8 +132,8 @@ func TestTransportBadAuth(t *testing.T) {
 		},
 	}
 
-	if _, err := New(testReference.Context().Registry, &badAuth{}, tprt, []string{testReference.Scope(PullScope)}); err == nil {
-		t.Errorf("New() expected err, got nil")
+	if _, err := NewWithContext(context.Background(), testReference.Context().Registry, &badAuth{}, tprt, []string{testReference.Scope(PullScope)}); err == nil {
+		t.Errorf("NewWithContext() expected err, got nil")
 	}
 }
 
@@ -173,14 +173,14 @@ func TestTransportSelectionBearer(t *testing.T) {
 	}
 
 	basic := &authn.Basic{Username: "foo", Password: "bar"}
-	tp, err := New(testReference.Context().Registry, basic, tprt, []string{testReference.Scope(PullScope)})
+	tp, err := NewWithContext(context.Background(), testReference.Context().Registry, basic, tprt, []string{testReference.Scope(PullScope)})
 	if err != nil {
-		t.Errorf("New() = %v", err)
+		t.Errorf("NewWithContext() = %v", err)
 	}
 	if tpw, ok := tp.(*Wrapper); !ok {
-		t.Errorf("New(); got %T, want *Wrapper", tp)
+		t.Errorf("NewWithContext(); got %T, want *Wrapper", tp)
 	} else if _, ok := tpw.inner.(*bearerTransport); !ok {
-		t.Errorf("New(); got %T, want *bearerTransport", tp)
+		t.Errorf("NewWithContext(); got %T, want *bearerTransport", tp)
 	}
 }
 
@@ -198,9 +198,9 @@ func TestTransportSelectionBearerMissingRealm(t *testing.T) {
 	}
 
 	basic := &authn.Basic{Username: "foo", Password: "bar"}
-	tp, err := New(testReference.Context().Registry, basic, tprt, []string{testReference.Scope(PullScope)})
+	tp, err := NewWithContext(context.Background(), testReference.Context().Registry, basic, tprt, []string{testReference.Scope(PullScope)})
 	if err == nil || !strings.Contains(err.Error(), "missing realm") {
-		t.Errorf("New() = %v, %v", tp, err)
+		t.Errorf("NewWithContext() = %v, %v", tp, err)
 	}
 }
 
@@ -225,9 +225,9 @@ func TestTransportSelectionBearerAuthError(t *testing.T) {
 	}
 
 	basic := &authn.Basic{Username: "foo", Password: "bar"}
-	tp, err := New(testReference.Context().Registry, basic, tprt, []string{testReference.Scope(PullScope)})
+	tp, err := NewWithContext(context.Background(), testReference.Context().Registry, basic, tprt, []string{testReference.Scope(PullScope)})
 	if err == nil {
-		t.Errorf("New() = %v", tp)
+		t.Errorf("NewWithContext() = %v", tp)
 	}
 }
 
@@ -245,9 +245,9 @@ func TestTransportSelectionUnrecognizedChallenge(t *testing.T) {
 	}
 
 	basic := &authn.Basic{Username: "foo", Password: "bar"}
-	tp, err := New(testReference.Context().Registry, basic, tprt, []string{testReference.Scope(PullScope)})
+	tp, err := NewWithContext(context.Background(), testReference.Context().Registry, basic, tprt, []string{testReference.Scope(PullScope)})
 	if err == nil || !strings.Contains(err.Error(), "challenge") {
-		t.Errorf("New() = %v, %v", tp, err)
+		t.Errorf("NewWithContext() = %v, %v", tp, err)
 	}
 }
 
@@ -272,9 +272,9 @@ func TestTransportAlwaysTriesHttps(t *testing.T) {
 	}
 
 	basic := &authn.Basic{Username: "foo", Password: "bar"}
-	tp, err := New(registry, basic, server.Client().Transport, []string{testReference.Scope(PullScope)})
+	tp, err := NewWithContext(context.Background(), registry, basic, server.Client().Transport, []string{testReference.Scope(PullScope)})
 	if err != nil {
-		t.Fatalf("New() = %v, %v", tp, err)
+		t.Fatalf("NewWithContext() = %v, %v", tp, err)
 	}
 	if count == 0 {
 		t.Errorf("failed to call TLS localhost server")