From e4f55ab808d125084f7a7224f7dece9fdc9f5721 Mon Sep 17 00:00:00 2001 From: Christopher Crone Date: Fri, 31 Jul 2020 15:57:00 +0200 Subject: [PATCH] aci: Normalize testing frameworks Signed-off-by: Christopher Crone --- aci/aci_test.go | 2 +- aci/backend_test.go | 48 ++++++---------- aci/context_test.go | 134 +++++++++++++++++++++----------------------- 3 files changed, 81 insertions(+), 103 deletions(-) diff --git a/aci/aci_test.go b/aci/aci_test.go index c9976e468..145bf2802 100644 --- a/aci/aci_test.go +++ b/aci/aci_test.go @@ -3,7 +3,7 @@ package aci import ( "testing" - "github.com/stretchr/testify/assert" + "gotest.tools/v3/assert" ) func TestGetLinesWritten(t *testing.T) { diff --git a/aci/backend_test.go b/aci/backend_test.go index 5b95ce7df..e6b72765c 100644 --- a/aci/backend_test.go +++ b/aci/backend_test.go @@ -22,55 +22,39 @@ import ( "github.com/docker/api/containers" - "github.com/stretchr/testify/suite" - - . "github.com/onsi/gomega" + "gotest.tools/v3/assert" ) -type BackendSuiteTest struct { - suite.Suite -} - -func (suite *BackendSuiteTest) TestGetContainerName() { +func TestGetContainerName(t *testing.T) { group, container := getGroupAndContainerName("docker1234") - Expect(group).To(Equal("docker1234")) - Expect(container).To(Equal("docker1234")) + assert.Equal(t, group, "docker1234") + assert.Equal(t, container, "docker1234") group, container = getGroupAndContainerName("compose_service1") - Expect(group).To(Equal("compose")) - Expect(container).To(Equal("service1")) + assert.Equal(t, group, "compose") + assert.Equal(t, container, "service1") group, container = getGroupAndContainerName("compose_stack_service1") - Expect(group).To(Equal("compose_stack")) - Expect(container).To(Equal("service1")) + assert.Equal(t, group, "compose_stack") + assert.Equal(t, container, "service1") } -func (suite *BackendSuiteTest) TestErrorMessageDeletingContainerFromComposeApplication() { +func TestErrorMessageDeletingContainerFromComposeApplication(t *testing.T) { service := aciContainerService{} err := service.Delete(context.TODO(), "compose-app_service1", false) - - Expect(err).NotTo(BeNil()) - Expect(err.Error()).To(Equal("cannot delete service \"service1\" from compose application \"compose-app\", you can delete the entire compose app with docker compose down --project-name compose-app")) + assert.Error(t, err, "cannot delete service \"service1\" from compose application \"compose-app\", you can delete the entire compose app with docker compose down --project-name compose-app") } -func (suite *BackendSuiteTest) TestErrorMessageRunSingleContainerNameWithComposeSeparator() { +func TestErrorMessageRunSingleContainerNameWithComposeSeparator(t *testing.T) { service := aciContainerService{} err := service.Run(context.TODO(), containers.ContainerConfig{ID: "container_name"}) - - Expect(err).NotTo(BeNil()) - Expect(err.Error()).To(Equal("invalid container name. ACI container name cannot include \"_\"")) + assert.Error(t, err, "invalid container name. ACI container name cannot include \"_\"") } -func (suite *BackendSuiteTest) TestVerifyCommand() { +func TestVerifyCommand(t *testing.T) { err := verifyExecCommand("command") // Command without an argument - Expect(err).To(BeNil()) + assert.NilError(t, err) err = verifyExecCommand("command argument") // Command with argument - Expect(err).NotTo(BeNil()) - Expect(err.Error()).To(Equal("ACI exec command does not accept arguments to the command. " + - "Only the binary should be specified")) -} - -func TestBackendSuite(t *testing.T) { - RegisterTestingT(t) - suite.Run(t, new(BackendSuiteTest)) + assert.Error(t, err, "ACI exec command does not accept arguments to the command. "+ + "Only the binary should be specified") } diff --git a/aci/context_test.go b/aci/context_test.go index 7da6f876b..1ee90259a 100644 --- a/aci/context_test.go +++ b/aci/context_test.go @@ -25,132 +25,131 @@ import ( "github.com/Azure/go-autorest/autorest/to" "github.com/pkg/errors" "github.com/stretchr/testify/mock" - "github.com/stretchr/testify/suite" + "gotest.tools/v3/assert" + "gotest.tools/v3/assert/cmp" "github.com/docker/api/context/store" - - . "github.com/onsi/gomega" ) -type ContextSuiteTest struct { - suite.Suite - mockUserPrompt *mockUserPrompt - mockResourceGroupHeper *MockResourceGroupHelper - contextCreateHelper contextCreateACIHelper +type contextMocks struct { + userPrompt *mockUserPrompt + resourceGroupHelper *MockResourceGroupHelper + contextCreateHelper contextCreateACIHelper } -func (suite *ContextSuiteTest) BeforeTest(suiteName, testName string) { - suite.mockUserPrompt = &mockUserPrompt{} - suite.mockResourceGroupHeper = &MockResourceGroupHelper{} - suite.contextCreateHelper = contextCreateACIHelper{ - suite.mockUserPrompt, - suite.mockResourceGroupHeper, +func testContextMocks() contextMocks { + mockUserPrompt := &mockUserPrompt{} + mockResourceGroupHelper := &MockResourceGroupHelper{} + contextCreateHelper := contextCreateACIHelper{ + mockUserPrompt, + mockResourceGroupHelper, } + return contextMocks{mockUserPrompt, mockResourceGroupHelper, contextCreateHelper} } -func (suite *ContextSuiteTest) TestCreateSpecifiedSubscriptionAndGroup() { +func TestCreateSpecifiedSubscriptionAndGroup(t *testing.T) { ctx := context.TODO() opts := options("1234", "myResourceGroup") - suite.mockResourceGroupHeper.On("GetGroup", ctx, "1234", "myResourceGroup").Return(group("myResourceGroup", "eastus"), nil) + m := testContextMocks() + m.resourceGroupHelper.On("GetGroup", ctx, "1234", "myResourceGroup").Return(group("myResourceGroup", "eastus"), nil) - data, description, err := suite.contextCreateHelper.createContextData(ctx, opts) - - Expect(err).To(BeNil()) - Expect(description).To(Equal("myResourceGroup@eastus")) - Expect(data).To(Equal(aciContext("1234", "myResourceGroup", "eastus"))) + data, description, err := m.contextCreateHelper.createContextData(ctx, opts) + assert.NilError(t, err) + assert.Equal(t, description, "myResourceGroup@eastus") + assert.DeepEqual(t, data, aciContext("1234", "myResourceGroup", "eastus")) } -func (suite *ContextSuiteTest) TestErrorOnNonExistentResourceGroup() { +func TestErrorOnNonExistentResourceGroup(t *testing.T) { ctx := context.TODO() opts := options("1234", "myResourceGroup") notFoundError := errors.New(`Not Found: "myResourceGroup"`) - suite.mockResourceGroupHeper.On("GetGroup", ctx, "1234", "myResourceGroup").Return(resources.Group{}, notFoundError) + m := testContextMocks() + m.resourceGroupHelper.On("GetGroup", ctx, "1234", "myResourceGroup").Return(resources.Group{}, notFoundError) - data, description, err := suite.contextCreateHelper.createContextData(ctx, opts) - - Expect(data).To(BeNil()) - Expect(description).To(Equal("")) - Expect(err.Error()).To(Equal("Could not find resource group \"myResourceGroup\": Not Found: \"myResourceGroup\"")) + data, description, err := m.contextCreateHelper.createContextData(ctx, opts) + assert.Assert(t, cmp.Nil(data)) + assert.Equal(t, description, "") + assert.Error(t, err, "Could not find resource group \"myResourceGroup\": Not Found: \"myResourceGroup\"") } -func (suite *ContextSuiteTest) TestCreateNewResourceGroup() { +func TestCreateNewResourceGroup(t *testing.T) { ctx := context.TODO() opts := options("1234", "") - suite.mockResourceGroupHeper.On("GetGroup", ctx, "1234", "myResourceGroup").Return(group("myResourceGroup", "eastus"), nil) + m := testContextMocks() + m.resourceGroupHelper.On("GetGroup", ctx, "1234", "myResourceGroup").Return(group("myResourceGroup", "eastus"), nil) selectOptions := []string{"create a new resource group", "group1 (eastus)", "group2 (westeurope)"} - suite.mockUserPrompt.On("Select", "Select a resource group", selectOptions).Return(0, nil) - suite.mockResourceGroupHeper.On("CreateOrUpdate", ctx, "1234", mock.AnythingOfType("string"), mock.AnythingOfType("resources.Group")).Return(group("newResourceGroup", "eastus"), nil) - suite.mockResourceGroupHeper.On("ListGroups", ctx, "1234").Return([]resources.Group{ + m.userPrompt.On("Select", "Select a resource group", selectOptions).Return(0, nil) + m.resourceGroupHelper.On("CreateOrUpdate", ctx, "1234", mock.AnythingOfType("string"), mock.AnythingOfType("resources.Group")).Return(group("newResourceGroup", "eastus"), nil) + m.resourceGroupHelper.On("ListGroups", ctx, "1234").Return([]resources.Group{ group("group1", "eastus"), group("group2", "westeurope"), }, nil) - data, description, err := suite.contextCreateHelper.createContextData(ctx, opts) - - Expect(err).To(BeNil()) - Expect(description).To(Equal("newResourceGroup@eastus")) - Expect(data).To(Equal(aciContext("1234", "newResourceGroup", "eastus"))) + data, description, err := m.contextCreateHelper.createContextData(ctx, opts) + assert.NilError(t, err) + assert.Equal(t, description, "newResourceGroup@eastus") + assert.DeepEqual(t, data, aciContext("1234", "newResourceGroup", "eastus")) } -func (suite *ContextSuiteTest) TestSelectExistingResourceGroup() { +func TestSelectExistingResourceGroup(t *testing.T) { ctx := context.TODO() opts := options("1234", "") selectOptions := []string{"create a new resource group", "group1 (eastus)", "group2 (westeurope)"} - suite.mockUserPrompt.On("Select", "Select a resource group", selectOptions).Return(2, nil) - suite.mockResourceGroupHeper.On("ListGroups", ctx, "1234").Return([]resources.Group{ + m := testContextMocks() + m.userPrompt.On("Select", "Select a resource group", selectOptions).Return(2, nil) + m.resourceGroupHelper.On("ListGroups", ctx, "1234").Return([]resources.Group{ group("group1", "eastus"), group("group2", "westeurope"), }, nil) - data, description, err := suite.contextCreateHelper.createContextData(ctx, opts) - - Expect(err).To(BeNil()) - Expect(description).To(Equal("group2@westeurope")) - Expect(data).To(Equal(aciContext("1234", "group2", "westeurope"))) + data, description, err := m.contextCreateHelper.createContextData(ctx, opts) + assert.NilError(t, err) + assert.Equal(t, description, "group2@westeurope") + assert.DeepEqual(t, data, aciContext("1234", "group2", "westeurope")) } -func (suite *ContextSuiteTest) TestSelectSingleSubscriptionIdAndExistingResourceGroup() { +func TestSelectSingleSubscriptionIdAndExistingResourceGroup(t *testing.T) { ctx := context.TODO() opts := options("", "") - suite.mockResourceGroupHeper.On("GetSubscriptionIDs", ctx).Return([]subscription.Model{subModel("123456", "Subscription1")}, nil) + m := testContextMocks() + m.resourceGroupHelper.On("GetSubscriptionIDs", ctx).Return([]subscription.Model{subModel("123456", "Subscription1")}, nil) selectOptions := []string{"create a new resource group", "group1 (eastus)", "group2 (westeurope)"} - suite.mockUserPrompt.On("Select", "Select a resource group", selectOptions).Return(2, nil) - suite.mockResourceGroupHeper.On("ListGroups", ctx, "123456").Return([]resources.Group{ + m.userPrompt.On("Select", "Select a resource group", selectOptions).Return(2, nil) + m.resourceGroupHelper.On("ListGroups", ctx, "123456").Return([]resources.Group{ group("group1", "eastus"), group("group2", "westeurope"), }, nil) - data, description, err := suite.contextCreateHelper.createContextData(ctx, opts) - - Expect(err).To(BeNil()) - Expect(description).To(Equal("group2@westeurope")) - Expect(data).To(Equal(aciContext("123456", "group2", "westeurope"))) + data, description, err := m.contextCreateHelper.createContextData(ctx, opts) + assert.NilError(t, err) + assert.Equal(t, description, "group2@westeurope") + assert.DeepEqual(t, data, aciContext("123456", "group2", "westeurope")) } -func (suite *ContextSuiteTest) TestSelectSubscriptionIdAndExistingResourceGroup() { +func TestSelectSubscriptionIdAndExistingResourceGroup(t *testing.T) { ctx := context.TODO() opts := options("", "") sub1 := subModel("1234", "Subscription1") sub2 := subModel("5678", "Subscription2") - suite.mockResourceGroupHeper.On("GetSubscriptionIDs", ctx).Return([]subscription.Model{sub1, sub2}, nil) + m := testContextMocks() + m.resourceGroupHelper.On("GetSubscriptionIDs", ctx).Return([]subscription.Model{sub1, sub2}, nil) selectOptions := []string{"Subscription1 (1234)", "Subscription2 (5678)"} - suite.mockUserPrompt.On("Select", "Select a subscription ID", selectOptions).Return(1, nil) + m.userPrompt.On("Select", "Select a subscription ID", selectOptions).Return(1, nil) selectOptions = []string{"create a new resource group", "group1 (eastus)", "group2 (westeurope)"} - suite.mockUserPrompt.On("Select", "Select a resource group", selectOptions).Return(2, nil) - suite.mockResourceGroupHeper.On("ListGroups", ctx, "5678").Return([]resources.Group{ + m.userPrompt.On("Select", "Select a resource group", selectOptions).Return(2, nil) + m.resourceGroupHelper.On("ListGroups", ctx, "5678").Return([]resources.Group{ group("group1", "eastus"), group("group2", "westeurope"), }, nil) - data, description, err := suite.contextCreateHelper.createContextData(ctx, opts) - - Expect(err).To(BeNil()) - Expect(description).To(Equal("group2@westeurope")) - Expect(data).To(Equal(aciContext("5678", "group2", "westeurope"))) + data, description, err := m.contextCreateHelper.createContextData(ctx, opts) + assert.NilError(t, err) + assert.Equal(t, description, "group2@westeurope") + assert.DeepEqual(t, data, aciContext("5678", "group2", "westeurope")) } func subModel(subID string, display string) subscription.Model { @@ -183,11 +182,6 @@ func options(subscriptionID string, resourceGroupName string) ContextParams { } } -func TestContextSuite(t *testing.T) { - RegisterTestingT(t) - suite.Run(t, new(ContextSuiteTest)) -} - type mockUserPrompt struct { mock.Mock }