Skip to content

Commit

Permalink
AUT-161 - de-globalizing unit tests. Also removed parallelism (#968)
Browse files Browse the repository at this point in the history 
* AUT-161 - de-globalizing unit tests. Also removed parallelism to prevent parallel database calls.
  • Loading branch information
@alexcottner
alexcottner committed Sep 3, 2024
1 parent d91b559 commit 869ae50
Show file tree
Hide file tree
Showing 6 changed files with 74 additions and 96 deletions.
36 changes: 18 additions & 18 deletions authorize_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import (
)

func TestMissingAuthorization(t *testing.T) {
t.Parallel()
ag, _ := newTestAutographer(t)

body := []byte("aaaaaaaaaaaaaaaaaaaaaaaaaaaa")
bodyrdr := bytes.NewReader(body)
Expand All @@ -35,7 +35,7 @@ func TestMissingAuthorization(t *testing.T) {
}

func TestBogusAuthorization(t *testing.T) {
t.Parallel()
ag, _ := newTestAutographer(t)

body := []byte("aaaaaaaaaaaaaaaaaaaaaaaaaaaa")
bodyrdr := bytes.NewReader(body)
Expand All @@ -54,7 +54,7 @@ func TestBogusAuthorization(t *testing.T) {
}

func TestBadPayload(t *testing.T) {
t.Parallel()
ag, conf := newTestAutographer(t)

body := []byte("aaaaaaaaaaaaaaaaaaaaaaaaaaaa")
bodyrdr := bytes.NewReader(body)
Expand All @@ -78,7 +78,7 @@ func TestBadPayload(t *testing.T) {
}

func TestExpiredAuth(t *testing.T) {
t.Parallel()
ag, _ := newTestAutographer(t)

body := []byte("aaaaaaaaaaaaaaaaaaaaaaaaaaaa")
bodyrdr := bytes.NewReader(body)
Expand All @@ -98,6 +98,8 @@ func TestExpiredAuth(t *testing.T) {
}

func TestDuplicateNonce(t *testing.T) {
ag, conf := newTestAutographer(t)

body := []byte("aaaaaaaaaaaaaaaaaaaaaaaaaaaa")
bodyrdr := bytes.NewReader(body)
req, err := http.NewRequest("POST", "http://foo.bar/sign/data", bodyrdr)
Expand Down Expand Up @@ -125,6 +127,8 @@ func TestDuplicateNonce(t *testing.T) {
}

func TestNonceFromLRU(t *testing.T) {
ag, conf := newTestAutographer(t)

req, err := http.NewRequest("POST", "http://foo.bar/sign/data", nil)
if err != nil {
t.Fatal(err)
Expand Down Expand Up @@ -170,7 +174,7 @@ func TestNonceFromLRU(t *testing.T) {
}

func TestSignerNotFound(t *testing.T) {
t.Parallel()
ag, _ := newTestAutographer(t)

_, err := ag.authBackend.getSignerForUser(`unknown018qoegdxc`, `unkown093ytid`)
if err == nil {
Expand All @@ -179,7 +183,7 @@ func TestSignerNotFound(t *testing.T) {
}

func TestDefaultSignerNotFound(t *testing.T) {
t.Parallel()
ag, _ := newTestAutographer(t)

_, err := ag.authBackend.getSignerForUser(`unknown018qoegdxc`, ``)
if err == nil {
Expand All @@ -188,7 +192,7 @@ func TestDefaultSignerNotFound(t *testing.T) {
}

func TestAutographerAddAuthorizationsFails(t *testing.T) {
t.Parallel()
ag, _ := newTestAutographer(t)

testcases := []struct {
name string
Expand All @@ -213,11 +217,11 @@ func TestAutographerAddAuthorizationsFails(t *testing.T) {
name: "authorization without a signer ID fails",
auths: []authorization{
{
ID: "alice",
ID: "bernie",
Signers: []string{},
},
},
errStr: `auth id "alice" must have at least one signer configured`,
errStr: `auth id "bernie" must have at least one signer configured`,
},
{
name: "invalid empty string auth ID fails",
Expand Down Expand Up @@ -274,9 +278,7 @@ func TestAutographerAddAuthorizationsFails(t *testing.T) {

for _, testcase := range testcases {
t.Run(testcase.name, func(t *testing.T) {
tmpag := newAutographer(1)
tmpag.addSigners(conf.Signers)
err := tmpag.addAuthorizations(testcase.auths)
err := ag.addAuthorizations(testcase.auths)
if err == nil {
t.Fatalf("%s: addAuthorizations did not fail as expected", testcase.name)
}
Expand All @@ -290,16 +292,14 @@ func TestAutographerAddAuthorizationsFails(t *testing.T) {
// set an authorization with a ts validity of 2 seconds, then sleep 5 seconds
// to trigger the hawk skew error
func TestHawkTimestampSkewFail(t *testing.T) {
t.Parallel()
ag, _ := newTestAutographer(t)

var err error
tmpag := newAutographer(1)
tmpag.hawkMaxTimestampSkew, err = time.ParseDuration("2s")
ag.hawkMaxTimestampSkew, err = time.ParseDuration("2s")
if err != nil {
t.Fatal(err)
}
tmpag.addSigners(conf.Signers)
tmpag.addAuthorizations([]authorization{
ag.addAuthorizations([]authorization{
{
ID: "alice",
Key: "1862300e9bd18eafab2eb8d6",
Expand All @@ -316,7 +316,7 @@ func TestHawkTimestampSkewFail(t *testing.T) {
authheader := getAuthHeader(req, "alice", "1862300e9bd18eafab2eb8d6", sha256.New, id(), "application/json", body)
req.Header.Set("Authorization", authheader)
time.Sleep(5 * time.Second)
_, _, err = tmpag.authorizeHeader(req)
_, _, err = ag.authorizeHeader(req)
if err.Error() != hawk.ErrTimestampSkew.Error() {
t.Errorf("expected auth to fail with skewed timestamp but got error: %v", err)
}
Expand Down
1 change: 1 addition & 0 deletions handlers_racing_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import (

func TestSignaturePass(t *testing.T) {
t.Parallel()
ag, conf := newTestAutographer(t)

var TESTCASES = []struct {
endpoint string
Expand Down
56 changes: 25 additions & 31 deletions handlers_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ type HandlerTestCase struct {
expectedBody string
}

func (testcase *HandlerTestCase) NewRequest(t *testing.T) *http.Request {
func (testcase *HandlerTestCase) NewRequest(ag *autographer, t *testing.T) *http.Request {
// test request setup
var (
req *http.Request
Expand Down Expand Up @@ -115,9 +115,9 @@ func (testcase *HandlerTestCase) ValidateResponse(t *testing.T, w *httptest.Resp
}
}

func (testcase *HandlerTestCase) Run(t *testing.T, handler func(http.ResponseWriter, *http.Request)) {
func (testcase *HandlerTestCase) Run(ag *autographer, t *testing.T, handler func(http.ResponseWriter, *http.Request)) {
// test request setup
var req = testcase.NewRequest(t)
var req = testcase.NewRequest(ag, t)

// run the request
w := httptest.NewRecorder()
Expand All @@ -128,7 +128,7 @@ func (testcase *HandlerTestCase) Run(t *testing.T, handler func(http.ResponseWri
}

func TestBadRequest(t *testing.T) {
t.Parallel()
ag, conf := newTestAutographer(t)

var TESTCASES = []struct {
endpoint string
Expand Down Expand Up @@ -204,7 +204,6 @@ func TestBadRequest(t *testing.T) {
testcase := testcase

t.Run(fmt.Sprintf("returns 400 for invalid %s %s %s", testcase.method, testcase.endpoint, testcase.body), func(t *testing.T) {
t.Parallel()

body := strings.NewReader(testcase.body)
req, err := http.NewRequest(testcase.method, "http://foo.bar"+testcase.endpoint, body)
Expand Down Expand Up @@ -235,7 +234,7 @@ func TestBadRequest(t *testing.T) {
}

func TestRequestTooLarge(t *testing.T) {
t.Parallel()
ag, conf := newTestAutographer(t)

blob := strings.Repeat("foobar", 200)
body := strings.NewReader(blob)
Expand Down Expand Up @@ -264,7 +263,7 @@ func TestRequestTooLarge(t *testing.T) {
}

func TestBadContentType(t *testing.T) {
t.Parallel()
ag, conf := newTestAutographer(t)

blob := "foofoofoofoofoofoofoofoofoofoofoofoofoofoo"
body := strings.NewReader(blob)
Expand Down Expand Up @@ -293,7 +292,7 @@ func TestBadContentType(t *testing.T) {
}

func TestAuthFail(t *testing.T) {
t.Parallel()
ag, _ := newTestAutographer(t)

var TESTCASES = []struct {
user string
Expand Down Expand Up @@ -333,8 +332,6 @@ func TestAuthFail(t *testing.T) {
}

func TestLBHeartbeat(t *testing.T) {
t.Parallel()

var TESTCASES = []struct {
expect int
method string
Expand All @@ -358,7 +355,7 @@ func TestLBHeartbeat(t *testing.T) {
}
}

func checkHeartbeatReturnsExpectedStatusAndBody(t *testing.T, name, method string, expectedStatusCode int, expectedBody []byte) {
func checkHeartbeatReturnsExpectedStatusAndBody(ag *autographer, t *testing.T, name, method string, expectedStatusCode int, expectedBody []byte) {
req, err := http.NewRequest(method, "http://foo.bar/__heartbeat__", nil)
if err != nil {
t.Fatal(err)
Expand All @@ -375,7 +372,8 @@ func checkHeartbeatReturnsExpectedStatusAndBody(t *testing.T, name, method strin
}

func TestHeartbeat(t *testing.T) {
t.Parallel()
ag, _ := newTestAutographer(t)
ag.heartbeatConf = &heartbeatConfig{}

var TESTCASES = []struct {
name string
Expand All @@ -389,11 +387,12 @@ func TestHeartbeat(t *testing.T) {
{"returns 405 for HEAD", `HEAD`, http.StatusMethodNotAllowed, "HEAD method not allowed; endpoint accepts GET only\r\nrequest-id: -\n"},
}
for _, testcase := range TESTCASES {
checkHeartbeatReturnsExpectedStatusAndBody(t, testcase.name, testcase.method, testcase.expectedHTTPStatus, []byte((testcase.expectedBody)))
checkHeartbeatReturnsExpectedStatusAndBody(ag, t, testcase.name, testcase.method, testcase.expectedHTTPStatus, []byte((testcase.expectedBody)))
}
}

func TestHeartbeatChecksHSMStatusFails(t *testing.T) {
ag, _ := newTestAutographer(t)
// NB: do not run in parallel with TestHeartbeat*
ag.heartbeatConf = &heartbeatConfig{
HSMCheckTimeout: time.Second,
Expand All @@ -402,21 +401,19 @@ func TestHeartbeatChecksHSMStatusFails(t *testing.T) {

expectedStatus := http.StatusInternalServerError
expectedBody := []byte("{\"hsmAccessible\":false}")
checkHeartbeatReturnsExpectedStatusAndBody(t, "returns 500 for GET with HSM inaccessible", `GET`, expectedStatus, expectedBody)

ag.heartbeatConf = nil
checkHeartbeatReturnsExpectedStatusAndBody(ag, t, "returns 500 for GET with HSM inaccessible", `GET`, expectedStatus, expectedBody)
}

func TestHeartbeatChecksHSMStatusFailsWhenNotConfigured(t *testing.T) {
ag, _ := newTestAutographer(t)
// NB: do not run in parallel with TestHeartbeat*
ag.heartbeatConf = nil

expectedStatus := http.StatusInternalServerError
expectedBody := []byte("Missing heartbeat config\r\nrequest-id: -\n")
checkHeartbeatReturnsExpectedStatusAndBody(t, "returns 500 for GET without heartbeat config HSM", `GET`, expectedStatus, expectedBody)
checkHeartbeatReturnsExpectedStatusAndBody(ag, t, "returns 500 for GET without heartbeat config HSM", `GET`, expectedStatus, expectedBody)
}

func TestHeartbeatChecksDBStatusOKAndTimesout(t *testing.T) {
ag, _ := newTestAutographer(t)
// NB: do not run in parallel with TestHeartbeat* or DB tests
host := database.GetTestDBHost()
db, err := database.Connect(database.Config{
Expand All @@ -436,29 +433,25 @@ func TestHeartbeatChecksDBStatusOKAndTimesout(t *testing.T) {
// check OK run locally requires running DB container
expectedStatus := http.StatusOK
expectedBody := []byte("{\"dbAccessible\":true}")
checkHeartbeatReturnsExpectedStatusAndBody(t, "returns 200 for GET with DB accessible", `GET`, expectedStatus, expectedBody)
checkHeartbeatReturnsExpectedStatusAndBody(ag, t, "returns 200 for GET with DB accessible", `GET`, expectedStatus, expectedBody)

// drop timeout
ag.heartbeatConf.DBCheckTimeout = 1 * time.Nanosecond
// check DB request times out
expectedStatus = http.StatusOK
expectedBody = []byte("{\"dbAccessible\":false}")
checkHeartbeatReturnsExpectedStatusAndBody(t, "returns 200 for GET with DB time out", `GET`, expectedStatus, expectedBody)
checkHeartbeatReturnsExpectedStatusAndBody(ag, t, "returns 200 for GET with DB time out", `GET`, expectedStatus, expectedBody)

// restore longer timeout and close the DB connection
ag.heartbeatConf.DBCheckTimeout = 1 * time.Second
db.Close()
// check DB request still fails
expectedStatus = http.StatusOK
expectedBody = []byte("{\"dbAccessible\":false}")
checkHeartbeatReturnsExpectedStatusAndBody(t, "returns 200 for GET with DB inaccessible", `GET`, expectedStatus, expectedBody)

ag.db = nil
checkHeartbeatReturnsExpectedStatusAndBody(ag, t, "returns 200 for GET with DB inaccessible", `GET`, expectedStatus, expectedBody)
}

func TestVersion(t *testing.T) {
t.Parallel()

var TESTCASES = []struct {
expect int
method string
Expand Down Expand Up @@ -487,7 +480,7 @@ func TestVersion(t *testing.T) {
// * `appkey1` and `appkey2` for `alice`
// * `appkey2` only for `bob`
func TestSignerAuthorized(t *testing.T) {
t.Parallel()
ag, conf := newTestAutographer(t)

var TESTCASES = []struct {
userid string
Expand Down Expand Up @@ -577,7 +570,7 @@ func TestSignerAuthorized(t *testing.T) {

// verify that user `bob` is not allowed to sign with `appkey1`
func TestSignerUnauthorized(t *testing.T) {
t.Parallel()
ag, conf := newTestAutographer(t)

var TESTCASES = []formats.SignatureRequest{
// request signature that need to prepend the content-signature:\x00 header
Expand Down Expand Up @@ -616,7 +609,7 @@ func TestSignerUnauthorized(t *testing.T) {
}

func TestContentType(t *testing.T) {
t.Parallel()
ag, conf := newTestAutographer(t)

var TESTCASES = []formats.SignatureRequest{
formats.SignatureRequest{
Expand Down Expand Up @@ -650,6 +643,7 @@ func TestContentType(t *testing.T) {
}

func TestDebug(t *testing.T) {
ag, _ := newTestAutographer(t)
ag.enableDebug()
if !ag.debug {
t.Fatalf("expected debug mode to be enabled, but is disabled")
Expand All @@ -661,7 +655,7 @@ func TestDebug(t *testing.T) {
}

func TestHandleGetAuthKeyIDs(t *testing.T) {
t.Parallel()
ag, _ := newTestAutographer(t)

const autographDevAliceKeyIDsJSON = "[\"apk_cert_with_ecdsa_sha256\",\"apk_cert_with_ecdsa_sha256_v3\",\"appkey1\",\"appkey2\",\"dummyrsa\",\"dummyrsapss\",\"extensions-ecdsa\",\"extensions-ecdsa-expired-chain\",\"legacy_apk_with_rsa\",\"normandy\",\"pgpsubkey\",\"pgpsubkey-debsign\",\"randompgp\",\"randompgp-debsign\",\"remote-settings\",\"testapp-android\",\"testapp-android-legacy\",\"testapp-android-v3\",\"testauthenticode\",\"testmar\",\"testmarecdsa\",\"webextensions-rsa\",\"webextensions-rsa-with-recommendation\"]"

Expand Down Expand Up @@ -790,7 +784,7 @@ func TestHandleGetAuthKeyIDs(t *testing.T) {
},
}
for _, testcase := range testcases {
testcase.Run(t, ag.handleGetAuthKeyIDs)
testcase.Run(ag, t, ag.handleGetAuthKeyIDs)
}
}

Expand Down
Loading

0 comments on commit 869ae50

Please sign in to comment.