mirror of https://github.com/containers/image.git
145 lines
5.7 KiB
Go
145 lines
5.7 KiB
Go
package docker
|
|
|
|
import (
|
|
"bufio"
|
|
"bytes"
|
|
"errors"
|
|
"net/http"
|
|
"testing"
|
|
|
|
"github.com/docker/distribution/registry/api/errcode"
|
|
v2 "github.com/docker/distribution/registry/api/v2"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
// NOTE: This test records expected text strings, but NEITHER the returned error types
|
|
// NOR the error texts are an API commitment subject to API stability expectations;
|
|
// they can change at any time for any reason.
|
|
func TestRegistryHTTPResponseToError(t *testing.T) {
|
|
var unwrappedUnexpectedHTTPResponseError *unexpectedHTTPResponseError
|
|
for _, c := range []struct {
|
|
name string
|
|
response string
|
|
errorString string
|
|
errorType interface{} // A value of the same type as the expected error, or nil
|
|
unwrappedErrorPtr interface{} // A pointer to a value expected to be reachable using errors.As, or nil
|
|
errorCode *errcode.ErrorCode // A matching ErrorCode, or nil
|
|
fn func(t *testing.T, err error) // A more specialized test, or nil
|
|
}{
|
|
{
|
|
name: "HTTP status out of registry error range",
|
|
response: "HTTP/1.1 333 HTTP status out of range\r\n" +
|
|
"Header1: Value1\r\n" +
|
|
"\r\n" +
|
|
"Body of the request\r\n",
|
|
errorString: "received unexpected HTTP status: 333 HTTP status out of range",
|
|
errorType: &unexpectedHTTPStatusError{},
|
|
},
|
|
{
|
|
name: "HTTP body not in expected format",
|
|
response: "HTTP/1.1 400 I don't like this request\r\n" +
|
|
"Header1: Value1\r\n" +
|
|
"\r\n" +
|
|
"<html><body>JSON? What JSON?</body></html>\r\n",
|
|
errorString: "StatusCode: 400, <html><body>JSON? What JSON?</body></html>\r\n",
|
|
errorType: nil,
|
|
unwrappedErrorPtr: &unwrappedUnexpectedHTTPResponseError,
|
|
},
|
|
{
|
|
name: "401 body not in expected format",
|
|
response: "HTTP/1.1 401 I don't like this request\r\n" +
|
|
"Header1: Value1\r\n" +
|
|
"\r\n" +
|
|
"<html><body>JSON? What JSON?</body></html>\r\n",
|
|
errorString: "unauthorized: authentication required",
|
|
errorType: errcode.Error{},
|
|
unwrappedErrorPtr: nil,
|
|
errorCode: &errcode.ErrorCodeUnauthorized,
|
|
},
|
|
{ // docker.io when an image is not found
|
|
name: "GET https://registry-1.docker.io/v2/library/this-does-not-exist/manifests/latest",
|
|
response: "HTTP/1.1 401 Unauthorized\r\n" +
|
|
"Connection: close\r\n" +
|
|
"Content-Length: 170\r\n" +
|
|
"Content-Type: application/json\r\n" +
|
|
"Date: Thu, 12 Aug 2021 20:11:01 GMT\r\n" +
|
|
"Docker-Distribution-Api-Version: registry/2.0\r\n" +
|
|
"Strict-Transport-Security: max-age=31536000\r\n" +
|
|
"Www-Authenticate: Bearer realm=\"https://auth.docker.io/token\",service=\"registry.docker.io\",scope=\"repository:library/this-does-not-exist:pull\",error=\"insufficient_scope\"\r\n" +
|
|
"\r\n" +
|
|
"{\"errors\":[{\"code\":\"UNAUTHORIZED\",\"message\":\"authentication required\",\"detail\":[{\"Type\":\"repository\",\"Class\":\"\",\"Name\":\"library/this-does-not-exist\",\"Action\":\"pull\"}]}]}\n",
|
|
errorString: "denied: requested access to the resource is denied",
|
|
errorType: errcode.Error{},
|
|
unwrappedErrorPtr: nil,
|
|
errorCode: &errcode.ErrorCodeDenied,
|
|
},
|
|
{ // docker.io when a tag is not found
|
|
name: "GET https://registry-1.docker.io/v2/library/busybox/manifests/this-does-not-exist",
|
|
response: "HTTP/1.1 404 Not Found\r\n" +
|
|
"Connection: close\r\n" +
|
|
"Content-Length: 109\r\n" +
|
|
"Content-Type: application/json\r\n" +
|
|
"Date: Thu, 12 Aug 2021 20:51:32 GMT\r\n" +
|
|
"Docker-Distribution-Api-Version: registry/2.0\r\n" +
|
|
"Ratelimit-Limit: 100;w=21600\r\n" +
|
|
"Ratelimit-Remaining: 100;w=21600\r\n" +
|
|
"Strict-Transport-Security: max-age=31536000\r\n" +
|
|
"\r\n" +
|
|
"{\"errors\":[{\"code\":\"MANIFEST_UNKNOWN\",\"message\":\"manifest unknown\",\"detail\":{\"Tag\":\"this-does-not-exist\"}}]}\n",
|
|
errorString: "manifest unknown: manifest unknown",
|
|
errorType: errcode.Error{},
|
|
unwrappedErrorPtr: nil,
|
|
errorCode: &v2.ErrorCodeManifestUnknown,
|
|
},
|
|
{ // public.ecr.aws does not implement tag list
|
|
name: "GET https://public.ecr.aws/v2/nginx/nginx/tags/list",
|
|
response: "HTTP/1.1 404 Not Found\r\n" +
|
|
"Connection: close\r\n" +
|
|
"Content-Length: 65\r\n" +
|
|
"Content-Type: application/json; charset=utf-8\r\n" +
|
|
"Date: Tue, 06 Sep 2022 21:19:02 GMT\r\n" +
|
|
"Docker-Distribution-Api-Version: registry/2.0\r\n" +
|
|
"\r\n" +
|
|
"{\"errors\":[{\"code\":\"NOT_FOUND\",\"message\":\"404 page not found\"}]}\r\n",
|
|
errorString: "unknown: 404 page not found",
|
|
errorType: errcode.Error{},
|
|
unwrappedErrorPtr: nil,
|
|
errorCode: &errcode.ErrorCodeUnknown,
|
|
fn: func(t *testing.T, err error) {
|
|
var e errcode.Error
|
|
ok := errors.As(err, &e)
|
|
require.True(t, ok)
|
|
// Note: (skopeo inspect) is checking for this errcode.Error value
|
|
assert.Equal(t, errcode.Error{
|
|
Code: errcode.ErrorCodeUnknown, // The NOT_FOUND value is not defined, and turns into Unknown
|
|
Message: "404 page not found",
|
|
Detail: nil,
|
|
}, e)
|
|
},
|
|
},
|
|
} {
|
|
res, err := http.ReadResponse(bufio.NewReader(bytes.NewReader([]byte(c.response))), nil)
|
|
require.NoError(t, err, c.name)
|
|
|
|
err = registryHTTPResponseToError(res)
|
|
assert.Equal(t, c.errorString, err.Error(), c.name)
|
|
if c.errorType != nil {
|
|
assert.IsType(t, c.errorType, err, c.name)
|
|
}
|
|
if c.unwrappedErrorPtr != nil {
|
|
found := errors.As(err, c.unwrappedErrorPtr)
|
|
assert.True(t, found, c.name)
|
|
}
|
|
if c.errorCode != nil {
|
|
var ec errcode.ErrorCoder
|
|
ok := errors.As(err, &ec)
|
|
require.True(t, ok, c.name)
|
|
assert.Equal(t, *c.errorCode, ec.ErrorCode(), c.name)
|
|
}
|
|
if c.fn != nil {
|
|
c.fn(t, err)
|
|
}
|
|
}
|
|
}
|