Skip to content

Commit 365ebfb

Browse files
test: Simplify Projects v2 tests with cmp.Diff
Replace the hand-written field-by-field assertions in the new draft, field, view and view-item method tests with a single cmp.Diff against a fully-populated want struct, which also verifies every decoded field.
1 parent e5df91b commit 365ebfb

1 file changed

Lines changed: 34 additions & 30 deletions

File tree

‎github/projects_test.go‎

Lines changed: 34 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ import (
1111
"fmt"
1212
"net/http"
1313
"testing"
14+
15+
"github.com/google/go-cmp/cmp"
1416
)
1517

1618
func TestProjectsService_ListOrganizationProjects(t *testing.T) {
@@ -1519,8 +1521,9 @@ func TestProjectsService_CreateOrganizationProjectDraftItem(t *testing.T) {
15191521
if err != nil {
15201522
t.Fatalf("Projects.CreateOrganizationProjectDraftItem returned error: %v", err)
15211523
}
1522-
if item.GetID() != 42 {
1523-
t.Fatalf("unexpected item: %+v", item)
1524+
want := &ProjectV2Item{ID: Ptr(int64(42)), NodeID: Ptr("PVTI_draft"), ContentType: Ptr(ProjectV2ItemContentTypeDraftIssue)}
1525+
if diff := cmp.Diff(want, item); diff != "" {
1526+
t.Errorf("Projects.CreateOrganizationProjectDraftItem mismatch (-want +got):\n%v", diff)
15241527
}
15251528

15261529
const methodName = "CreateOrganizationProjectDraftItem"
@@ -1554,8 +1557,9 @@ func TestProjectsService_CreateUserProjectDraftItem(t *testing.T) {
15541557
if err != nil {
15551558
t.Fatalf("Projects.CreateUserProjectDraftItem returned error: %v", err)
15561559
}
1557-
if item.GetID() != 43 {
1558-
t.Fatalf("unexpected item: %+v", item)
1560+
want := &ProjectV2Item{ID: Ptr(int64(43)), NodeID: Ptr("PVTI_draft_u"), ContentType: Ptr(ProjectV2ItemContentTypeDraftIssue)}
1561+
if diff := cmp.Diff(want, item); diff != "" {
1562+
t.Errorf("Projects.CreateUserProjectDraftItem mismatch (-want +got):\n%v", diff)
15591563
}
15601564

15611565
const methodName = "CreateUserProjectDraftItem"
@@ -1592,8 +1596,9 @@ func TestProjectsService_AddOrganizationProjectField(t *testing.T) {
15921596
if err != nil {
15931597
t.Fatalf("Projects.AddOrganizationProjectField returned error: %v", err)
15941598
}
1595-
if field.GetID() != 7 || field.GetDataType() != "single_select" {
1596-
t.Fatalf("unexpected field: %+v", field)
1599+
want := &ProjectV2Field{ID: Ptr(int64(7)), Name: Ptr("Priority"), DataType: Ptr("single_select")}
1600+
if diff := cmp.Diff(want, field); diff != "" {
1601+
t.Errorf("Projects.AddOrganizationProjectField mismatch (-want +got):\n%v", diff)
15971602
}
15981603

15991604
const methodName = "AddOrganizationProjectField"
@@ -1637,8 +1642,9 @@ func TestProjectsService_AddUserProjectField(t *testing.T) {
16371642
if err != nil {
16381643
t.Fatalf("Projects.AddUserProjectField returned error: %v", err)
16391644
}
1640-
if field.GetID() != 8 {
1641-
t.Fatalf("unexpected field: %+v", field)
1645+
want := &ProjectV2Field{ID: Ptr(int64(8)), Name: Ptr("Sprint"), DataType: Ptr("iteration")}
1646+
if diff := cmp.Diff(want, field); diff != "" {
1647+
t.Errorf("Projects.AddUserProjectField mismatch (-want +got):\n%v", diff)
16421648
}
16431649

16441650
const methodName = "AddUserProjectField"
@@ -1679,23 +1685,18 @@ func TestProjectsService_CreateOrganizationProjectView(t *testing.T) {
16791685
if err != nil {
16801686
t.Fatalf("Projects.CreateOrganizationProjectView returned error: %v", err)
16811687
}
1682-
if view.GetID() != 5 || view.GetNumber() != 2 || view.GetLayout() != "board" {
1683-
t.Fatalf("unexpected view: %+v", view)
1684-
}
1685-
if len(view.SortBy) != 2 {
1686-
t.Fatalf("unexpected sort_by: %+v", view.SortBy)
1687-
}
1688-
if got, want := view.SortBy[0].GetFieldID(), int64(9007199254740993); got != want {
1689-
t.Errorf("view.SortBy[0].FieldID = %v, want %v", got, want)
1690-
}
1691-
if got, want := view.SortBy[0].GetDirection(), "asc"; got != want {
1692-
t.Errorf("view.SortBy[0].Direction = %q, want %q", got, want)
1693-
}
1694-
if got, want := view.SortBy[1].GetFieldID(), int64(456); got != want {
1695-
t.Errorf("view.SortBy[1].FieldID = %v, want %v", got, want)
1688+
want := &ProjectV2View{
1689+
ID: Ptr(int64(5)),
1690+
Number: Ptr(2),
1691+
Name: Ptr("My board"),
1692+
Layout: Ptr("board"),
1693+
SortBy: []*ProjectV2ViewSortBy{
1694+
{FieldID: Ptr(int64(9007199254740993)), Direction: Ptr("asc")},
1695+
{FieldID: Ptr(int64(456)), Direction: Ptr("desc")},
1696+
},
16961697
}
1697-
if got, want := view.SortBy[1].GetDirection(), "desc"; got != want {
1698-
t.Errorf("view.SortBy[1].Direction = %q, want %q", got, want)
1698+
if diff := cmp.Diff(want, view); diff != "" {
1699+
t.Errorf("Projects.CreateOrganizationProjectView mismatch (-want +got):\n%v", diff)
16991700
}
17001701

17011702
const methodName = "CreateOrganizationProjectView"
@@ -1729,8 +1730,9 @@ func TestProjectsService_CreateUserProjectView(t *testing.T) {
17291730
if err != nil {
17301731
t.Fatalf("Projects.CreateUserProjectView returned error: %v", err)
17311732
}
1732-
if view.GetID() != 6 || view.GetLayout() != "table" {
1733-
t.Fatalf("unexpected view: %+v", view)
1733+
want := &ProjectV2View{ID: Ptr(int64(6)), Number: Ptr(3), Name: Ptr("My table"), Layout: Ptr("table")}
1734+
if diff := cmp.Diff(want, view); diff != "" {
1735+
t.Errorf("Projects.CreateUserProjectView mismatch (-want +got):\n%v", diff)
17341736
}
17351737

17361738
const methodName = "CreateUserProjectView"
@@ -1759,8 +1761,9 @@ func TestProjectsService_ListOrganizationProjectViewItems(t *testing.T) {
17591761
if err != nil {
17601762
t.Fatalf("Projects.ListOrganizationProjectViewItems returned error: %v", err)
17611763
}
1762-
if len(items) != 1 || items[0].GetID() != 21 {
1763-
t.Fatalf("Projects.ListOrganizationProjectViewItems returned %+v", items)
1764+
want := []*ProjectV2Item{{ID: Ptr(int64(21)), NodeID: Ptr("PVTI_view_item")}}
1765+
if diff := cmp.Diff(want, items); diff != "" {
1766+
t.Errorf("Projects.ListOrganizationProjectViewItems mismatch (-want +got):\n%v", diff)
17641767
}
17651768

17661769
const methodName = "ListOrganizationProjectViewItems"
@@ -1793,8 +1796,9 @@ func TestProjectsService_ListUserProjectViewItems(t *testing.T) {
17931796
if err != nil {
17941797
t.Fatalf("Projects.ListUserProjectViewItems returned error: %v", err)
17951798
}
1796-
if len(items) != 1 || items[0].GetID() != 22 {
1797-
t.Fatalf("Projects.ListUserProjectViewItems returned %+v", items)
1799+
want := []*ProjectV2Item{{ID: Ptr(int64(22)), NodeID: Ptr("PVTI_view_item_u")}}
1800+
if diff := cmp.Diff(want, items); diff != "" {
1801+
t.Errorf("Projects.ListUserProjectViewItems mismatch (-want +got):\n%v", diff)
17981802
}
17991803

18001804
const methodName = "ListUserProjectViewItems"

0 commit comments

Comments
 (0)