From 8093b3372e812af6a5c3aab32559881011861243 Mon Sep 17 00:00:00 2001 From: Ethan Koenig Date: Tue, 24 Jan 2017 21:49:51 -0500 Subject: [PATCH] Less boilerplate in models/ unit tests (#725) --- models/access_test.go | 31 ++++++++++++-------------- models/action_test.go | 48 ++++++++++++++-------------------------- models/pull_test.go | 42 +++++++++-------------------------- models/setup_for_test.go | 3 ++- models/token_test.go | 22 +++--------------- models/update_test.go | 14 ++---------- 6 files changed, 47 insertions(+), 113 deletions(-) diff --git a/models/access_test.go b/models/access_test.go index a2e59b3e9..8d8b156cc 100644 --- a/models/access_test.go +++ b/models/access_test.go @@ -6,6 +6,7 @@ package models import ( "testing" + "github.com/stretchr/testify/assert" ) @@ -19,10 +20,10 @@ var accessModes = []AccessMode{ func TestAccessLevel(t *testing.T) { assert.NoError(t, PrepareTestDatabase()) - user1 := &User{ID: 2}; AssertExistsAndLoadBean(t, user1) - user2 := &User{ID: 4}; AssertExistsAndLoadBean(t, user2) - repo1 := &Repository{OwnerID: 2, IsPrivate: false}; AssertExistsAndLoadBean(t, repo1) - repo2 := &Repository{OwnerID: 3, IsPrivate: true}; AssertExistsAndLoadBean(t, repo2) + user1 := AssertExistsAndLoadBean(t, &User{ID: 2}).(*User) + user2 := AssertExistsAndLoadBean(t, &User{ID: 4}).(*User) + repo1 := AssertExistsAndLoadBean(t, &Repository{OwnerID: 2, IsPrivate: false}).(*Repository) + repo2 := AssertExistsAndLoadBean(t, &Repository{OwnerID: 3, IsPrivate: true}).(*Repository) level, err := AccessLevel(user1, repo1) assert.NoError(t, err) @@ -44,10 +45,10 @@ func TestAccessLevel(t *testing.T) { func TestHasAccess(t *testing.T) { assert.NoError(t, PrepareTestDatabase()) - user1 := &User{ID: 2}; AssertExistsAndLoadBean(t, user1) - user2 := &User{ID: 4}; AssertExistsAndLoadBean(t, user2) - repo1 := &Repository{OwnerID: 2, IsPrivate: false}; AssertExistsAndLoadBean(t, repo1) - repo2 := &Repository{OwnerID: 3, IsPrivate: true}; AssertExistsAndLoadBean(t, repo2) + user1 := AssertExistsAndLoadBean(t, &User{ID: 2}).(*User) + user2 := AssertExistsAndLoadBean(t, &User{ID: 4}).(*User) + repo1 := AssertExistsAndLoadBean(t, &Repository{OwnerID: 2, IsPrivate: false}).(*Repository) + repo2 := AssertExistsAndLoadBean(t, &Repository{OwnerID: 3, IsPrivate: true}).(*Repository) for _, accessMode := range accessModes { has, err := HasAccess(user1, repo1, accessMode) @@ -71,9 +72,7 @@ func TestHasAccess(t *testing.T) { func TestUser_GetRepositoryAccesses(t *testing.T) { assert.NoError(t, PrepareTestDatabase()) - user1 := &User{ID: 1}; AssertExistsAndLoadBean(t, user1) - user2 := &User{ID: 2}; AssertExistsAndLoadBean(t, user2) - + user1 := AssertExistsAndLoadBean(t, &User{ID: 1}).(*User) accesses, err := user1.GetRepositoryAccesses() assert.NoError(t, err) assert.Len(t, accesses, 0) @@ -82,23 +81,21 @@ func TestUser_GetRepositoryAccesses(t *testing.T) { func TestUser_GetAccessibleRepositories(t *testing.T) { assert.NoError(t, PrepareTestDatabase()) - user1 := &User{ID: 1}; AssertExistsAndLoadBean(t, user1) - user2 := &User{ID: 2}; AssertExistsAndLoadBean(t, user2) - + user1 := AssertExistsAndLoadBean(t, &User{ID: 1}).(*User) repos, err := user1.GetAccessibleRepositories(0) assert.NoError(t, err) assert.Len(t, repos, 0) + user2 := AssertExistsAndLoadBean(t, &User{ID: 2}).(*User) repos, err = user2.GetAccessibleRepositories(0) assert.NoError(t, err) assert.Len(t, repos, 1) } - func TestRepository_RecalculateAccesses(t *testing.T) { // test with organization repo assert.NoError(t, PrepareTestDatabase()) - repo1 := &Repository{ID: 3}; AssertExistsAndLoadBean(t, repo1) + repo1 := AssertExistsAndLoadBean(t, &Repository{ID: 3}).(*Repository) assert.NoError(t, repo1.GetOwner()) sess := x.NewSession() @@ -119,7 +116,7 @@ func TestRepository_RecalculateAccesses(t *testing.T) { func TestRepository_RecalculateAccesses2(t *testing.T) { // test with non-organization repo assert.NoError(t, PrepareTestDatabase()) - repo1 := &Repository{ID: 4}; AssertExistsAndLoadBean(t, repo1) + repo1 := AssertExistsAndLoadBean(t, &Repository{ID: 4}).(*Repository) assert.NoError(t, repo1.GetOwner()) sess := x.NewSession() diff --git a/models/action_test.go b/models/action_test.go index f60bc511b..f29ec65cf 100644 --- a/models/action_test.go +++ b/models/action_test.go @@ -29,10 +29,8 @@ func TestAction_GetRepoLink(t *testing.T) { func TestNewRepoAction(t *testing.T) { assert.NoError(t, PrepareTestDatabase()) - user := &User{ID: 2} - AssertExistsAndLoadBean(t, user) - repo := &Repository{OwnerID: user.ID} - AssertExistsAndLoadBean(t, repo) + user := AssertExistsAndLoadBean(t, &User{ID: 2}).(*User) + repo := AssertExistsAndLoadBean(t, &Repository{OwnerID: user.ID}).(*Repository) repo.Owner = user actionBean := &Action{ @@ -53,10 +51,8 @@ func TestNewRepoAction(t *testing.T) { func TestRenameRepoAction(t *testing.T) { assert.NoError(t, PrepareTestDatabase()) - user := &User{ID: 2} - AssertExistsAndLoadBean(t, user) - repo := &Repository{OwnerID: user.ID} - AssertExistsAndLoadBean(t, repo) + user := AssertExistsAndLoadBean(t, &User{ID: 2}).(*User) + repo := AssertExistsAndLoadBean(t, &Repository{OwnerID: user.ID}).(*Repository) repo.Owner = user oldRepoName := repo.Name @@ -179,10 +175,8 @@ func TestUpdateIssuesCommit(t *testing.T) { }, } - user := &User{ID: 2} - AssertExistsAndLoadBean(t, user) - repo := &Repository{ID: 1} - AssertExistsAndLoadBean(t, repo) + user := AssertExistsAndLoadBean(t, &User{ID: 2}).(*User) + repo := AssertExistsAndLoadBean(t, &Repository{ID: 1}).(*Repository) repo.Owner = user commentBean := &Comment{ @@ -203,10 +197,8 @@ func TestUpdateIssuesCommit(t *testing.T) { func TestCommitRepoAction(t *testing.T) { assert.NoError(t, PrepareTestDatabase()) - user := &User{ID: 2} - AssertExistsAndLoadBean(t, user) - repo := &Repository{ID: 2, OwnerID: user.ID} - AssertExistsAndLoadBean(t, repo) + user := AssertExistsAndLoadBean(t, &User{ID: 2}).(*User) + repo := AssertExistsAndLoadBean(t, &Repository{ID: 2, OwnerID: user.ID}).(*Repository) repo.Owner = user pushCommits := NewPushCommits() @@ -255,12 +247,9 @@ func TestCommitRepoAction(t *testing.T) { func TestTransferRepoAction(t *testing.T) { assert.NoError(t, PrepareTestDatabase()) - user2 := &User{ID: 2} - AssertExistsAndLoadBean(t, user2) - user4 := &User{ID: 4} - AssertExistsAndLoadBean(t, user4) - repo := &Repository{ID: 1, OwnerID: user2.ID} - AssertExistsAndLoadBean(t, repo) + user2 := AssertExistsAndLoadBean(t, &User{ID: 2}).(*User) + user4 := AssertExistsAndLoadBean(t, &User{ID: 4}).(*User) + repo := AssertExistsAndLoadBean(t, &Repository{ID: 1, OwnerID: user2.ID}).(*Repository) repo.OwnerID = user4.ID repo.Owner = user4 @@ -281,13 +270,10 @@ func TestTransferRepoAction(t *testing.T) { func TestMergePullRequestAction(t *testing.T) { assert.NoError(t, PrepareTestDatabase()) - user := &User{ID: 2} - AssertExistsAndLoadBean(t, user) - repo := &Repository{ID: 1, OwnerID: user.ID} - AssertExistsAndLoadBean(t, repo) + user := AssertExistsAndLoadBean(t, &User{ID: 2}).(*User) + repo := AssertExistsAndLoadBean(t, &Repository{ID: 1, OwnerID: user.ID}).(*Repository) repo.Owner = user - issue := &Issue{ID: 3, RepoID: repo.ID} - AssertExistsAndLoadBean(t, issue) + issue := AssertExistsAndLoadBean(t, &Issue{ID: 3, RepoID: repo.ID}).(*Issue) actionBean := &Action{ OpType: ActionMergePullRequest, @@ -306,8 +292,7 @@ func TestMergePullRequestAction(t *testing.T) { func TestGetFeeds(t *testing.T) { // test with an individual user assert.NoError(t, PrepareTestDatabase()) - user := &User{ID: 2} - AssertExistsAndLoadBean(t, user) + user := AssertExistsAndLoadBean(t, &User{ID: 2}).(*User) actions, err := GetFeeds(user, user.ID, 0, false) assert.NoError(t, err) @@ -323,8 +308,7 @@ func TestGetFeeds(t *testing.T) { func TestGetFeeds2(t *testing.T) { // test with an organization user assert.NoError(t, PrepareTestDatabase()) - user := &User{ID: 3} - AssertExistsAndLoadBean(t, user) + user := AssertExistsAndLoadBean(t, &User{ID: 3}).(*User) actions, err := GetFeeds(user, user.ID, 0, false) assert.NoError(t, err) diff --git a/models/pull_test.go b/models/pull_test.go index 402b00962..f0352be35 100644 --- a/models/pull_test.go +++ b/models/pull_test.go @@ -11,21 +11,9 @@ import ( "github.com/stretchr/testify/assert" ) -// getPullRequest load a fixture pull request from the test database -func loadFixturePullRequest(t *testing.T, id int64) *PullRequest { - sess := x.NewSession() - defer sess.Close() - - pr := &PullRequest{ID: id} - has, err := sess.Get(pr) - assert.NoError(t, err) - assert.True(t, has) - return pr -} - func TestPullRequest_LoadAttributes(t *testing.T) { assert.NoError(t, PrepareTestDatabase()) - pr := loadFixturePullRequest(t, 1) + pr := AssertExistsAndLoadBean(t, &PullRequest{ID: 1}).(*PullRequest) assert.NoError(t, pr.LoadAttributes()) assert.NotNil(t, pr.Merger) assert.Equal(t, pr.MergerID, pr.Merger.ID) @@ -33,7 +21,7 @@ func TestPullRequest_LoadAttributes(t *testing.T) { func TestPullRequest_LoadIssue(t *testing.T) { assert.NoError(t, PrepareTestDatabase()) - pr := loadFixturePullRequest(t, 1) + pr := AssertExistsAndLoadBean(t, &PullRequest{ID: 1}).(*PullRequest) assert.NoError(t, pr.LoadIssue()) assert.NotNil(t, pr.Issue) assert.Equal(t, int64(2), pr.Issue.ID) @@ -46,7 +34,7 @@ func TestPullRequest_LoadIssue(t *testing.T) { func TestPullRequest_GetBaseRepo(t *testing.T) { assert.NoError(t, PrepareTestDatabase()) - pr := loadFixturePullRequest(t, 1) + pr := AssertExistsAndLoadBean(t, &PullRequest{ID: 1}).(*PullRequest) assert.NoError(t, pr.GetBaseRepo()) assert.NotNil(t, pr.BaseRepo) assert.Equal(t, pr.BaseRepoID, pr.BaseRepo.ID) @@ -57,7 +45,7 @@ func TestPullRequest_GetBaseRepo(t *testing.T) { func TestPullRequest_GetHeadRepo(t *testing.T) { assert.NoError(t, PrepareTestDatabase()) - pr := loadFixturePullRequest(t, 1) + pr := AssertExistsAndLoadBean(t, &PullRequest{ID: 1}).(*PullRequest) assert.NoError(t, pr.GetHeadRepo()) assert.NotNil(t, pr.HeadRepo) assert.Equal(t, pr.HeadRepoID, pr.HeadRepo.ID) @@ -175,12 +163,7 @@ func TestPullRequest_Update(t *testing.T) { } pr.Update() - sess := x.NewSession() - defer sess.Close() - pr = &PullRequest{ID: 1} - has, err := sess.Get(pr) - assert.NoError(t, err) - assert.True(t, has) + pr = AssertExistsAndLoadBean(t, &PullRequest{ID: 1}).(*PullRequest) assert.Equal(t, int64(100), pr.IssueID) assert.Equal(t, "baseBranch", pr.BaseBranch) assert.Equal(t, "headBranch", pr.HeadBranch) @@ -196,12 +179,7 @@ func TestPullRequest_UpdateCols(t *testing.T) { } pr.UpdateCols("issue_id", "head_branch") - sess := x.NewSession() - defer sess.Close() - pr = &PullRequest{ID: 1} - has, err := sess.Get(pr) - assert.NoError(t, err) - assert.True(t, has) + pr = AssertExistsAndLoadBean(t, &PullRequest{ID: 1}).(*PullRequest) assert.Equal(t, int64(100), pr.IssueID) assert.Equal(t, "master", pr.BaseBranch) assert.Equal(t, "headBranch", pr.HeadBranch) @@ -214,14 +192,14 @@ func TestPullRequest_UpdateCols(t *testing.T) { func TestPullRequest_AddToTaskQueue(t *testing.T) { assert.NoError(t, PrepareTestDatabase()) - pr := loadFixturePullRequest(t, 1) + pr := AssertExistsAndLoadBean(t, &PullRequest{ID: 1}).(*PullRequest) pr.AddToTaskQueue() // briefly sleep so that background threads have time to run time.Sleep(time.Millisecond) assert.True(t, pullRequestQueue.Exist(pr.ID)) - pr = loadFixturePullRequest(t, 1) + pr = AssertExistsAndLoadBean(t, &PullRequest{ID: 1}).(*PullRequest) assert.Equal(t, PullRequestStatusChecking, pr.Status) } @@ -229,8 +207,8 @@ func TestPullRequestList_LoadAttributes(t *testing.T) { assert.NoError(t, PrepareTestDatabase()) prs := []*PullRequest{ - loadFixturePullRequest(t, 1), - loadFixturePullRequest(t, 2), + AssertExistsAndLoadBean(t, &PullRequest{ID: 1}).(*PullRequest), + AssertExistsAndLoadBean(t, &PullRequest{ID: 2}).(*PullRequest), } assert.NoError(t, PullRequestList(prs).LoadAttributes()) for _, pr := range prs { diff --git a/models/setup_for_test.go b/models/setup_for_test.go index 7d2176894..e6f86ec68 100644 --- a/models/setup_for_test.go +++ b/models/setup_for_test.go @@ -59,10 +59,11 @@ func loadBeanIfExists(bean interface{}, conditions ...interface{}) (bool, error) // AssertExistsAndLoadBean assert that a bean exists and load it from the test // database -func AssertExistsAndLoadBean(t *testing.T, bean interface{}, conditions ...interface{}) { +func AssertExistsAndLoadBean(t *testing.T, bean interface{}, conditions ...interface{}) interface{} { exists, err := loadBeanIfExists(bean, conditions...) assert.NoError(t, err) assert.True(t, exists) + return bean } // AssertNotExistsBean assert that a bean does not exist in the test database diff --git a/models/token_test.go b/models/token_test.go index 15207ceb6..9674be126 100644 --- a/models/token_test.go +++ b/models/token_test.go @@ -17,13 +17,7 @@ func TestNewAccessToken(t *testing.T) { Name: "Token C", } assert.NoError(t, NewAccessToken(token)) - sess := x.NewSession() - defer sess.Close() - has, err := sess.Get(*token) - assert.NoError(t, err) - assert.True(t, has) - assert.Equal(t, int64(3), token.UID) - assert.Equal(t, "Token C", token.Name) + AssertExistsAndLoadBean(t, token) invalidToken := &AccessToken{ ID: token.ID, // duplicate @@ -78,13 +72,7 @@ func TestUpdateAccessToken(t *testing.T) { token.Name = "Token Z" assert.NoError(t, UpdateAccessToken(token)) - - sess := x.NewSession() - defer sess.Close() - has, err := sess.Get(token) - assert.NoError(t, err) - assert.True(t, has) - assert.Equal(t, token.Name, "Token Z") + AssertExistsAndLoadBean(t, token) } func TestDeleteAccessTokenByID(t *testing.T) { @@ -95,11 +83,7 @@ func TestDeleteAccessTokenByID(t *testing.T) { assert.Equal(t, int64(1), token.UID) assert.NoError(t, DeleteAccessTokenByID(token.ID, 1)) - sess := x.NewSession() - defer sess.Close() - has, err := sess.Get(token) - assert.NoError(t, err) - assert.False(t, has) + AssertNotExistsBean(t, token) err = DeleteAccessTokenByID(100, 100) assert.Error(t, err) diff --git a/models/update_test.go b/models/update_test.go index 6d044c08d..db9d7b94b 100644 --- a/models/update_test.go +++ b/models/update_test.go @@ -23,13 +23,7 @@ func TestAddUpdateTask(t *testing.T) { NewCommitID: "newCommitId4", } assert.NoError(t, AddUpdateTask(task)) - - sess := x.NewSession() - defer sess.Close() - has, err := sess.Get(task) - assert.NoError(t, err) - assert.True(t, has) - assert.Equal(t, "uuid4", task.UUID) + AssertExistsAndLoadBean(t, task) } func TestGetUpdateTaskByUUID(t *testing.T) { @@ -49,11 +43,7 @@ func TestGetUpdateTaskByUUID(t *testing.T) { func TestDeleteUpdateTaskByUUID(t *testing.T) { assert.NoError(t, PrepareTestDatabase()) assert.NoError(t, DeleteUpdateTaskByUUID("uuid1")) - sess := x.NewSession() - defer sess.Close() - has, err := sess.Get(&UpdateTask{UUID: "uuid1"}) - assert.NoError(t, err) - assert.False(t, has) + AssertNotExistsBean(t, &UpdateTask{UUID: "uuid1"}) assert.NoError(t, DeleteUpdateTaskByUUID("invalid")) }