aci: Normalize testing frameworks

Signed-off-by: Christopher Crone <christopher.crone@docker.com>
This commit is contained in:
Christopher Crone 2020-07-31 15:57:00 +02:00 committed by Chris Crone
parent 6412b9f638
commit e4f55ab808
3 changed files with 81 additions and 103 deletions

View File

@ -3,7 +3,7 @@ package aci
import ( import (
"testing" "testing"
"github.com/stretchr/testify/assert" "gotest.tools/v3/assert"
) )
func TestGetLinesWritten(t *testing.T) { func TestGetLinesWritten(t *testing.T) {

View File

@ -22,55 +22,39 @@ import (
"github.com/docker/api/containers" "github.com/docker/api/containers"
"github.com/stretchr/testify/suite" "gotest.tools/v3/assert"
. "github.com/onsi/gomega"
) )
type BackendSuiteTest struct { func TestGetContainerName(t *testing.T) {
suite.Suite
}
func (suite *BackendSuiteTest) TestGetContainerName() {
group, container := getGroupAndContainerName("docker1234") group, container := getGroupAndContainerName("docker1234")
Expect(group).To(Equal("docker1234")) assert.Equal(t, group, "docker1234")
Expect(container).To(Equal("docker1234")) assert.Equal(t, container, "docker1234")
group, container = getGroupAndContainerName("compose_service1") group, container = getGroupAndContainerName("compose_service1")
Expect(group).To(Equal("compose")) assert.Equal(t, group, "compose")
Expect(container).To(Equal("service1")) assert.Equal(t, container, "service1")
group, container = getGroupAndContainerName("compose_stack_service1") group, container = getGroupAndContainerName("compose_stack_service1")
Expect(group).To(Equal("compose_stack")) assert.Equal(t, group, "compose_stack")
Expect(container).To(Equal("service1")) assert.Equal(t, container, "service1")
} }
func (suite *BackendSuiteTest) TestErrorMessageDeletingContainerFromComposeApplication() { func TestErrorMessageDeletingContainerFromComposeApplication(t *testing.T) {
service := aciContainerService{} service := aciContainerService{}
err := service.Delete(context.TODO(), "compose-app_service1", false) err := service.Delete(context.TODO(), "compose-app_service1", false)
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")
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"))
} }
func (suite *BackendSuiteTest) TestErrorMessageRunSingleContainerNameWithComposeSeparator() { func TestErrorMessageRunSingleContainerNameWithComposeSeparator(t *testing.T) {
service := aciContainerService{} service := aciContainerService{}
err := service.Run(context.TODO(), containers.ContainerConfig{ID: "container_name"}) err := service.Run(context.TODO(), containers.ContainerConfig{ID: "container_name"})
assert.Error(t, err, "invalid container name. ACI container name cannot include \"_\"")
Expect(err).NotTo(BeNil())
Expect(err.Error()).To(Equal("invalid container name. ACI container name cannot include \"_\""))
} }
func (suite *BackendSuiteTest) TestVerifyCommand() { func TestVerifyCommand(t *testing.T) {
err := verifyExecCommand("command") // Command without an argument err := verifyExecCommand("command") // Command without an argument
Expect(err).To(BeNil()) assert.NilError(t, err)
err = verifyExecCommand("command argument") // Command with argument err = verifyExecCommand("command argument") // Command with argument
Expect(err).NotTo(BeNil()) assert.Error(t, err, "ACI exec command does not accept arguments to the command. "+
Expect(err.Error()).To(Equal("ACI exec command does not accept arguments to the command. " + "Only the binary should be specified")
"Only the binary should be specified"))
}
func TestBackendSuite(t *testing.T) {
RegisterTestingT(t)
suite.Run(t, new(BackendSuiteTest))
} }

View File

@ -25,132 +25,131 @@ import (
"github.com/Azure/go-autorest/autorest/to" "github.com/Azure/go-autorest/autorest/to"
"github.com/pkg/errors" "github.com/pkg/errors"
"github.com/stretchr/testify/mock" "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/docker/api/context/store"
. "github.com/onsi/gomega"
) )
type ContextSuiteTest struct { type contextMocks struct {
suite.Suite userPrompt *mockUserPrompt
mockUserPrompt *mockUserPrompt resourceGroupHelper *MockResourceGroupHelper
mockResourceGroupHeper *MockResourceGroupHelper
contextCreateHelper contextCreateACIHelper contextCreateHelper contextCreateACIHelper
} }
func (suite *ContextSuiteTest) BeforeTest(suiteName, testName string) { func testContextMocks() contextMocks {
suite.mockUserPrompt = &mockUserPrompt{} mockUserPrompt := &mockUserPrompt{}
suite.mockResourceGroupHeper = &MockResourceGroupHelper{} mockResourceGroupHelper := &MockResourceGroupHelper{}
suite.contextCreateHelper = contextCreateACIHelper{ contextCreateHelper := contextCreateACIHelper{
suite.mockUserPrompt, mockUserPrompt,
suite.mockResourceGroupHeper, mockResourceGroupHelper,
} }
return contextMocks{mockUserPrompt, mockResourceGroupHelper, contextCreateHelper}
} }
func (suite *ContextSuiteTest) TestCreateSpecifiedSubscriptionAndGroup() { func TestCreateSpecifiedSubscriptionAndGroup(t *testing.T) {
ctx := context.TODO() ctx := context.TODO()
opts := options("1234", "myResourceGroup") 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) data, description, err := m.contextCreateHelper.createContextData(ctx, opts)
assert.NilError(t, err)
Expect(err).To(BeNil()) assert.Equal(t, description, "myResourceGroup@eastus")
Expect(description).To(Equal("myResourceGroup@eastus")) assert.DeepEqual(t, data, aciContext("1234", "myResourceGroup", "eastus"))
Expect(data).To(Equal(aciContext("1234", "myResourceGroup", "eastus")))
} }
func (suite *ContextSuiteTest) TestErrorOnNonExistentResourceGroup() { func TestErrorOnNonExistentResourceGroup(t *testing.T) {
ctx := context.TODO() ctx := context.TODO()
opts := options("1234", "myResourceGroup") opts := options("1234", "myResourceGroup")
notFoundError := errors.New(`Not Found: "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) data, description, err := m.contextCreateHelper.createContextData(ctx, opts)
assert.Assert(t, cmp.Nil(data))
Expect(data).To(BeNil()) assert.Equal(t, description, "")
Expect(description).To(Equal("")) assert.Error(t, err, "Could not find resource group \"myResourceGroup\": Not Found: \"myResourceGroup\"")
Expect(err.Error()).To(Equal("Could not find resource group \"myResourceGroup\": Not Found: \"myResourceGroup\""))
} }
func (suite *ContextSuiteTest) TestCreateNewResourceGroup() { func TestCreateNewResourceGroup(t *testing.T) {
ctx := context.TODO() ctx := context.TODO()
opts := options("1234", "") 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)"} selectOptions := []string{"create a new resource group", "group1 (eastus)", "group2 (westeurope)"}
suite.mockUserPrompt.On("Select", "Select a resource group", selectOptions).Return(0, nil) m.userPrompt.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) m.resourceGroupHelper.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.resourceGroupHelper.On("ListGroups", ctx, "1234").Return([]resources.Group{
group("group1", "eastus"), group("group1", "eastus"),
group("group2", "westeurope"), group("group2", "westeurope"),
}, nil) }, nil)
data, description, err := suite.contextCreateHelper.createContextData(ctx, opts) data, description, err := m.contextCreateHelper.createContextData(ctx, opts)
assert.NilError(t, err)
Expect(err).To(BeNil()) assert.Equal(t, description, "newResourceGroup@eastus")
Expect(description).To(Equal("newResourceGroup@eastus")) assert.DeepEqual(t, data, aciContext("1234", "newResourceGroup", "eastus"))
Expect(data).To(Equal(aciContext("1234", "newResourceGroup", "eastus")))
} }
func (suite *ContextSuiteTest) TestSelectExistingResourceGroup() { func TestSelectExistingResourceGroup(t *testing.T) {
ctx := context.TODO() ctx := context.TODO()
opts := options("1234", "") opts := options("1234", "")
selectOptions := []string{"create a new resource group", "group1 (eastus)", "group2 (westeurope)"} selectOptions := []string{"create a new resource group", "group1 (eastus)", "group2 (westeurope)"}
suite.mockUserPrompt.On("Select", "Select a resource group", selectOptions).Return(2, nil) m := testContextMocks()
suite.mockResourceGroupHeper.On("ListGroups", ctx, "1234").Return([]resources.Group{ 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("group1", "eastus"),
group("group2", "westeurope"), group("group2", "westeurope"),
}, nil) }, nil)
data, description, err := suite.contextCreateHelper.createContextData(ctx, opts) data, description, err := m.contextCreateHelper.createContextData(ctx, opts)
assert.NilError(t, err)
Expect(err).To(BeNil()) assert.Equal(t, description, "group2@westeurope")
Expect(description).To(Equal("group2@westeurope")) assert.DeepEqual(t, data, aciContext("1234", "group2", "westeurope"))
Expect(data).To(Equal(aciContext("1234", "group2", "westeurope")))
} }
func (suite *ContextSuiteTest) TestSelectSingleSubscriptionIdAndExistingResourceGroup() { func TestSelectSingleSubscriptionIdAndExistingResourceGroup(t *testing.T) {
ctx := context.TODO() ctx := context.TODO()
opts := options("", "") 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)"} selectOptions := []string{"create a new resource group", "group1 (eastus)", "group2 (westeurope)"}
suite.mockUserPrompt.On("Select", "Select a resource group", selectOptions).Return(2, nil) m.userPrompt.On("Select", "Select a resource group", selectOptions).Return(2, nil)
suite.mockResourceGroupHeper.On("ListGroups", ctx, "123456").Return([]resources.Group{ m.resourceGroupHelper.On("ListGroups", ctx, "123456").Return([]resources.Group{
group("group1", "eastus"), group("group1", "eastus"),
group("group2", "westeurope"), group("group2", "westeurope"),
}, nil) }, nil)
data, description, err := suite.contextCreateHelper.createContextData(ctx, opts) data, description, err := m.contextCreateHelper.createContextData(ctx, opts)
assert.NilError(t, err)
Expect(err).To(BeNil()) assert.Equal(t, description, "group2@westeurope")
Expect(description).To(Equal("group2@westeurope")) assert.DeepEqual(t, data, aciContext("123456", "group2", "westeurope"))
Expect(data).To(Equal(aciContext("123456", "group2", "westeurope")))
} }
func (suite *ContextSuiteTest) TestSelectSubscriptionIdAndExistingResourceGroup() { func TestSelectSubscriptionIdAndExistingResourceGroup(t *testing.T) {
ctx := context.TODO() ctx := context.TODO()
opts := options("", "") opts := options("", "")
sub1 := subModel("1234", "Subscription1") sub1 := subModel("1234", "Subscription1")
sub2 := subModel("5678", "Subscription2") 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)"} 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)"} selectOptions = []string{"create a new resource group", "group1 (eastus)", "group2 (westeurope)"}
suite.mockUserPrompt.On("Select", "Select a resource group", selectOptions).Return(2, nil) m.userPrompt.On("Select", "Select a resource group", selectOptions).Return(2, nil)
suite.mockResourceGroupHeper.On("ListGroups", ctx, "5678").Return([]resources.Group{ m.resourceGroupHelper.On("ListGroups", ctx, "5678").Return([]resources.Group{
group("group1", "eastus"), group("group1", "eastus"),
group("group2", "westeurope"), group("group2", "westeurope"),
}, nil) }, nil)
data, description, err := suite.contextCreateHelper.createContextData(ctx, opts) data, description, err := m.contextCreateHelper.createContextData(ctx, opts)
assert.NilError(t, err)
Expect(err).To(BeNil()) assert.Equal(t, description, "group2@westeurope")
Expect(description).To(Equal("group2@westeurope")) assert.DeepEqual(t, data, aciContext("5678", "group2", "westeurope"))
Expect(data).To(Equal(aciContext("5678", "group2", "westeurope")))
} }
func subModel(subID string, display string) subscription.Model { 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 { type mockUserPrompt struct {
mock.Mock mock.Mock
} }