Merge pull request 'zones: fix jpictl dump by explicitly omitting Machine.logger and Zone.logger' (#15)

Reviewed-on: #15

.vscode/settings.json

@@ -2,6 +2,7 @@
     "cSpell.words": [
         "ceph",
         "darvaza",
+        "gofrs",
         "jpictl",
         "zerolog"
     ]

cmd/jpictl/config.go

@@ -17,5 +17,6 @@ var cfg = &Config{
 func (cfg *Config) LoadZones(resolve bool) (*zones.Zones, error) {
 	return zones.New(cfg.Base, cfg.Domain,
 		zones.ResolvePublicAddresses(resolve),
+		zones.WithLogger(log),
 	)
 }

cmd/jpictl/env.go

@@ -16,7 +16,11 @@ var envCmd = &cobra.Command{
 			return err
 		}
 
-		_, err = m.Env(*envExport).WriteTo(os.Stdout)
+		env, err := m.Env(*envExport)
+		if err != nil {
+			return err
+		}
+		_, err = env.WriteTo(os.Stdout)
 		return err
 	},
 }

cmd/jpictl/log.go

@@ -7,6 +7,7 @@ import (
 	"darvaza.org/slog"
 )
 
+// TODO: make log level configurable via flags
 var (
 	log = zerolog.New(nil, slog.Debug)
 )

go.mod

@@ -8,6 +8,7 @@ require (
 	darvaza.org/resolver v0.5.4
 	darvaza.org/sidecar v0.0.2
 	darvaza.org/slog v0.5.3
+	darvaza.org/slog/handlers/discard v0.4.5
 	github.com/burntSushi/toml v0.3.1
 	github.com/gofrs/uuid/v5 v5.0.0
 	github.com/hack-pad/hackpadfs v0.2.1

go.sum

@@ -10,6 +10,8 @@ darvaza.org/sidecar v0.0.2 h1:4H8FUxc43kkLjxdShN1CoxLTcoHQsZjDVwm7kt6eIK0=
 darvaza.org/sidecar v0.0.2/go.mod h1:yFC3Qt3j+uS7n9CMpLxwrA68z+FNJhENoenBc9zBJJo=
 darvaza.org/slog v0.5.3 h1:sQzmZXgqRh9oFMKBwEYrEpucLvKJVZxaxa2bHIA6GJ0=
 darvaza.org/slog v0.5.3/go.mod h1:59d+yi+C7gn4pDDuwbbOKawERpdXthFFk1Yc+Sv6XB0=
+darvaza.org/slog/handlers/discard v0.4.5 h1:RRykOItNolHyiUav57lG/GFBL33rcljoa0nWTpY+T0g=
+darvaza.org/slog/handlers/discard v0.4.5/go.mod h1:HYHfISQjMqcPbPoPZ92ib/u7s9JcXvF6OaygpPFwdF8=
 darvaza.org/slog/handlers/filter v0.4.5 h1:CX1bMzldd67e3y3s3Sh4jK8Lyo0WMvTGBB2lD315jhc=
 darvaza.org/slog/handlers/filter v0.4.5/go.mod h1:OuH9rHYg9CIErTJCZliMnFexBfP/HJ9PZ1V1VwSCZ1g=
 darvaza.org/slog/handlers/zerolog v0.4.5 h1:W4cgGORx4wImr+RL96CWSQGTdkZzKX6YHXPSYJvdoB4=

pkg/zones/ceph.go

@@ -14,8 +14,12 @@ import (
 // GetCephFSID returns our Ceph's FSID
 func (m *Zones) GetCephFSID() (uuid.UUID, error) {
 	if core.IsZero(m.CephFSID) {
-		// TODO: generate one
-		return uuid.Nil, nil
+		// generate one
+		v, err := uuid.NewV4()
+		if err != nil {
+			return uuid.Nil, err
+		}
+		m.CephFSID = v
 	}
 	return m.CephFSID, nil
 }

pkg/zones/env.go

@@ -11,15 +11,24 @@ import (
 type Env struct {
 	ZoneIterator
 
-	export bool
+	cephFSID string
+	export   bool
 }
 
 // Env returns a shell environment factory
-func (m *Zones) Env(export bool) *Env {
-	return &Env{
+func (m *Zones) Env(export bool) (*Env, error) {
+	fsid, err := m.GetCephFSID()
+	if err != nil {
+		return nil, err
+	}
+
+	env := &Env{
 		ZoneIterator: m,
+		cephFSID:     fsid.String(),
 		export:       export,
 	}
+
+	return env, nil
 }
 
 // Zones returns the list of Zone IDs
@@ -38,7 +47,12 @@ func (m *Env) Zones() []int {
 func (m *Env) WriteTo(w io.Writer) (int64, error) {
 	var buf bytes.Buffer
 
+	if m.cephFSID != "" {
+		m.writeEnvVar(&buf, m.cephFSID, "FSID")
+	}
+
 	m.writeEnvVarInts(&buf, m.Zones(), "ZONES")
+
 	m.ForEachZone(func(z *Zone) bool {
 		m.writeEnvZone(&buf, z)
 		return false

pkg/zones/errors.go

@@ -0,0 +1,16 @@
+package zones
+
+import "errors"
+
+var (
+	// ErrInvalidName indicates the name isn't valid
+	ErrInvalidName = errors.New("invalid name")
+
+	// ErrUnknownNode indicates there is a reference to a node
+	// we don't have on the tree
+	ErrUnknownNode = errors.New("node does not exist")
+
+	// ErrInvalidNode indicates the nodes can't be used for
+	// the intended purpose
+	ErrInvalidNode = errors.New("invalid node")
+)

pkg/zones/log.go

@@ -0,0 +1,49 @@
+package zones
+
+import "darvaza.org/slog"
+
+type logger interface {
+	withDebug() (slog.Logger, bool)
+	withInfo() (slog.Logger, bool)
+
+	debug() slog.Logger
+	info() slog.Logger
+	warn(error) slog.Logger
+	error(error) slog.Logger
+}
+
+var (
+	_ logger = (*Zones)(nil)
+)
+
+func (z *Zones) withDebug() (slog.Logger, bool) {
+	return z.debug().WithEnabled()
+}
+
+func (z *Zones) withInfo() (slog.Logger, bool) {
+	return z.debug().WithEnabled()
+}
+
+func (z *Zones) debug() slog.Logger {
+	return z.log.Debug()
+}
+
+func (z *Zones) info() slog.Logger {
+	return z.log.Info()
+}
+
+func (z *Zones) warn(err error) slog.Logger {
+	l := z.log.Warn()
+	if err != nil {
+		l = l.WithField(slog.ErrorFieldName, err)
+	}
+	return l
+}
+
+func (z *Zones) error(err error) slog.Logger {
+	l := z.log.Error()
+	if err != nil {
+		l = l.WithField(slog.ErrorFieldName, err)
+	}
+	return l
+}

pkg/zones/machine.go

@@ -9,7 +9,9 @@ import (
 
 // A Machine is a machine on a Zone
 type Machine struct {
-	zone *Zone
+	zone   *Zone
+	logger `toml:"-" json:"-" yaml:"-"`
+
 	ID   int    `toml:"id"`
 	Name string `toml:"-" json:"-" yaml:"-"`
 

pkg/zones/machine_rings.go

@@ -2,6 +2,7 @@ package zones
 
 import (
 	"bytes"
+	"errors"
 	"fmt"
 	"os"
 
@@ -135,7 +136,11 @@ func (m *Machine) applyWireguardConfig(ring int, wg *wireguard.Config) error {
 	}
 
 	for _, peer := range wg.Peer {
-		if err := m.applyWireguardPeerConfig(ring, peer); err != nil {
+		err := m.applyWireguardPeerConfig(ring, peer)
+		switch {
+		case errors.Is(err, ErrUnknownNode):
+			// ignore unknown peers
+		case err != nil:
 			err = core.Wrapf(err, "%s: wg%v:%s", m.Name, ring, addr)
 			return err
 		}
@@ -183,8 +188,10 @@ func (m *Machine) applyWireguardPeerConfig(ring int, pc wireguard.PeerConfig) er
 	switch {
 	case !found:
 		// unknown
+		return core.Wrap(ErrUnknownNode, pc.Endpoint.Host)
 	case ring == 1 && m.zone != peer.zone:
 		// invalid zone
+		return core.Wrap(ErrInvalidNode, peer.Name)
 	default:
 		// apply RingInfo
 		ri := &RingInfo{
@@ -197,8 +204,6 @@ func (m *Machine) applyWireguardPeerConfig(ring int, pc wireguard.PeerConfig) er
 
 		return peer.applyRingInfo(ring, ri)
 	}
-
-	return fmt.Errorf("%q: invalid peer endpoint", pc.Endpoint.Host)
 }
 
 func (m *Machine) applyZoneNodeID(zoneID, nodeID int) error {

pkg/zones/machine_scan.go

@@ -4,7 +4,10 @@ import (
 	"context"
 	"net/netip"
 	"strconv"
+	"strings"
 	"time"
+
+	"darvaza.org/core"
 )
 
 // LookupNetIP uses the DNS Resolver to get the public addresses associated
@@ -30,21 +33,32 @@ func (m *Machine) UpdatePublicAddresses() error {
 
 func (m *Machine) init() error {
 	if err := m.setID(); err != nil {
-		return err
+		return core.Wrap(err, m.Name)
 	}
 
 	for i := 0; i < RingsCount; i++ {
 		if err := m.tryReadWireguardKeys(i); err != nil {
-			return err
+			return core.Wrap(err, m.Name)
 		}
 	}
+
 	return nil
 }
 
 func (m *Machine) setID() error {
 	zoneName := m.zone.Name
-	suffix := m.Name[len(zoneName)+1:]
 
+	l := len(zoneName)
+	switch {
+	case len(m.Name) < l+2:
+		return ErrInvalidName
+	case !strings.HasPrefix(m.Name, zoneName):
+		return ErrInvalidName
+	case m.Name[l] != '-':
+		return ErrInvalidName
+	}
+
+	suffix := m.Name[l+1:]
 	id, err := strconv.ParseInt(suffix, 10, 8)
 	if err != nil {
 		return err

pkg/zones/options.go

@@ -5,10 +5,12 @@ import (
 	"path/filepath"
 
 	"darvaza.org/resolver"
+	"darvaza.org/slog"
+	"darvaza.org/slog/handlers/discard"
 	"github.com/hack-pad/hackpadfs/os"
 )
 
-// A ScanOption preconfigures the Zones before scanning
+// A ScanOption pre-configures the Zones before scanning
 type ScanOption func(*Zones, *ScanOptions) error
 
 // ScanOptions contains flags used by the initial scan
@@ -17,6 +19,10 @@ type ScanOptions struct {
 	// pre-populate Machine.PublicAddresses during the
 	// initial scan
 	DontResolvePublicAddresses bool
+
+	// Logger specifies the logger to be used. otherwise
+	// the scanner will be mute
+	slog.Logger
 }
 
 // ResolvePublicAddresses instructs the scanner to use
@@ -55,6 +61,19 @@ func WithResolver(h resolver.Resolver) ScanOption {
 	}
 }
 
+// WithLogger specifies what to use for logging
+func WithLogger(log slog.Logger) ScanOption {
+	return func(m *Zones, opt *ScanOptions) error {
+		if log == nil {
+			log = discard.New()
+		}
+
+		opt.Logger = log
+		m.log = log
+		return nil
+	}
+}
+
 func (m *Zones) setDefaults(opt *ScanOptions) error {
 	if m.resolver == nil {
 		h := resolver.NewCloudflareLookuper()
@@ -64,6 +83,12 @@ func (m *Zones) setDefaults(opt *ScanOptions) error {
 		}
 	}
 
+	if opt.Logger == nil {
+		if err := WithLogger(nil)(m, opt); err != nil {
+			return err
+		}
+	}
+
 	return nil
 }
 

pkg/zones/scan.go

@@ -3,6 +3,8 @@ package zones
 import (
 	"io/fs"
 	"sort"
+
+	"darvaza.org/core"
 )
 
 func (m *Zones) scan(opts *ScanOptions) error {
@@ -31,22 +33,32 @@ func (m *Zones) scanDirectory(_ *ScanOptions) error {
 
 	for _, e := range entries {
 		if e.IsDir() {
-			z := &Zone{
-				zones: m,
-				Name:  e.Name(),
+			z, err := m.newZone(e.Name())
+			switch {
+			case err != nil:
+				return core.Wrap(err, e.Name())
+			case z.Machines.Len() > 0:
+				m.Zones = append(m.Zones, z)
 			}
-
-			if err := z.scan(); err != nil {
-				return err
-			}
-
-			m.Zones = append(m.Zones, z)
 		}
 	}
 
 	return nil
 }
 
+func (m *Zones) newZone(name string) (*Zone, error) {
+	z := &Zone{
+		zones:  m,
+		logger: m,
+		Name:   name,
+	}
+
+	if err := z.scan(); err != nil {
+		return nil, err
+	}
+	return z, nil
+}
+
 func (m *Zones) scanMachines(opts *ScanOptions) error {
 	var err error
 	m.ForEachMachine(func(p *Machine) bool {
@@ -132,8 +144,9 @@ func (z *Zone) scan() error {
 	for _, e := range entries {
 		if e.IsDir() {
 			m := &Machine{
-				zone: z,
-				Name: e.Name(),
+				zone:   z,
+				logger: z,
+				Name:   e.Name(),
 			}
 
 			if err := m.init(); err != nil {

pkg/zones/zones.go

@@ -6,6 +6,7 @@ import (
 	"sort"
 
 	"darvaza.org/resolver"
+	"darvaza.org/slog"
 	"github.com/gofrs/uuid/v5"
 )
 
@@ -86,7 +87,8 @@ func FilterMachines(m MachineIterator, cond func(*Machine) bool) (Machines, int)
 
 // Zone represents one zone in a cluster
 type Zone struct {
-	zones *Zones
+	zones  *Zones
+	logger `toml:"-" json:"-" yaml:"-"`
 
 	ID   int    `toml:"id"`
 	Name string `toml:"name"`
@@ -141,6 +143,7 @@ func (z *Zone) GatewayIDs() ([]int, int) {
 // Zones represents all zones in a cluster
 type Zones struct {
 	dir      fs.FS
+	log      slog.Logger
 	resolver resolver.Resolver
 	domain   string