zones: introduce RingInfo.Merge()

Signed-off-by: Alejandro Mery <amery@jpi.io>

pkg/wireguard/config.go

@@ -31,13 +31,13 @@ func (f *Config) Peers() int {
 // InterfaceConfig represents the [Interface] section
 type InterfaceConfig struct {
 	Address    netip.Addr
-	PrivateKey PrivateKey
+	PrivateKey BinaryKey
 	ListenPort uint16
 }
 
 // PeerConfig represents a [Peer] section
 type PeerConfig struct {
-	PublicKey  PublicKey
+	PublicKey  BinaryKey
 	Endpoint   EndpointAddress
 	AllowedIPs []netip.Prefix
 }
@@ -135,7 +135,7 @@ func (p interfaceConfig) Export() (InterfaceConfig, error) {
 		ListenPort: p.ListenPort,
 	}
 
-	out.PrivateKey, err = PrivateKeyFromBase64(p.PrivateKey)
+	out.PrivateKey, err = BinaryKeyFromBase64(p.PrivateKey)
 	if err != nil {
 		err = core.Wrap(err, "PrivateKey")
 		return InterfaceConfig{}, err
@@ -162,7 +162,7 @@ func (v *intermediateConfig) ExportPeer(i int) (PeerConfig, error) {
 	}
 
 	// PublicKey
-	out.PublicKey, err = PublicKeyFromBase64(v.Peer.PublicKey[i])
+	out.PublicKey, err = BinaryKeyFromBase64(v.Peer.PublicKey[i])
 	if err != nil {
 		err = core.Wrap(err, "PublicKey")
 		return out, err

pkg/wireguard/keys.go

@@ -3,94 +3,34 @@ package wireguard
 import (
 	"bytes"
 	"encoding/base64"
-	"errors"
 )
 
-const (
-	// PrivateKeySize is the length in bytes of a Wireguard Private Key
-	PrivateKeySize = 32
-	// PublicKeySize is the length in bytes of a Wireguard Public Key
-	PublicKeySize = 32
-)
+// BinaryKey is a binary blob
+type BinaryKey []byte
 
-var (
-	// ErrInvalidKeySize indicates the key size is wrong
-	ErrInvalidKeySize = errors.New("invalid key size")
-)
-
-type (
-	// PrivateKey is a binary Wireguard Private Key
-	PrivateKey []byte
-	// PublicKey is a binary Wireguard Public Key
-	PublicKey []byte
-)
-
-func (key PrivateKey) String() string {
-	return encodeKey(key)
-}
-
-func (pub PublicKey) String() string {
-	return encodeKey(pub)
+func (k BinaryKey) String() string {
+	return base64.StdEncoding.EncodeToString(k)
 }
 
 // IsZero tells if the key hasn't been set
-func (key PrivateKey) IsZero() bool {
-	return len(key) == 0
+func (k BinaryKey) IsZero() bool {
+	return len(k) == 0
 }
 
-// IsZero tells if the key hasn't been set
-func (pub PublicKey) IsZero() bool {
-	return len(pub) == 0
+// Equal checks if two keys are identical
+func (k BinaryKey) Equal(alter BinaryKey) bool {
+	return bytes.Equal(k, alter)
 }
 
-// Equal checks if two private keys are identical
-func (key PrivateKey) Equal(alter PrivateKey) bool {
-	return bytes.Equal(key, alter)
-}
-
-// Equal checks if two public keys are identical
-func (pub PublicKey) Equal(alter PublicKey) bool {
-	return bytes.Equal(pub, alter)
-}
-
-// PrivateKeyFromBase64 decodes a base64-based string into
-// a [PrivateKey]
-func PrivateKeyFromBase64(data string) (PrivateKey, error) {
-	b, err := decodeKey(data, PrivateKeySize)
-	return b, err
-}
-
-// PublicKeyFromBase64 decodes a base64-based string into
-// a [PublicKey]
-func PublicKeyFromBase64(data string) (PublicKey, error) {
-	b, err := decodeKey(data, PublicKeySize)
-	return b, err
-}
-
-func encodeKey(b []byte) string {
-	switch {
-	case len(b) == 0:
-		return ""
-	default:
-		return base64.StdEncoding.EncodeToString(b)
-	}
-}
-
-func decodeKey(data string, size int) ([]byte, error) {
+// BinaryKeyFromBase64 decodes a base64-based string into
+// a [BinaryKey]
+func BinaryKeyFromBase64(data string) (BinaryKey, error) {
 	b, err := base64.StdEncoding.DecodeString(data)
-	switch {
-	case err != nil:
-		return []byte{}, err
-	case len(b) != size:
-		err = ErrInvalidKeySize
-		return []byte{}, err
-	default:
-		return b, nil
-	}
+	return BinaryKey(b), err
 }
 
 // KeyPair holds a Key pair
 type KeyPair struct {
-	PrivateKey PrivateKey
-	PublicKey  PublicKey
+	PrivateKey BinaryKey
+	PublicKey  BinaryKey
 }

pkg/zones/env.go

@@ -1,104 +1,9 @@
+// Package zones abstracts the cluster zones
 package zones
 
-import (
-	"bytes"
-	"fmt"
-	"io"
-	"strings"
-)
+import "io"
 
 // WriteEnv generates environment variables for shell scripts
-func (m *Zones) WriteEnv(w io.Writer) error {
-	var buf bytes.Buffer
-
-	m.writeEnvVarFn(&buf, genEnvZones, "ZONES")
-	m.ForEachZone(func(z *Zone) bool {
-		m.writeEnvZone(&buf, z)
-		return false
-	})
-
-	_, err := buf.WriteTo(w)
-	return err
-}
-
-func (m *Zones) writeEnvZone(w io.Writer, z *Zone) {
-	zoneID := z.ID
-
-	// ZONE{zoneID}
-	m.writeEnvVar(w, genEnvZoneNodes(z), "ZONE%v", zoneID)
-
-	// ZONE{zoneID}_NAME
-	m.writeEnvVar(w, z.Name, "ZONE%v_%s", zoneID, "NAME")
-
-	// ZONE{zoneID}_GW
-	gatewayID := getRingZeroGatewayID(z)
-	m.writeEnvVar(w, fmt.Sprintf("%v", gatewayID), "ZONE%v_%s", zoneID, "GW")
-
-	// ZONE{zoneID}_IP
-	ip, _ := RingZeroAddress(zoneID, gatewayID)
-	m.writeEnvVar(w, ip.String(), "ZONE%v_%s", zoneID, "IP")
-}
-
-func (m *Zones) writeEnvVarFn(w io.Writer, fn func(*Zones) string, name string, args ...any) {
-	var value string
-
-	if fn != nil {
-		value = fn(m)
-	}
-
-	m.writeEnvVar(w, value, name, args...)
-}
-
-func (*Zones) writeEnvVar(w io.Writer, value string, name string, args ...any) {
-	if len(args) > 0 {
-		name = fmt.Sprintf(name, args...)
-	}
-
-	if name != "" {
-		value = strings.TrimSpace(value)
-
-		_, _ = fmt.Fprintf(w, "%s=%q\n", name, value)
-	}
-}
-
-func genEnvZones(m *Zones) string {
-	s := make([]string, 0, len(m.Zones))
-	for _, z := range m.Zones {
-		s = append(s, fmt.Sprintf("%v", z.ID))
-	}
-
-	return strings.Join(s, " ")
-}
-
-func genEnvZoneNodes(z *Zone) string {
-	s := make([]string, 0, len(z.Machines))
-	for _, p := range z.Machines {
-		s = append(s, p.Name)
-	}
-	return strings.Join(s, " ")
-}
-
-func getRingZeroGatewayID(z *Zone) int {
-	var firstNodeID, gatewayID int
-
-	z.ForEachMachine(func(p *Machine) bool {
-		nodeID := p.ID()
-
-		if firstNodeID == 0 {
-			firstNodeID = nodeID
-		}
-
-		if _, found := p.getRingInfo(0); found {
-			gatewayID = nodeID
-		}
-
-		return gatewayID != 0
-	})
-
-	switch {
-	case gatewayID == 0:
-		return firstNodeID
-	default:
-		return gatewayID
-	}
+func (*Zones) WriteEnv(io.Writer) error {
+	return nil
 }

pkg/zones/machine.go

@@ -82,7 +82,3 @@ func (m *Machine) getFilename(name string, args ...any) string {
 
 	return filepath.Join(s...)
 }
-
-func (m *Machine) getPeerByName(name string) (*Machine, bool) {
-	return m.zone.zones.GetMachineByName(name)
-}

pkg/zones/machine_rings.go

@@ -45,79 +45,9 @@ func (m *Machine) applyWireguardConfig(ring int, wg *wireguard.Config) error {
 		return err
 	}
 
-	if err := m.applyWireguardInterfaceConfig(ring, wg.Interface); err != nil {
-		err = core.Wrapf(err, "%s: wg%v:%s", m.Name, ring, addr)
-		return err
-	}
-
-	for _, peer := range wg.Peer {
-		if err := m.applyWireguardPeerConfig(ring, peer); err != nil {
-			err = core.Wrapf(err, "%s: wg%v:%s", m.Name, ring, addr)
-			return err
-		}
-	}
-
 	return nil
 }
 
-func (m *Machine) getRingInfo(ring int) (*RingInfo, bool) {
-	for _, ri := range m.RingAddresses {
-		if ri.Ring == ring {
-			return ri, true
-		}
-	}
-
-	return nil, false
-}
-
-func (m *Machine) applyRingInfo(ring int, new *RingInfo) error {
-	cur, found := m.getRingInfo(ring)
-	if !found {
-		// first, append
-		m.RingAddresses = append(m.RingAddresses, new)
-		return nil
-	}
-
-	// extra, merge
-	return cur.Merge(new)
-}
-
-func (m *Machine) applyWireguardInterfaceConfig(ring int, data wireguard.InterfaceConfig) error {
-	ri := &RingInfo{
-		Ring:    ring,
-		Enabled: true,
-		Address: data.Address,
-		Keys: &wireguard.KeyPair{
-			PrivateKey: data.PrivateKey,
-		},
-	}
-
-	return m.applyRingInfo(ring, ri)
-}
-
-func (m *Machine) applyWireguardPeerConfig(ring int, pc wireguard.PeerConfig) error {
-	peer, found := m.getPeerByName(pc.Endpoint.Name())
-	switch {
-	case !found:
-		// unknown
-	case ring == 1 && m.zone != peer.zone:
-		// invalid zone
-	default:
-		// apply RingInfo
-		ri := &RingInfo{
-			Ring:    ring,
-			Enabled: true,
-			Keys: &wireguard.KeyPair{
-				PublicKey: pc.PublicKey,
-			},
-		}
-
-		return peer.applyRingInfo(ring, ri)
-	}
-
-	return fmt.Errorf("%q: invalid peer endpoint", pc.Endpoint.Host)
-}
-
 func (m *Machine) applyZoneNodeID(zoneID, nodeID int) error {
 	switch {
 	case zoneID == 0:

pkg/zones/rings.go

@@ -51,6 +51,7 @@ func (ri *RingInfo) Merge(alter *RingInfo) error {
 		if ri.Keys.PrivateKey.IsZero() {
 			ri.Keys.PrivateKey = alter.Keys.PrivateKey
 		}
+
 		if ri.Keys.PublicKey.IsZero() {
 			ri.Keys.PublicKey = alter.Keys.PublicKey
 		}

pkg/zones/scan.go

@@ -2,25 +2,9 @@ package zones
 
 import (
 	"io/fs"
-	"sort"
 )
 
 func (m *Zones) scan() error {
-	for _, fn := range []func() error{
-		m.scanDirectory,
-		m.scanMachines,
-		m.scanZoneIDs,
-		m.scanSort,
-	} {
-		if err := fn(); err != nil {
-			return err
-		}
-	}
-
-	return nil
-}
-
-func (m *Zones) scanDirectory() error {
 	// each directory is a zone
 	entries, err := fs.ReadDir(m.dir, ".")
 	if err != nil {
@@ -42,7 +26,7 @@ func (m *Zones) scanDirectory() error {
 		}
 	}
 
-	return nil
+	return m.scanMachines()
 }
 
 func (m *Zones) scanMachines() error {
@@ -54,67 +38,6 @@ func (m *Zones) scanMachines() error {
 	return err
 }
 
-func (m *Zones) scanZoneIDs() error {
-	var hasMissing bool
-	var lastZoneID int
-
-	m.ForEachZone(func(z *Zone) bool {
-		switch {
-		case z.ID == 0:
-			hasMissing = true
-		case z.ID > lastZoneID:
-			lastZoneID = z.ID
-		}
-
-		return false
-	})
-
-	if hasMissing {
-		next := lastZoneID + 1
-
-		m.ForEachZone(func(z *Zone) bool {
-			if z.ID == 0 {
-				z.ID, next = next, next+1
-			}
-
-			return false
-		})
-	}
-
-	return nil
-}
-
-func (m *Zones) scanSort() error {
-	sort.SliceStable(m.Zones, func(i, j int) bool {
-		id1 := m.Zones[i].ID
-		id2 := m.Zones[j].ID
-		return id1 < id2
-	})
-
-	m.ForEachZone(func(z *Zone) bool {
-		sort.SliceStable(z.Machines, func(i, j int) bool {
-			id1 := z.Machines[i].ID()
-			id2 := z.Machines[j].ID()
-			return id1 < id2
-		})
-
-		return false
-	})
-
-	m.ForEachMachine(func(p *Machine) bool {
-		sort.SliceStable(p.RingAddresses, func(i, j int) bool {
-			ri1 := p.RingAddresses[i]
-			ri2 := p.RingAddresses[j]
-
-			return ri1.Ring < ri2.Ring
-		})
-
-		return false
-	})
-
-	return nil
-}
-
 func (z *Zone) scan() error {
 	// each directory is a machine
 	entries, err := fs.ReadDir(z.zones.dir, z.Name)

pkg/zones/zones.go

@@ -22,16 +22,6 @@ func (z *Zone) String() string {
 	return z.Name
 }
 
-// ForEachMachine calls a function for each Machine in the zone
-// until instructed to terminate the loop
-func (z *Zone) ForEachMachine(fn func(*Machine) bool) {
-	for _, p := range z.Machines {
-		if fn(p) {
-			return
-		}
-	}
-}
-
 // Zones represents all zones in a cluster
 type Zones struct {
 	dir      fs.FS
@@ -42,22 +32,18 @@ type Zones struct {
 }
 
 // ForEachMachine calls a function for each Machine in the cluster
-// until instructed to terminate the loop
 func (m *Zones) ForEachMachine(fn func(*Machine) bool) {
-	m.ForEachZone(func(z *Zone) bool {
-		var term bool
-
-		z.ForEachMachine(func(p *Machine) bool {
-			term = fn(p)
-			return term
-		})
-
-		return term
-	})
+	for _, z := range m.Zones {
+		for _, p := range z.Machines {
+			if fn(p) {
+				// terminate
+				return
+			}
+		}
+	}
 }
 
 // ForEachZone calls a function for each Zone in the cluster
-// until instructed to terminate the loop
 func (m *Zones) ForEachZone(fn func(*Zone) bool) {
 	for _, p := range m.Zones {
 		if fn(p) {