mirror of
https://github.com/moby/moby.git
synced 2026-01-11 10:41:43 +00:00
9bcb12aa48
This change changes the default for noOverwriteDirNonDir to be true internally, with the intent to change the default at the API to follow accordingly. The `AllowOverwriteDirWithFile` option in the Client was added when reimplementing the CLI using the API Client lib in [moby@1b2b91b]. Before that refactor, the `noOverwriteDirNonDir` query argument [would be set unconditionally][1] by the CLI, with no options to control the behavior. The `noOverwriteDirNonDir` query parameter was added in [moby@db9cc91] to set the `NoOverwriteDirNonDir` option that was implemented in pkg/archive in [moby@a74799b]. It was added in [PR13171-comment2], following a discussion on the risk of replacing a directory with a file and vice-versa in [PR13171-comment]. > In my latest changes from yesterday: > > - Removed the `GET stat-path` endpoint and added a `HEAD` handler to > the `archive-path` endpoint. Updated the api docs to reflect this. > Also moved api docs changes from `v1.19` to `v1.20`. > - Added a `NoOverwriteDirNonDir` flag to `archive.TarOptions` to indicate > that we do not want to overwrite a directory with a non-directory (and > vice versa) when unpacking an archive. > - Added a corresponding but optional `noOverwriteDirNonDir` parameter > to the `PUT extract-to-dir` endpoint to specify desired behavior. > > These changes combine to keep the behavior we want It's unclear why these were added as an *option* and why it was implemented as opt-in (not opt-out), as overwriting a file with a directory (or vice-versa) would generally be unexpected behavior. [1]:8c9ad7b818/api/client/cp.go (L345-L346)[moby@1b2b91b]:1b2b91ba43[moby@a74799b]:a74799b701[moby@db9cc91]:db9cc91a9e[PR13171-comment]: https://github.com/moby/moby/pull/13171#issuecomment-106559765 [PR13171-comment2]: https://github.com/moby/moby/pull/13171#issuecomment-108538643 Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
80 lines
3.7 KiB
Go
80 lines
3.7 KiB
Go
package container
|
|
|
|
import (
|
|
"context"
|
|
"io"
|
|
|
|
"github.com/docker/docker/api/types/backend"
|
|
"github.com/docker/docker/api/types/container"
|
|
"github.com/docker/docker/api/types/filters"
|
|
"github.com/moby/go-archive"
|
|
)
|
|
|
|
// execBackend includes functions to implement to provide exec functionality.
|
|
type execBackend interface {
|
|
ContainerExecCreate(name string, options *container.ExecOptions) (string, error)
|
|
ContainerExecInspect(id string) (*backend.ExecInspect, error)
|
|
ContainerExecResize(ctx context.Context, name string, height, width uint32) error
|
|
ContainerExecStart(ctx context.Context, name string, options backend.ExecStartConfig) error
|
|
ExecExists(name string) (bool, error)
|
|
}
|
|
|
|
// copyBackend includes functions to implement to provide container copy functionality.
|
|
type copyBackend interface {
|
|
ContainerArchivePath(name string, path string) (content io.ReadCloser, stat *container.PathStat, err error)
|
|
ContainerExport(ctx context.Context, name string, out io.Writer) error
|
|
ContainerExtractToDir(name, path string, copyUIDGID, allowOverwriteDirWithFile bool, content io.Reader) error
|
|
ContainerStatPath(name string, path string) (stat *container.PathStat, err error)
|
|
}
|
|
|
|
// stateBackend includes functions to implement to provide container state lifecycle functionality.
|
|
type stateBackend interface {
|
|
ContainerCreate(ctx context.Context, config backend.ContainerCreateConfig) (container.CreateResponse, error)
|
|
ContainerKill(name string, signal string) error
|
|
ContainerPause(name string) error
|
|
ContainerRename(oldName, newName string) error
|
|
ContainerResize(ctx context.Context, name string, height, width uint32) error
|
|
ContainerRestart(ctx context.Context, name string, options container.StopOptions) error
|
|
ContainerRm(name string, config *backend.ContainerRmConfig) error
|
|
ContainerStart(ctx context.Context, name string, checkpoint string, checkpointDir string) error
|
|
ContainerStop(ctx context.Context, name string, options container.StopOptions) error
|
|
ContainerUnpause(name string) error
|
|
ContainerUpdate(name string, hostConfig *container.HostConfig) (container.UpdateResponse, error)
|
|
ContainerWait(ctx context.Context, name string, condition container.WaitCondition) (<-chan container.StateStatus, error)
|
|
}
|
|
|
|
// monitorBackend includes functions to implement to provide containers monitoring functionality.
|
|
type monitorBackend interface {
|
|
ContainerChanges(ctx context.Context, name string) ([]archive.Change, error)
|
|
ContainerInspect(ctx context.Context, name string, options backend.ContainerInspectOptions) (*container.InspectResponse, error)
|
|
ContainerLogs(ctx context.Context, name string, config *container.LogsOptions) (msgs <-chan *backend.LogMessage, tty bool, err error)
|
|
ContainerStats(ctx context.Context, name string, config *backend.ContainerStatsConfig) error
|
|
ContainerTop(name string, psArgs string) (*container.TopResponse, error)
|
|
Containers(ctx context.Context, config *container.ListOptions) ([]*container.Summary, error)
|
|
}
|
|
|
|
// attachBackend includes function to implement to provide container attaching functionality.
|
|
type attachBackend interface {
|
|
ContainerAttach(name string, c *backend.ContainerAttachConfig) error
|
|
}
|
|
|
|
// systemBackend includes functions to implement to provide system wide containers functionality
|
|
type systemBackend interface {
|
|
ContainersPrune(ctx context.Context, pruneFilters filters.Args) (*container.PruneReport, error)
|
|
}
|
|
|
|
type commitBackend interface {
|
|
CreateImageFromContainer(ctx context.Context, name string, config *backend.CreateImageConfig) (imageID string, err error)
|
|
}
|
|
|
|
// Backend is all the methods that need to be implemented to provide container specific functionality.
|
|
type Backend interface {
|
|
commitBackend
|
|
execBackend
|
|
copyBackend
|
|
stateBackend
|
|
monitorBackend
|
|
attachBackend
|
|
systemBackend
|
|
}
|