compose/internal/containerops/commit.go
Nicolas De Loof f877cf1525 refactor(containerops): move exec, cp, export and commit to internal/containerops
These four operations act from the outside on the container of a service.
They only need the Docker client, the concurrency bound, the event bus, the
dry-run switch, the Docker CLI (which owns the terminal streams) and the two
container lookups, so they move out of the flat pkg/compose package into
internal/containerops behind a Backend interface declaring exactly that.

composeService implements the interface in a new file and keeps Exec, Copy,
Export and Commit as one-line forwarders (the progress wrapper of the last
three stays there), so no caller changes. The now unused checkRelayTarget
forwarder is dropped. Behavior is unchanged: the cp test still runs through
the forwarders.

Part of #14396

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2026-10-27 11:19:35 +01:00

75 lines
1.9 KiB
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 containerops
import (
"context"
"strings"
"github.com/moby/moby/client"
"github.com/docker/compose/v5/internal/inspect"
"github.com/docker/compose/v5/internal/naming"
"github.com/docker/compose/v5/pkg/api"
)
// Commit creates an image from the changes made to a container of a service.
func (s *Service) Commit(ctx context.Context, projectName string, options api.CommitOptions) error {
projectName = strings.ToLower(projectName)
ctr, err := s.backend.SpecifiedContainer(ctx, projectName, inspect.OneOffInclude, false, options.Service, options.Index)
if err != nil {
return err
}
name := naming.CanonicalContainerName(ctr)
s.backend.Events().On(api.Resource{
ID: name,
Status: api.Working,
Text: api.StatusCommitting,
})
if s.backend.DryRun() {
s.backend.Events().On(api.Resource{
ID: name,
Status: api.Done,
Text: api.StatusCommitted,
})
return nil
}
response, err := s.backend.APIClient().ContainerCommit(ctx, ctr.ID, client.ContainerCommitOptions{
Reference: options.Reference,
Comment: options.Comment,
Author: options.Author,
Changes: options.Changes.GetSlice(),
NoPause: !options.Pause,
})
if err != nil {
return err
}
s.backend.Events().On(api.Resource{
ID: name,
Text: "Committed as " + response.ID,
Status: api.Done,
})
return nil
}