Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use assert and require in a more idiomatic way in our tests #634

Merged
merged 1 commit into from
Nov 21, 2023
Merged

Use assert and require in a more idiomatic way in our tests #634

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 12 additions & 16 deletions tests/integration/golang/admin/namespace/create_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ import (
"testing"

"github.com/PuerkitoBio/goquery"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"

"github.com/G-Research/fasttrackml/pkg/api/mlflow/common"
Expand All @@ -28,14 +26,14 @@ func TestCreateNamespaceTestSuite(t *testing.T) {

func (s *CreateNamespaceTestSuite) Test_Ok() {
defer func() {
require.Nil(s.T(), s.NamespaceFixtures.UnloadFixtures())
s.Require().Nil(s.NamespaceFixtures.UnloadFixtures())
}()
_, err := s.NamespaceFixtures.CreateNamespace(context.Background(), &models.Namespace{
ID: 1,
Code: "default",
DefaultExperimentID: common.GetPointer(int32(0)),
})
require.Nil(s.T(), err)
s.Require().Nil(err)

requests := []request.Namespace{
{
Expand All @@ -48,8 +46,7 @@ func (s *CreateNamespaceTestSuite) Test_Ok() {
},
}
for _, request := range requests {
require.Nil(
s.T(),
s.Require().Nil(
s.AdminClient().WithMethod(
http.MethodPost,
).WithRequest(
Expand All @@ -59,23 +56,23 @@ func (s *CreateNamespaceTestSuite) Test_Ok() {
}

namespaces, err := s.NamespaceFixtures.GetNamespaces(context.Background())
require.Nil(s.T(), err)
assert.True(s.T(), helpers.CheckNamespaces(namespaces, requests))
s.Require().Nil(err)
s.True(helpers.CheckNamespaces(namespaces, requests))

// Check the length of the namespaces considering the default namespace
assert.Equal(s.T(), len(requests)+1, len(namespaces))
s.Equal(len(requests)+1, len(namespaces))
}

func (s *CreateNamespaceTestSuite) Test_Error() {
defer func() {
require.Nil(s.T(), s.NamespaceFixtures.UnloadFixtures())
s.Require().Nil(s.NamespaceFixtures.UnloadFixtures())
}()
_, err := s.NamespaceFixtures.CreateNamespace(context.Background(), &models.Namespace{
ID: 1,
Code: "default",
DefaultExperimentID: common.GetPointer(int32(0)),
})
require.Nil(s.T(), err)
s.Require().Nil(err)

testData := []struct {
name string
Expand Down Expand Up @@ -126,8 +123,7 @@ func (s *CreateNamespaceTestSuite) Test_Error() {
for _, tt := range testData {
s.Run(tt.name, func() {
var resp goquery.Document
require.Nil(
s.T(),
s.Require().Nil(
s.AdminClient().WithMethod(
http.MethodPost,
).WithRequest(
Expand All @@ -140,13 +136,13 @@ func (s *CreateNamespaceTestSuite) Test_Error() {
)

msg := resp.Find(".error-message").Text()
assert.Equal(s.T(), tt.error, msg)
s.Equal(tt.error, msg)

namespaces, err := s.NamespaceFixtures.GetNamespaces(context.Background())
require.Nil(s.T(), err)
s.Require().Nil(err)

// Check that creation failed, only the default namespace is present
assert.Equal(s.T(), 1, len(namespaces))
s.Equal(1, len(namespaces))
})
}
}
32 changes: 14 additions & 18 deletions tests/integration/golang/admin/namespace/delete_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ import (
"net/http"
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"

"github.com/G-Research/fasttrackml/pkg/api/mlflow/common"
Expand All @@ -26,28 +24,28 @@ func TestDeleteNamespaceTestSuite(t *testing.T) {

func (s *DeleteNamespaceTestSuite) Test_Ok() {
defer func() {
require.Nil(s.T(), s.NamespaceFixtures.UnloadFixtures())
s.Require().Nil(s.NamespaceFixtures.UnloadFixtures())
}()
_, err := s.NamespaceFixtures.CreateNamespace(context.Background(), &models.Namespace{
ID: 1,
Code: "default",
DefaultExperimentID: common.GetPointer(int32(0)),
})
require.Nil(s.T(), err)
s.Require().Nil(err)
_, err = s.NamespaceFixtures.CreateNamespace(context.Background(), &models.Namespace{
ID: 2,
Code: "test2",
Description: "test namespace 2 description",
DefaultExperimentID: common.GetPointer(int32(0)),
})
require.Nil(s.T(), err)
s.Require().Nil(err)
ns2, err := s.NamespaceFixtures.CreateNamespace(context.Background(), &models.Namespace{
ID: 3,
Code: "test3",
Description: "test namespace 3 description",
DefaultExperimentID: common.GetPointer(int32(0)),
})
require.Nil(s.T(), err)
s.Require().Nil(err)

tests := []struct {
name string
Expand All @@ -60,38 +58,37 @@ func (s *DeleteNamespaceTestSuite) Test_Ok() {
}
for _, tt := range tests {
s.Run(tt.name, func() {
require.Nil(
s.T(),
s.Require().Nil(
s.AdminClient().WithMethod(
http.MethodDelete,
).DoRequest(
"/namespaces/%d", ns2.ID,
),
)
namespaces, err := s.NamespaceFixtures.GetNamespaces(context.Background())
require.Nil(s.T(), err)
assert.Equal(s.T(), tt.expectedNamespaceCount, len(namespaces))
s.Require().Nil(err)
s.Equal(tt.expectedNamespaceCount, len(namespaces))
})
}
}

func (s *DeleteNamespaceTestSuite) Test_Error() {
defer func() {
require.Nil(s.T(), s.NamespaceFixtures.UnloadFixtures())
s.Require().Nil(s.NamespaceFixtures.UnloadFixtures())
}()
_, err := s.NamespaceFixtures.CreateNamespace(context.Background(), &models.Namespace{
ID: 1,
Code: "default",
DefaultExperimentID: common.GetPointer(int32(0)),
})
require.Nil(s.T(), err)
s.Require().Nil(err)
_, err = s.NamespaceFixtures.CreateNamespace(context.Background(), &models.Namespace{
ID: 2,
Code: "test2",
Description: "test namespace 2 description",
DefaultExperimentID: common.GetPointer(int32(0)),
})
require.Nil(s.T(), err)
s.Require().Nil(err)

testData := []struct {
name string
Expand All @@ -112,8 +109,7 @@ func (s *DeleteNamespaceTestSuite) Test_Error() {
for _, tt := range testData {
s.Run(tt.name, func() {
var resp any
require.Nil(
s.T(),
s.Require().Nil(
s.AdminClient().WithMethod(
http.MethodDelete,
).WithResponse(
Expand All @@ -122,11 +118,11 @@ func (s *DeleteNamespaceTestSuite) Test_Error() {
"/namespaces/%s", tt.ID,
),
)
assert.Equal(s.T(), resp, tt.response)
s.Equal(resp, tt.response)
})
namespaces, err := s.NamespaceFixtures.GetNamespaces(context.Background())
require.Nil(s.T(), err)
s.Require().Nil(err)
// Check that deletion failed and the namespace is still there
assert.Equal(s.T(), tt.expectedNamespacesCount, len(namespaces))
s.Equal(tt.expectedNamespacesCount, len(namespaces))
}
}
34 changes: 15 additions & 19 deletions tests/integration/golang/admin/namespace/update_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ import (
"net/http"
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"

"github.com/G-Research/fasttrackml/pkg/api/mlflow/common"
Expand All @@ -27,28 +25,27 @@ func TestUpdateNamespaceTestSuite(t *testing.T) {

func (s *UpdateNamespaceTestSuite) Test_Ok() {
defer func() {
require.Nil(s.T(), s.NamespaceFixtures.UnloadFixtures())
s.Require().Nil(s.NamespaceFixtures.UnloadFixtures())
}()
_, err := s.NamespaceFixtures.CreateNamespace(context.Background(), &models.Namespace{
ID: 1,
Code: "default",
DefaultExperimentID: common.GetPointer(int32(0)),
})
require.Nil(s.T(), err)
s.Require().Nil(err)
ns, err := s.NamespaceFixtures.CreateNamespace(context.Background(), &models.Namespace{
ID: 2,
Code: "test2",
Description: "test namespace 2 description",
DefaultExperimentID: common.GetPointer(int32(0)),
})
require.Nil(s.T(), err)
s.Require().Nil(err)

request := request.Namespace{
Code: "test2Updated",
Description: "test namespace 2 description updated",
}
require.Nil(
s.T(),
s.Require().Nil(
s.AdminClient().WithMethod(
http.MethodPut,
).WithRequest(
Expand All @@ -57,31 +54,31 @@ func (s *UpdateNamespaceTestSuite) Test_Ok() {
)

namespace, err := s.NamespaceFixtures.GetNamespaceByID(context.Background(), ns.ID)
require.Nil(s.T(), err)
s.Require().Nil(err)

assert.Equal(s.T(), namespace.Code, request.Code)
assert.Equal(s.T(), namespace.Description, request.Description)
s.Equal(namespace.Code, request.Code)
s.Equal(namespace.Description, request.Description)
}

func (s *UpdateNamespaceTestSuite) Test_Error() {
defer func() {
require.Nil(s.T(), s.NamespaceFixtures.UnloadFixtures())
s.Require().Nil(s.NamespaceFixtures.UnloadFixtures())
}()
_, err := s.NamespaceFixtures.CreateNamespace(context.Background(), &models.Namespace{
ID: 1,
Code: "default",
DefaultExperimentID: common.GetPointer(int32(0)),
})
require.Nil(s.T(), err)
s.Require().Nil(err)
_, err = s.NamespaceFixtures.CreateNamespace(context.Background(), &models.Namespace{
ID: 2,
Code: "test2",
Description: "test namespace 2 description",
DefaultExperimentID: common.GetPointer(int32(0)),
})
require.Nil(s.T(), err)
s.Require().Nil(err)
expectedNamespaces, err := s.NamespaceFixtures.GetNamespaces(context.Background())
require.Nil(s.T(), err)
s.Require().Nil(err)

testData := []struct {
name string
Expand Down Expand Up @@ -129,8 +126,7 @@ func (s *UpdateNamespaceTestSuite) Test_Error() {
for _, tt := range testData {
s.Run(tt.name, func() {
var resp any
require.Nil(
s.T(),
s.Require().Nil(
s.AdminClient().WithMethod(
http.MethodPut,
).WithRequest(
Expand All @@ -141,10 +137,10 @@ func (s *UpdateNamespaceTestSuite) Test_Error() {
"/namespaces/%s", tt.ID,
),
)
assert.Equal(s.T(), resp, tt.response)
s.Equal(resp, tt.response)
})
actualNamespaces, err := s.NamespaceFixtures.GetNamespaces(context.Background())
require.Nil(s.T(), err)
assert.Equal(s.T(), expectedNamespaces, actualNamespaces)
s.Require().Nil(err)
s.Equal(expectedNamespaces, actualNamespaces)
}
}
28 changes: 12 additions & 16 deletions tests/integration/golang/aim/app/create_app_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ import (
"net/http"
"testing"

"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"

"github.com/G-Research/fasttrackml/pkg/api/aim/request"
Expand All @@ -28,15 +26,15 @@ func TestCreateAppTestSuite(t *testing.T) {

func (s *CreateAppTestSuite) Test_Ok() {
defer func() {
require.Nil(s.T(), s.NamespaceFixtures.UnloadFixtures())
s.Require().Nil(s.NamespaceFixtures.UnloadFixtures())
}()

_, err := s.NamespaceFixtures.CreateNamespace(context.Background(), &models.Namespace{
ID: 1,
Code: "default",
DefaultExperimentID: common.GetPointer(int32(0)),
})
require.Nil(s.T(), err)
s.Require().Nil(err)

tests := []struct {
name string
Expand All @@ -55,8 +53,7 @@ func (s *CreateAppTestSuite) Test_Ok() {
for _, tt := range tests {
s.Run(tt.name, func() {
var resp response.App
require.Nil(
s.T(),
s.Require().Nil(
s.AIMClient().WithMethod(
http.MethodPost,
).WithRequest(
Expand All @@ -67,26 +64,26 @@ func (s *CreateAppTestSuite) Test_Ok() {
"/apps",
),
)
assert.Equal(s.T(), tt.requestBody.Type, resp.Type)
assert.Equal(s.T(), tt.requestBody.State["app-state-key"], resp.State["app-state-key"])
assert.NotEmpty(s.T(), resp.ID)
assert.NotEmpty(s.T(), resp.CreatedAt)
assert.NotEmpty(s.T(), resp.UpdatedAt)
s.Equal(tt.requestBody.Type, resp.Type)
s.Equal(tt.requestBody.State["app-state-key"], resp.State["app-state-key"])
s.NotEmpty(resp.ID)
s.NotEmpty(resp.CreatedAt)
s.NotEmpty(resp.UpdatedAt)
})
}
}

func (s *CreateAppTestSuite) Test_Error() {
defer func() {
require.Nil(s.T(), s.NamespaceFixtures.UnloadFixtures())
s.Require().Nil(s.NamespaceFixtures.UnloadFixtures())
}()

_, err := s.NamespaceFixtures.CreateNamespace(context.Background(), &models.Namespace{
ID: 1,
Code: "default",
DefaultExperimentID: common.GetPointer(int32(0)),
})
require.Nil(s.T(), err)
s.Require().Nil(err)

tests := []struct {
name string
Expand All @@ -102,8 +99,7 @@ func (s *CreateAppTestSuite) Test_Error() {
for _, tt := range tests {
s.Run(tt.name, func() {
var resp response.Error
require.Nil(
s.T(),
s.Require().Nil(
s.AIMClient().WithMethod(
http.MethodPost,
).WithRequest(
Expand All @@ -112,7 +108,7 @@ func (s *CreateAppTestSuite) Test_Error() {
&resp,
).DoRequest("/apps"),
)
assert.Contains(s.T(), resp.Message, "cannot unmarshal")
s.Contains(resp.Message, "cannot unmarshal")
})
}
}
Loading