introduce service hooks #12166
+189
−31
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
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
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
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
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,122 @@ | ||
| /* | ||
| 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 compose | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "io" | ||
| "time" | ||
|
|
||
| "github.com/compose-spec/compose-go/v2/types" | ||
| "github.com/docker/compose/v2/pkg/api" | ||
| "github.com/docker/compose/v2/pkg/utils" | ||
| moby "github.com/docker/docker/api/types" | ||
| containerType "github.com/docker/docker/api/types/container" | ||
| "github.com/docker/docker/pkg/stdcopy" | ||
| ) | ||
|
|
||
| func (s composeService) runHook(ctx context.Context, container moby.Container, service types.ServiceConfig, hook types.ServiceHook, listener api.ContainerEventListener) error { | ||
| wOut := utils.GetWriter(func(line string) { | ||
| listener(api.ContainerEvent{ | ||
| Type: api.HookEventLog, | ||
| Container: getContainerNameWithoutProject(container) + " ->", | ||
|
There was a problem hiding this comment. I would propose to change the There was a problem hiding this comment. hooks have no name so far (to be debated) There was a problem hiding this comment. how about we choose an emoji for each hook? 😆 There was a problem hiding this comment. My first implementation was using 🪝 but this won't run well on a Windows terminal |
||
| ID: container.ID, | ||
| Service: service.Name, | ||
| Line: line, | ||
| }) | ||
| }) | ||
| defer wOut.Close() //nolint:errcheck | ||
|
|
||
| detached := listener == nil | ||
| exec, err := s.apiClient().ContainerExecCreate(ctx, container.ID, containerType.ExecOptions{ | ||
| User: hook.User, | ||
| Privileged: hook.Privileged, | ||
| Env: ToMobyEnv(hook.Environment), | ||
| WorkingDir: hook.WorkingDir, | ||
| Cmd: hook.Command, | ||
| Detach: detached, | ||
| AttachStdout: !detached, | ||
| AttachStderr: !detached, | ||
| }) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if detached { | ||
| return s.runWaitExec(ctx, exec, service, listener) | ||
| } | ||
|
|
||
| height, width := s.stdout().GetTtySize() | ||
| consoleSize := &[2]uint{height, width} | ||
| attach, err := s.apiClient().ContainerExecAttach(ctx, exec.ID, containerType.ExecAttachOptions{ | ||
| Tty: service.Tty, | ||
| ConsoleSize: consoleSize, | ||
| }) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer attach.Close() | ||
|
|
||
| if service.Tty { | ||
| _, err = io.Copy(wOut, attach.Reader) | ||
| } else { | ||
| _, err = stdcopy.StdCopy(wOut, wOut, attach.Reader) | ||
| } | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| inspected, err := s.apiClient().ContainerExecInspect(ctx, exec.ID) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if inspected.ExitCode != 0 { | ||
| return fmt.Errorf("%s hook exited with status %d", service.Name, inspected.ExitCode) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func (s composeService) runWaitExec(ctx context.Context, exec moby.IDResponse, service types.ServiceConfig, listener api.ContainerEventListener) error { | ||
| err := s.apiClient().ContainerExecStart(ctx, exec.ID, containerType.ExecStartOptions{ | ||
| Detach: listener == nil, | ||
| Tty: service.Tty, | ||
| }) | ||
| if err != nil { | ||
| return nil | ||
| } | ||
|
|
||
| // We miss a ContainerExecWait API | ||
| tick := time.NewTicker(100 * time.Millisecond) | ||
| for { | ||
| select { | ||
| case <-ctx.Done(): | ||
| return nil | ||
| case <-tick.C: | ||
| inspect, err := s.apiClient().ContainerExecInspect(ctx, exec.ID) | ||
| if err != nil { | ||
| return nil | ||
|
There was a problem hiding this comment. Might have missed something, but shouldn't we return the error in this case? I see the same is done for |
||
| } | ||
| if !inspect.Running { | ||
| if inspect.ExitCode != 0 { | ||
| return fmt.Errorf("%s hook exited with status %d", service.Name, inspect.ExitCode) | ||
| } | ||
| 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
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could add a validation that the service exists here. Since this is the place where we get its value becoming easier later on for debugging.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
as we run inside
InReverseDependencyOrderservice is guaranteed to exist (actually,InReverseDependencyOrdercould pass a*ServiceConfig, but this could have impact on immutability)serviceis passed as a pointer down tocompose/pkg/compose/down.go
Line 304 in 0aacddf
nil