mirror of
https://github.com/docker/compose.git
synced 2026-11-18 22:27:03 +00:00
Most files already grouped imports into "stdlib -> other -> local",
but some files didn't. The gci formatter is similar to goimports, but
has better options to make sure imports are grouped in the expected
order (and to make sure no additional groups are present).
This formatter has a 'fix' function, so code can be re-formatted auto-
matically;
golangci-lint run -v --fix
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
283 lines
7.6 KiB
Go
283 lines
7.6 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 compose
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
"os/exec"
|
|
"path/filepath"
|
|
"strings"
|
|
"sync"
|
|
|
|
"github.com/compose-spec/compose-go/v2/types"
|
|
"github.com/containerd/errdefs"
|
|
"github.com/docker/cli/cli-plugins/manager"
|
|
"github.com/docker/cli/cli/config"
|
|
"github.com/sirupsen/logrus"
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/docker/compose/v5/pkg/api"
|
|
)
|
|
|
|
type JsonMessage struct {
|
|
Type string `json:"type"`
|
|
Message string `json:"message"`
|
|
}
|
|
|
|
const (
|
|
ErrorType = "error"
|
|
InfoType = "info"
|
|
SetEnvType = "setenv"
|
|
DebugType = "debug"
|
|
providerMetadataDirectory = "compose/providers"
|
|
)
|
|
|
|
var mux sync.Mutex
|
|
|
|
func (s *composeService) runPlugin(ctx context.Context, project *types.Project, service types.ServiceConfig, command string) error {
|
|
provider := *service.Provider
|
|
|
|
plugin, err := s.getPluginBinaryPath(provider.Type)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
cmd, err := s.setupPluginCommand(ctx, project, service, plugin, command)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
variables, err := s.executePlugin(cmd, command, service)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
mux.Lock()
|
|
defer mux.Unlock()
|
|
for name, s := range project.Services {
|
|
if _, ok := s.DependsOn[service.Name]; ok {
|
|
prefix := strings.ToUpper(service.Name) + "_"
|
|
for key, val := range variables {
|
|
s.Environment[prefix+key] = &val
|
|
}
|
|
project.Services[name] = s
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (s *composeService) executePlugin(cmd *exec.Cmd, command string, service types.ServiceConfig) (types.Mapping, error) {
|
|
var action string
|
|
switch command {
|
|
case "up":
|
|
s.events.On(creatingEvent(service.Name))
|
|
action = "create"
|
|
case "down":
|
|
s.events.On(removingEvent(service.Name))
|
|
action = "remove"
|
|
default:
|
|
return nil, fmt.Errorf("unsupported plugin command: %s", command)
|
|
}
|
|
|
|
stdout, err := cmd.StdoutPipe()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
err = cmd.Start()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
decoder := json.NewDecoder(stdout)
|
|
defer func() { _ = stdout.Close() }()
|
|
|
|
variables := types.Mapping{}
|
|
|
|
for {
|
|
var msg JsonMessage
|
|
err = decoder.Decode(&msg)
|
|
if errors.Is(err, io.EOF) {
|
|
break
|
|
}
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
switch msg.Type {
|
|
case ErrorType:
|
|
s.events.On(newEvent(service.Name, api.Error, msg.Message))
|
|
return nil, errors.New(msg.Message)
|
|
case InfoType:
|
|
s.events.On(newEvent(service.Name, api.Working, msg.Message))
|
|
case SetEnvType:
|
|
key, val, found := strings.Cut(msg.Message, "=")
|
|
if !found {
|
|
return nil, fmt.Errorf("invalid response from plugin: %s", msg.Message)
|
|
}
|
|
variables[key] = val
|
|
case DebugType:
|
|
logrus.Debugf("%s: %s", service.Name, msg.Message)
|
|
default:
|
|
return nil, fmt.Errorf("invalid response from plugin: %s", msg.Type)
|
|
}
|
|
}
|
|
|
|
err = cmd.Wait()
|
|
if err != nil {
|
|
s.events.On(errorEvent(service.Name, err.Error()))
|
|
return nil, fmt.Errorf("failed to %s service provider: %s", action, err.Error())
|
|
}
|
|
switch command {
|
|
case "up":
|
|
s.events.On(createdEvent(service.Name))
|
|
case "down":
|
|
s.events.On(removedEvent(service.Name))
|
|
}
|
|
return variables, nil
|
|
}
|
|
|
|
func (s *composeService) getPluginBinaryPath(provider string) (path string, err error) {
|
|
if provider == "compose" {
|
|
return "", errors.New("'compose' is not a valid provider type")
|
|
}
|
|
plugin, err := manager.GetPlugin(provider, s.dockerCli, &cobra.Command{})
|
|
if err == nil {
|
|
path = plugin.Path
|
|
}
|
|
if errdefs.IsNotFound(err) {
|
|
path, err = exec.LookPath(executable(provider))
|
|
}
|
|
return path, err
|
|
}
|
|
|
|
func (s *composeService) setupPluginCommand(ctx context.Context, project *types.Project, service types.ServiceConfig, path, command string) (*exec.Cmd, error) {
|
|
cmdOptionsMetadata := s.getPluginMetadata(path, service.Provider.Type, project)
|
|
var currentCommandMetadata CommandMetadata
|
|
switch command {
|
|
case "up":
|
|
currentCommandMetadata = cmdOptionsMetadata.Up
|
|
case "down":
|
|
currentCommandMetadata = cmdOptionsMetadata.Down
|
|
}
|
|
|
|
provider := *service.Provider
|
|
commandMetadataIsEmpty := cmdOptionsMetadata.IsEmpty()
|
|
if err := currentCommandMetadata.CheckRequiredParameters(provider); !commandMetadataIsEmpty && err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
args := []string{"compose", fmt.Sprintf("--project-name=%s", project.Name), command}
|
|
for k, v := range provider.Options {
|
|
for _, value := range v {
|
|
if _, ok := currentCommandMetadata.GetParameter(k); commandMetadataIsEmpty || ok {
|
|
args = append(args, fmt.Sprintf("--%s=%s", k, value))
|
|
}
|
|
}
|
|
}
|
|
args = append(args, service.Name)
|
|
|
|
cmd := exec.CommandContext(ctx, path, args...)
|
|
|
|
err := s.prepareShellOut(ctx, project.Environment, cmd)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return cmd, nil
|
|
}
|
|
|
|
func (s *composeService) getPluginMetadata(path, command string, project *types.Project) ProviderMetadata {
|
|
cmd := exec.Command(path, "compose", "metadata")
|
|
err := s.prepareShellOut(context.Background(), project.Environment, cmd)
|
|
if err != nil {
|
|
logrus.Debugf("failed to prepare plugin metadata command: %v", err)
|
|
return ProviderMetadata{}
|
|
}
|
|
stdout := &bytes.Buffer{}
|
|
cmd.Stdout = stdout
|
|
|
|
if err := cmd.Run(); err != nil {
|
|
logrus.Debugf("failed to start plugin metadata command: %v", err)
|
|
return ProviderMetadata{}
|
|
}
|
|
|
|
var metadata ProviderMetadata
|
|
if err := json.Unmarshal(stdout.Bytes(), &metadata); err != nil {
|
|
output, _ := io.ReadAll(stdout)
|
|
logrus.Debugf("failed to decode plugin metadata: %v - %s", err, output)
|
|
return ProviderMetadata{}
|
|
}
|
|
// Save metadata into docker home directory to be used by Docker LSP tool
|
|
// Just log the error as it's not a critical error for the main flow
|
|
metadataDir := filepath.Join(config.Dir(), providerMetadataDirectory)
|
|
if err := os.MkdirAll(metadataDir, 0o700); err == nil {
|
|
metadataFilePath := filepath.Join(metadataDir, command+".json")
|
|
if err := os.WriteFile(metadataFilePath, stdout.Bytes(), 0o600); err != nil {
|
|
logrus.Debugf("failed to save plugin metadata: %v", err)
|
|
}
|
|
} else {
|
|
logrus.Debugf("failed to create plugin metadata directory: %v", err)
|
|
}
|
|
return metadata
|
|
}
|
|
|
|
type ProviderMetadata struct {
|
|
Description string `json:"description"`
|
|
Up CommandMetadata `json:"up"`
|
|
Down CommandMetadata `json:"down"`
|
|
}
|
|
|
|
func (p ProviderMetadata) IsEmpty() bool {
|
|
return p.Description == "" && p.Up.Parameters == nil && p.Down.Parameters == nil
|
|
}
|
|
|
|
type CommandMetadata struct {
|
|
Parameters []ParameterMetadata `json:"parameters"`
|
|
}
|
|
|
|
type ParameterMetadata struct {
|
|
Name string `json:"name"`
|
|
Description string `json:"description"`
|
|
Required bool `json:"required"`
|
|
Type string `json:"type"`
|
|
Default string `json:"default,omitempty"`
|
|
}
|
|
|
|
func (c CommandMetadata) GetParameter(paramName string) (ParameterMetadata, bool) {
|
|
for _, p := range c.Parameters {
|
|
if p.Name == paramName {
|
|
return p, true
|
|
}
|
|
}
|
|
return ParameterMetadata{}, false
|
|
}
|
|
|
|
func (c CommandMetadata) CheckRequiredParameters(provider types.ServiceProviderConfig) error {
|
|
for _, p := range c.Parameters {
|
|
if p.Required {
|
|
if _, ok := provider.Options[p.Name]; !ok {
|
|
return fmt.Errorf("required parameter %q is missing from provider %q definition", p.Name, provider.Type)
|
|
}
|
|
}
|
|
}
|
|
return nil
|
|
}
|