File: hostList.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 (144 lines) | stat: -rw-r--r-- 3,736 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
/*
   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"
	"fmt"
	"sort"
	"strings"
)

// HostsList is a list of colon-separated host-ip mappings
type HostsList map[string][]string

// NewHostsList creates a HostsList from a list of `host=ip` strings
func NewHostsList(hosts []string) (HostsList, error) {
	list := HostsList{}
	for _, s := range hosts {
		var found bool
		for _, sep := range hostListSerapators {
			host, ip, ok := strings.Cut(s, sep)
			if ok {
				// Mapping found with this separator, stop here.
				if ips, ok := list[host]; ok {
					list[host] = append(ips, strings.Split(ip, ",")...)
				} else {
					list[host] = strings.Split(ip, ",")
				}
				found = true
				break
			}
		}
		if !found {
			return nil, fmt.Errorf("invalid additional host, missing IP: %s", s)
		}
	}
	err := list.cleanup()
	return list, err
}

// AsList returns host-ip mappings as a list of strings, using the given
// separator. The Docker Engine API expects ':' separators, the original format
// for '--add-hosts'. But an '=' separator is used in YAML/JSON renderings to
// make IPv6 addresses more readable (for example "my-host=::1" instead of
// "my-host:::1").
func (h HostsList) AsList(sep string) []string {
	l := make([]string, 0, len(h))
	for k, v := range h {
		for _, ip := range v {
			l = append(l, fmt.Sprintf("%s%s%s", k, sep, ip))
		}
	}
	return l
}

func (h HostsList) MarshalYAML() (interface{}, error) {
	list := h.AsList("=")
	sort.Strings(list)
	return list, nil
}

func (h HostsList) MarshalJSON() ([]byte, error) {
	list := h.AsList("=")
	sort.Strings(list)
	return json.Marshal(list)
}

var hostListSerapators = []string{"=", ":"}

func (h *HostsList) DecodeMapstructure(value interface{}) error {
	switch v := value.(type) {
	case map[string]interface{}:
		list := make(HostsList, len(v))
		for i, e := range v {
			if e == nil {
				e = ""
			}
			switch t := e.(type) {
			case string:
				list[i] = []string{t}
			case []any:
				hosts := make([]string, len(t))
				for j, h := range t {
					hosts[j] = fmt.Sprint(h)
				}
				list[i] = hosts
			default:
				return fmt.Errorf("unexpected value type %T for extra_hosts entry", value)
			}
		}
		err := list.cleanup()
		if err != nil {
			return err
		}
		*h = list
		return nil
	case []interface{}:
		s := make([]string, len(v))
		for i, e := range v {
			s[i] = fmt.Sprint(e)
		}
		list, err := NewHostsList(s)
		if err != nil {
			return err
		}
		*h = list
		return nil
	default:
		return fmt.Errorf("unexpected value type %T for extra_hosts", value)
	}
}

func (h HostsList) cleanup() error {
	for host, ips := range h {
		// Check that there is a hostname and that it doesn't contain either
		// of the allowed separators, to generate a clearer error than the
		// engine would do if it splits the string differently.
		if host == "" || strings.ContainsAny(host, ":=") {
			return fmt.Errorf("bad host name '%s'", host)
		}
		for i, ip := range ips {
			// Remove brackets from IP addresses (for example "[::1]" -> "::1").
			if len(ip) > 2 && ip[0] == '[' && ip[len(ip)-1] == ']' {
				ips[i] = ip[1 : len(ip)-1]
			}
		}
		h[host] = ips
	}
	return nil
}