Merge pull request #13 from rinchsan/tidy-and-add-tests

api_test.go

@@ -198,3 +198,17 @@ func TestAPI_do(t *testing.T) {
 		})
 	}
 }
+
+type roundTripFunc func(req *http.Request) *http.Response
+
+func (f roundTripFunc) RoundTrip(req *http.Request) (*http.Response, error) {
+	return f(req), nil
+}
+
+func newMockHTTPClient(resp *http.Response) *http.Client {
+	return &http.Client{
+		Transport: roundTripFunc(func(r *http.Request) *http.Response {
+			return resp
+		}),
+	}
+}

codecov.yml

@@ -0,0 +1,6 @@
+coverage:
+  status:
+    project:
+      default:
+        target: 90%
+    patch: off

error.go

@@ -3,6 +3,7 @@ package devicecheck
 import (
 	"errors"
 	"net/http"
+	"strings"
 )
 
 const (
@@ -21,14 +22,8 @@ var (
 	ErrBitStateNotFound   = errors.New("bit state not found")
 )
 
-func newErrorForQuery(code int, body string) error {
-	if code != http.StatusOK {
-		return newError(code)
-	}
-	if body == bitStateNotFoundStr {
-		return ErrBitStateNotFound
-	}
-	return nil
+func isErrBitStateNotFound(body string) bool {
+	return strings.Contains(body, bitStateNotFoundStr)
 }
 
 func newError(code int) error {

error_test.go

@@ -6,6 +6,37 @@ import (
 	"testing"
 )
 
+func Test_isErrBitStateNotFound(t *testing.T) {
+	t.Parallel()
+
+	cases := map[string]struct {
+		body string
+		want bool
+	}{
+		"is ErrBitStateNotFound": {
+			body: "Failed to find bit state",
+			want: true,
+		},
+		"is not ErrBitStateNotFound": {
+			body: "Missing or incorrectly formatted bits",
+			want: false,
+		},
+	}
+
+	for name, c := range cases {
+		c := c
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			got := isErrBitStateNotFound(c.body)
+
+			if !reflect.DeepEqual(got, c.want) {
+				t.Errorf("want '%+v', got '%+v'", c.want, got)
+			}
+		})
+	}
+}
+
 func Test_newError(t *testing.T) {
 	t.Parallel()
 

go.sum

@@ -1,7 +1,5 @@
 github.com/dvsekhvalnov/jose2go v0.0.0-20201001154944-b09cfaf05951 h1:U+H8oUNmugZTzB9c3EZQzdC2B9rXCqROImRSxnwh4Ck=
 github.com/dvsekhvalnov/jose2go v0.0.0-20201001154944-b09cfaf05951/go.mod h1:QsHjhyTlD/lAVqn/NSbVZmSCGeDehTB/mPZadG+mhXU=
-github.com/google/uuid v1.1.2 h1:EVhdT+1Kseyi1/pUmXKaFxYsDNy9RQYkMWRH68J/W7Y=
-github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/google/uuid v1.1.4 h1:0ecGp3skIrHWPNGPJDaBIghfA6Sp7Ruo2Io8eLKzWm0=
 github.com/google/uuid v1.1.4/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=

jwt.go

@@ -3,7 +3,6 @@ package devicecheck
 import (
 	"crypto/ecdsa"
 	"encoding/json"
-	"fmt"
 	"time"
 
 	jose "github.com/dvsekhvalnov/jose2go"
@@ -27,10 +26,8 @@ func (jwt jwt) generate(key *ecdsa.PrivateKey) (string, error) {
 		"iat": time.Now().UTC().Unix(),
 	}
 
-	claimsJSON, err := json.Marshal(claims)
-	if err != nil {
-		return "", fmt.Errorf("json: %w", err)
-	}
+	// Ignoring error, because json.Marshal never fails.
+	claimsJSON, _ := json.Marshal(claims)
 
 	headers := map[string]interface{}{
 		"alg": jose.ES256,

query.go

@@ -5,6 +5,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"io/ioutil"
+	"net/http"
 	"strings"
 	"time"
 
@@ -71,17 +72,19 @@ func (client *Client) QueryTwoBits(deviceToken string, result *QueryTwoBitsResul
 	}
 	defer resp.Body.Close()
 
-	respBody, err := ioutil.ReadAll(resp.Body)
-	if err != nil {
-		return err
-	}
-	err = newErrorForQuery(resp.StatusCode, string(respBody))
-	if err == ErrBitStateNotFound {
-		return err
-	}
-	if err != nil {
-		return fmt.Errorf("devicecheck: %w", err)
-	}
+	switch resp.StatusCode {
+	case http.StatusOK:
+		respBody, err := ioutil.ReadAll(resp.Body)
+		if err != nil {
+			return fmt.Errorf("devicecheck: failed to read response body: %w", err)
+		}
+
+		if isErrBitStateNotFound(string(respBody)) {
+			return ErrBitStateNotFound
+		}
 
-	return json.NewDecoder(bytes.NewReader(respBody)).Decode(result)
+		return json.NewDecoder(bytes.NewReader(respBody)).Decode(result)
+	default:
+		return fmt.Errorf("devicecheck: %w", newError(resp.StatusCode))
+	}
 }

query_test.go

@@ -1,8 +1,10 @@
 package devicecheck
 
 import (
+	"io/ioutil"
 	"net/http"
 	"reflect"
+	"strings"
 	"testing"
 	"time"
 )
@@ -89,13 +91,15 @@ func TestClient_QueryTwoBits(t *testing.T) {
 
 	cases := map[string]struct {
 		client Client
+		noErr  bool
 	}{
 		"invalid key": {
 			client: Client{
 				api:  newAPI(Development),
 				cred: NewCredentialFile("unknown_file.p8"),
 				jwt:  newJWT("issuer", "keyID"),
 			},
+			noErr: false,
 		},
 		"invalid url": {
 			client: Client{
@@ -106,13 +110,37 @@ func TestClient_QueryTwoBits(t *testing.T) {
 				cred: NewCredentialFile("revoked_private_key.p8"),
 				jwt:  newJWT("issuer", "keyID"),
 			},
+			noErr: false,
 		},
 		"invalid device token": {
 			client: Client{
 				api:  newAPI(Development),
 				cred: NewCredentialFile("revoked_private_key.p8"),
 				jwt:  newJWT("issuer", "keyID"),
 			},
+			noErr: false,
+		},
+		"status ok with ErrBitStateNotFound": {
+			client: Client{
+				api: newAPIWithHTTPClient(newMockHTTPClient(&http.Response{
+					StatusCode: http.StatusOK,
+					Body:       ioutil.NopCloser(strings.NewReader("Failed to find bit state")),
+				}), Development),
+				cred: NewCredentialFile("revoked_private_key.p8"),
+				jwt:  newJWT("issuer", "keyID"),
+			},
+			noErr: false,
+		},
+		"status ok with valid response": {
+			client: Client{
+				api: newAPIWithHTTPClient(newMockHTTPClient(&http.Response{
+					StatusCode: http.StatusOK,
+					Body:       ioutil.NopCloser(strings.NewReader(`{"bit0":true,"bit1":false,"last_update_time":"2006-01"}`)),
+				}), Development),
+				cred: NewCredentialFile("revoked_private_key.p8"),
+				jwt:  newJWT("issuer", "keyID"),
+			},
+			noErr: true,
 		},
 	}
 
@@ -124,8 +152,14 @@ func TestClient_QueryTwoBits(t *testing.T) {
 			var result QueryTwoBitsResult
 			err := c.client.QueryTwoBits("device_token", &result)
 
-			if err == nil {
-				t.Error("want 'not nil', got 'nil'")
+			if c.noErr {
+				if err != nil {
+					t.Errorf("want 'nil', got '%+v'", err)
+				}
+			} else {
+				if err == nil {
+					t.Error("want 'not nil', got 'nil'")
+				}
 			}
 		})
 	}

update_test.go

@@ -1,7 +1,9 @@
 package devicecheck
 
 import (
+	"io/ioutil"
 	"net/http"
+	"strings"
 	"testing"
 )
 
@@ -10,13 +12,15 @@ func TestClient_UpdateTwoBits(t *testing.T) {
 
 	cases := map[string]struct {
 		client Client
+		noErr  bool
 	}{
 		"invalid key": {
 			client: Client{
 				api:  newAPI(Development),
 				cred: NewCredentialFile("unknown_file.p8"),
 				jwt:  newJWT("issuer", "keyID"),
 			},
+			noErr: false,
 		},
 		"invalid url": {
 			client: Client{
@@ -27,13 +31,26 @@ func TestClient_UpdateTwoBits(t *testing.T) {
 				cred: NewCredentialFile("revoked_private_key.p8"),
 				jwt:  newJWT("issuer", "keyID"),
 			},
+			noErr: false,
 		},
 		"invalid device token": {
 			client: Client{
 				api:  newAPI(Development),
 				cred: NewCredentialFile("revoked_private_key.p8"),
 				jwt:  newJWT("issuer", "keyID"),
 			},
+			noErr: false,
+		},
+		"status ok": {
+			client: Client{
+				api: newAPIWithHTTPClient(newMockHTTPClient(&http.Response{
+					StatusCode: http.StatusOK,
+					Body:       ioutil.NopCloser(strings.NewReader("success")),
+				}), Development),
+				cred: NewCredentialFile("revoked_private_key.p8"),
+				jwt:  newJWT("issuer", "keyID"),
+			},
+			noErr: true,
 		},
 	}
 
@@ -44,8 +61,14 @@ func TestClient_UpdateTwoBits(t *testing.T) {
 
 			err := c.client.UpdateTwoBits("device_token", true, true)
 
-			if err == nil {
-				t.Error("want 'not nil', got 'nil'")
+			if c.noErr {
+				if err != nil {
+					t.Errorf("want 'nil', got '%+v'", err)
+				}
+			} else {
+				if err == nil {
+					t.Error("want 'not nil', got 'nil'")
+				}
 			}
 		})
 	}

validate_test.go

@@ -1,7 +1,9 @@
 package devicecheck
 
 import (
+	"io/ioutil"
 	"net/http"
+	"strings"
 	"testing"
 )
 
@@ -10,13 +12,15 @@ func TestClient_ValidateDeviceToken(t *testing.T) {
 
 	cases := map[string]struct {
 		client Client
+		noErr  bool
 	}{
 		"invalid key": {
 			client: Client{
 				api:  newAPI(Development),
 				cred: NewCredentialFile("unknown_file.p8"),
 				jwt:  newJWT("issuer", "keyID"),
 			},
+			noErr: false,
 		},
 		"invalid url": {
 			client: Client{
@@ -27,13 +31,26 @@ func TestClient_ValidateDeviceToken(t *testing.T) {
 				cred: NewCredentialFile("revoked_private_key.p8"),
 				jwt:  newJWT("issuer", "keyID"),
 			},
+			noErr: false,
 		},
 		"invalid device token": {
 			client: Client{
 				api:  newAPI(Development),
 				cred: NewCredentialFile("revoked_private_key.p8"),
 				jwt:  newJWT("issuer", "keyID"),
 			},
+			noErr: false,
+		},
+		"status ok": {
+			client: Client{
+				api: newAPIWithHTTPClient(newMockHTTPClient(&http.Response{
+					StatusCode: http.StatusOK,
+					Body:       ioutil.NopCloser(strings.NewReader("success")),
+				}), Development),
+				cred: NewCredentialFile("revoked_private_key.p8"),
+				jwt:  newJWT("issuer", "keyID"),
+			},
+			noErr: true,
 		},
 	}
 
@@ -44,8 +61,14 @@ func TestClient_ValidateDeviceToken(t *testing.T) {
 
 			err := c.client.ValidateDeviceToken("device_token")
 
-			if err == nil {
-				t.Error("want 'not nil', got 'nil'")
+			if c.noErr {
+				if err != nil {
+					t.Errorf("want 'nil', got '%+v'", err)
+				}
+			} else {
+				if err == nil {
+					t.Error("want 'not nil', got 'nil'")
+				}
 			}
 		})
 	}