docker-compose/aci/convert/registry_credentials_test.go

/*
   Copyright 2020 Docker Compose CLI authors

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/

package convert

import (
	"errors"
	"strconv"
	"testing"

	"github.com/Azure/azure-sdk-for-go/profiles/latest/containerinstance/mgmt/containerinstance"
	"github.com/Azure/go-autorest/autorest/to"
	"github.com/compose-spec/compose-go/types"
	cliconfigtypes "github.com/docker/cli/cli/config/types"
	"github.com/docker/compose-cli/aci/login"
	"github.com/stretchr/testify/mock"
	"gotest.tools/v3/assert"
	is "gotest.tools/v3/assert/cmp"
)

const getAllCredentials = "getAllRegistryCredentials"
const autoLoginAcr = "autoLoginAcr"

func TestHubPrivateImage(t *testing.T) {
	registryHelper := &MockRegistryHelper{}
	registryHelper.On(getAllCredentials).Return(registry("https://index.docker.io", userPwdCreds("toto", "pwd")), nil)

	creds, err := getRegistryCredentials(composeServices("gtardif/privateimg"), registryHelper)
	assert.NilError(t, err)
	assert.DeepEqual(t, creds, []containerinstance.ImageRegistryCredential{
		{
			Server:   to.StringPtr(dockerHub),
			Username: to.StringPtr("toto"),
			Password: to.StringPtr("pwd"),
		},
	})
}

func TestRegistryNameWithoutProtocol(t *testing.T) {
	registryHelper := &MockRegistryHelper{}
	registryHelper.On(getAllCredentials).Return(registry("index.docker.io", userPwdCreds("toto", "pwd")), nil)

	creds, err := getRegistryCredentials(composeServices("gtardif/privateimg"), registryHelper)
	assert.NilError(t, err)
	assert.DeepEqual(t, creds, []containerinstance.ImageRegistryCredential{
		{
			Server:   to.StringPtr(dockerHub),
			Username: to.StringPtr("toto"),
			Password: to.StringPtr("pwd"),
		},
	})
}

func TestInvalidCredentials(t *testing.T) {
	registryHelper := &MockRegistryHelper{}
	registryHelper.On(getAllCredentials).Return(registry("18.195.159.6:444", userPwdCreds("toto", "pwd")), nil)

	creds, err := getRegistryCredentials(composeServices("gtardif/privateimg"), registryHelper)
	assert.NilError(t, err)
	assert.Equal(t, len(creds), 0)
}

func TestImageWithDotInName(t *testing.T) {
	registryHelper := &MockRegistryHelper{}
	registryHelper.On(getAllCredentials).Return(registry("index.docker.io", userPwdCreds("toto", "pwd")), nil)

	creds, err := getRegistryCredentials(composeServices("my.image"), registryHelper)
	assert.NilError(t, err)
	assert.DeepEqual(t, creds, []containerinstance.ImageRegistryCredential{
		{
			Server:   to.StringPtr(dockerHub),
			Username: to.StringPtr("toto"),
			Password: to.StringPtr("pwd"),
		},
	})
}

func TestAcrPrivateImage(t *testing.T) {
	registryHelper := &MockRegistryHelper{}
	registryHelper.On(getAllCredentials).Return(registry("https://mycontainerregistrygta.azurecr.io", tokenCreds("123456")), nil)
	registryHelper.On(autoLoginAcr, "mycontainerregistrygta.azurecr.io").Return(nil)

	creds, err := getRegistryCredentials(composeServices("mycontainerregistrygta.azurecr.io/privateimg"), registryHelper)
	assert.NilError(t, err)
	assert.DeepEqual(t, creds, []containerinstance.ImageRegistryCredential{
		{
			Server:   to.StringPtr("mycontainerregistrygta.azurecr.io"),
			Username: to.StringPtr(tokenUsername),
			Password: to.StringPtr("123456"),
		},
	})
}

func TestAcrPrivateImageLinux(t *testing.T) {
	registryHelper := &MockRegistryHelper{}
	token := tokenCreds("123456")
	token.Username = tokenUsername
	registryHelper.On(getAllCredentials).Return(registry("https://mycontainerregistrygta.azurecr.io", token), nil)
	registryHelper.On(autoLoginAcr, "mycontainerregistrygta.azurecr.io").Return(nil)

	creds, err := getRegistryCredentials(composeServices("mycontainerregistrygta.azurecr.io/privateimg"), registryHelper)
	assert.NilError(t, err)
	assert.DeepEqual(t, creds, []containerinstance.ImageRegistryCredential{
		{
			Server:   to.StringPtr("mycontainerregistrygta.azurecr.io"),
			Username: to.StringPtr(tokenUsername),
			Password: to.StringPtr("123456"),
		},
	})
}

func TestNoMoreRegistriesThanImages(t *testing.T) {
	registryHelper := &MockRegistryHelper{}
	configs := map[string]cliconfigtypes.AuthConfig{
		"https://mycontainerregistrygta.azurecr.io": tokenCreds("123456"),
		"https://index.docker.io":                   userPwdCreds("toto", "pwd"),
	}
	registryHelper.On(getAllCredentials).Return(configs, nil)
	registryHelper.On(autoLoginAcr, "mycontainerregistrygta.azurecr.io").Return(nil)

	creds, err := getRegistryCredentials(composeServices("mycontainerregistrygta.azurecr.io/privateimg"), registryHelper)
	assert.NilError(t, err)
	assert.DeepEqual(t, creds, []containerinstance.ImageRegistryCredential{
		{
			Server:   to.StringPtr("mycontainerregistrygta.azurecr.io"),
			Username: to.StringPtr(tokenUsername),
			Password: to.StringPtr("123456"),
		},
	})

	creds, err = getRegistryCredentials(composeServices("someuser/privateimg"), registryHelper)
	assert.NilError(t, err)
	assert.DeepEqual(t, creds, []containerinstance.ImageRegistryCredential{
		{
			Server:   to.StringPtr(dockerHub),
			Username: to.StringPtr("toto"),
			Password: to.StringPtr("pwd"),
		},
	})
}

func TestHubAndSeveralACRRegistries(t *testing.T) {
	registryHelper := &MockRegistryHelper{}
	configs := map[string]cliconfigtypes.AuthConfig{
		"https://mycontainerregistry1.azurecr.io": tokenCreds("123456"),
		"https://mycontainerregistry2.azurecr.io": tokenCreds("456789"),
		"https://mycontainerregistry3.azurecr.io": tokenCreds("123456789"),
		"https://index.docker.io":                 userPwdCreds("toto", "pwd"),
		"https://other.registry.io":               userPwdCreds("user", "password"),
	}
	registryHelper.On(getAllCredentials).Return(configs, nil)
	registryHelper.On(autoLoginAcr, "mycontainerregistry1.azurecr.io").Return(nil)
	registryHelper.On(autoLoginAcr, "mycontainerregistry2.azurecr.io").Return(nil)

	creds, err := getRegistryCredentials(composeServices("mycontainerregistry1.azurecr.io/privateimg", "someuser/privateImg2", "mycontainerregistry2.azurecr.io/privateimg"), registryHelper)
	assert.NilError(t, err)

	assert.Assert(t, is.Contains(creds, containerinstance.ImageRegistryCredential{
		Server:   to.StringPtr("mycontainerregistry1.azurecr.io"),
		Username: to.StringPtr(tokenUsername),
		Password: to.StringPtr("123456"),
	}))
	assert.Assert(t, is.Contains(creds, containerinstance.ImageRegistryCredential{
		Server:   to.StringPtr("mycontainerregistry2.azurecr.io"),
		Username: to.StringPtr(tokenUsername),
		Password: to.StringPtr("456789"),
	}))
	assert.Assert(t, is.Contains(creds, containerinstance.ImageRegistryCredential{
		Server:   to.StringPtr(dockerHub),
		Username: to.StringPtr("toto"),
		Password: to.StringPtr("pwd"),
	}))
}

func TestIgnoreACRRegistryFailedAutoLogin(t *testing.T) {
	registryHelper := &MockRegistryHelper{}
	configs := map[string]cliconfigtypes.AuthConfig{
		"https://mycontainerregistry1.azurecr.io": tokenCreds("123456"),
		"https://mycontainerregistry3.azurecr.io": tokenCreds("123456789"),
		"https://index.docker.io":                 userPwdCreds("toto", "pwd"),
		"https://other.registry.io":               userPwdCreds("user", "password"),
	}
	registryHelper.On(getAllCredentials).Return(configs, nil)
	registryHelper.On(autoLoginAcr, "mycontainerregistry1.azurecr.io").Return(nil)
	registryHelper.On(autoLoginAcr, "mycontainerregistry2.azurecr.io").Return(errors.New("could not login"))

	creds, err := getRegistryCredentials(composeServices("mycontainerregistry1.azurecr.io/privateimg", "someuser/privateImg2", "mycontainerregistry2.azurecr.io/privateimg"), registryHelper)
	assert.NilError(t, err)
	assert.Equal(t, len(creds), 2)

	assert.Assert(t, is.Contains(creds, containerinstance.ImageRegistryCredential{
		Server:   to.StringPtr("mycontainerregistry1.azurecr.io"),
		Username: to.StringPtr(tokenUsername),
		Password: to.StringPtr("123456"),
	}))

	assert.Assert(t, is.Contains(creds, containerinstance.ImageRegistryCredential{
		Server:   to.StringPtr(dockerHub),
		Username: to.StringPtr("toto"),
		Password: to.StringPtr("pwd"),
	}))
}

func composeServices(images ...string) types.Project {
	var services []types.ServiceConfig
	for index, name := range images {
		service := types.ServiceConfig{
			Name:  "service" + strconv.Itoa(index),
			Image: name,
		}
		services = append(services, service)
	}
	return types.Project{
		Services: services,
	}
}

func registry(host string, configregistryData cliconfigtypes.AuthConfig) map[string]cliconfigtypes.AuthConfig {
	return map[string]cliconfigtypes.AuthConfig{
		host: configregistryData,
	}
}

func userPwdCreds(user string, password string) cliconfigtypes.AuthConfig {
	return cliconfigtypes.AuthConfig{
		Username: user,
		Password: password,
	}
}

func tokenCreds(token string) cliconfigtypes.AuthConfig {
	return cliconfigtypes.AuthConfig{
		IdentityToken: token,
	}
}

type MockRegistryHelper struct {
	mock.Mock
}

func (s *MockRegistryHelper) getAllRegistryCredentials() (map[string]cliconfigtypes.AuthConfig, error) {
	args := s.Called()
	return args.Get(0).(map[string]cliconfigtypes.AuthConfig), args.Error(1)
}

func (s *MockRegistryHelper) autoLoginAcr(registry string, loginService login.AzureLoginService) error {
	args := s.Called(registry, loginService)
	return args.Error(0)
}