File: config.go

package info (click to toggle)
golang-github-compose-spec-compose-go 2.4.8-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,628 kB
  • sloc: makefile: 36; sh: 8
file content (145 lines) | stat: -rw-r--r-- 4,214 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/*
   Copyright 2020 The Compose Specification 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 types

import (
	"encoding/json"
	"runtime"
	"strings"

	"github.com/go-viper/mapstructure/v2"
)

var (
	// isCaseInsensitiveEnvVars is true on platforms where environment variable names are treated case-insensitively.
	isCaseInsensitiveEnvVars = (runtime.GOOS == "windows")
)

// ConfigDetails are the details about a group of ConfigFiles
type ConfigDetails struct {
	Version     string
	WorkingDir  string
	ConfigFiles []ConfigFile
	Environment Mapping
}

// LookupEnv provides a lookup function for environment variables
func (cd *ConfigDetails) LookupEnv(key string) (string, bool) {
	v, ok := cd.Environment[key]
	if !isCaseInsensitiveEnvVars || ok {
		return v, ok
	}
	// variable names must be treated case-insensitively on some platforms (that is, Windows).
	// Resolves in this way:
	// * Return the value if its name matches with the passed name case-sensitively.
	// * Otherwise, return the value if its lower-cased name matches lower-cased passed name.
	//     * The value is indefinite if multiple variables match.
	lowerKey := strings.ToLower(key)
	for k, v := range cd.Environment {
		if strings.ToLower(k) == lowerKey {
			return v, true
		}
	}
	return "", false
}

// ConfigFile is a filename and the contents of the file as a Dict
type ConfigFile struct {
	// Filename is the name of the yaml configuration file
	Filename string
	// Content is the raw yaml content. Will be loaded from Filename if not set
	Content []byte
	// Config if the yaml tree for this config file. Will be parsed from Content if not set
	Config map[string]interface{}
}

func (cf ConfigFile) IsStdin() bool {
	return cf.Filename == "-"
}

func ToConfigFiles(path []string) (f []ConfigFile) {
	for _, p := range path {
		f = append(f, ConfigFile{Filename: p})
	}
	return
}

// Config is a full compose file configuration and model
type Config struct {
	Filename   string          `yaml:"-" json:"-"`
	Name       string          `yaml:"name,omitempty" json:"name,omitempty"`
	Services   Services        `yaml:"services" json:"services"`
	Networks   Networks        `yaml:"networks,omitempty" json:"networks,omitempty"`
	Volumes    Volumes         `yaml:"volumes,omitempty" json:"volumes,omitempty"`
	Secrets    Secrets         `yaml:"secrets,omitempty" json:"secrets,omitempty"`
	Configs    Configs         `yaml:"configs,omitempty" json:"configs,omitempty"`
	Extensions Extensions      `yaml:",inline" json:"-"`
	Include    []IncludeConfig `yaml:"include,omitempty" json:"include,omitempty"`
}

// Volumes is a map of VolumeConfig
type Volumes map[string]VolumeConfig

// Networks is a map of NetworkConfig
type Networks map[string]NetworkConfig

// Secrets is a map of SecretConfig
type Secrets map[string]SecretConfig

// Configs is a map of ConfigObjConfig
type Configs map[string]ConfigObjConfig

// Extensions is a map of custom extension
type Extensions map[string]any

func (e Extensions) DeepCopy(t Extensions) {
	for k, v := range e {
		t[k] = v
	}
}

// MarshalJSON makes Config implement json.Marshaler
func (c Config) MarshalJSON() ([]byte, error) {
	m := map[string]interface{}{
		"services": c.Services,
	}

	if len(c.Networks) > 0 {
		m["networks"] = c.Networks
	}
	if len(c.Volumes) > 0 {
		m["volumes"] = c.Volumes
	}
	if len(c.Secrets) > 0 {
		m["secrets"] = c.Secrets
	}
	if len(c.Configs) > 0 {
		m["configs"] = c.Configs
	}
	for k, v := range c.Extensions {
		m[k] = v
	}
	return json.Marshal(m)
}

func (e Extensions) Get(name string, target interface{}) (bool, error) {
	if v, ok := e[name]; ok {
		err := mapstructure.Decode(v, target)
		return true, err
	}
	return false, nil
}