Include metal-networker

Author: majst01

Makefile

@@ -11,7 +11,7 @@ LINKMODE := -extldflags=-static \
 		 -X 'github.com/metal-stack/v.GitSHA1=$(SHA)' \
 		 -X 'github.com/metal-stack/v.BuildDate=$(BUILDDATE)'
 
-all: test binary
+all: test validate binary
 
 .PHONY: binary
 binary:
@@ -26,4 +26,11 @@ binary:
 
 .PHONY: test
 test:
-	GO_ENV=testing go test -race -cover ./...
+	GO_ENV=testing go test -race -cover ./...
+
+
+.PHONY: validate
+validate:
+	cd pkg/network
+	./validate.sh
+	cd -

go.mod

@@ -3,22 +3,22 @@ module github.com/metal-stack/os-installer
 go 1.26
 
 require (
+	github.com/Masterminds/semver/v3 v3.4.0
+	github.com/coreos/go-systemd/v22 v22.7.0
 	github.com/flatcar/ignition v0.36.2
 	github.com/google/go-cmp v0.7.0
 	github.com/metal-stack/metal-go v0.43.0
-	github.com/metal-stack/metal-networker v0.46.3
+	github.com/metal-stack/metal-lib v0.24.0
 	github.com/metal-stack/v v1.0.3
 	github.com/spf13/afero v1.15.0
 	github.com/stretchr/testify v1.11.1
 	gopkg.in/yaml.v3 v3.0.1
 )
 
 require (
-	github.com/Masterminds/semver/v3 v3.4.0 // indirect
 	github.com/ajeddeloh/go-json v0.0.0-20160803184958-73d058cf8437 // indirect
 	github.com/coreos/go-semver v0.3.1 // indirect
 	github.com/coreos/go-systemd v0.0.0-20191104093116-d3cd4ed1dbcf // indirect
-	github.com/coreos/go-systemd/v22 v22.7.0 // indirect
 	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
 	github.com/go-openapi/analysis v0.24.2 // indirect
 	github.com/go-openapi/errors v0.22.6 // indirect
@@ -43,9 +43,6 @@ require (
 	github.com/go-viper/mapstructure/v2 v2.5.0 // indirect
 	github.com/godbus/dbus/v5 v5.2.2 // indirect
 	github.com/google/uuid v1.6.0 // indirect
-	github.com/kr/text v0.2.0 // indirect
-	github.com/metal-stack/metal-hammer v0.14.1 // indirect
-	github.com/metal-stack/metal-lib v0.24.0 // indirect
 	github.com/oklog/ulid v1.3.1 // indirect
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
 	github.com/vincent-petithory/dataurl v1.0.0 // indirect

go.sum

@@ -11,7 +11,6 @@ github.com/coreos/go-systemd v0.0.0-20191104093116-d3cd4ed1dbcf h1:iW4rZ826su+pq
 github.com/coreos/go-systemd v0.0.0-20191104093116-d3cd4ed1dbcf/go.mod h1:F5haX7vjVVG0kc13fIWeqUViNPyEJxv/OmvnBo0Yme4=
 github.com/coreos/go-systemd/v22 v22.7.0 h1:LAEzFkke61DFROc7zNLX/WA2i5J8gYqe0rSj9KI28KA=
 github.com/coreos/go-systemd/v22 v22.7.0/go.mod h1:xNUYtjHu2EDXbsxz1i41wouACIwT7Ybq9o0BQhMwD0w=
-github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc h1:U9qPSI2PIWSS1VwoXQT9A3Wy9MM3WgvqSxFWenqJduM=
 github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -76,18 +75,10 @@ github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+
 github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY=
 github.com/jmespath/go-jmespath v0.0.0-20160202185014-0b12d6b521d8/go.mod h1:Nht3zPeWKUH0NzdCt2Blrr5ys8VGpn0CEB0cQHVjt7k=
 github.com/jtolds/gls v4.20.0+incompatible/go.mod h1:QJZ7F/aHp+rZTRtaJ1ow/lLfFfVYBRgL+9YlvaHOwJU=
-github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
-github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
-github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
-github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
 github.com/metal-stack/metal-go v0.43.0 h1:uODD0YCwnAYzyvFxWNakZrymBoMz1FAvP5hkhsR83VQ=
 github.com/metal-stack/metal-go v0.43.0/go.mod h1:GSfXrAj55LGsUSMHWGDsmq5n056NG0yb1JM8bgfvKOw=
-github.com/metal-stack/metal-hammer v0.14.1 h1:4Zuh7jdK/EUfJGZcrYjVAqRmgnZBf2S4WuL2mPqvexs=
-github.com/metal-stack/metal-hammer v0.14.1/go.mod h1:RLwtW2d02Ghv8fwFLNQNJD/bfYL+4M0qzVehM1/WadQ=
 github.com/metal-stack/metal-lib v0.24.0 h1:wvQQPWIXcA2tP+I6zAHUNdtVLLJfQnnV9yG2SoqUkz4=
 github.com/metal-stack/metal-lib v0.24.0/go.mod h1:oITaqj/BtB9vDKM66jCXkeA+4D0eTZElgIKal5vtiNY=
-github.com/metal-stack/metal-networker v0.46.3 h1:0suUDm6trfwMElZsf9cuewJmrYmsBSpxlVYcOAGWsPk=
-github.com/metal-stack/metal-networker v0.46.3/go.mod h1:FFER+4gOERGz3eTCoWqyfQ5eXwHNlYC00j5hdEJhqDU=
 github.com/metal-stack/v v1.0.3 h1:Sh2oBlnxrCUD+mVpzfC8HiqL045YWkxs0gpTvkjppqs=
 github.com/metal-stack/v v1.0.3/go.mod h1:YTahEu7/ishwpYKnp/VaW/7nf8+PInogkfGwLcGPdXg=
 github.com/oklog/ulid v1.3.1 h1:EGfNDEx6MqHz8B3uNV6QAib1UR2Lm97sHi3ocA6ESJ4=
@@ -97,8 +88,6 @@ github.com/pin/tftp v2.1.0+incompatible/go.mod h1:xVpZOMCXTy+A5QMjEVN0Glwa1sUvaJ
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 h1:Jamvg5psRIccs7FGNTlIRMkT8wgtp5eCXdBlqhYGL6U=
 github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ=
-github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc=
 github.com/sigma/bdoor v0.0.0-20160202064022-babf2a4017b0/go.mod h1:WBu7REWbxC/s/J06jsk//d+9DOz9BbsmcIrimuGRFbs=
 github.com/sigma/vmw-guestinfo v0.0.0-20160204083807-95dd4126d6e8/go.mod h1:JrRFFC0veyh0cibh0DAhriSY7/gV3kDdNaVUOmfx01U=
 github.com/smartystreets/assertions v1.2.0/go.mod h1:tcbTF8ujkAEcZ8TElKY+i30BzYlVhC/LOxJk7iOWnoo=
@@ -134,9 +123,8 @@ golang.org/x/text v0.34.0 h1:oL/Qq0Kdaqxa1KbNeMKwQq0reLCCaFtqu2eNuSeNHbk=
 golang.org/x/text v0.34.0/go.mod h1:homfLqTYRFyVYemLBFl5GgL/DWEiH5wcsQ5gSh1yziA=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
 golang.org/x/tools v0.0.0-20190328211700-ab21143f2384/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
-gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
 gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

install.go

@@ -14,8 +14,8 @@ import (
 
 	ignitionConfig "github.com/flatcar/ignition/config/v2_4"
 	"github.com/metal-stack/metal-go/api/models"
-	"github.com/metal-stack/metal-networker/pkg/netconf"
 	v1 "github.com/metal-stack/os-installer/api/v1"
+	"github.com/metal-stack/os-installer/pkg/network"
 	"github.com/metal-stack/os-installer/templates"
 	"github.com/metal-stack/v"
 	"github.com/spf13/afero"
@@ -411,17 +411,17 @@ func (i *installer) createMetalUser() error {
 
 func (i *installer) configureNetwork() error {
 	i.log.Info("configure network")
-	kb, err := netconf.New(i.log.WithGroup("networker"), installYAML)
+	kb, err := network.New(i.log.WithGroup("networker"), installYAML)
 	if err != nil {
 		return err
 	}
 
-	var kind netconf.BareMetalType
+	var kind network.BareMetalType
 	switch i.config.Role {
 	case models.V1MachineAllocationRoleFirewall:
-		kind = netconf.Firewall
+		kind = network.Firewall
 	case models.V1MachineAllocationRoleMachine:
-		kind = netconf.Machine
+		kind = network.Machine
 	default:
 		return fmt.Errorf("unknown role:%s", i.config.Role)
 	}
@@ -431,11 +431,11 @@ func (i *installer) configureNetwork() error {
 		return err
 	}
 
-	c, err := netconf.NewConfigurator(kind, *kb, false)
+	c, err := network.NewConfigurator(kind, *kb, false)
 	if err != nil {
 		return err
 	}
-	c.Configure(netconf.ForwardPolicyDrop)
+	c.Configure(network.ForwardPolicyDrop)
 	return nil
 }
 

pkg/exec/doc.go

@@ -0,0 +1,4 @@
+/*
+Package exec groups functionality related for command execution.
+*/
+package exec

pkg/exec/verbosecmd.go

@@ -0,0 +1,32 @@
+package exec
+
+import (
+	"bytes"
+	"fmt"
+	"os/exec"
+)
+
+// VerboseCmd represents a system command with verbose output to be able to get an idea of the issue in case the cmd
+// fails.
+type VerboseCmd struct {
+	Cmd exec.Cmd
+}
+
+// NewVerboseCmd creates a new instance of VerboseCmd.
+func NewVerboseCmd(name string, args ...string) VerboseCmd {
+	cmd := exec.Command(name, args...)
+	return VerboseCmd{*cmd}
+}
+
+//Run executes the command and returns any errors in case exist.
+func (v VerboseCmd) Run() error {
+	var stderr bytes.Buffer
+	v.Cmd.Stderr = &stderr
+
+	err := v.Cmd.Run()
+	if err != nil {
+		return fmt.Errorf("%w: %s", err, stderr.String())
+	}
+
+	return nil
+}

pkg/net/README.md

@@ -0,0 +1,28 @@
+# network
+
+Network can apply changes to `/etc/network/interfaces` and `/etc/frr/frr.conf`. 
+
+It was intentionally created to provide a common means to:
+
+- apply validation
+- render interfaces/frr.conf files
+- reload required services to apply changes
+
+## Requirements
+
+Network lib relies on `ifupdown2` and `systemd`. It also is assumed frr is installed as systemd service.
+
+## Usage
+
+Make use network lib:
+
+```go
+package main
+
+import "github.com/metal-stack/os-installer/pkg/net"
+
+func main() {
+	// TODO
+}
+
+```

pkg/net/applier.go

@@ -0,0 +1,128 @@
+package net
+
+import (
+	"bufio"
+	"bytes"
+	"crypto/sha256"
+	"io"
+	"os"
+	"text/template"
+)
+
+// Applier is an interface to render changes and reload services to apply them.
+type Applier interface {
+	Apply(tpl template.Template, tmpFile, destFile string, reload bool) (bool, error)
+	Render(writer io.Writer, tpl template.Template) error
+	Reload() error
+	Validate() error
+	Compare(tmpFile, destFile string) bool
+}
+
+// networkApplier holds the toolset for applying network configuration changes.
+type networkApplier struct {
+	data      any
+	validator Validator
+	reloader  Reloader
+}
+
+// NewNetworkApplier creates a new NewNetworkApplier.
+func NewNetworkApplier(data any, validator Validator, reloader Reloader) Applier {
+	return &networkApplier{data: data, validator: validator, reloader: reloader}
+}
+
+// Apply applies the current configuration with the given template.
+func (n *networkApplier) Apply(tpl template.Template, tmpFile, destFile string, reload bool) (bool, error) {
+	f, err := os.OpenFile(tmpFile, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0644)
+	if err != nil {
+		return false, err
+	}
+
+	defer func() {
+		_ = f.Close()
+	}()
+
+	w := bufio.NewWriter(f)
+	err = n.Render(w, tpl)
+	if err != nil {
+		return false, err
+	}
+
+	err = w.Flush()
+	if err != nil {
+		return false, err
+	}
+
+	err = n.Validate()
+	if err != nil {
+		return false, err
+	}
+
+	equal := n.Compare(tmpFile, destFile)
+	if equal {
+		return false, nil
+	}
+
+	err = os.Rename(tmpFile, destFile)
+	if err != nil {
+		return false, err
+	}
+
+	if !reload {
+		return true, nil
+	}
+
+	err = n.Reload()
+	if err != nil {
+		return true, err
+	}
+
+	return true, nil
+}
+
+// Render renders the network interfaces to the given writer using the given template.
+func (n *networkApplier) Render(w io.Writer, tpl template.Template) error {
+	return tpl.Execute(w, n.data)
+}
+
+// Validate applies the given validator to validate current changes.
+func (n *networkApplier) Validate() error {
+	return n.validator.Validate()
+}
+
+// Reload reloads the necessary services when the network interfaces configuration was changed.
+func (n *networkApplier) Reload() error {
+	return n.reloader.Reload()
+}
+
+// Compare compare source and target for hash equality.
+func (n *networkApplier) Compare(source, target string) bool {
+	sourceChecksum, err := checksum(source)
+	if err != nil {
+		return false
+	}
+
+	targetChecksum, err := checksum(target)
+	if err != nil {
+		return false
+	}
+
+	return bytes.Equal(sourceChecksum, targetChecksum)
+}
+
+func checksum(file string) ([]byte, error) {
+	f, err := os.Open(file)
+	if err != nil {
+		return nil, err
+	}
+
+	defer func() {
+		_ = f.Close()
+	}()
+
+	h := sha256.New()
+	if _, err := io.Copy(h, f); err != nil {
+		return nil, err
+	}
+
+	return h.Sum(nil), nil
+}

pkg/net/applier_test.go

@@ -0,0 +1,33 @@
+package net
+
+import "testing"
+
+func TestNetworkApplier_Compare(t *testing.T) {
+	tests := []struct {
+		name   string
+		source string
+		target string
+		want   bool
+	}{
+		{
+			name:   "simple test",
+			source: "/etc/hostname",
+			target: "/etc/passwd",
+			want:   false,
+		},
+		{
+			name:   "simple test",
+			source: "/etc/hostname",
+			target: "/etc/hostname",
+			want:   true,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			n := &networkApplier{}
+			if got := n.Compare(tt.source, tt.target); got != tt.want {
+				t.Errorf("NetworkApplier.Compare() = %v, want %v", got, tt.want)
+			}
+		})
+	}
+}

pkg/net/doc.go

@@ -0,0 +1,2 @@
+// Package net contains code to apply changes to network interfaces and FRR (Free Range Routing).
+package net