forked from docker/compose
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request docker#10791 from milas/watch-refactor-sync
watch: move sync logic into separate package
- Loading branch information
Showing
4 changed files
with
188 additions
and
75 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| /* | ||
| 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 sync | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "io" | ||
| "io/fs" | ||
| "os" | ||
|
|
||
| "github.com/compose-spec/compose-go/types" | ||
| "github.com/docker/compose/v2/pkg/api" | ||
| "github.com/sirupsen/logrus" | ||
| ) | ||
|
|
||
| type ComposeClient interface { | ||
| Exec(ctx context.Context, projectName string, options api.RunOptions) (int, error) | ||
|
|
||
| Copy(ctx context.Context, projectName string, options api.CopyOptions) error | ||
| } | ||
|
|
||
| type DockerCopy struct { | ||
| client ComposeClient | ||
|
|
||
| projectName string | ||
|
|
||
| infoWriter io.Writer | ||
| } | ||
|
|
||
| var _ Syncer = &DockerCopy{} | ||
|
|
||
| func NewDockerCopy(projectName string, client ComposeClient, infoWriter io.Writer) *DockerCopy { | ||
| return &DockerCopy{ | ||
| projectName: projectName, | ||
| client: client, | ||
| infoWriter: infoWriter, | ||
| } | ||
| } | ||
|
|
||
| func (d *DockerCopy) Sync(ctx context.Context, service types.ServiceConfig, paths []PathMapping) error { | ||
| var errs []error | ||
| for i := range paths { | ||
| if err := d.sync(ctx, service, paths[i]); err != nil { | ||
| errs = append(errs, err) | ||
| } | ||
| } | ||
| return errors.Join(errs...) | ||
| } | ||
|
|
||
| func (d *DockerCopy) sync(ctx context.Context, service types.ServiceConfig, pathMapping PathMapping) error { | ||
| scale := 1 | ||
| if service.Deploy != nil && service.Deploy.Replicas != nil { | ||
| scale = int(*service.Deploy.Replicas) | ||
| } | ||
|
|
||
| if fi, statErr := os.Stat(pathMapping.HostPath); statErr == nil { | ||
| if fi.IsDir() { | ||
| for i := 1; i <= scale; i++ { | ||
| _, err := d.client.Exec(ctx, d.projectName, api.RunOptions{ | ||
| Service: pathMapping.Service, | ||
| Command: []string{"mkdir", "-p", pathMapping.ContainerPath}, | ||
| Index: i, | ||
| }) | ||
| if err != nil { | ||
| logrus.Warnf("failed to create %q from %s: %v", pathMapping.ContainerPath, pathMapping.Service, err) | ||
| } | ||
| } | ||
| fmt.Fprintf(d.infoWriter, "%s created\n", pathMapping.ContainerPath) | ||
| } else { | ||
| err := d.client.Copy(ctx, d.projectName, api.CopyOptions{ | ||
| Source: pathMapping.HostPath, | ||
| Destination: fmt.Sprintf("%s:%s", pathMapping.Service, pathMapping.ContainerPath), | ||
| }) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| fmt.Fprintf(d.infoWriter, "%s updated\n", pathMapping.ContainerPath) | ||
| } | ||
| } else if errors.Is(statErr, fs.ErrNotExist) { | ||
| for i := 1; i <= scale; i++ { | ||
| _, err := d.client.Exec(ctx, d.projectName, api.RunOptions{ | ||
| Service: pathMapping.Service, | ||
| Command: []string{"rm", "-rf", pathMapping.ContainerPath}, | ||
| Index: i, | ||
| }) | ||
| if err != nil { | ||
| logrus.Warnf("failed to delete %q from %s: %v", pathMapping.ContainerPath, pathMapping.Service, err) | ||
| } | ||
| } | ||
| fmt.Fprintf(d.infoWriter, "%s deleted from service\n", pathMapping.ContainerPath) | ||
| } | ||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| /* | ||
| 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 sync | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/compose-spec/compose-go/types" | ||
| ) | ||
|
|
||
| // PathMapping contains the Compose service and modified host system path. | ||
| type PathMapping struct { | ||
| // Service that the file event is for. | ||
| Service string | ||
| // HostPath that was created/modified/deleted outside the container. | ||
| // | ||
| // This is the path as seen from the user's perspective, e.g. | ||
| // - C:\Users\moby\Documents\hello-world\main.go (file on Windows) | ||
| // - /Users/moby/Documents/hello-world (directory on macOS) | ||
| HostPath string | ||
| // ContainerPath for the target file inside the container (only populated | ||
| // for sync events, not rebuild). | ||
| // | ||
| // This is the path as used in Docker CLI commands, e.g. | ||
| // - /workdir/main.go | ||
| // - /workdir/subdir | ||
| ContainerPath string | ||
| } | ||
|
|
||
| type Syncer interface { | ||
| Sync(ctx context.Context, service types.ServiceConfig, paths []PathMapping) error | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters