mirror of
https://github.com/docker/compose.git
synced 2026-11-02 18:24:29 +00:00
1fdbcb6255
The big change here is to pass around an explicit `*BuildOptions` object
as part of Compose operations like `up` & `run` that may or may not do
builds. If the options object is `nil`, no builds whatsoever will be
attempted.
Motivation is to allow for partial rebuilds in the context of an `up`
for watch. This was broken and tricky to accomplish because various parts
of the Compose APIs mutate the `*Project` for convenience in ways that
make it unusable afterwards. (For example, it might set `service.Build = nil`
because it's not going to build that service right _then_. But we might
still want to build it later!)
NOTE: This commit does not actually touch the watch logic. This is all
in preparation to make it possible.
As part of this, a bunch of code moved around and I eliminated a bunch
of partially redundant logic, mostly around multi-platform. Several
edge cases have been addressed as part of this:
* `DOCKER_DEFAULT_PLATFORM` was _overriding_ explicitly set platforms
in some cases, this is no longer true, and it behaves like the Docker
CLI now
* It was possible for Compose to build an image for one platform and
then try to run it for a different platform (and fail)
* Errors are no longer returned if a local image exists but for the
wrong platform - the correct platform will be fetched/built (if
possible).
Because there's a LOT of subtlety and tricky logic here, I've also tried
to add an excessive amount of explanatory comments.
Signed-off-by: Milas Bowman <milas.bowman@docker.com>
130 lines
3.4 KiB
Go
130 lines
3.4 KiB
Go
/*
|
|
Copyright 2023 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 compose
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/compose-spec/compose-go/types"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestApplyPlatforms_InferFromRuntime(t *testing.T) {
|
|
makeProject := func() *types.Project {
|
|
return &types.Project{
|
|
Services: []types.ServiceConfig{
|
|
{
|
|
Name: "test",
|
|
Image: "foo",
|
|
Build: &types.BuildConfig{
|
|
Context: ".",
|
|
Platforms: []string{
|
|
"linux/amd64",
|
|
"linux/arm64",
|
|
"alice/32",
|
|
},
|
|
},
|
|
Platform: "alice/32",
|
|
},
|
|
},
|
|
}
|
|
}
|
|
|
|
t.Run("SinglePlatform", func(t *testing.T) {
|
|
project := makeProject()
|
|
require.NoError(t, applyPlatforms(project, true))
|
|
require.EqualValues(t, []string{"alice/32"}, project.Services[0].Build.Platforms)
|
|
})
|
|
|
|
t.Run("MultiPlatform", func(t *testing.T) {
|
|
project := makeProject()
|
|
require.NoError(t, applyPlatforms(project, false))
|
|
require.EqualValues(t, []string{"linux/amd64", "linux/arm64", "alice/32"},
|
|
project.Services[0].Build.Platforms)
|
|
})
|
|
}
|
|
|
|
func TestApplyPlatforms_DockerDefaultPlatform(t *testing.T) {
|
|
makeProject := func() *types.Project {
|
|
return &types.Project{
|
|
Environment: map[string]string{
|
|
"DOCKER_DEFAULT_PLATFORM": "linux/amd64",
|
|
},
|
|
Services: []types.ServiceConfig{
|
|
{
|
|
Name: "test",
|
|
Image: "foo",
|
|
Build: &types.BuildConfig{
|
|
Context: ".",
|
|
Platforms: []string{
|
|
"linux/amd64",
|
|
"linux/arm64",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
}
|
|
|
|
t.Run("SinglePlatform", func(t *testing.T) {
|
|
project := makeProject()
|
|
require.NoError(t, applyPlatforms(project, true))
|
|
require.EqualValues(t, []string{"linux/amd64"}, project.Services[0].Build.Platforms)
|
|
})
|
|
|
|
t.Run("MultiPlatform", func(t *testing.T) {
|
|
project := makeProject()
|
|
require.NoError(t, applyPlatforms(project, false))
|
|
require.EqualValues(t, []string{"linux/amd64", "linux/arm64"},
|
|
project.Services[0].Build.Platforms)
|
|
})
|
|
}
|
|
|
|
func TestApplyPlatforms_UnsupportedPlatform(t *testing.T) {
|
|
makeProject := func() *types.Project {
|
|
return &types.Project{
|
|
Environment: map[string]string{
|
|
"DOCKER_DEFAULT_PLATFORM": "commodore/64",
|
|
},
|
|
Services: []types.ServiceConfig{
|
|
{
|
|
Name: "test",
|
|
Image: "foo",
|
|
Build: &types.BuildConfig{
|
|
Context: ".",
|
|
Platforms: []string{
|
|
"linux/amd64",
|
|
"linux/arm64",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
}
|
|
|
|
t.Run("SinglePlatform", func(t *testing.T) {
|
|
project := makeProject()
|
|
require.EqualError(t, applyPlatforms(project, true),
|
|
`service "test" build.platforms does not support value set by DOCKER_DEFAULT_PLATFORM: commodore/64`)
|
|
})
|
|
|
|
t.Run("MultiPlatform", func(t *testing.T) {
|
|
project := makeProject()
|
|
require.EqualError(t, applyPlatforms(project, false),
|
|
`service "test" build.platforms does not support value set by DOCKER_DEFAULT_PLATFORM: commodore/64`)
|
|
})
|
|
}
|