From f713f482fa809dc246befb2f80622023aa74beec Mon Sep 17 00:00:00 2001 From: GnomeZworc Date: Mon, 12 Oct 2026 15:44:07 +0200 Subject: [PATCH 1/5] =?UTF-8?q?f-55:=20lab:=20provision=20g=C3=A9n=C3=A9ri?= =?UTF-8?q?que=20des=20n=C5=93uds,=20r=C3=B4le=20host,=20two=20install?= =?UTF-8?q?=C3=A9=20par=20test/e2e=20#55?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: GnomeZworc --- cmd/lab/main.go | 11 +- cmd/lab/main_test.go | 45 ++++-- docs/developpement/lab.rst | 80 ++++++----- internal/lab/machine/machine.go | 5 +- internal/lab/machine/machine_test.go | 14 +- internal/lab/provision/provision.go | 41 ++++-- internal/lab/provision/provision_test.go | 54 ++++--- internal/lab/render/render.go | 16 ++- internal/lab/render/render_test.go | 10 +- internal/lab/render/roles_test.go | 132 +++++++++--------- internal/lab/render/seed.go | 51 +++---- internal/lab/topology/format.go | 8 +- internal/lab/topology/plan.go | 44 +++--- internal/lab/topology/plan_test.go | 25 ++-- internal/lab/topology/roles_test.go | 116 +++++++-------- internal/lab/topology/topology.go | 100 +++++++------ internal/lab/topology/validate.go | 32 +++-- scripts/embed.go | 9 -- test/e2e/topologies/evpn-2hv.yml | 14 +- test/e2e/topologies/evpn-3hv.yml | 21 +-- .../topologies/provision/hypervisor-post.sh | 3 + test/e2e/topologies/provision/hypervisor.sh | 19 +++ 22 files changed, 481 insertions(+), 369 deletions(-) delete mode 100644 scripts/embed.go create mode 100755 test/e2e/topologies/provision/hypervisor-post.sh create mode 100755 test/e2e/topologies/provision/hypervisor.sh diff --git a/cmd/lab/main.go b/cmd/lab/main.go index 3ff3cf2..90c2e50 100644 --- a/cmd/lab/main.go +++ b/cmd/lab/main.go @@ -130,17 +130,12 @@ func renderCmd(args []string, stdout, stderr io.Writer) int { fmt.Fprintf(stderr, "lab: %v\n", err) return 1 } - frr, err := provision.ReadFRR(p) - if err != nil { + opts := render.Options{RunDir: dir, AuthorizedKeys: authorized} + if err := provision.ReadInputs(p, &opts); err != nil { fmt.Fprintf(stderr, "lab: %v\n", err) return 1 } - agent, err := provision.ReadAgent(p) - if err != nil { - fmt.Fprintf(stderr, "lab: %v\n", err) - return 1 - } - nodes, err := render.Render(p, render.Options{RunDir: dir, AuthorizedKeys: authorized, FRR: frr, Agent: agent}) + nodes, err := render.Render(p, opts) if err != nil { fmt.Fprintf(stderr, "lab: %v\n", err) return 1 diff --git a/cmd/lab/main_test.go b/cmd/lab/main_test.go index 4b4ac5e..8987dcc 100644 --- a/cmd/lab/main_test.go +++ b/cmd/lab/main_test.go @@ -2,6 +2,7 @@ package main import ( "bytes" + "encoding/base64" "os" "os/exec" "path/filepath" @@ -9,6 +10,8 @@ import ( "strings" "syscall" "testing" + + "go.yaml.in/yaml/v3" ) func runLab(args ...string) (int, string, string) { @@ -165,11 +168,11 @@ func TestRun_CommandsWithoutALabInTheRunDir(t *testing.T) { func TestRun_StatusOfAStoppedLab(t *testing.T) { code, stdout, stderr := runLab("status", "-run", savedLab(t)) - want := `node role state pid ssh -sw1 switch stopped - 127.0.0.1:2200 -rr1 rr stopped - 127.0.0.1:2201 -hv1 hypervisor stopped - 127.0.0.1:2202 -hv2 hypervisor stopped - 127.0.0.1:2203 + want := `node role state pid ssh +sw1 switch stopped - 127.0.0.1:2200 +rr1 rr stopped - 127.0.0.1:2201 +hv1 host stopped - 127.0.0.1:2202 +hv2 host stopped - 127.0.0.1:2203 ` if code != 0 || stdout != want { t.Errorf("code %d, stderr %q, stdout:\n%s", code, stderr, stdout) @@ -315,8 +318,8 @@ func TestRun_RenderShipsTheExampleFRRConfigs(t *testing.T) { for node, wants := range map[string][]string{ "sw1": {"router bgp 65100"}, "rr1": {"bgp listen range 192.168.14.0/24 peer-group fabric"}, - "hv1": {"hostname hv1", "route_reflectors: [10.255.255.1]"}, - "hv2": {"hostname hv2", "route_reflectors: [10.255.255.1]"}, + "hv1": {"hostname hv1"}, + "hv2": {"hostname hv2"}, } { data, err := os.ReadFile(filepath.Join(out, node, "user-data")) if err != nil { @@ -328,6 +331,32 @@ func TestRun_RenderShipsTheExampleFRRConfigs(t *testing.T) { } } } + for _, node := range []string{"hv1", "hv2"} { + data, err := os.ReadFile(filepath.Join(out, node, "user-data")) + if err != nil { + t.Fatal(err) + } + var cfg struct { + Files []struct { + Path string `yaml:"path"` + Content string `yaml:"content"` + } `yaml:"write_files"` + } + if err := yaml.Unmarshal(data, &cfg); err != nil { + t.Fatal(err) + } + var agent []byte + for _, f := range cfg.Files { + if f.Path == "/etc/lab/files/agent.yml" { + if agent, err = base64.StdEncoding.DecodeString(f.Content); err != nil { + t.Fatal(err) + } + } + } + if !strings.Contains(string(agent), "route_reflectors: [10.255.255.1]") { + t.Errorf("%s agent.yml = %q", node, agent) + } + } } func TestRun_RenderReportsAMissingFRRConfig(t *testing.T) { @@ -344,7 +373,7 @@ segments: underlay: { switch: sw1, cidr: 10.1.0.0/24 } nodes: sw1: { role: switch, image: deb, cpus: 1, memory: 512, frr: frr/absent.conf } - hv1: { role: hypervisor, image: deb, cpus: 1, memory: 512, segments: [underlay], release: 0.2.0rc002 } + hv1: { role: host, image: deb, cpus: 1, memory: 512, segments: [underlay] } ` if err := os.WriteFile(topo, []byte(doc), 0o600); err != nil { t.Fatal(err) diff --git a/docs/developpement/lab.rst b/docs/developpement/lab.rst index d45aa3d..d9fa252 100644 --- a/docs/developpement/lab.rst +++ b/docs/developpement/lab.rst @@ -231,7 +231,7 @@ Ce que le fichier déclare : bridge (15 caractères au plus sous Linux). ``nodes`` - ``role`` (``switch``, ``rr`` ou ``hypervisor``), ``image``, ``cpus``, ``memory`` en Mio + ``role`` (``switch``, ``rr`` ou ``host``), ``image``, ``cpus``, ``memory`` en Mio (256 au moins), ``segments`` auxquels le nœud est relié, et ``addresses`` pour fixer l'adresse d'un nœud sur un segment (``addresses: {underlay: 192.168.14.50}``). Un switch ne déclare ni ``segments`` ni ``addresses`` : il porte ceux dont il est le ``switch``. @@ -247,15 +247,17 @@ Ce que le fichier déclare : (``loopback: 10.255.255.1/32``) ; * ``frr`` — le chemin d'un ``frr.conf``, relatif au fichier de topologie : FRR est installé au démarrage et la configuration déposée **telle quelle** (voir `Rôles`_). - * ``release`` — **obligatoire pour un hyperviseur**, refusé ailleurs : le tag de la release de - two que ``deploy.sh`` installe (``release: 0.2.0rc008``). Sans lui, ``deploy.sh`` prendrait la - dernière release, et le lab ne serait plus reproductible. - * ``agent`` — pour un hyperviseur seulement : le chemin d'un ``agent.yml``, relatif au fichier - de topologie, déposé dans ``/etc/two/agent.yml`` avant ``deploy.sh``. Sans lui, l'agent tourne - avec sa configuration par défaut. Les deux fichiers fournis donnent à l'agent la section - ``bgp`` (AS 64600, route reflector ``10.255.255.1``) et un watchdog toutes les 10 s ; - ``test/e2e/topologies/agent/two.yml`` met en plus hv1 sur le serveur DHCP intégré - (``dhcp.backend: two``), ``agent/bgp.yml`` laisse les autres sur dnsmasq. + * ``provision`` — le chemin d'un script, relatif au fichier de topologie, exécuté au premier + démarrage **avant** FRR ; + * ``post_provision`` — un second script, exécuté **après** FRR ; + * ``files`` — des fichiers déposés dans ``/etc/lab/files/`` avant les scripts, sous la + forme ``{: }`` (``files: {agent.yml: agent/two.yml}``) ; + * ``services`` — les unités systemd que ``lab up`` vérifie actives sur le nœud. + + Les scripts reçoivent ``LAB_NODE`` (nom du nœud), ``LAB_UPLINK`` (interface de son premier + segment, qui porte la route par défaut) et ``LAB_FILES`` (``/etc/lab/files``). L'outil ne sait + rien de ce qu'ils installent : l'installation de two est une provision de + ``test/e2e/topologies/`` (voir `Rôles`_). ``mgmt0`` et ``lo1`` sont réservés : aucun segment ne peut porter ces noms. @@ -295,18 +297,18 @@ Limites : 1000 nœuds, 256 segments, et autant de câbles que la plage UDP le pe lab evpn-2hv: nodes 4, segments 1, cables 3 nodes - name role image cpus memory ssh - sw1 switch debian12 2 1024 MiB 127.0.0.1:2200 - rr1 rr debian12 1 1024 MiB 127.0.0.1:2201 - hv1 hypervisor debian12 4 16384 MiB 127.0.0.1:2202 - hv2 hypervisor debian12 4 16384 MiB 127.0.0.1:2203 + name role image cpus memory ssh + sw1 switch debian12 2 1024 MiB 127.0.0.1:2200 + rr1 rr debian12 1 1024 MiB 127.0.0.1:2201 + hv1 host debian12 4 16384 MiB 127.0.0.1:2202 + hv2 host debian12 4 16384 MiB 127.0.0.1:2203 roles - name loopback secondary frr release agent - sw1 - underlay 169.254.0.1/28 sw1.conf - - - rr1 lo1 10.255.255.1/32 underlay 169.254.0.3/28 rr1.conf - - - hv1 - - hv1.conf 0.2.0rc008 two.yml - hv2 - - hv2.conf 0.2.0rc008 bgp.yml + name loopback secondary frr provision post_provision files services + sw1 - underlay 169.254.0.1/28 sw1.conf - - - - + rr1 lo1 10.255.255.1/32 underlay 169.254.0.3/28 rr1.conf - - - - + hv1 - - hv1.conf hypervisor.sh hypervisor-post.sh agent.yml agent.service + hv2 - - hv2.conf hypervisor.sh hypervisor-post.sh agent.yml agent.service segment underlay: 192.168.14.0/24, mtu 9000, switch sw1, bridge br-underlay, gateway 192.168.14.1 node interface address mac udp switch port mac udp @@ -365,34 +367,42 @@ même valeur sur ``keys.openpgp.org`` et ``keyserver.ubuntu.com`` : Une clé renouvelée par FRR fera échouer l'installation (signature inconnue) : remplacer le fichier après avoir vérifié les nouvelles empreintes. -**Hyperviseurs.** Ils se déploient comme en production, par ``deploy.sh`` — celui **du dépôt**, -embarqué dans ``lab`` avec ``bootstrap_kvm.sh`` (paquet ``scripts``) et déposé dans -``/opt/two/scripts/``, où ``deploy.sh`` cherche d'abord ``bootstrap_kvm.sh`` : +**Hyperviseurs.** Ce sont des nœuds ``host`` dont la provision installe two comme en +production. ``test/e2e/topologies/provision/hypervisor.sh`` dépose ``agent.yml`` (fichier +``agent.yml`` du nœud) dans ``/etc/two/agent.yml``, télécharge ``deploy.sh`` et +``bootstrap_kvm.sh`` **au tag de la release testée** dans ``/opt/two/scripts/``, où ``deploy.sh`` +cherche d'abord ``bootstrap_kvm.sh``, puis lance : .. code-block:: text - deploy.sh --noup_script -i -u -t + deploy.sh --noup_script -i -u "$LAB_UPLINK" -t -``--noup_script`` empêche l'auto-mise à jour de remplacer le script par celui de ``main`` : le lab -teste les scripts de sa branche. L'uplink ``-u`` est l'interface qui porte la route par défaut — -celle du premier segment de l'hyperviseur dans l'ordre de déclaration des segments — parce que -``deploy.sh`` y lit l'adresse et la passerelle qu'il déplace sur ``br-000000``. ``deploy.sh`` -télécharge la release sur ``git.g3e.fr`` sans réessayer : le lancement attend d'abord que le serveur -réponde, à travers le switch. FRR est installé **après** : il démarre sur le réseau final. Démarré +La release est fixée dans le script (``RELEASE=``) : sans elle, ``deploy.sh`` prendrait la dernière, +et le lab ne serait plus reproductible. ``--noup_script`` empêche l'auto-mise à jour de remplacer le +script par celui de ``main``. L'uplink ``-u`` est l'interface qui porte la route par défaut, parce +que ``deploy.sh`` y lit l'adresse et la passerelle qu'il déplace sur ``br-000000``. ``deploy.sh`` +télécharge la release sur ``git.g3e.fr`` sans réessayer : le script attend d'abord que le serveur +réponde, à travers le switch. Les deux fichiers ``agent/`` donnent à l'agent la section ``bgp`` +(AS 64600, route reflector ``10.255.255.1``) et un watchdog toutes les 10 s ; +``agent/two.yml`` met en plus hv1 sur le serveur DHCP intégré (``dhcp.backend: two``), +``agent/bgp.yml`` laisse les autres sur dnsmasq. + +FRR est installé **après** la provision : il démarre sur le réseau final. Démarré avant la migration, zebra peut perdre la route par défaut quand elle passe de l'uplink à ``br-000000`` — constaté le 2026-10-11 sur un hyperviseur sur deux : route reflector ``unresolved``, session BGP jamais établie. L'agent, configuré avec une section ``bgp``, refuse de -démarrer tant que FRR n'est pas là : son premier démarrage par ``deploy.sh`` échoue, et le -provisionnement le **redémarre** une fois FRR installé. +démarrer tant que FRR n'est pas là : son premier démarrage par ``deploy.sh`` échoue, et +``provision/hypervisor-post.sh`` (``post_provision``) le **redémarre** une fois FRR installé. **Un seul script de provisionnement par nœud.** cloud-init exécute ``runcmd`` comme un script ``sh`` sans ``set -e`` : seule la dernière commande compte, et un ``deploy.sh`` en échec suivi d'un FRR installé avec succès passerait pour un démarrage réussi. Chaque nœud reçoit donc -``/usr/local/sbin/lab-provision``, en ``set -eu``, qui enchaîne ses étapes ; ``runcmd`` n'appelle +``/usr/local/sbin/lab-provision``, en ``set -eu``, qui enchaîne ses étapes — script du switch ou +de la loopback, ``provision``, FRR, ``post_provision`` ; ``runcmd`` n'appelle que lui, et la première étape en échec met cloud-init en erreur. -**Ce que vérifie** ``lab up``, une fois cloud-init terminé sans erreur : ``agent.service`` actif -sur chaque hyperviseur, ``frr`` actif sur chaque nœud qui en a un. Ce contrôle couvre ce que +**Ce que vérifie** ``lab up``, une fois cloud-init terminé sans erreur : les ``services`` déclarés +par chaque nœud (``agent.service`` sur les hyperviseurs), et ``frr`` sur chaque nœud qui en a un. Ce contrôle couvre ce que cloud-init ne voit pas — si la migration réseau échoue, ``deploy.sh`` arme un redémarrage de secours, et la VM redémarrée ne rejoue pas ``runcmd``. diff --git a/internal/lab/machine/machine.go b/internal/lab/machine/machine.go index 29e1312..a88c386 100644 --- a/internal/lab/machine/machine.go +++ b/internal/lab/machine/machine.go @@ -168,10 +168,7 @@ func (l Lab) waitReady(ctx context.Context, n topology.NodePlan) error { } func services(n topology.NodePlan) []string { - var units []string - if n.Role == topology.RoleHypervisor { - units = append(units, "agent.service") - } + units := append([]string(nil), n.Services...) if n.FRR != "" { units = append(units, "frr.service") } diff --git a/internal/lab/machine/machine_test.go b/internal/lab/machine/machine_test.go index 78e2ba4..abb7575 100644 --- a/internal/lab/machine/machine_test.go +++ b/internal/lab/machine/machine_test.go @@ -127,9 +127,9 @@ nodes: return p } -const switchLast = ` rr1: { role: rr, image: deb, cpus: 1, memory: 1024, segments: [underlay] } - hv1: { role: hypervisor, image: deb, cpus: 4, memory: 16384, segments: [underlay], release: 0.2.0rc002 } - sw1: { role: switch, image: deb, cpus: 2, memory: 1024 } +const switchLast = ` rr1: { role: rr, image: deb, cpus: 1, memory: 1024, segments: [underlay] } + hv1: { role: host, image: deb, cpus: 4, memory: 16384, segments: [underlay], services: [agent.service] } + sw1: { role: switch, image: deb, cpus: 2, memory: 1024 } ` type fixture struct { @@ -278,10 +278,10 @@ func TestStatus(t *testing.T) { if w < 3 { w = 3 } - want := fmt.Sprintf("node role state %-*s ssh\n", w, "pid") + - fmt.Sprintf("rr1 rr stopped %-*s 127.0.0.1:2200\n", w, "-") + - fmt.Sprintf("hv1 hypervisor running %-*s 127.0.0.1:2201\n", w, pid) + - fmt.Sprintf("sw1 switch stopped %-*s 127.0.0.1:2202\n", w, "-") + want := fmt.Sprintf("node role state %-*s ssh\n", w, "pid") + + fmt.Sprintf("rr1 rr stopped %-*s 127.0.0.1:2200\n", w, "-") + + fmt.Sprintf("hv1 host running %-*s 127.0.0.1:2201\n", w, pid) + + fmt.Sprintf("sw1 switch stopped %-*s 127.0.0.1:2202\n", w, "-") if out.String() != want { t.Errorf("status:\n%s\nwant:\n%s", out.String(), want) } diff --git a/internal/lab/provision/provision.go b/internal/lab/provision/provision.go index b83751a..36d0a7f 100644 --- a/internal/lab/provision/provision.go +++ b/internal/lab/provision/provision.go @@ -72,15 +72,11 @@ func Prepare(ctx context.Context, p *topology.Plan, o Options) ([]render.Node, e if err != nil { return nil, err } - frr, err := ReadFRR(p) - if err != nil { + opts := render.Options{RunDir: o.RunDir, AuthorizedKeys: []string{key}} + if err := ReadInputs(p, &opts); err != nil { return nil, err } - agent, err := ReadAgent(p) - if err != nil { - return nil, err - } - nodes, err := render.Render(p, render.Options{RunDir: o.RunDir, AuthorizedKeys: []string{key}, FRR: frr, Agent: agent}) + nodes, err := render.Render(p, opts) if err != nil { return nil, err } @@ -92,12 +88,31 @@ func Prepare(ctx context.Context, p *topology.Plan, o Options) ([]render.Node, e return nodes, nil } -func ReadFRR(p *topology.Plan) (map[string]string, error) { - return readNodeFiles(p, func(n topology.NodePlan) string { return n.FRR }) -} - -func ReadAgent(p *topology.Plan) (map[string]string, error) { - return readNodeFiles(p, func(n topology.NodePlan) string { return n.Agent }) +func ReadInputs(p *topology.Plan, o *render.Options) error { + var err error + if o.FRR, err = readNodeFiles(p, func(n topology.NodePlan) string { return n.FRR }); err != nil { + return err + } + if o.Provision, err = readNodeFiles(p, func(n topology.NodePlan) string { return n.Provision }); err != nil { + return err + } + if o.PostProvision, err = readNodeFiles(p, func(n topology.NodePlan) string { return n.PostProvision }); err != nil { + return err + } + o.Files = map[string]map[string][]byte{} + for _, n := range p.Nodes { + for name, src := range n.Files { + data, err := os.ReadFile(src) + if err != nil { + return fmt.Errorf("node %s: file %s: %w", n.Name, name, err) + } + if o.Files[n.Name] == nil { + o.Files[n.Name] = map[string][]byte{} + } + o.Files[n.Name][name] = data + } + } + return nil } func readNodeFiles(p *topology.Plan, path func(topology.NodePlan) string) (map[string]string, error) { diff --git a/internal/lab/provision/provision_test.go b/internal/lab/provision/provision_test.go index 403d3cc..d4d7a5a 100644 --- a/internal/lab/provision/provision_test.go +++ b/internal/lab/provision/provision_test.go @@ -60,8 +60,8 @@ segments: nodes: sw1: { role: switch, image: debian12, cpus: 2, memory: 1024 } rr1: { role: rr, image: debian12, cpus: 1, memory: 1024, segments: [underlay] } - hv1: { role: hypervisor, image: debian12, cpus: 4, memory: 16384, segments: [underlay], release: 0.2.0rc002 } - hv2: { role: hypervisor, image: debian12, cpus: 4, memory: 16384, segments: [underlay], release: 0.2.0rc002 } + hv1: { role: host, image: debian12, cpus: 4, memory: 16384, segments: [underlay] } + hv2: { role: host, image: debian12, cpus: 4, memory: 16384, segments: [underlay] } ` topo, err := topology.Parse([]byte(doc)) if err != nil { @@ -316,7 +316,7 @@ func TestEnsureKey_WithTheRealSSHKeygen(t *testing.T) { } } -func TestReadFRR_ReadsOnlyTheNodesThatDeclareOne(t *testing.T) { +func TestReadInputs_ReadsOnlyTheFRRConfigsDeclared(t *testing.T) { dir := t.TempDir() conf := filepath.Join(dir, "rr1.conf") if err := os.WriteFile(conf, []byte("hostname rr1\n"), 0o600); err != nil { @@ -326,19 +326,20 @@ func TestReadFRR_ReadsOnlyTheNodesThatDeclareOne(t *testing.T) { p := labPlan(t, m) p.Nodes[1].FRR = conf - got, err := ReadFRR(p) + var o render.Options + err := ReadInputs(p, &o) - if err != nil || !reflect.DeepEqual(got, map[string]string{"rr1": "hostname rr1\n"}) { - t.Errorf("ReadFRR = %q, %v", got, err) + if err != nil || !reflect.DeepEqual(o.FRR, map[string]string{"rr1": "hostname rr1\n"}) { + t.Errorf("FRR = %q, %v", o.FRR, err) } } -func TestReadFRR_NamesTheNodeOfAMissingFile(t *testing.T) { +func TestReadInputs_NamesTheNodeOfAMissingFRRConfig(t *testing.T) { m := newMirror(t) p := labPlan(t, m) p.Nodes[2].FRR = filepath.Join(t.TempDir(), "absent.conf") - if _, err := ReadFRR(p); err == nil || !strings.Contains(err.Error(), "node hv1: ") || !strings.Contains(err.Error(), "absent.conf") { + if err := ReadInputs(p, &render.Options{}); err == nil || !strings.Contains(err.Error(), "node hv1: ") || !strings.Contains(err.Error(), "absent.conf") { t.Errorf("error = %v", err) } } @@ -386,22 +387,37 @@ func TestPrepare_PutsTheFRRConfigIntoTheSeed(t *testing.T) { t.Errorf("hv1 user-data has no /etc/lab/frr.conf:\n%s", data) } -func TestReadAgent_ReadsOnlyTheNodesThatDeclareOne(t *testing.T) { - conf := filepath.Join(t.TempDir(), "two.yml") - if err := os.WriteFile(conf, []byte("dhcp:\n backend: two\n"), 0o600); err != nil { - t.Fatal(err) +func TestReadInputs_ReadsTheProvisionScriptsAndFiles(t *testing.T) { + dir := t.TempDir() + write := func(name, content string) string { + path := filepath.Join(dir, name) + if err := os.WriteFile(path, []byte(content), 0o600); err != nil { + t.Fatal(err) + } + return path } m := newMirror(t) p := labPlan(t, m) - p.Nodes[2].Agent = conf + p.Nodes[2].Provision = write("hv.sh", "#!/bin/sh\necho provision\n") + p.Nodes[2].PostProvision = write("hv-post.sh", "#!/bin/sh\necho post\n") + p.Nodes[2].Files = map[string]string{"agent.yml": write("two.yml", "dhcp:\n backend: two\n")} - got, err := ReadAgent(p) - - if err != nil || !reflect.DeepEqual(got, map[string]string{"hv1": "dhcp:\n backend: two\n"}) { - t.Errorf("ReadAgent = %q, %v", got, err) + var o render.Options + if err := ReadInputs(p, &o); err != nil { + t.Fatal(err) } - p.Nodes[3].Agent = filepath.Join(t.TempDir(), "absent.yml") - if _, err := ReadAgent(p); err == nil || !strings.Contains(err.Error(), "node hv2: ") { + if !reflect.DeepEqual(o.Provision, map[string]string{"hv1": "#!/bin/sh\necho provision\n"}) { + t.Errorf("provision = %q", o.Provision) + } + if !reflect.DeepEqual(o.PostProvision, map[string]string{"hv1": "#!/bin/sh\necho post\n"}) { + t.Errorf("post_provision = %q", o.PostProvision) + } + if !reflect.DeepEqual(o.Files, map[string]map[string][]byte{"hv1": {"agent.yml": []byte("dhcp:\n backend: two\n")}}) { + t.Errorf("files = %q", o.Files) + } + + p.Nodes[3].Files = map[string]string{"agent.yml": filepath.Join(dir, "absent.yml")} + if err := ReadInputs(p, &render.Options{}); err == nil || !strings.Contains(err.Error(), "node hv2: file agent.yml: ") { t.Errorf("error = %v", err) } } diff --git a/internal/lab/render/render.go b/internal/lab/render/render.go index be95453..723a465 100644 --- a/internal/lab/render/render.go +++ b/internal/lab/render/render.go @@ -31,7 +31,9 @@ type Options struct { RunDir string AuthorizedKeys []string FRR map[string]string - Agent map[string]string + Provision map[string]string + PostProvision map[string]string + Files map[string]map[string][]byte } type Node struct { @@ -51,8 +53,16 @@ func Render(p *topology.Plan, o Options) ([]Node, error) { if _, ok := o.FRR[n.Name]; n.FRR != "" && !ok { return nil, fmt.Errorf("node %s: frr configuration %s was not read", n.Name, n.FRR) } - if _, ok := o.Agent[n.Name]; n.Agent != "" && !ok { - return nil, fmt.Errorf("node %s: agent configuration %s was not read", n.Name, n.Agent) + if _, ok := o.Provision[n.Name]; n.Provision != "" && !ok { + return nil, fmt.Errorf("node %s: provision script %s was not read", n.Name, n.Provision) + } + if _, ok := o.PostProvision[n.Name]; n.PostProvision != "" && !ok { + return nil, fmt.Errorf("node %s: post_provision script %s was not read", n.Name, n.PostProvision) + } + for name, src := range n.Files { + if _, ok := o.Files[n.Name][name]; !ok { + return nil, fmt.Errorf("node %s: file %s (%s) was not read", n.Name, name, src) + } } } var nodes []Node diff --git a/internal/lab/render/render_test.go b/internal/lab/render/render_test.go index 78bb186..fd6ea47 100644 --- a/internal/lab/render/render_test.go +++ b/internal/lab/render/render_test.go @@ -22,8 +22,8 @@ segments: nodes: sw1: { role: switch, image: deb, cpus: 2, memory: 1024 } rr1: { role: rr, image: deb, cpus: 1, memory: 1024, segments: [underlay] } - hv1: { role: hypervisor, image: deb, cpus: 4, memory: 16384, segments: [underlay], release: 0.2.0rc002 } - hv2: { role: hypervisor, image: deb, cpus: 4, memory: 16384, segments: [underlay], release: 0.2.0rc002 } + hv1: { role: host, image: deb, cpus: 4, memory: 16384, segments: [underlay] } + hv2: { role: host, image: deb, cpus: 4, memory: 16384, segments: [underlay] } ` const twoSegments = `name: two-seg @@ -36,7 +36,7 @@ segments: blue: { switch: sw, cidr: 10.2.0.0/24, mtu: 1500 } nodes: sw: { role: switch, image: deb, cpus: 1, memory: 512 } - hv: { role: hypervisor, image: deb, cpus: 1, memory: 512, segments: [blue, red], release: 0.2.0rc002 } + hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [blue, red] } ` func plan(t *testing.T, doc string) *topology.Plan { @@ -315,9 +315,9 @@ func TestNetworkConfig_DefaultRouteOnlyOnFirstSegment(t *testing.T) { } } -func TestUserData_Hypervisor(t *testing.T) { +func TestUserData_HostWithoutProvision(t *testing.T) { cfg := user(t, nodeNamed(t, renderAll(t, twoHypervisors), "hv1")) - if cfg.Hostname != "hv1" || !cfg.DisableRoot || len(cfg.Packages) != 0 || !reflect.DeepEqual(cfg.Runcmd, [][]string{{"/usr/local/sbin/lab-provision"}}) { + if cfg.Hostname != "hv1" || !cfg.DisableRoot || len(cfg.Packages) != 0 || cfg.Runcmd != nil || len(cfg.WriteFiles) != 0 { t.Errorf("hv1 user-data = %+v", cfg) } if !reflect.DeepEqual(cfg.SSHAuthorizedKeys, []string{labKey}) { diff --git a/internal/lab/render/roles_test.go b/internal/lab/render/roles_test.go index c62a805..bf15644 100644 --- a/internal/lab/render/roles_test.go +++ b/internal/lab/render/roles_test.go @@ -1,11 +1,9 @@ package render import ( - "bytes" "crypto/sha256" "encoding/base64" "encoding/hex" - "os" "reflect" "strings" "testing" @@ -21,8 +19,8 @@ segments: nodes: sw1: { role: switch, image: deb, cpus: 2, memory: 1024, secondary: { underlay: [169.254.0.1/28] }, frr: sw1.conf } rr1: { role: rr, image: deb, cpus: 1, memory: 1024, segments: [underlay], secondary: { underlay: [169.254.0.3/28] }, loopback: 10.255.255.1/32, frr: rr1.conf } - hv1: { role: hypervisor, image: deb, cpus: 4, memory: 16384, segments: [underlay], frr: hv1.conf, release: 0.2.0rc002 } - hv2: { role: hypervisor, image: deb, cpus: 4, memory: 16384, segments: [underlay], release: 0.2.0rc002 } + hv1: { role: host, image: deb, cpus: 4, memory: 16384, segments: [underlay], frr: hv1.conf, provision: hv.sh, post_provision: hv-post.sh, files: { agent.yml: two.yml }, services: [agent.service] } + hv2: { role: host, image: deb, cpus: 4, memory: 16384, segments: [underlay] } ` var frrConfigs = map[string]string{ @@ -31,9 +29,20 @@ var frrConfigs = map[string]string{ "hv1": "hostname hv1\nrouter bgp 64600\n", } +func roleOptions() Options { + return Options{ + RunDir: "/srv/lab", + AuthorizedKeys: []string{labKey}, + FRR: frrConfigs, + Provision: map[string]string{"hv1": "#!/bin/sh\necho provision\n"}, + PostProvision: map[string]string{"hv1": "#!/bin/sh\necho post\n"}, + Files: map[string]map[string][]byte{"hv1": {"agent.yml": []byte("dhcp:\n backend: two\n")}}, + } +} + func renderRoles(t *testing.T) map[string]Node { t.Helper() - nodes, err := Render(plan(t, withRoles), Options{RunDir: "/srv/lab", AuthorizedKeys: []string{labKey}, FRR: frrConfigs}) + nodes, err := Render(plan(t, withRoles), roleOptions()) if err != nil { t.Fatalf("Render: %v", err) } @@ -145,10 +154,10 @@ func TestRoles_FRRKeyIsThePinnedRepositoryKey(t *testing.T) { func TestRoles_ProvisioningIsOneScriptThatStopsAtTheFirstFailure(t *testing.T) { nodes := renderRoles(t) + env := "LAB_NODE=hv1 LAB_UPLINK=underlay LAB_FILES=/etc/lab/files " for name, steps := range map[string]string{ "sw1": "systemctl daemon-reload\nsystemctl enable --now lab-switch.service\n/usr/local/sbin/lab-frr\n", - "hv1": "/usr/local/sbin/lab-deploy\n/usr/local/sbin/lab-frr\nsystemctl restart agent.service\n", - "hv2": "/usr/local/sbin/lab-deploy\n", + "hv1": env + "/usr/local/sbin/lab-node-provision\n/usr/local/sbin/lab-frr\n" + env + "/usr/local/sbin/lab-node-post-provision\n", } { cfg := user(t, nodeNamed(t, nodes, name)) if !reflect.DeepEqual(cfg.Runcmd, [][]string{{"/usr/local/sbin/lab-provision"}}) { @@ -159,47 +168,34 @@ func TestRoles_ProvisioningIsOneScriptThatStopsAtTheFirstFailure(t *testing.T) { t.Errorf("%s lab-provision (%s):\n%s", name, f.Permissions, f.Content) } } + if cfg := user(t, nodeNamed(t, nodes, "hv2")); cfg.Runcmd != nil { + t.Errorf("hv2 has nothing to provision, runcmd = %q", cfg.Runcmd) + } } -func TestRoles_HypervisorDeploysTheReleaseThroughTheRepositoryScripts(t *testing.T) { +func TestRoles_HostReceivesItsScriptsAndFiles(t *testing.T) { cfg := user(t, nodeNamed(t, renderRoles(t), "hv1")) - - f := fileAt(t, cfg, "/usr/local/sbin/lab-deploy") - want := `#!/bin/sh -set -eu -n=0 -until curl -fsS -o /dev/null https://git.g3e.fr/; do - n=$((n + 1)) - [ "$n" -lt 30 ] || exit 1 - sleep 10 -done -cd /opt/two/scripts -bash ./deploy.sh --noup_script -i -u underlay -t 0.2.0rc002 -` - if f.Content != want || f.Permissions != "0755" { - t.Errorf("lab-deploy (%s):\n%s\nwant:\n%s", f.Permissions, f.Content, want) - } - - for path, source := range map[string]string{ - "/opt/two/scripts/deploy.sh": "../../../scripts/deploy.sh", - "/opt/two/scripts/bootstrap_kvm.sh": "../../../scripts/bootstrap_kvm.sh", + for path, want := range map[string]struct { + content string + permissions string + }{ + "/usr/local/sbin/lab-node-provision": {"#!/bin/sh\necho provision\n", "0755"}, + "/usr/local/sbin/lab-node-post-provision": {"#!/bin/sh\necho post\n", "0755"}, + "/etc/lab/files/agent.yml": {"dhcp:\n backend: two\n", "0644"}, } { f := fileAt(t, cfg, path) got, err := base64.StdEncoding.DecodeString(f.Content) if err != nil { t.Fatal(err) } - repo, err := os.ReadFile(source) - if err != nil { - t.Fatal(err) - } - if f.Encoding != "b64" || f.Permissions != "0755" || !bytes.Equal(got, repo) { - t.Errorf("%s: encoding %q, permissions %q, identical to %s: %v", path, f.Encoding, f.Permissions, source, bytes.Equal(got, repo)) + if f.Encoding != "b64" || f.Permissions != want.permissions || string(got) != want.content { + t.Errorf("%s: encoding %q, permissions %q, content %q", path, f.Encoding, f.Permissions, got) } } } func TestRoles_UplinkIsTheInterfaceCarryingTheDefaultRoute(t *testing.T) { + p := plan(t, twoSegments) hv := nodeNamed(t, renderAll(t, twoSegments), "hv") var withDefault []string for name, e := range network(t, hv).Ethernets { @@ -212,22 +208,36 @@ func TestRoles_UplinkIsTheInterfaceCarryingTheDefaultRoute(t *testing.T) { if !reflect.DeepEqual(withDefault, []string{"red"}) { t.Fatalf("default route on %v, want [red]", withDefault) } - if got := fileAt(t, user(t, hv), "/usr/local/sbin/lab-deploy").Content; !strings.HasSuffix(got, "bash ./deploy.sh --noup_script -i -u red -t 0.2.0rc002\n") { - t.Errorf("lab-deploy:\n%s", got) + for _, n := range p.Nodes { + if n.Name == "hv" { + if got := provisionEnv(p, n); got != "LAB_NODE=hv LAB_UPLINK=red LAB_FILES=/etc/lab/files " { + t.Errorf("provision environment = %q", got) + } + } } } -func TestRoles_OnlyHypervisorsDeployTwo(t *testing.T) { +func TestRoles_NodesWithoutProvisionReceiveNoProvisionFiles(t *testing.T) { nodes := renderRoles(t) - for _, name := range []string{"sw1", "rr1"} { + for _, name := range []string{"sw1", "rr1", "hv2"} { for _, f := range user(t, nodeNamed(t, nodes, name)).WriteFiles { - if strings.HasPrefix(f.Path, "/opt/two/") || f.Path == "/usr/local/sbin/lab-deploy" { + if strings.HasPrefix(f.Path, "/etc/lab/files/") || strings.HasPrefix(f.Path, "/usr/local/sbin/lab-node-") { t.Errorf("%s receives %s", name, f.Path) } } } } +func TestRoles_FRRDaemons(t *testing.T) { + p := plan(t, withRoles) + want := map[string][]string{"sw1": {"bgpd", "bfdd"}, "rr1": {"bgpd", "bfdd"}, "hv1": {"bgpd"}} + for _, n := range p.Nodes { + if w, ok := want[n.Name]; ok && !reflect.DeepEqual(frrDaemons(n), w) { + t.Errorf("%s daemons = %v, want %v", n.Name, frrDaemons(n), w) + } + } +} + func TestRoles_NodeWithoutRoleFieldsGetsNoFRR(t *testing.T) { for _, f := range user(t, nodeNamed(t, renderRoles(t), "hv2")).WriteFiles { if strings.Contains(f.Path, "frr") { @@ -246,7 +256,7 @@ func TestRoles_RefusesAnUnreadFRRConfig(t *testing.T) { func TestRoles_SwitchLoopbackIsCreatedByTheSwitchScript(t *testing.T) { doc := strings.Replace(withRoles, "secondary: { underlay: [169.254.0.1/28] }, frr: sw1.conf", "secondary: { underlay: [169.254.0.1/28] }, loopback: 10.255.254.1/32, frr: sw1.conf", 1) - nodes, err := Render(plan(t, doc), Options{RunDir: "/srv/lab", AuthorizedKeys: []string{labKey}, FRR: frrConfigs}) + nodes, err := Render(plan(t, doc), roleOptions()) if err != nil { t.Fatalf("Render: %v", err) } @@ -263,36 +273,20 @@ func TestRoles_SwitchLoopbackIsCreatedByTheSwitchScript(t *testing.T) { } } -func TestRoles_HypervisorAgentConfigIsWrittenBeforeTheDeployment(t *testing.T) { - doc := strings.Replace(withRoles, "frr: hv1.conf, release: 0.2.0rc002 }", "frr: hv1.conf, release: 0.2.0rc002, agent: two.yml }", 1) - nodes, err := Render(plan(t, doc), Options{RunDir: "/srv/lab", AuthorizedKeys: []string{labKey}, FRR: frrConfigs, Agent: map[string]string{"hv1": "dhcp:\n backend: two\n"}}) - if err != nil { - t.Fatalf("Render: %v", err) +func TestRoles_RefusesUnreadProvisionInputs(t *testing.T) { + cases := map[string]struct { + mutate func(*Options) + want string + }{ + "provision": {func(o *Options) { o.Provision = nil }, "node hv1: provision script hv.sh was not read"}, + "post": {func(o *Options) { o.PostProvision = nil }, "node hv1: post_provision script hv-post.sh was not read"}, + "file": {func(o *Options) { o.Files = nil }, "node hv1: file agent.yml (two.yml) was not read"}, } - var hv1, hv2 Node - for _, n := range nodes { - switch n.Name { - case "hv1": - hv1 = n - case "hv2": - hv2 = n - } - } - f := fileAt(t, user(t, hv1), "/etc/two/agent.yml") - if f.Content != "dhcp:\n backend: two\n" || f.Permissions != "0640" { - t.Errorf("agent.yml (%s) = %q", f.Permissions, f.Content) - } - for _, w := range user(t, hv2).WriteFiles { - if w.Path == "/etc/two/agent.yml" { - t.Error("hv2 receives an agent.yml it does not declare") + for name, c := range cases { + o := roleOptions() + c.mutate(&o) + if _, err := Render(plan(t, withRoles), o); err == nil || err.Error() != c.want { + t.Errorf("%s: error = %v, want %q", name, err, c.want) } } } - -func TestRoles_RefusesAnUnreadAgentConfig(t *testing.T) { - doc := strings.Replace(withRoles, "frr: hv1.conf, release: 0.2.0rc002 }", "frr: hv1.conf, release: 0.2.0rc002, agent: two.yml }", 1) - _, err := Render(plan(t, doc), Options{RunDir: "/srv/lab", AuthorizedKeys: []string{labKey}, FRR: frrConfigs}) - if err == nil || err.Error() != "node hv1: agent configuration two.yml was not read" { - t.Errorf("error = %v", err) - } -} diff --git a/internal/lab/render/seed.go b/internal/lab/render/seed.go index 34ef572..28c130c 100644 --- a/internal/lab/render/seed.go +++ b/internal/lab/render/seed.go @@ -4,12 +4,12 @@ import ( _ "embed" "encoding/base64" "fmt" + "sort" "strings" "go.yaml.in/yaml/v3" "git.g3e.fr/syonad/two/internal/lab/topology" - "git.g3e.fr/syonad/two/scripts" ) const ( @@ -27,11 +27,10 @@ const ( FRRRepo = "https://deb.frrouting.org/frr" FRRPackages = "frr frr-pythontools" - ProvisionScript = "/usr/local/sbin/lab-provision" - DeployScript = "/usr/local/sbin/lab-deploy" - TwoScriptsDir = "/opt/two/scripts" - TwoGitServer = "https://git.g3e.fr/" - AgentConfig = "/etc/two/agent.yml" + ProvisionScript = "/usr/local/sbin/lab-provision" + NodeProvision = "/usr/local/sbin/lab-node-provision" + NodePostProvision = "/usr/local/sbin/lab-node-post-provision" + FilesDir = "/etc/lab/files" ) //go:embed frrouting.gpg @@ -115,16 +114,17 @@ func userData(p *topology.Plan, n topology.NodePlan, o Options) ([]byte, error) } steps = append(steps, "systemctl daemon-reload", "systemctl enable --now lab-node.service") } - if n.Agent != "" { - cfg.WriteFiles = append(cfg.WriteFiles, writeFile{Path: AgentConfig, Permissions: "0640", Content: o.Agent[n.Name]}) + names := make([]string, 0, len(n.Files)) + for name := range n.Files { + names = append(names, name) } - if n.Role == topology.RoleHypervisor { - cfg.WriteFiles = append(cfg.WriteFiles, - writeFile{Path: TwoScriptsDir + "/deploy.sh", Permissions: "0755", Encoding: "b64", Content: base64.StdEncoding.EncodeToString(scripts.Deploy)}, - writeFile{Path: TwoScriptsDir + "/bootstrap_kvm.sh", Permissions: "0755", Encoding: "b64", Content: base64.StdEncoding.EncodeToString(scripts.BootstrapKVM)}, - writeFile{Path: DeployScript, Permissions: "0755", Content: deployScript(p, n)}, - ) - steps = append(steps, DeployScript) + sort.Strings(names) + for _, name := range names { + cfg.WriteFiles = append(cfg.WriteFiles, writeFile{Path: FilesDir + "/" + name, Permissions: "0644", Encoding: "b64", Content: base64.StdEncoding.EncodeToString(o.Files[n.Name][name])}) + } + if n.Provision != "" { + cfg.WriteFiles = append(cfg.WriteFiles, writeFile{Path: NodeProvision, Permissions: "0755", Encoding: "b64", Content: base64.StdEncoding.EncodeToString([]byte(o.Provision[n.Name]))}) + steps = append(steps, provisionEnv(p, n)+NodeProvision) } if n.FRR != "" { cfg.WriteFiles = append(cfg.WriteFiles, @@ -133,9 +133,10 @@ func userData(p *topology.Plan, n topology.NodePlan, o Options) ([]byte, error) writeFile{Path: FRRScript, Permissions: "0755", Content: frrScript(n)}, ) steps = append(steps, FRRScript) - if n.Role == topology.RoleHypervisor { - steps = append(steps, "systemctl restart agent.service") - } + } + if n.PostProvision != "" { + cfg.WriteFiles = append(cfg.WriteFiles, writeFile{Path: NodePostProvision, Permissions: "0755", Encoding: "b64", Content: base64.StdEncoding.EncodeToString([]byte(o.PostProvision[n.Name]))}) + steps = append(steps, provisionEnv(p, n)+NodePostProvision) } if len(steps) > 0 { cfg.WriteFiles = append(cfg.WriteFiles, @@ -154,16 +155,16 @@ func retry(command string) string { return "n=0\nuntil " + command + "; do\n n=$((n + 1))\n [ \"$n\" -lt 30 ] || exit 1\n sleep 10\ndone\n" } -func deployScript(p *topology.Plan, n topology.NodePlan) string { - uplink := nodeCables(p, n.Name)[0].NodeInterface - return "#!/bin/sh\nset -eu\n" + - retry("curl -fsS -o /dev/null "+TwoGitServer) + - "cd " + TwoScriptsDir + "\n" + - fmt.Sprintf("bash ./deploy.sh --noup_script -i -u %s -t %s\n", uplink, n.Release) +func provisionEnv(p *topology.Plan, n topology.NodePlan) string { + uplink := "" + if cables := nodeCables(p, n.Name); len(cables) > 0 { + uplink = cables[0].NodeInterface + } + return fmt.Sprintf("LAB_NODE=%s LAB_UPLINK=%s LAB_FILES=%s ", n.Name, uplink, FilesDir) } func frrDaemons(n topology.NodePlan) []string { - if n.Role == topology.RoleHypervisor { + if n.Role == topology.RoleHost { return []string{"bgpd"} } return []string{"bgpd", "bfdd"} diff --git a/internal/lab/topology/format.go b/internal/lab/topology/format.go index 1ba73fd..5f9e992 100644 --- a/internal/lab/topology/format.go +++ b/internal/lab/topology/format.go @@ -22,15 +22,17 @@ func (p *Plan) Write(w io.Writer) error { var extras []NodePlan for _, n := range p.Nodes { - if len(n.Secondary) > 0 || n.Loopback.IsValid() || n.FRR != "" || n.Release != "" || n.Agent != "" { + if len(n.Secondary) > 0 || n.Loopback.IsValid() || n.FRR != "" || n.Provision != "" || n.PostProvision != "" || len(n.Files) > 0 || len(n.Services) > 0 { extras = append(extras, n) } } if len(extras) > 0 { fmt.Fprintf(tw, "\nroles\n") - fmt.Fprintf(tw, " name\tloopback\tsecondary\tfrr\trelease\tagent\n") + fmt.Fprintf(tw, " name\tloopback\tsecondary\tfrr\tprovision\tpost_provision\tfiles\tservices\n") for _, n := range extras { - fmt.Fprintf(tw, " %s\t%s\t%s\t%s\t%s\t%s\n", n.Name, orDash(loopback(n)), orDash(secondary(n)), orDash(filepath.Base(n.FRR)), orDash(n.Release), orDash(filepath.Base(n.Agent))) + fmt.Fprintf(tw, " %s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\n", n.Name, orDash(loopback(n)), orDash(secondary(n)), + orDash(filepath.Base(n.FRR)), orDash(filepath.Base(n.Provision)), orDash(filepath.Base(n.PostProvision)), + orDash(strings.Join(sortedKeys(n.Files), ",")), orDash(strings.Join(n.Services, ","))) } } diff --git a/internal/lab/topology/plan.go b/internal/lab/topology/plan.go index e5ba293..c0b1a39 100644 --- a/internal/lab/topology/plan.go +++ b/internal/lab/topology/plan.go @@ -34,17 +34,19 @@ type SegmentPlan struct { } type NodePlan struct { - Name string - Role string - Image string - CPUs int - Memory int - SSHPort int - Secondary map[string][]netip.Prefix - Loopback netip.Prefix - FRR string - Release string - Agent string + Name string + Role string + Image string + CPUs int + Memory int + SSHPort int + Secondary map[string][]netip.Prefix + Loopback netip.Prefix + FRR string + Provision string + PostProvision string + Files map[string]string + Services []string } type Cable struct { @@ -71,15 +73,17 @@ func Compute(t *Topology) (*Plan, error) { p := &Plan{Name: t.Name, Images: append([]Image(nil), t.Images...)} for i, n := range t.Nodes { node := NodePlan{ - Name: n.Name, - Role: n.Role, - Image: n.Image, - CPUs: n.CPUs, - Memory: n.Memory, - SSHPort: SSHBasePort + i, - FRR: n.FRR, - Release: n.Release, - Agent: n.Agent, + Name: n.Name, + Role: n.Role, + Image: n.Image, + CPUs: n.CPUs, + Memory: n.Memory, + SSHPort: SSHBasePort + i, + FRR: n.FRR, + Provision: n.Provision, + PostProvision: n.PostProvision, + Files: n.Files, + Services: n.Services, } for segment, raws := range n.Secondary { for _, raw := range raws { diff --git a/internal/lab/topology/plan_test.go b/internal/lab/topology/plan_test.go index c8d4e05..6fb4279 100644 --- a/internal/lab/topology/plan_test.go +++ b/internal/lab/topology/plan_test.go @@ -55,8 +55,8 @@ segments: nodes: sw1: { role: switch, image: deb, cpus: 2, memory: 1024 } rr1: { role: rr, image: deb, cpus: 1, memory: 1024, segments: [underlay] } - hv1: { role: hypervisor, image: deb, cpus: 4, memory: 16384, segments: [underlay], release: 0.2.0rc002 } - hv2: { role: hypervisor, image: deb, cpus: 4, memory: 16384, segments: [underlay], release: 0.2.0rc002 } + hv1: { role: host, image: deb, cpus: 4, memory: 16384, segments: [underlay] } + hv2: { role: host, image: deb, cpus: 4, memory: 16384, segments: [underlay] } ` func TestCompute_TwoHypervisorsPlan(t *testing.T) { @@ -102,7 +102,7 @@ func TestCompute_TwoHypervisorsPlan(t *testing.T) { t.Errorf("%s ssh port = %d, want %d", name, got, port) } } - if hv := nodeOf(t, p, "hv1"); hv.Role != "hypervisor" || hv.CPUs != 4 || hv.Memory != 16384 || hv.Image != "deb" { + if hv := nodeOf(t, p, "hv1"); hv.Role != "host" || hv.CPUs != 4 || hv.Memory != 16384 || hv.Image != "deb" { t.Errorf("hv1 = %+v", hv) } } @@ -165,7 +165,7 @@ segments: blue: { switch: sw, cidr: 10.2.0.0/24, mtu: 1500 } nodes: sw: { role: switch, image: deb, cpus: 1, memory: 512 } - hv: { role: hypervisor, image: deb, cpus: 1, memory: 512, segments: [blue, red], release: 0.2.0rc002 } + hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [blue, red] } rr: { role: rr, image: deb, cpus: 1, memory: 512, segments: [red] } `) got := make([]string, 0, len(p.Cables)) @@ -193,7 +193,7 @@ nodes: sw: { role: switch, image: deb, cpus: 1, memory: 512 } n1: { role: rr, image: deb, cpus: 1, memory: 512, segments: [a, b] } n2: { role: rr, image: deb, cpus: 1, memory: 512, segments: [a, b] } - n3: { role: hypervisor, image: deb, cpus: 1, memory: 512, segments: [b, a], release: 0.2.0rc002 } + n3: { role: host, image: deb, cpus: 1, memory: 512, segments: [b, a] } `) macs := map[string]bool{} ports := map[int]bool{} @@ -308,16 +308,11 @@ func TestWrite_TwoHypervisorsPlan(t *testing.T) { want := `lab lab-test: nodes 4, segments 1, cables 3 nodes - name role image cpus memory ssh - sw1 switch deb 2 1024 MiB 127.0.0.1:2200 - rr1 rr deb 1 1024 MiB 127.0.0.1:2201 - hv1 hypervisor deb 4 16384 MiB 127.0.0.1:2202 - hv2 hypervisor deb 4 16384 MiB 127.0.0.1:2203 - -roles - name loopback secondary frr release agent - hv1 - - - 0.2.0rc002 - - hv2 - - - 0.2.0rc002 - + name role image cpus memory ssh + sw1 switch deb 2 1024 MiB 127.0.0.1:2200 + rr1 rr deb 1 1024 MiB 127.0.0.1:2201 + hv1 host deb 4 16384 MiB 127.0.0.1:2202 + hv2 host deb 4 16384 MiB 127.0.0.1:2203 segment underlay: 10.250.0.0/24, mtu 9000, switch sw1, bridge br-underlay, gateway 10.250.0.1 node interface address mac udp switch port mac udp diff --git a/internal/lab/topology/roles_test.go b/internal/lab/topology/roles_test.go index d3e209c..651c7ef 100644 --- a/internal/lab/topology/roles_test.go +++ b/internal/lab/topology/roles_test.go @@ -15,7 +15,7 @@ segments: nodes: sw1: { role: switch, image: deb, cpus: 2, memory: 1024, secondary: { underlay: [169.254.0.1/28] }, frr: frr/sw1.conf } rr1: { role: rr, image: deb, cpus: 1, memory: 1024, segments: [underlay], secondary: { underlay: [169.254.0.3/28] }, loopback: 10.255.255.1/32, frr: frr/rr1.conf } - hv1: { role: hypervisor, image: deb, cpus: 4, memory: 16384, segments: [underlay], frr: /etc/lab/hv1.conf, release: 0.2.0rc002 } + hv1: { role: host, image: deb, cpus: 4, memory: 16384, segments: [underlay], frr: /etc/lab/hv1.conf, provision: provision/hv.sh, post_provision: /opt/lab/post.sh, files: { agent.yml: agent/two.yml, deploy.sh: /opt/deploy.sh }, services: [agent.service] } ` func TestCompute_CarriesTheRoleFields(t *testing.T) { @@ -99,7 +99,7 @@ segments: blue: { switch: sw, cidr: 10.2.0.0/24 } nodes: sw: { role: switch, image: deb, cpus: 1, memory: 512 } - hv: { role: hypervisor, image: deb, cpus: 1, memory: 512, segments: [red, blue], release: 0.2.0rc002 } + hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [red, blue] } ` + c.node + ` ` requireContains(t, validationError(t, doc), c.want) @@ -115,7 +115,7 @@ segments: nodes: sw: { role: switch, image: deb, cpus: 1, memory: 512, secondary: { red: [169.254.0.1/28], blue: [169.254.1.1/28] } } other: { role: switch, image: deb, cpus: 1, memory: 512 } - hv: { role: hypervisor, image: deb, cpus: 1, memory: 512, segments: [red, blue], release: 0.2.0rc002 } + hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [red, blue] } ` msg := validationError(t, doc) requireContains(t, msg, "node sw: secondary address given for segment blue it is not attached to") @@ -130,7 +130,7 @@ segments: lo1: { switch: sw, cidr: 10.1.0.0/24 } nodes: sw: { role: switch, image: deb, cpus: 1, memory: 512 } - hv: { role: hypervisor, image: deb, cpus: 1, memory: 512, segments: [lo1], release: 0.2.0rc002 } + hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [lo1] } ` requireContains(t, validationError(t, doc), "segment lo1: name is reserved for the loopback interface") } @@ -142,10 +142,10 @@ func TestWrite_ShowsTheRoles(t *testing.T) { } want := ` roles - name loopback secondary frr release agent - sw1 - underlay 169.254.0.1/28 sw1.conf - - - rr1 lo1 10.255.255.1/32 underlay 169.254.0.3/28 rr1.conf - - - hv1 - - hv1.conf 0.2.0rc002 - + name loopback secondary frr provision post_provision files services + sw1 - underlay 169.254.0.1/28 sw1.conf - - - - + rr1 lo1 10.255.255.1/32 underlay 169.254.0.3/28 rr1.conf - - - - + hv1 - - hv1.conf hv.sh post.sh agent.yml,deploy.sh agent.service ` if !bytes.Contains(buf.Bytes(), []byte(want)) { t.Errorf("plan:\n%s\ndoes not contain:\n%s", buf.String(), want) @@ -169,27 +169,30 @@ nodes: } } -func TestValidate_ReleaseRejections(t *testing.T) { +func TestValidate_ProvisionRejections(t *testing.T) { cases := map[string]struct { node string want string }{ - "hypervisor without release": { + "the hypervisor role is gone": { `hv: { role: hypervisor, image: deb, cpus: 1, memory: 512, segments: [red] }`, - "node hv: a hypervisor needs the release of two to deploy (release: )", + `node hv: role "hypervisor" must be one of switch, rr, host`, }, - "release with shell characters": { - `hv: { role: hypervisor, image: deb, cpus: 1, memory: 512, segments: [red], release: "0.2.0; reboot" }`, - `node hv: release "0.2.0; reboot" must match`, + "file name leaving the files directory": { + `hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [red], files: { ../etc/passwd: a.yml } }`, + `node hv: file name "../etc/passwd" must match`, }, - "release on a route reflector": { - `hv: { role: rr, image: deb, cpus: 1, memory: 512, segments: [red], release: 0.2.0rc002 }`, - "node hv: release is only for hypervisors", + "file without source": { + `hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [red], files: { agent.yml: "" } }`, + "node hv: file agent.yml has no source", }, - "release on a switch": { - `hv: { role: hypervisor, image: deb, cpus: 1, memory: 512, segments: [red], release: 0.2.0rc002 } - sw2: { role: switch, image: deb, cpus: 1, memory: 512, release: 0.2.0rc002 }`, - "node sw2: release is only for hypervisors", + "service with shell characters": { + `hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [red], services: ["agent.service; reboot"] }`, + `node hv: service "agent.service; reboot" must match`, + }, + "service listed twice": { + `hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [red], services: [agent.service, agent.service] }`, + "node hv: service agent.service listed twice", }, } for name, c := range cases { @@ -206,60 +209,61 @@ nodes: } } -func TestCompute_CarriesTheRelease(t *testing.T) { - if got := nodeOf(t, compute(t, withRoles), "hv1").Release; got != "0.2.0rc002" { - t.Errorf("hv1 release = %q", got) - } - if got := nodeOf(t, compute(t, withRoles), "rr1").Release; got != "" { - t.Errorf("rr1 release = %q", got) - } -} - -func TestValidate_AgentOnlyForHypervisors(t *testing.T) { +func TestValidate_ProvisionIsAllowedOnEveryRole(t *testing.T) { doc := header + ` segments: red: { switch: sw, cidr: 10.1.0.0/24 } nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512 } - rr: { role: rr, image: deb, cpus: 1, memory: 512, segments: [red], agent: agent.yml } - hv: { role: hypervisor, image: deb, cpus: 1, memory: 512, segments: [red], release: 0.2.0rc003, agent: agent.yml } + sw: { role: switch, image: deb, cpus: 1, memory: 512, provision: sw.sh, files: { a.conf: a.conf }, services: [lab-switch.service] } + rr: { role: rr, image: deb, cpus: 1, memory: 512, segments: [red], provision: rr.sh, post_provision: rr-post.sh } + hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [red], files: { agent.yml: agent.yml }, services: [agent.service] } ` - msg := validationError(t, doc) - requireContains(t, msg, "node rr: agent is only for hypervisors") - if bytes.Contains([]byte(msg), []byte("node hv: agent")) { - t.Errorf("a hypervisor agent was refused:\n%s", msg) + compute(t, doc) +} + +func TestCompute_CarriesTheProvision(t *testing.T) { + hv1 := nodeOf(t, compute(t, withRoles), "hv1") + if hv1.Provision != "provision/hv.sh" || hv1.PostProvision != "/opt/lab/post.sh" { + t.Errorf("hv1 provision = %q, post_provision = %q", hv1.Provision, hv1.PostProvision) + } + if !reflect.DeepEqual(hv1.Files, map[string]string{"agent.yml": "agent/two.yml", "deploy.sh": "/opt/deploy.sh"}) { + t.Errorf("hv1 files = %v", hv1.Files) + } + if !reflect.DeepEqual(hv1.Services, []string{"agent.service"}) { + t.Errorf("hv1 services = %v", hv1.Services) + } + rr1 := nodeOf(t, compute(t, withRoles), "rr1") + if rr1.Provision != "" || rr1.PostProvision != "" || rr1.Files != nil || rr1.Services != nil { + t.Errorf("rr1 = %+v, want no provision", rr1) } } -func TestLoad_ResolvesTheAgentPathAgainstTheTopologyFile(t *testing.T) { +func TestLoad_ResolvesProvisionPathsAgainstTheTopologyFile(t *testing.T) { dir := t.TempDir() path := filepath.Join(dir, "lab.yml") - doc := header + ` -segments: - red: { switch: sw, cidr: 10.1.0.0/24 } -nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512 } - hv1: { role: hypervisor, image: deb, cpus: 1, memory: 512, segments: [red], release: 0.2.0rc003, agent: agent/two.yml } - hv2: { role: hypervisor, image: deb, cpus: 1, memory: 512, segments: [red], release: 0.2.0rc003, agent: /etc/lab/agent.yml } -` - if err := os.WriteFile(path, []byte(doc), 0o600); err != nil { + if err := os.WriteFile(path, []byte(withRoles), 0o600); err != nil { t.Fatal(err) } topo, err := Load(path) if err != nil { t.Fatalf("Load: %v", err) } - want := map[string]string{"sw": "", "hv1": filepath.Join(dir, "agent", "two.yml"), "hv2": "/etc/lab/agent.yml"} - for _, n := range topo.Nodes { - if n.Agent != want[n.Name] { - t.Errorf("%s agent = %q, want %q", n.Name, n.Agent, want[n.Name]) - } - } p, err := Compute(topo) if err != nil { t.Fatal(err) } - if got := nodeOf(t, p, "hv1").Agent; got != filepath.Join(dir, "agent", "two.yml") { - t.Errorf("plan hv1 agent = %q", got) + hv1 := nodeOf(t, p, "hv1") + if hv1.Provision != filepath.Join(dir, "provision", "hv.sh") { + t.Errorf("provision = %q", hv1.Provision) + } + if hv1.PostProvision != "/opt/lab/post.sh" { + t.Errorf("post_provision = %q, an absolute path must be kept", hv1.PostProvision) + } + want := map[string]string{"agent.yml": filepath.Join(dir, "agent", "two.yml"), "deploy.sh": "/opt/deploy.sh"} + if !reflect.DeepEqual(hv1.Files, want) { + t.Errorf("files = %v, want %v", hv1.Files, want) + } + if rr1 := nodeOf(t, p, "rr1"); rr1.Provision != "" || rr1.Files != nil { + t.Errorf("rr1 = %+v", rr1) } } diff --git a/internal/lab/topology/topology.go b/internal/lab/topology/topology.go index 66337d8..a5a4296 100644 --- a/internal/lab/topology/topology.go +++ b/internal/lab/topology/topology.go @@ -11,9 +11,9 @@ import ( ) const ( - RoleSwitch = "switch" - RoleRR = "rr" - RoleHypervisor = "hypervisor" + RoleSwitch = "switch" + RoleRR = "rr" + RoleHost = "host" DefaultMTU = 9000 ) @@ -39,18 +39,20 @@ type Segment struct { } type Node struct { - Name string - Role string - Image string - CPUs int - Memory int - Segments []string - Addresses map[string]string - Secondary map[string][]string - Loopback string - FRR string - Release string - Agent string + Name string + Role string + Image string + CPUs int + Memory int + Segments []string + Addresses map[string]string + Secondary map[string][]string + Loopback string + FRR string + Provision string + PostProvision string + Files map[string]string + Services []string } type fileImage struct { @@ -65,17 +67,19 @@ type fileSegment struct { } type fileNode struct { - Role string `yaml:"role"` - Image string `yaml:"image"` - CPUs int `yaml:"cpus"` - Memory int `yaml:"memory"` - Segments []string `yaml:"segments"` - Addresses map[string]string `yaml:"addresses"` - Secondary map[string][]string `yaml:"secondary"` - Loopback string `yaml:"loopback"` - FRR string `yaml:"frr"` - Release string `yaml:"release"` - Agent string `yaml:"agent"` + Role string `yaml:"role"` + Image string `yaml:"image"` + CPUs int `yaml:"cpus"` + Memory int `yaml:"memory"` + Segments []string `yaml:"segments"` + Addresses map[string]string `yaml:"addresses"` + Secondary map[string][]string `yaml:"secondary"` + Loopback string `yaml:"loopback"` + FRR string `yaml:"frr"` + Provision string `yaml:"provision"` + PostProvision string `yaml:"post_provision"` + Files map[string]string `yaml:"files"` + Services []string `yaml:"services"` } type file struct { @@ -94,17 +98,25 @@ func Load(path string) (*Topology, error) { if err != nil { return nil, fmt.Errorf("%s: %w", path, err) } + dir := filepath.Dir(path) for i, n := range t.Nodes { - if n.FRR != "" && !filepath.IsAbs(n.FRR) { - t.Nodes[i].FRR = filepath.Join(filepath.Dir(path), n.FRR) - } - if n.Agent != "" && !filepath.IsAbs(n.Agent) { - t.Nodes[i].Agent = filepath.Join(filepath.Dir(path), n.Agent) + t.Nodes[i].FRR = relativeTo(dir, n.FRR) + t.Nodes[i].Provision = relativeTo(dir, n.Provision) + t.Nodes[i].PostProvision = relativeTo(dir, n.PostProvision) + for name, src := range n.Files { + t.Nodes[i].Files[name] = relativeTo(dir, src) } } return t, nil } +func relativeTo(dir, path string) string { + if path == "" || filepath.IsAbs(path) { + return path + } + return filepath.Join(dir, path) +} + func Parse(data []byte) (*Topology, error) { var f file dec := yaml.NewDecoder(bytes.NewReader(data)) @@ -138,18 +150,20 @@ func Parse(data []byte) (*Topology, error) { for _, name := range order["nodes"] { n := f.Nodes[name] t.Nodes = append(t.Nodes, Node{ - Name: name, - Role: n.Role, - Image: n.Image, - CPUs: n.CPUs, - Memory: n.Memory, - Segments: n.Segments, - Addresses: n.Addresses, - Secondary: n.Secondary, - Loopback: n.Loopback, - FRR: n.FRR, - Release: n.Release, - Agent: n.Agent, + Name: name, + Role: n.Role, + Image: n.Image, + CPUs: n.CPUs, + Memory: n.Memory, + Segments: n.Segments, + Addresses: n.Addresses, + Secondary: n.Secondary, + Loopback: n.Loopback, + FRR: n.FRR, + Provision: n.Provision, + PostProvision: n.PostProvision, + Files: n.Files, + Services: n.Services, }) } return t, nil diff --git a/internal/lab/topology/validate.go b/internal/lab/topology/validate.go index 432fedf..6d21297 100644 --- a/internal/lab/topology/validate.go +++ b/internal/lab/topology/validate.go @@ -23,7 +23,8 @@ const ( var ( namePattern = regexp.MustCompile(`^[a-z][a-z0-9-]{0,14}$`) segmentPattern = regexp.MustCompile(`^[a-z][a-z0-9]{0,11}$`) - releasePattern = regexp.MustCompile(`^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$`) + filePattern = regexp.MustCompile(`^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$`) + unitPattern = regexp.MustCompile(`^[A-Za-z0-9][A-Za-z0-9@._:-]{0,127}$`) ) func (t *Topology) Validate() error { @@ -108,9 +109,9 @@ func (t *Topology) Validate() error { add("node %s: name must match %s", n.Name, namePattern) } switch n.Role { - case RoleSwitch, RoleRR, RoleHypervisor: + case RoleSwitch, RoleRR, RoleHost: default: - add("node %s: role %q must be one of %s, %s, %s", n.Name, n.Role, RoleSwitch, RoleRR, RoleHypervisor) + add("node %s: role %q must be one of %s, %s, %s", n.Name, n.Role, RoleSwitch, RoleRR, RoleHost) } if !images[n.Image] { add("node %s: image %q is not declared", n.Name, n.Image) @@ -207,16 +208,23 @@ func validateExtras(n Node, segments map[string]Segment, add func(string, ...any } } } - switch { - case n.Role == RoleHypervisor && n.Release == "": - add("node %s: a hypervisor needs the release of two to deploy (release: )", n.Name) - case n.Role == RoleHypervisor && !releasePattern.MatchString(n.Release): - add("node %s: release %q must match %s", n.Name, n.Release, releasePattern) - case n.Role != RoleHypervisor && n.Release != "": - add("node %s: release is only for hypervisors", n.Name) + for _, name := range sortedKeys(n.Files) { + switch { + case !filePattern.MatchString(name): + add("node %s: file name %q must match %s", n.Name, name, filePattern) + case n.Files[name] == "": + add("node %s: file %s has no source", n.Name, name) + } } - if n.Role != RoleHypervisor && n.Agent != "" { - add("node %s: agent is only for hypervisors", n.Name) + seenUnits := map[string]bool{} + for _, unit := range n.Services { + switch { + case !unitPattern.MatchString(unit): + add("node %s: service %q must match %s", n.Name, unit, unitPattern) + case seenUnits[unit]: + add("node %s: service %s listed twice", n.Name, unit) + } + seenUnits[unit] = true } if n.Loopback != "" { prefix, err := netip.ParsePrefix(n.Loopback) diff --git a/scripts/embed.go b/scripts/embed.go deleted file mode 100644 index 481e8e5..0000000 --- a/scripts/embed.go +++ /dev/null @@ -1,9 +0,0 @@ -package scripts - -import _ "embed" - -//go:embed deploy.sh -var Deploy []byte - -//go:embed bootstrap_kvm.sh -var BootstrapKVM []byte diff --git a/test/e2e/topologies/evpn-2hv.yml b/test/e2e/topologies/evpn-2hv.yml index 293da21..9a6137a 100644 --- a/test/e2e/topologies/evpn-2hv.yml +++ b/test/e2e/topologies/evpn-2hv.yml @@ -20,10 +20,12 @@ nodes: addresses: { underlay: 192.168.14.2 }, secondary: { underlay: [169.254.0.3/28] }, loopback: 10.255.255.1/32, frr: frr/rr1.conf } hv1: - { role: hypervisor, image: debian12, cpus: 4, memory: 16384, segments: [underlay], - addresses: { underlay: 192.168.14.11 }, frr: frr/hv1.conf, release: 0.2.0rc008, - agent: agent/two.yml } + { role: host, image: debian12, cpus: 4, memory: 16384, segments: [underlay], + addresses: { underlay: 192.168.14.11 }, frr: frr/hv1.conf, provision: provision/hypervisor.sh, + post_provision: provision/hypervisor-post.sh, files: { agent.yml: agent/two.yml }, + services: [agent.service] } hv2: - { role: hypervisor, image: debian12, cpus: 4, memory: 16384, segments: [underlay], - addresses: { underlay: 192.168.14.12 }, frr: frr/hv2.conf, release: 0.2.0rc008, - agent: agent/bgp.yml } + { role: host, image: debian12, cpus: 4, memory: 16384, segments: [underlay], + addresses: { underlay: 192.168.14.12 }, frr: frr/hv2.conf, provision: provision/hypervisor.sh, + post_provision: provision/hypervisor-post.sh, files: { agent.yml: agent/bgp.yml }, + services: [agent.service] } diff --git a/test/e2e/topologies/evpn-3hv.yml b/test/e2e/topologies/evpn-3hv.yml index 7b2893d..16598c8 100644 --- a/test/e2e/topologies/evpn-3hv.yml +++ b/test/e2e/topologies/evpn-3hv.yml @@ -20,14 +20,17 @@ nodes: addresses: { underlay: 192.168.14.2 }, secondary: { underlay: [169.254.0.3/28] }, loopback: 10.255.255.1/32, frr: frr/rr1.conf } hv1: - { role: hypervisor, image: debian12, cpus: 4, memory: 16384, segments: [underlay], - addresses: { underlay: 192.168.14.11 }, frr: frr/hv1.conf, release: 0.2.0rc008, - agent: agent/two.yml } + { role: host, image: debian12, cpus: 4, memory: 16384, segments: [underlay], + addresses: { underlay: 192.168.14.11 }, frr: frr/hv1.conf, provision: provision/hypervisor.sh, + post_provision: provision/hypervisor-post.sh, files: { agent.yml: agent/two.yml }, + services: [agent.service] } hv2: - { role: hypervisor, image: debian12, cpus: 4, memory: 16384, segments: [underlay], - addresses: { underlay: 192.168.14.12 }, frr: frr/hv2.conf, release: 0.2.0rc008, - agent: agent/bgp.yml } + { role: host, image: debian12, cpus: 4, memory: 16384, segments: [underlay], + addresses: { underlay: 192.168.14.12 }, frr: frr/hv2.conf, provision: provision/hypervisor.sh, + post_provision: provision/hypervisor-post.sh, files: { agent.yml: agent/bgp.yml }, + services: [agent.service] } hv3: - { role: hypervisor, image: debian12, cpus: 4, memory: 16384, segments: [underlay], - addresses: { underlay: 192.168.14.13 }, frr: frr/hv3.conf, release: 0.2.0rc008, - agent: agent/bgp.yml } + { role: host, image: debian12, cpus: 4, memory: 16384, segments: [underlay], + addresses: { underlay: 192.168.14.13 }, frr: frr/hv3.conf, provision: provision/hypervisor.sh, + post_provision: provision/hypervisor-post.sh, files: { agent.yml: agent/bgp.yml }, + services: [agent.service] } diff --git a/test/e2e/topologies/provision/hypervisor-post.sh b/test/e2e/topologies/provision/hypervisor-post.sh new file mode 100755 index 0000000..c211d7c --- /dev/null +++ b/test/e2e/topologies/provision/hypervisor-post.sh @@ -0,0 +1,3 @@ +#!/bin/sh +set -eu +systemctl restart agent.service diff --git a/test/e2e/topologies/provision/hypervisor.sh b/test/e2e/topologies/provision/hypervisor.sh new file mode 100755 index 0000000..c7eb354 --- /dev/null +++ b/test/e2e/topologies/provision/hypervisor.sh @@ -0,0 +1,19 @@ +#!/bin/sh +set -eu +RELEASE=0.2.0rc008 +GIT_SERVER=https://git.g3e.fr/ +REPO=syonad/two +n=0 +until curl -fsS -o /dev/null "${GIT_SERVER}"; do + n=$((n + 1)) + [ "$n" -lt 30 ] || exit 1 + sleep 10 +done +install -D -m 0640 "${LAB_FILES}/agent.yml" /etc/two/agent.yml +mkdir -p /opt/two/scripts +cd /opt/two/scripts +for script in deploy.sh bootstrap_kvm.sh; do + curl -fsS -o "${script}" "${GIT_SERVER}${REPO}/raw/tag/${RELEASE}/scripts/${script}" +done +chmod 0755 deploy.sh bootstrap_kvm.sh +bash ./deploy.sh --noup_script -i -u "${LAB_UPLINK}" -t "${RELEASE}" -- 2.52.0 From aceffe7b5817e375561bd258bcd6900d746300aa Mon Sep 17 00:00:00 2001 From: GnomeZworc Date: Mon, 12 Oct 2026 15:50:54 +0200 Subject: [PATCH 2/5] =?UTF-8?q?f-55:=20lab:=20fichiers=20des=20n=C5=93uds?= =?UTF-8?q?=20sur=20un=20ISO=20d=C3=A9di=C3=A9,=20envoi=20des=20binaires?= =?UTF-8?q?=20compil=C3=A9s=20en=20local=20#55?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: GnomeZworc --- .gitignore | 4 ++ cmd/lab/main_test.go | 28 ++++--------- docs/developpement/lab.rst | 21 +++++++++- internal/lab/provision/provision.go | 24 +++++++---- internal/lab/provision/provision_test.go | 35 ++++++++++++++-- internal/lab/render/qemu.go | 3 ++ internal/lab/render/render.go | 10 ++--- internal/lab/render/roles_test.go | 30 +++++++++++--- internal/lab/render/seed.go | 16 ++++---- internal/lab/topology/roles_test.go | 4 ++ internal/lab/topology/validate.go | 2 + test/e2e/build.sh | 45 +++++++++++++++++++++ test/e2e/topologies/bin/.gitkeep | 0 test/e2e/topologies/evpn-2hv.yml | 4 +- test/e2e/topologies/evpn-3hv.yml | 6 +-- test/e2e/topologies/provision/hypervisor.sh | 7 ++++ 16 files changed, 181 insertions(+), 58 deletions(-) create mode 100755 test/e2e/build.sh create mode 100644 test/e2e/topologies/bin/.gitkeep diff --git a/.gitignore b/.gitignore index fd7d60e..3f0d6a4 100644 --- a/.gitignore +++ b/.gitignore @@ -33,3 +33,7 @@ data/ # Sphinx build output docs/_build/ + +# Binaires compilés en local pour le lab (test/e2e/build.sh) +test/e2e/topologies/bin/* +!test/e2e/topologies/bin/.gitkeep diff --git a/cmd/lab/main_test.go b/cmd/lab/main_test.go index 8987dcc..cb78c26 100644 --- a/cmd/lab/main_test.go +++ b/cmd/lab/main_test.go @@ -2,7 +2,6 @@ package main import ( "bytes" - "encoding/base64" "os" "os/exec" "path/filepath" @@ -10,8 +9,6 @@ import ( "strings" "syscall" "testing" - - "go.yaml.in/yaml/v3" ) func runLab(args ...string) (int, string, string) { @@ -336,25 +333,14 @@ func TestRun_RenderShipsTheExampleFRRConfigs(t *testing.T) { if err != nil { t.Fatal(err) } - var cfg struct { - Files []struct { - Path string `yaml:"path"` - Content string `yaml:"content"` - } `yaml:"write_files"` + if !strings.Contains(string(data), "mount -o ro LABEL=LABFILES /run/lab-files") { + t.Errorf("%s user-data does not mount its files", node) } - if err := yaml.Unmarshal(data, &cfg); err != nil { - t.Fatal(err) - } - var agent []byte - for _, f := range cfg.Files { - if f.Path == "/etc/lab/files/agent.yml" { - if agent, err = base64.StdEncoding.DecodeString(f.Content); err != nil { - t.Fatal(err) - } - } - } - if !strings.Contains(string(agent), "route_reflectors: [10.255.255.1]") { - t.Errorf("%s agent.yml = %q", node, agent) + } + for _, agent := range []string{"two.yml", "bgp.yml"} { + data, err := os.ReadFile(filepath.Join("..", "..", "test", "e2e", "topologies", "agent", agent)) + if err != nil || !strings.Contains(string(data), "route_reflectors: [10.255.255.1]") { + t.Errorf("agent/%s = %q, %v", agent, data, err) } } } diff --git a/docs/developpement/lab.rst b/docs/developpement/lab.rst index d9fa252..ff4e46b 100644 --- a/docs/developpement/lab.rst +++ b/docs/developpement/lab.rst @@ -250,8 +250,11 @@ Ce que le fichier déclare : * ``provision`` — le chemin d'un script, relatif au fichier de topologie, exécuté au premier démarrage **avant** FRR ; * ``post_provision`` — un second script, exécuté **après** FRR ; - * ``files`` — des fichiers déposés dans ``/etc/lab/files/`` avant les scripts, sous la - forme ``{: }`` (``files: {agent.yml: agent/two.yml}``) ; + * ``files`` — des fichiers **ou répertoires** déposés dans ``/etc/lab/files/`` avant les + scripts, sous la forme ``{: }`` (``files: {agent.yml: agent/two.yml, bin: bin}``). + Ils voyagent dans un ``files.iso`` propre au nœud (volume ``LABFILES``), attaché comme second + lecteur et recopié au premier démarrage : la taille n'est pas limitée par cloud-init, et un + binaire de plusieurs dizaines de Mio passe ; * ``services`` — les unités systemd que ``lab up`` vérifie actives sur le nœud. Les scripts reçoivent ``LAB_NODE`` (nom du nœud), ``LAB_UPLINK`` (interface de son premier @@ -387,6 +390,20 @@ réponde, à travers le switch. Les deux fichiers ``agent/`` donnent à l'agent ``agent/two.yml`` met en plus hv1 sur le serveur DHCP intégré (``dhcp.backend: two``), ``agent/bgp.yml`` laisse les autres sur dnsmasq. +**Tester l'arbre courant plutôt que la release.** ``test/e2e/build.sh`` compile ``agent``, +``dhcp`` et ``metadata`` pour linux/amd64 dans ``test/e2e/topologies/bin/`` (ignoré par git), +que les hyperviseurs reçoivent par ``files: {bin: bin}``. Après ``deploy.sh``, +``hypervisor.sh`` installe chaque binaire présent dans ``/opt/two/local/bin/`` et y fait pointer +``/opt/two/bin/`` ; le reste (units, scripts) vient de la release. ``build.sh --clean`` vide +le répertoire : le lab suivant teste la release seule. + +.. code-block:: text + + test/e2e/build.sh # binaires de l'arbre courant + scripts/lab-host.sh push test/e2e/topologies/evpn-3hv.yml + scripts/lab-host.sh ssh './lab up topology/evpn-3hv.yml' + test/e2e/build.sh --clean # retour à la release seule + FRR est installé **après** la provision : il démarre sur le réseau final. Démarré avant la migration, zebra peut perdre la route par défaut quand elle passe de l'uplink à ``br-000000`` — constaté le 2026-10-11 sur un hyperviseur sur deux : route reflector diff --git a/internal/lab/provision/provision.go b/internal/lab/provision/provision.go index 36d0a7f..fe20c9f 100644 --- a/internal/lab/provision/provision.go +++ b/internal/lab/provision/provision.go @@ -7,6 +7,7 @@ import ( "os" "os/exec" "path/filepath" + "sort" "strings" "git.g3e.fr/syonad/two/internal/lab/render" @@ -99,17 +100,11 @@ func ReadInputs(p *topology.Plan, o *render.Options) error { if o.PostProvision, err = readNodeFiles(p, func(n topology.NodePlan) string { return n.PostProvision }); err != nil { return err } - o.Files = map[string]map[string][]byte{} for _, n := range p.Nodes { for name, src := range n.Files { - data, err := os.ReadFile(src) - if err != nil { + if _, err := os.Stat(src); err != nil { return fmt.Errorf("node %s: file %s: %w", n.Name, name, err) } - if o.Files[n.Name] == nil { - o.Files[n.Name] = map[string][]byte{} - } - o.Files[n.Name][name] = data } } return nil @@ -184,6 +179,21 @@ func Stage(ctx context.Context, r Runner, n render.Node, base string) error { for _, f := range SeedFiles { args = append(args, filepath.Join(n.Dir, f)) } + if err := r.Run(ctx, "genisoimage", args...); err != nil { + return err + } + if len(n.Files) == 0 { + return nil + } + names := make([]string, 0, len(n.Files)) + for name := range n.Files { + names = append(names, name) + } + sort.Strings(names) + args = []string{"-quiet", "-output", filepath.Join(n.Dir, render.FilesISO), "-volid", render.FilesLabel, "-joliet", "-rock", "-graft-points"} + for _, name := range names { + args = append(args, name+"="+n.Files[name]) + } return r.Run(ctx, "genisoimage", args...) } diff --git a/internal/lab/provision/provision_test.go b/internal/lab/provision/provision_test.go index d4d7a5a..a837f05 100644 --- a/internal/lab/provision/provision_test.go +++ b/internal/lab/provision/provision_test.go @@ -280,6 +280,31 @@ func TestEnsureKey_ReportsAFailedGeneration(t *testing.T) { } } +func TestStage_BurnsTheNodeFilesIntoTheirOwnISO(t *testing.T) { + runner := &fakeRunner{} + dir := t.TempDir() + n := render.Node{Name: "hv1", Dir: dir, Files: map[string]string{"bin": "/src/bin", "agent.yml": "/src/two.yml"}} + if err := Stage(context.Background(), runner, n, "/cache/deb.qcow2"); err != nil { + t.Fatalf("Stage: %v", err) + } + isos := runner.commands("genisoimage") + want := []string{"genisoimage", "-quiet", "-output", filepath.Join(dir, "files.iso"), "-volid", "LABFILES", "-joliet", "-rock", "-graft-points", + "agent.yml=/src/two.yml", "bin=/src/bin"} + if len(isos) != 2 || !reflect.DeepEqual(isos[1], want) { + t.Errorf("genisoimage calls:\n%q\nwant second:\n%q", isos, want) + } +} + +func TestStage_NoFilesNoFilesISO(t *testing.T) { + runner := &fakeRunner{} + if err := Stage(context.Background(), runner, render.Node{Name: "rr1", Dir: t.TempDir()}, "/cache/deb.qcow2"); err != nil { + t.Fatalf("Stage: %v", err) + } + if n := len(runner.commands("genisoimage")); n != 1 { + t.Errorf("genisoimage ran %d times, want only the seed", n) + } +} + func TestStage_RefusesARelativeBaseImage(t *testing.T) { runner := &fakeRunner{} err := Stage(context.Background(), runner, render.Node{Name: "hv1", Dir: t.TempDir()}, "debian.qcow2") @@ -387,7 +412,7 @@ func TestPrepare_PutsTheFRRConfigIntoTheSeed(t *testing.T) { t.Errorf("hv1 user-data has no /etc/lab/frr.conf:\n%s", data) } -func TestReadInputs_ReadsTheProvisionScriptsAndFiles(t *testing.T) { +func TestReadInputs_ReadsTheScriptsAndChecksTheFiles(t *testing.T) { dir := t.TempDir() write := func(name, content string) string { path := filepath.Join(dir, name) @@ -402,6 +427,11 @@ func TestReadInputs_ReadsTheProvisionScriptsAndFiles(t *testing.T) { p.Nodes[2].PostProvision = write("hv-post.sh", "#!/bin/sh\necho post\n") p.Nodes[2].Files = map[string]string{"agent.yml": write("two.yml", "dhcp:\n backend: two\n")} + if err := os.Mkdir(filepath.Join(dir, "bin"), 0o700); err != nil { + t.Fatal(err) + } + p.Nodes[2].Files["bin"] = filepath.Join(dir, "bin") + var o render.Options if err := ReadInputs(p, &o); err != nil { t.Fatal(err) @@ -412,9 +442,6 @@ func TestReadInputs_ReadsTheProvisionScriptsAndFiles(t *testing.T) { if !reflect.DeepEqual(o.PostProvision, map[string]string{"hv1": "#!/bin/sh\necho post\n"}) { t.Errorf("post_provision = %q", o.PostProvision) } - if !reflect.DeepEqual(o.Files, map[string]map[string][]byte{"hv1": {"agent.yml": []byte("dhcp:\n backend: two\n")}}) { - t.Errorf("files = %q", o.Files) - } p.Nodes[3].Files = map[string]string{"agent.yml": filepath.Join(dir, "absent.yml")} if err := ReadInputs(p, &render.Options{}); err == nil || !strings.Contains(err.Error(), "node hv2: file agent.yml: ") { diff --git a/internal/lab/render/qemu.go b/internal/lab/render/qemu.go index 9a870d2..4c380c8 100644 --- a/internal/lab/render/qemu.go +++ b/internal/lab/render/qemu.go @@ -26,6 +26,9 @@ func qemuArgs(p *topology.Plan, n topology.NodePlan, index int, dir string) []st "-drive", "file=" + filepath.Join(dir, DiskFile) + ",if=virtio,format=qcow2", "-drive", "file=" + filepath.Join(dir, SeedFile) + ",media=cdrom,readonly=on", } + if len(n.Files) > 0 { + args = append(args, "-drive", "file="+filepath.Join(dir, FilesISO)+",media=cdrom,readonly=on") + } restrict := "on" if n.Role == topology.RoleSwitch { diff --git a/internal/lab/render/render.go b/internal/lab/render/render.go index 723a465..7fbe3b7 100644 --- a/internal/lab/render/render.go +++ b/internal/lab/render/render.go @@ -20,6 +20,8 @@ const ( DiskFile = "disk.qcow2" SeedFile = "seed.iso" + FilesISO = "files.iso" + FilesLabel = "LABFILES" ConsoleFile = "console.log" QMPFile = "qmp.sock" PIDFile = "qemu.pid" @@ -33,12 +35,12 @@ type Options struct { FRR map[string]string Provision map[string]string PostProvision map[string]string - Files map[string]map[string][]byte } type Node struct { Name string Dir string + Files map[string]string QEMU []string MetaData []byte UserData []byte @@ -59,11 +61,6 @@ func Render(p *topology.Plan, o Options) ([]Node, error) { if _, ok := o.PostProvision[n.Name]; n.PostProvision != "" && !ok { return nil, fmt.Errorf("node %s: post_provision script %s was not read", n.Name, n.PostProvision) } - for name, src := range n.Files { - if _, ok := o.Files[n.Name][name]; !ok { - return nil, fmt.Errorf("node %s: file %s (%s) was not read", n.Name, name, src) - } - } } var nodes []Node for index, n := range p.Nodes { @@ -83,6 +80,7 @@ func Render(p *topology.Plan, o Options) ([]Node, error) { nodes = append(nodes, Node{ Name: n.Name, Dir: dir, + Files: n.Files, QEMU: qemuArgs(p, n, index, dir), MetaData: meta, UserData: user, diff --git a/internal/lab/render/roles_test.go b/internal/lab/render/roles_test.go index bf15644..686b3b5 100644 --- a/internal/lab/render/roles_test.go +++ b/internal/lab/render/roles_test.go @@ -36,7 +36,6 @@ func roleOptions() Options { FRR: frrConfigs, Provision: map[string]string{"hv1": "#!/bin/sh\necho provision\n"}, PostProvision: map[string]string{"hv1": "#!/bin/sh\necho post\n"}, - Files: map[string]map[string][]byte{"hv1": {"agent.yml": []byte("dhcp:\n backend: two\n")}}, } } @@ -155,9 +154,10 @@ func TestRoles_FRRKeyIsThePinnedRepositoryKey(t *testing.T) { func TestRoles_ProvisioningIsOneScriptThatStopsAtTheFirstFailure(t *testing.T) { nodes := renderRoles(t) env := "LAB_NODE=hv1 LAB_UPLINK=underlay LAB_FILES=/etc/lab/files " + files := "mkdir -p /etc/lab/files /run/lab-files\nmount -o ro LABEL=LABFILES /run/lab-files\ncp -R /run/lab-files/. /etc/lab/files/\numount /run/lab-files\n" for name, steps := range map[string]string{ "sw1": "systemctl daemon-reload\nsystemctl enable --now lab-switch.service\n/usr/local/sbin/lab-frr\n", - "hv1": env + "/usr/local/sbin/lab-node-provision\n/usr/local/sbin/lab-frr\n" + env + "/usr/local/sbin/lab-node-post-provision\n", + "hv1": files + env + "/usr/local/sbin/lab-node-provision\n/usr/local/sbin/lab-frr\n" + env + "/usr/local/sbin/lab-node-post-provision\n", } { cfg := user(t, nodeNamed(t, nodes, name)) if !reflect.DeepEqual(cfg.Runcmd, [][]string{{"/usr/local/sbin/lab-provision"}}) { @@ -173,7 +173,29 @@ func TestRoles_ProvisioningIsOneScriptThatStopsAtTheFirstFailure(t *testing.T) { } } -func TestRoles_HostReceivesItsScriptsAndFiles(t *testing.T) { +func TestRoles_FilesTravelOnASecondCDROM(t *testing.T) { + nodes := renderRoles(t) + hv1 := nodeNamed(t, nodes, "hv1") + if !reflect.DeepEqual(hv1.Files, map[string]string{"agent.yml": "two.yml"}) { + t.Errorf("hv1 files = %v", hv1.Files) + } + drive := "file=/srv/lab/hv1/files.iso,media=cdrom,readonly=on" + if !strings.Contains(strings.Join(hv1.QEMU, " "), "-drive "+drive) { + t.Errorf("hv1 qemu lacks %s:\n%s", drive, strings.Join(hv1.QEMU, "\n")) + } + for _, f := range user(t, hv1).WriteFiles { + if strings.HasPrefix(f.Path, "/etc/lab/files/") { + t.Errorf("hv1 user-data carries %s, files belong to the ISO", f.Path) + } + } + for _, name := range []string{"sw1", "rr1", "hv2"} { + if n := nodeNamed(t, nodes, name); strings.Contains(strings.Join(n.QEMU, " "), "files.iso") || n.Files != nil { + t.Errorf("%s gets a files ISO", name) + } + } +} + +func TestRoles_HostReceivesItsScripts(t *testing.T) { cfg := user(t, nodeNamed(t, renderRoles(t), "hv1")) for path, want := range map[string]struct { content string @@ -181,7 +203,6 @@ func TestRoles_HostReceivesItsScriptsAndFiles(t *testing.T) { }{ "/usr/local/sbin/lab-node-provision": {"#!/bin/sh\necho provision\n", "0755"}, "/usr/local/sbin/lab-node-post-provision": {"#!/bin/sh\necho post\n", "0755"}, - "/etc/lab/files/agent.yml": {"dhcp:\n backend: two\n", "0644"}, } { f := fileAt(t, cfg, path) got, err := base64.StdEncoding.DecodeString(f.Content) @@ -280,7 +301,6 @@ func TestRoles_RefusesUnreadProvisionInputs(t *testing.T) { }{ "provision": {func(o *Options) { o.Provision = nil }, "node hv1: provision script hv.sh was not read"}, "post": {func(o *Options) { o.PostProvision = nil }, "node hv1: post_provision script hv-post.sh was not read"}, - "file": {func(o *Options) { o.Files = nil }, "node hv1: file agent.yml (two.yml) was not read"}, } for name, c := range cases { o := roleOptions() diff --git a/internal/lab/render/seed.go b/internal/lab/render/seed.go index 28c130c..948fe5d 100644 --- a/internal/lab/render/seed.go +++ b/internal/lab/render/seed.go @@ -4,7 +4,6 @@ import ( _ "embed" "encoding/base64" "fmt" - "sort" "strings" "go.yaml.in/yaml/v3" @@ -31,6 +30,7 @@ const ( NodeProvision = "/usr/local/sbin/lab-node-provision" NodePostProvision = "/usr/local/sbin/lab-node-post-provision" FilesDir = "/etc/lab/files" + FilesMount = "/run/lab-files" ) //go:embed frrouting.gpg @@ -114,13 +114,13 @@ func userData(p *topology.Plan, n topology.NodePlan, o Options) ([]byte, error) } steps = append(steps, "systemctl daemon-reload", "systemctl enable --now lab-node.service") } - names := make([]string, 0, len(n.Files)) - for name := range n.Files { - names = append(names, name) - } - sort.Strings(names) - for _, name := range names { - cfg.WriteFiles = append(cfg.WriteFiles, writeFile{Path: FilesDir + "/" + name, Permissions: "0644", Encoding: "b64", Content: base64.StdEncoding.EncodeToString(o.Files[n.Name][name])}) + if len(n.Files) > 0 { + steps = append(steps, + "mkdir -p "+FilesDir+" "+FilesMount, + "mount -o ro LABEL="+FilesLabel+" "+FilesMount, + "cp -R "+FilesMount+"/. "+FilesDir+"/", + "umount "+FilesMount, + ) } if n.Provision != "" { cfg.WriteFiles = append(cfg.WriteFiles, writeFile{Path: NodeProvision, Permissions: "0755", Encoding: "b64", Content: base64.StdEncoding.EncodeToString([]byte(o.Provision[n.Name]))}) diff --git a/internal/lab/topology/roles_test.go b/internal/lab/topology/roles_test.go index 651c7ef..0be43ee 100644 --- a/internal/lab/topology/roles_test.go +++ b/internal/lab/topology/roles_test.go @@ -186,6 +186,10 @@ func TestValidate_ProvisionRejections(t *testing.T) { `hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [red], files: { agent.yml: "" } }`, "node hv: file agent.yml has no source", }, + "file source with an equals sign": { + `hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [red], files: { bin: "a=b" } }`, + `node hv: file bin: source "a=b" must not contain '='`, + }, "service with shell characters": { `hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [red], services: ["agent.service; reboot"] }`, `node hv: service "agent.service; reboot" must match`, diff --git a/internal/lab/topology/validate.go b/internal/lab/topology/validate.go index 6d21297..7161b1f 100644 --- a/internal/lab/topology/validate.go +++ b/internal/lab/topology/validate.go @@ -214,6 +214,8 @@ func validateExtras(n Node, segments map[string]Segment, add func(string, ...any add("node %s: file name %q must match %s", n.Name, name, filePattern) case n.Files[name] == "": add("node %s: file %s has no source", n.Name, name) + case strings.Contains(n.Files[name], "="): + add("node %s: file %s: source %q must not contain '='", n.Name, name, n.Files[name]) } } seenUnits := map[string]bool{} diff --git a/test/e2e/build.sh b/test/e2e/build.sh new file mode 100755 index 0000000..3b68881 --- /dev/null +++ b/test/e2e/build.sh @@ -0,0 +1,45 @@ +#!/usr/bin/env bash + +E2E_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +REPO_DIR="$(cd "${E2E_DIR}/../.." && pwd)" +BIN_DIR="${BIN_DIR:-${E2E_DIR}/topologies/bin}" +BINARIES="agent dhcp metadata" + +usage () { + cat >&2 <&2 + (cd "${REPO_DIR}" && CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o "${BIN_DIR}/${binary}" "./cmd/${binary}") || return 1 + done + (cd "${BIN_DIR}" && sha256sum ${BINARIES} 2>/dev/null || shasum -a 256 ${BINARIES}) +} + +main () { + case "${1:-}" in + "") build ;; + --clean) clean ;; + *) usage ;; + esac +} + +if [[ "${BASH_SOURCE[0]}" == "${0}" || -z "${BASH_SOURCE[0]}" ]]; then + main "$@" +fi diff --git a/test/e2e/topologies/bin/.gitkeep b/test/e2e/topologies/bin/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/test/e2e/topologies/evpn-2hv.yml b/test/e2e/topologies/evpn-2hv.yml index 9a6137a..89e8b47 100644 --- a/test/e2e/topologies/evpn-2hv.yml +++ b/test/e2e/topologies/evpn-2hv.yml @@ -22,10 +22,10 @@ nodes: hv1: { role: host, image: debian12, cpus: 4, memory: 16384, segments: [underlay], addresses: { underlay: 192.168.14.11 }, frr: frr/hv1.conf, provision: provision/hypervisor.sh, - post_provision: provision/hypervisor-post.sh, files: { agent.yml: agent/two.yml }, + post_provision: provision/hypervisor-post.sh, files: { agent.yml: agent/two.yml, bin: bin }, services: [agent.service] } hv2: { role: host, image: debian12, cpus: 4, memory: 16384, segments: [underlay], addresses: { underlay: 192.168.14.12 }, frr: frr/hv2.conf, provision: provision/hypervisor.sh, - post_provision: provision/hypervisor-post.sh, files: { agent.yml: agent/bgp.yml }, + post_provision: provision/hypervisor-post.sh, files: { agent.yml: agent/bgp.yml, bin: bin }, services: [agent.service] } diff --git a/test/e2e/topologies/evpn-3hv.yml b/test/e2e/topologies/evpn-3hv.yml index 16598c8..92b726b 100644 --- a/test/e2e/topologies/evpn-3hv.yml +++ b/test/e2e/topologies/evpn-3hv.yml @@ -22,15 +22,15 @@ nodes: hv1: { role: host, image: debian12, cpus: 4, memory: 16384, segments: [underlay], addresses: { underlay: 192.168.14.11 }, frr: frr/hv1.conf, provision: provision/hypervisor.sh, - post_provision: provision/hypervisor-post.sh, files: { agent.yml: agent/two.yml }, + post_provision: provision/hypervisor-post.sh, files: { agent.yml: agent/two.yml, bin: bin }, services: [agent.service] } hv2: { role: host, image: debian12, cpus: 4, memory: 16384, segments: [underlay], addresses: { underlay: 192.168.14.12 }, frr: frr/hv2.conf, provision: provision/hypervisor.sh, - post_provision: provision/hypervisor-post.sh, files: { agent.yml: agent/bgp.yml }, + post_provision: provision/hypervisor-post.sh, files: { agent.yml: agent/bgp.yml, bin: bin }, services: [agent.service] } hv3: { role: host, image: debian12, cpus: 4, memory: 16384, segments: [underlay], addresses: { underlay: 192.168.14.13 }, frr: frr/hv3.conf, provision: provision/hypervisor.sh, - post_provision: provision/hypervisor-post.sh, files: { agent.yml: agent/bgp.yml }, + post_provision: provision/hypervisor-post.sh, files: { agent.yml: agent/bgp.yml, bin: bin }, services: [agent.service] } diff --git a/test/e2e/topologies/provision/hypervisor.sh b/test/e2e/topologies/provision/hypervisor.sh index c7eb354..20b10e5 100755 --- a/test/e2e/topologies/provision/hypervisor.sh +++ b/test/e2e/topologies/provision/hypervisor.sh @@ -17,3 +17,10 @@ for script in deploy.sh bootstrap_kvm.sh; do done chmod 0755 deploy.sh bootstrap_kvm.sh bash ./deploy.sh --noup_script -i -u "${LAB_UPLINK}" -t "${RELEASE}" +for binary in "${LAB_FILES}"/bin/*; do + [ -f "${binary}" ] || continue + name=$(basename "${binary}") + install -D -m 0755 "${binary}" "/opt/two/local/bin/${name}" + ln -sfn "/opt/two/local/bin/${name}" "/opt/two/bin/${name}" + echo "lab: ${name} compilé en local remplace celui de la release ${RELEASE}" +done -- 2.52.0 From 35f394796d737b5c687139916d2025fb3631478c Mon Sep 17 00:00:00 2001 From: GnomeZworc Date: Mon, 12 Oct 2026 16:18:50 +0200 Subject: [PATCH 3/5] f-55: lab: l'outil devient labctl, noms et chemins neutres #55 Signed-off-by: GnomeZworc --- cmd/{lab => labctl}/lifecycle.go | 30 +++--- cmd/{lab => labctl}/main.go | 20 ++-- cmd/{lab => labctl}/main_test.go | 8 +- cmd/{lab => labctl}/terminal.go | 0 cmd/{lab => labctl}/terminal_darwin.go | 0 cmd/{lab => labctl}/terminal_linux.go | 0 cmd/{lab => labctl}/terminal_other.go | 0 docs/developpement/lab.rst | 112 +++++++++++------------ internal/lab/machine/machine_test.go | 2 +- internal/lab/provision/provision.go | 2 +- internal/lab/provision/provision_test.go | 6 +- internal/lab/render/render_test.go | 2 +- scripts/lab-host.sh | 30 +++--- scripts/lab-host_test.sh | 76 +++++++-------- test/e2e/run.sh | 4 +- test/e2e/run_test.sh | 2 +- 16 files changed, 147 insertions(+), 147 deletions(-) rename cmd/{lab => labctl}/lifecycle.go (81%) rename cmd/{lab => labctl}/main.go (88%) rename cmd/{lab => labctl}/main_test.go (97%) rename cmd/{lab => labctl}/terminal.go (100%) rename cmd/{lab => labctl}/terminal_darwin.go (100%) rename cmd/{lab => labctl}/terminal_linux.go (100%) rename cmd/{lab => labctl}/terminal_other.go (100%) diff --git a/cmd/lab/lifecycle.go b/cmd/labctl/lifecycle.go similarity index 81% rename from cmd/lab/lifecycle.go rename to cmd/labctl/lifecycle.go index c91205e..6bc6547 100644 --- a/cmd/lab/lifecycle.go +++ b/cmd/labctl/lifecycle.go @@ -46,7 +46,7 @@ func flags(name string, stderr io.Writer) (*flag.FlagSet, *string) { func lab(runDir string, plan string, stdout, stderr io.Writer) (machine.Lab, bool) { dir, err := filepath.Abs(runDir) if err != nil { - fmt.Fprintf(stderr, "lab: %v\n", err) + fmt.Fprintf(stderr, "labctl: %v\n", err) return machine.Lab{}, false } p, ok := load(plan, stderr) @@ -67,7 +67,7 @@ func lab(runDir string, plan string, stdout, stderr io.Writer) (machine.Lab, boo func current(runDir string, stdout, stderr io.Writer) (machine.Lab, bool) { saved := filepath.Join(runDir, topologyFile) if _, err := os.Stat(saved); err != nil { - fmt.Fprintf(stderr, "lab: no lab in %s: %v\n", runDir, err) + fmt.Fprintf(stderr, "labctl: no lab in %s: %v\n", runDir, err) return machine.Lab{}, false } return lab(runDir, saved, stdout, stderr) @@ -75,7 +75,7 @@ func current(runDir string, stdout, stderr io.Writer) (machine.Lab, bool) { func upCmd(args []string, stdout, stderr io.Writer) int { fs, runDir := flags("up", stderr) - cacheDir := fs.String("cache", defaultDir(".cache", "two-lab"), "image cache directory") + cacheDir := fs.String("cache", defaultDir(".cache", "labctl"), "image cache directory") timeout := fs.Duration("timeout", 20*time.Minute, "how long to wait for the nodes to be ready") if err := fs.Parse(args); err != nil || fs.NArg() != 1 { fs.Usage() @@ -83,7 +83,7 @@ func upCmd(args []string, stdout, stderr io.Writer) int { } cache, err := filepath.Abs(*cacheDir) if err != nil { - fmt.Fprintf(stderr, "lab: %v\n", err) + fmt.Fprintf(stderr, "labctl: %v\n", err) return 1 } @@ -94,11 +94,11 @@ func upCmd(args []string, stdout, stderr io.Writer) int { } running, err := previous.Running() if err != nil { - fmt.Fprintf(stderr, "lab: %v\n", err) + fmt.Fprintf(stderr, "labctl: %v\n", err) return 1 } if len(running) > 0 { - fmt.Fprintf(stderr, "lab: lab %s is still running in %s: 'lab down' first\n", previous.Plan.Name, previous.RunDir) + fmt.Fprintf(stderr, "labctl: lab %s is still running in %s: 'lab down' first\n", previous.Plan.Name, previous.RunDir) return 1 } } @@ -109,15 +109,15 @@ func upCmd(args []string, stdout, stderr io.Writer) int { } source, err := os.ReadFile(fs.Arg(0)) if err != nil { - fmt.Fprintf(stderr, "lab: %v\n", err) + fmt.Fprintf(stderr, "labctl: %v\n", err) return 1 } if err := os.MkdirAll(l.RunDir, 0o700); err != nil { - fmt.Fprintf(stderr, "lab: %v\n", err) + fmt.Fprintf(stderr, "labctl: %v\n", err) return 1 } if err := os.WriteFile(filepath.Join(l.RunDir, topologyFile), source, 0o600); err != nil { - fmt.Fprintf(stderr, "lab: %v\n", err) + fmt.Fprintf(stderr, "labctl: %v\n", err) return 1 } @@ -125,7 +125,7 @@ func upCmd(args []string, stdout, stderr io.Writer) int { defer stop() fetcher := provision.Fetcher{Client: &http.Client{}, CacheDir: cache} if err := l.Up(ctx, fetcher, *timeout); err != nil { - fmt.Fprintf(stderr, "lab: %v\nlab: started nodes keep running: 'lab status', 'lab down'\n", err) + fmt.Fprintf(stderr, "labctl: %v\nlab: started nodes keep running: 'lab status', 'lab down'\n", err) return 1 } return 0 @@ -142,7 +142,7 @@ func statusCmd(args []string, stdout, stderr io.Writer) int { return 1 } if err := l.Status(stdout); err != nil { - fmt.Fprintf(stderr, "lab: %v\n", err) + fmt.Fprintf(stderr, "labctl: %v\n", err) return 1 } return 0 @@ -159,7 +159,7 @@ func downCmd(args []string, stdout, stderr io.Writer) int { return 1 } if err := l.Down(context.Background()); err != nil { - fmt.Fprintf(stderr, "lab: %v\n", err) + fmt.Fprintf(stderr, "labctl: %v\n", err) return 1 } return 0 @@ -177,16 +177,16 @@ func sshCmd(args []string, stdout, stderr io.Writer) int { } argv, err := l.SSH(fs.Arg(0), isTerminal(os.Stdin), fs.Args()[1:]) if err != nil { - fmt.Fprintf(stderr, "lab: %v\n", err) + fmt.Fprintf(stderr, "labctl: %v\n", err) return 1 } path, err := exec.LookPath(argv[0]) if err != nil { - fmt.Fprintf(stderr, "lab: %v\n", err) + fmt.Fprintf(stderr, "labctl: %v\n", err) return 1 } if err := execve(path, argv, os.Environ()); err != nil { - fmt.Fprintf(stderr, "lab: %v\n", err) + fmt.Fprintf(stderr, "labctl: %v\n", err) return 1 } return 0 diff --git a/cmd/lab/main.go b/cmd/labctl/main.go similarity index 88% rename from cmd/lab/main.go rename to cmd/labctl/main.go index 90c2e50..b4bd2c9 100644 --- a/cmd/lab/main.go +++ b/cmd/labctl/main.go @@ -13,7 +13,7 @@ import ( "git.g3e.fr/syonad/two/internal/lab/topology" ) -const usage = `usage: lab [options] [dir] +const usage = `usage: labctl [options] [dir] plan validate the topology and print the deterministic plan: addresses, cables, ports @@ -36,7 +36,7 @@ const usage = `usage: lab [options] [dir] ssh [-run dir] [command...] open a shell on a node, or run a command on it, with the key generated by up - defaults: -run $HOME/lab-run, -cache $HOME/.cache/two-lab, -timeout 20m + defaults: -run $HOME/lab-run, -cache $HOME/.cache/labctl, -timeout 20m ` type keyFiles []string @@ -79,12 +79,12 @@ func run(args []string, stdout, stderr io.Writer) int { func load(path string, stderr io.Writer) (*topology.Plan, bool) { t, err := topology.Load(path) if err != nil { - fmt.Fprintf(stderr, "lab: %v\n", err) + fmt.Fprintf(stderr, "labctl: %v\n", err) return nil, false } p, err := topology.Compute(t) if err != nil { - fmt.Fprintf(stderr, "lab: %s:\n%v\n", path, err) + fmt.Fprintf(stderr, "labctl: %s:\n%v\n", path, err) return nil, false } return p, true @@ -96,7 +96,7 @@ func plan(path string, stdout, stderr io.Writer) int { return 1 } if err := p.Write(stdout); err != nil { - fmt.Fprintf(stderr, "lab: %v\n", err) + fmt.Fprintf(stderr, "labctl: %v\n", err) return 1 } return 0 @@ -122,27 +122,27 @@ func renderCmd(args []string, stdout, stderr io.Writer) int { } dir, err := filepath.Abs(fs.Arg(1)) if err != nil { - fmt.Fprintf(stderr, "lab: %v\n", err) + fmt.Fprintf(stderr, "labctl: %v\n", err) return 1 } authorized, err := readKeys(keys) if err != nil { - fmt.Fprintf(stderr, "lab: %v\n", err) + fmt.Fprintf(stderr, "labctl: %v\n", err) return 1 } opts := render.Options{RunDir: dir, AuthorizedKeys: authorized} if err := provision.ReadInputs(p, &opts); err != nil { - fmt.Fprintf(stderr, "lab: %v\n", err) + fmt.Fprintf(stderr, "labctl: %v\n", err) return 1 } nodes, err := render.Render(p, opts) if err != nil { - fmt.Fprintf(stderr, "lab: %v\n", err) + fmt.Fprintf(stderr, "labctl: %v\n", err) return 1 } for _, n := range nodes { if err := provision.WriteFiles(n); err != nil { - fmt.Fprintf(stderr, "lab: %v\n", err) + fmt.Fprintf(stderr, "labctl: %v\n", err) return 1 } fmt.Fprintf(stdout, "%s\n", n.Dir) diff --git a/cmd/lab/main_test.go b/cmd/labctl/main_test.go similarity index 97% rename from cmd/lab/main_test.go rename to cmd/labctl/main_test.go index cb78c26..4f87a51 100644 --- a/cmd/lab/main_test.go +++ b/cmd/labctl/main_test.go @@ -78,7 +78,7 @@ func TestRun_MissingFile(t *testing.T) { func TestRun_RenderWritesEveryNodeFiles(t *testing.T) { dir := t.TempDir() key := filepath.Join(dir, "lab.pub") - if err := os.WriteFile(key, []byte("# lab key\n\nssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFG/JMmjfko96WkJV8DiL6rip/H/q/R++y8s27Z+Cj6O two-lab-automation\n"), 0o600); err != nil { + if err := os.WriteFile(key, []byte("# lab key\n\nssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFG/JMmjfko96WkJV8DiL6rip/H/q/R++y8s27Z+Cj6O lab-automation\n"), 0o600); err != nil { t.Fatal(err) } out := filepath.Join(dir, "run") @@ -112,7 +112,7 @@ func TestRun_RenderWritesEveryNodeFiles(t *testing.T) { if err != nil { t.Fatal(err) } - if !strings.Contains(string(userData), "two-lab-automation") || strings.Contains(string(userData), "# lab key") { + if !strings.Contains(string(userData), "lab-automation") || strings.Contains(string(userData), "# lab key") { t.Errorf("keys not read as an authorized_keys file:\n%s", userData) } } @@ -157,7 +157,7 @@ func TestRun_CommandsWithoutALabInTheRunDir(t *testing.T) { args = append(args, "hv1") } code, _, stderr := runLab(args...) - if code != 1 || !strings.Contains(stderr, "lab: no lab in "+run) { + if code != 1 || !strings.Contains(stderr, "labctl: no lab in "+run) { t.Errorf("%s: code %d, stderr %q", cmd, code, stderr) } } @@ -304,7 +304,7 @@ func TestRun_UpRefusesToReplaceARunningLab(t *testing.T) { func TestRun_RenderShipsTheExampleFRRConfigs(t *testing.T) { dir := t.TempDir() key := filepath.Join(dir, "lab.pub") - if err := os.WriteFile(key, []byte("ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFG/JMmjfko96WkJV8DiL6rip/H/q/R++y8s27Z+Cj6O two-lab-automation\n"), 0o600); err != nil { + if err := os.WriteFile(key, []byte("ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFG/JMmjfko96WkJV8DiL6rip/H/q/R++y8s27Z+Cj6O lab-automation\n"), 0o600); err != nil { t.Fatal(err) } out := filepath.Join(dir, "run") diff --git a/cmd/lab/terminal.go b/cmd/labctl/terminal.go similarity index 100% rename from cmd/lab/terminal.go rename to cmd/labctl/terminal.go diff --git a/cmd/lab/terminal_darwin.go b/cmd/labctl/terminal_darwin.go similarity index 100% rename from cmd/lab/terminal_darwin.go rename to cmd/labctl/terminal_darwin.go diff --git a/cmd/lab/terminal_linux.go b/cmd/labctl/terminal_linux.go similarity index 100% rename from cmd/lab/terminal_linux.go rename to cmd/labctl/terminal_linux.go diff --git a/cmd/lab/terminal_other.go b/cmd/labctl/terminal_other.go similarity index 100% rename from cmd/lab/terminal_other.go rename to cmd/labctl/terminal_other.go diff --git a/docs/developpement/lab.rst b/docs/developpement/lab.rst index ff4e46b..ffe98ab 100644 --- a/docs/developpement/lab.rst +++ b/docs/developpement/lab.rst @@ -14,8 +14,8 @@ comment s'en servir. .. note:: État actuel : le lab de #50 est livré — serveur loué à l'heure (``scripts/lab-host.sh``), - topologie déclarative et plan déterministe (``lab plan``), VM rendues et lancées sur le - serveur (``lab render``, ``lab up`` / ``status`` / ``down`` / ``ssh``), rôles installés au + topologie déclarative et plan déterministe (``labctl plan``), VM rendues et lancées sur le + serveur (``labctl render``, ``labctl up`` / ``status`` / ``down`` / ``ssh``), rôles installés au démarrage (FRR sur le switch et le route reflector, two par ``deploy.sh`` sur les hyperviseurs) et scénarios versionnés (``test/e2e/run.sh``). La redondance du plan de contrôle — deux route reflectors, deux switchs — est l'objet de @@ -62,9 +62,9 @@ Prérequis côté Scaleway Fichiers locaux --------------- -Tout ce dont le script a besoin vit sous ``~/.config/two-lab/``, hors du dépôt. +Tout ce dont le script a besoin vit sous ``~/.config/labctl/``, hors du dépôt. -``~/.config/two-lab/scaleway.env`` +``~/.config/labctl/scaleway.env`` Identifiants Scaleway, une ligne ``CLÉ=valeur`` chacun : .. code-block:: bash @@ -82,7 +82,7 @@ Tout ce dont le script a besoin vit sous ``~/.config/two-lab/``, hors du dépôt Pour changer de clé, remplacer la ligne ``SCW_SECRET_KEY=`` ; rien d'autre à modifier. -``~/.config/two-lab/ssh/lab_ed25519`` +``~/.config/labctl/ssh/lab_ed25519`` Clé SSH dédiée au lab, **sans phrase de passe**, pour que les sessions tournent sans intervention. Sa partie publique doit être enregistrée dans le projet. Quand elle existe, le script l'utilise **seule** (``IdentitiesOnly``, agent désactivé) ; sinon il retombe sur @@ -94,10 +94,10 @@ Tout ce dont le script a besoin vit sous ``~/.config/two-lab/``, hors du dépôt .. code-block:: bash - mkdir -p ~/.config/two-lab/ssh && chmod 700 ~/.config/two-lab ~/.config/two-lab/ssh - ssh-keygen -t ed25519 -N '' -C two-lab-automation -f ~/.config/two-lab/ssh/lab_ed25519 + mkdir -p ~/.config/labctl/ssh && chmod 700 ~/.config/labctl ~/.config/labctl/ssh + ssh-keygen -t ed25519 -N '' -C lab-automation -f ~/.config/labctl/ssh/lab_ed25519 -``~/.cache/two-lab/`` +``~/.cache/labctl/`` État de la session en cours : adresse et utilisateur du serveur, ``known_hosts`` dédié. Vidé par ``down``. @@ -115,11 +115,11 @@ Commandes status liste les serveurs de lab du projet, dans toutes les zones candidates ssh [commande] se connecte au serveur de lab ; avec une commande, un terminal n'est demandé que si l'entrée standard en est un - prepare installe sur le serveur ce dont lab a besoin (qemu, genisoimage), vérifie + prepare installe sur le serveur ce dont labctl a besoin (qemu, genisoimage), vérifie /dev/kvm, la virtualisation imbriquée et un CPU x86-64-v3 ; lancé aussi par up - push compile cmd/lab pour linux/amd64 et dépose sur le serveur ~/lab et le + push compile cmd/labctl pour linux/amd64 et dépose sur le serveur ~/labctl et le répertoire de la topologie dans ~/topology/ (avec les fichiers qu'elle - référence) ; ensuite : ssh './lab up topology/' + référence) ; ensuite : ssh './labctl up topology/' down supprime tous les serveurs de lab du projet, dans toutes les zones candidates, et attend leur disparition session [cmd] up, puis la commande distante (ou un shell), puis down quoi qu'il arrive @@ -190,16 +190,16 @@ environ 100 secondes la première fois — d'où l'attente intégrée à ``up``. ``up``, ``ssh`` et ``down`` séparément servent au debug interactif — et laissent la suppression à la charge de l'utilisateur. -Une campagne sur le lab enchaîne ces commandes depuis le Mac ; ``lab`` s'exécute sur le serveur +Une campagne sur le lab enchaîne ces commandes depuis le Mac ; ``labctl`` s'exécute sur le serveur (voir `Lancement des VM`_) : .. code-block:: text scripts/lab-host.sh up scripts/lab-host.sh push test/e2e/topologies/evpn-2hv.yml - scripts/lab-host.sh ssh './lab up topology/evpn-2hv.yml' - scripts/lab-host.sh ssh './lab ssh hv1' # shell interactif sur hv1 - scripts/lab-host.sh ssh './lab ssh hv1 ip -br a' # commande, code de retour propagé + scripts/lab-host.sh ssh './labctl up topology/evpn-2hv.yml' + scripts/lab-host.sh ssh './labctl ssh hv1' # shell interactif sur hv1 + scripts/lab-host.sh ssh './labctl ssh hv1 ip -br a' # commande, code de retour propagé scripts/lab-host.sh down ``push`` transfère par la connexion SSH du script — mêmes options, même clé, même @@ -255,7 +255,7 @@ Ce que le fichier déclare : Ils voyagent dans un ``files.iso`` propre au nœud (volume ``LABFILES``), attaché comme second lecteur et recopié au premier démarrage : la taille n'est pas limitée par cloud-init, et un binaire de plusieurs dizaines de Mio passe ; - * ``services`` — les unités systemd que ``lab up`` vérifie actives sur le nœud. + * ``services`` — les unités systemd que ``labctl up`` vérifie actives sur le nœud. Les scripts reçoivent ``LAB_NODE`` (nom du nœud), ``LAB_UPLINK`` (interface de son premier segment, qui porte la route par défaut) et ``LAB_FILES`` (``/etc/lab/files``). L'outil ne sait @@ -288,15 +288,15 @@ Ce que l'outil en déduit, de façon déterministe — même fichier, même plan .. warning:: Réordonner les nœuds ou les segments dans le fichier **change les adresses, les MAC et les - ports**. C'est assumé pour un lab ; ``lab plan`` montre le résultat avant tout lancement. + ports**. C'est assumé pour un lab ; ``labctl plan`` montre le résultat avant tout lancement. Limites : 1000 nœuds, 256 segments, et autant de câbles que la plage UDP le permet (22 768). -``lab plan`` valide le fichier et affiche le plan, sans rien lancer : +``labctl plan`` valide le fichier et affiche le plan, sans rien lancer : .. code-block:: text - $ go run ./cmd/lab plan test/e2e/topologies/evpn-2hv.yml + $ go run ./cmd/labctl plan test/e2e/topologies/evpn-2hv.yml lab evpn-2hv: nodes 4, segments 1, cables 3 nodes @@ -324,8 +324,8 @@ champs inconnus et les clés en double sont refusés aussi : .. code-block:: text - $ lab plan cassee.yml - lab: cassee.yml: + $ labctl plan cassee.yml + labctl: cassee.yml: segment underlay: rr1 is a rr, not a switch segment underlay: cidr 10.250.0.0/31 prefix length out of range [/8, /30] node sw1: switch carries no segment @@ -356,7 +356,7 @@ dépose le ``frr.conf`` du nœud et redémarre FRR. La mise à jour des index de pendant cinq minutes : un nœud peut démarrer avant que le switch, par lequel il sort, n'ait posé son NAT. -La **clé du dépôt FRR** n'est pas téléchargée au démarrage : elle est enregistrée dans ``lab`` +La **clé du dépôt FRR** n'est pas téléchargée au démarrage : elle est enregistrée dans ``labctl`` (``internal/lab/render/frrouting.gpg``) et déposée par cloud-init. Elle a été récupérée le 2026-10-04 sur ``deb.frrouting.org`` ; les empreintes de ses clés primaires sont publiées sous la même valeur sur ``keys.openpgp.org`` et ``keyserver.ubuntu.com`` : @@ -401,7 +401,7 @@ le répertoire : le lab suivant teste la release seule. test/e2e/build.sh # binaires de l'arbre courant scripts/lab-host.sh push test/e2e/topologies/evpn-3hv.yml - scripts/lab-host.sh ssh './lab up topology/evpn-3hv.yml' + scripts/lab-host.sh ssh './labctl up topology/evpn-3hv.yml' test/e2e/build.sh --clean # retour à la release seule FRR est installé **après** la provision : il démarre sur le réseau final. Démarré @@ -418,7 +418,7 @@ FRR installé avec succès passerait pour un démarrage réussi. Chaque nœud re de la loopback, ``provision``, FRR, ``post_provision`` ; ``runcmd`` n'appelle que lui, et la première étape en échec met cloud-init en erreur. -**Ce que vérifie** ``lab up``, une fois cloud-init terminé sans erreur : les ``services`` déclarés +**Ce que vérifie** ``labctl up``, une fois cloud-init terminé sans erreur : les ``services`` déclarés par chaque nœud (``agent.service`` sur les hyperviseurs), et ``frr`` sur chaque nœud qui en a un. Ce contrôle couvre ce que cloud-init ne voit pas — si la migration réseau échoue, ``deploy.sh`` arme un redémarrage de secours, et la VM redémarrée ne rejoue pas ``runcmd``. @@ -428,13 +428,13 @@ secours, et la VM redémarrée ne rejoue pas ``runcmd``. **Un hyperviseur du lab ne survit pas à un redémarrage.** En production, la racine est en tmpfs et ``deploy.sh --bootstrap`` est rejoué à chaque démarrage ; dans le lab, ``-i`` n'est exécuté qu'au premier, et la migration réseau, qui n'est pas persistée, est perdue. Recréer le - lab : ``lab down`` puis ``lab up``. + lab : ``labctl down`` puis ``labctl up``. Vérifié le 2026-10-04 sur le serveur de lab, topologie ``evpn-2hv``, release ``0.2.0rc002`` : .. code-block:: text - $ scripts/lab-host.sh ssh './lab up -timeout 25m topology/evpn-2hv.yml' + $ scripts/lab-host.sh ssh './labctl up -timeout 25m topology/evpn-2hv.yml' sw1: started rr1: started hv1: started @@ -450,7 +450,7 @@ Vérifié le 2026-10-04 sur le serveur de lab, topologie ``evpn-2hv``, release ` * - Vérification - Résultat - * - ``lab up`` complet : FRR, ``deploy.sh`` et vérification des services de chaque rôle + * - ``labctl up`` complet : FRR, ``deploy.sh`` et vérification des services de chaque rôle - 6 min 15 * - session switch ↔ route reflector, IPv4 unicast, BFD - Established, BFD up ; le switch reçoit la seule loopback du route reflector @@ -481,11 +481,11 @@ Vérifié le 2026-10-04 sur le serveur de lab, topologie ``evpn-2hv``, release ` Rendu des VM ------------ -``lab render`` produit, pour chaque nœud, ce qu'il faut pour démarrer sa VM — sans rien lancer : +``labctl render`` produit, pour chaque nœud, ce qu'il faut pour démarrer sa VM — sans rien lancer : .. code-block:: text - $ go run ./cmd/lab render -key ~/.config/two-lab/ssh/lab_ed25519.pub test/e2e/topologies/evpn-2hv.yml + $ go run ./cmd/labctl render -key ~/.config/labctl/ssh/lab_ed25519.pub test/e2e/topologies/evpn-2hv.yml ``//`` reçoit : @@ -547,7 +547,7 @@ Vérifié sur de vraies VM Le switch et le route reflector n'ont pas besoin de KVM imbriqué : ``sw1`` et ``rr1`` de l'exemple ont été démarrés **sur un Mac**, en émulation (TCG), avec Debian 12 ``generic`` et -les fichiers produits par ``lab render``. +les fichiers produits par ``labctl render``. .. list-table:: :header-rows: 1 @@ -586,7 +586,7 @@ Reste à vérifier sur le serveur de lab : les hyperviseurs, qui exigent KVM imb Lancement des VM ---------------- -``lab`` s'exécute **sur le serveur de lab**. Il garde l'état du lab dans un répertoire +``labctl`` s'exécute **sur le serveur de lab**. Il garde l'état du lab dans un répertoire (``-run``, par défaut ``~/lab-run``) : ``status``, ``down`` et ``ssh`` n'ont donc pas besoin de la topologie. @@ -597,13 +597,13 @@ topologie. lab down [-run dir] lab ssh [-run dir] [commande…] -``lab up`` +``labctl up`` 1. refuse de continuer si un lab tourne déjà dans le répertoire ; - 2. télécharge chaque image dans le cache (``-cache``, par défaut ``~/.cache/two-lab``) et la + 2. télécharge chaque image dans le cache (``-cache``, par défaut ``~/.cache/labctl``) et la vérifie contre ``SHA512SUMS`` ; une image déjà présente et toujours conforme n'est pas retéléchargée, la liste des sommes est relue à chaque fois ; 3. génère une paire de clés SSH dans le répertoire du lab, si elle n'existe pas encore ; - 4. pour chaque nœud : fichiers de ``lab render``, disque **neuf** en overlay qcow2 sur + 4. pour chaque nœud : fichiers de ``labctl render``, disque **neuf** en overlay qcow2 sur l'image (``qemu-img create -b``, 20 Gio annoncés), image ``cidata`` (``genisoimage``) ; 5. démarre les QEMU, **switchs d'abord**, détachés (``-daemonize``) : ils survivent à la session SSH qui les a lancés ; @@ -611,35 +611,35 @@ topologie. jusqu'au délai ``-timeout``. La topologie est copiée dans ``/topology.yml``. Un échec laisse les nœuds démarrés en - place : ``lab status``, puis ``lab down``. + place : ``labctl status``, puis ``labctl down``. -``lab status`` +``labctl status`` Pour chaque nœud : rôle, état du processus QEMU, PID, port SSH sur la boucle locale. -``lab down`` +``labctl down`` Arrête chaque QEMU par ``SIGTERM``, puis ``SIGKILL`` au bout de 30 s. Les disques sont conservés jusqu'au prochain ``up``, qui les recrée. -``lab ssh`` - Ouvre un shell sur un nœud, ou y exécute une commande, avec la clé générée par ``up``. ``lab`` +``labctl ssh`` + Ouvre un shell sur un nœud, ou y exécute une commande, avec la clé générée par ``up``. ``labctl`` cède la place à ``ssh``, dont le code de retour est donc celui de la commande. Un terminal - n'est demandé (``-t``) que si l'entrée de ``lab`` en est un : depuis un script, ni + n'est demandé (``-t``) que si l'entrée de ``labctl`` en est un : depuis un script, ni pseudo-terminal ni ``\r\n`` dans la sortie. - Comme ``ssh``, ``lab ssh`` recolle ses arguments par des espaces et les confie à un shell + Comme ``ssh``, ``labctl ssh`` recolle ses arguments par des espaces et les confie à un shell distant — et depuis le Mac, il y en a **deux** : celui du serveur, puis celui de la VM. Une commande qui contient elle-même des guillemets se passe en une seule chaîne : .. code-block:: text - $ echo | scripts/lab-host.sh ssh './lab ssh hv1 sh -c "exit 42"'; echo "rc 42=$?" + $ echo | scripts/lab-host.sh ssh './labctl ssh hv1 sh -c "exit 42"'; echo "rc 42=$?" rc 42=0 - $ echo | scripts/lab-host.sh ssh "./lab ssh hv1 'sh -c \"exit 42\"'"; echo "rc 42=$?" + $ echo | scripts/lab-host.sh ssh "./labctl ssh hv1 'sh -c \"exit 42\"'"; echo "rc 42=$?" rc 42=42 Dans le premier cas, la VM reçoit ``sh -c exit 42`` : ``exit`` sans argument, ``42`` en ``$0``. Pour plus d'une commande, passer un script sur l'entrée standard : - ``scripts/lab-host.sh ssh "./lab ssh hv1 'sudo bash -s'" < script.sh``. + ``scripts/lab-host.sh ssh "./labctl ssh hv1 'sudo bash -s'" < script.sh``. Un processus n'est tenu pour celui d'un nœud que si son PID, lu dans ``qemu.pid``, désigne un processus vivant dont la ligne de commande (``/proc//cmdline``) contient ``-name ``. @@ -667,7 +667,7 @@ Une campagne réelle, de la création du serveur à la première commande sur un $ scripts/lab-host.sh push test/e2e/topologies/evpn-2hv.yml == compilation de lab (linux/amd64) == déposés sur le serveur : ~/lab, ~/evpn-2hv.yml — ensuite : lab-host.sh ssh './lab up evpn-2hv.yml' - $ scripts/lab-host.sh ssh './lab up evpn-2hv.yml' + $ scripts/lab-host.sh ssh './labctl up evpn-2hv.yml' sw1: started rr1: started hv1: started @@ -676,14 +676,14 @@ Une campagne réelle, de la création du serveur à la première commande sur un rr1: ready hv1: ready hv2: ready - $ scripts/lab-host.sh ssh './lab status' + $ scripts/lab-host.sh ssh './labctl status' node role state pid ssh sw1 switch running 5158 127.0.0.1:2200 rr1 rr running 5171 127.0.0.1:2201 hv1 hypervisor running 5182 127.0.0.1:2202 hv2 hypervisor running 5196 127.0.0.1:2203 -``lab up`` a pris **49 secondes**, téléchargement et vérification de l'image (427 Mio) compris ; +``labctl up`` a pris **49 secondes**, téléchargement et vérification de l'image (427 Mio) compris ; l'essentiel du temps d'une campagne est la livraison du serveur (environ 25 minutes avec ``prepare``). @@ -713,17 +713,17 @@ Le 2026-10-04, sur un Xeon E5-2640 v3, Debian 12 et QEMU 7.2 sur le serveur, top - présent, ``Y`` * - racine de hv1 (overlay de 20 Gio) - 20 Go : ``growpart`` agrandit la partition au premier démarrage - * - code de retour à travers ``lab-host.sh ssh`` et ``lab ssh``, sans terminal + * - code de retour à travers ``lab-host.sh ssh`` et ``labctl ssh``, sans terminal - propagé jusqu'au Mac - * - ``scripts/lab-host.sh ssh './lab ssh hv1'`` depuis un terminal + * - ``scripts/lab-host.sh ssh './labctl ssh hv1'`` depuis un terminal - shell interactif - * - ``lab down`` puis ``lab up`` d'une autre topologie + * - ``labctl down`` puis ``labctl up`` d'une autre topologie - conforme Scénarios --------- -Les scénarios se lancent **depuis le Mac**, sur un lab démarré (``up``, ``push``, ``./lab up``) : +Les scénarios se lancent **depuis le Mac**, sur un lab démarré (``up``, ``push``, ``./labctl up``) : .. code-block:: text @@ -906,7 +906,7 @@ Les VM sont accessibles depuis le netns de leur VPC, sur l'hyperviseur, avec l'u .. code-block:: text - scripts/lab-host.sh ssh "./lab ssh hv1 'sudo ip netns exec vp-s4 ssh -i /root/.ssh/lab-vm syonad@10.240.1.10'" + scripts/lab-host.sh ssh "./labctl ssh hv1 'sudo ip netns exec vp-s4 ssh -i /root/.ssh/lab-vm syonad@10.240.1.10'" Écrire un scénario ~~~~~~~~~~~~~~~~~~ @@ -965,7 +965,7 @@ Ce que le script garantit : création. La CLI ``scw`` n'est pas utilisée pour cette raison : son ``server create type=…`` choisit l'offre par son seul nom et peut tomber sur la mensuelle, qui engage un mois ; * il refuse de créer un second serveur si un serveur de lab existe déjà ; -* ``down`` agit sur **tous** les serveurs portant le tag ``two-lab`` dans le projet, et +* ``down`` agit sur **tous** les serveurs portant le tag ``labctl`` dans le projet, et ``session`` y ajoute l'identifiant reçu à la création : un serveur créé juste avant une interruption est rattrapé ; * une suppression refusée pendant la livraison ou l'installation est réessayée tant qu'elle dure, @@ -1020,10 +1020,10 @@ Sécurité production. * Une clé secrète qui a circulé ailleurs que dans ``scaleway.env`` (conversation, terminal partagé, capture d'écran) se régénère. -* **Clé SSH des VM** : générée par ``lab up`` sur le serveur, c'est la seule clé autorisée dans +* **Clé SSH des VM** : générée par ``labctl up`` sur le serveur, c'est la seule clé autorisée dans les VM. Elle ne quitte jamais le serveur, n'ouvre que les VM du lab — qui n'écoutent qu'en boucle locale — et disparaît avec lui. La clé publique du Mac n'est jamais envoyée aux VM. -* **Clés d'hôte des VM non vérifiées** par ``lab ssh`` (``known_hosts`` jetable) : elles changent +* **Clés d'hôte des VM non vérifiées** par ``labctl ssh`` (``known_hosts`` jetable) : elles changent à chaque ``up``. Acceptable uniquement parce que la connexion reste sur la boucle locale d'un serveur auquel on s'est authentifié. * **Code exécuté sans épinglage par** ``deploy.sh`` : la bibliothèque ``shflags`` est récupérée @@ -1041,7 +1041,7 @@ Tests bash scripts/lab-host_test.sh bash test/e2e/run_test.sh - go test ./internal/lab/... ./cmd/lab/ + go test ./internal/lab/... ./cmd/labctl/ Environ une minute et demie, sans réseau : la suite remplace ``curl`` par une fausse API Scaleway qui se place dans le pire cas (offre mensuelle listée avant l'horaire, serveurs d'autres projets, diff --git a/internal/lab/machine/machine_test.go b/internal/lab/machine/machine_test.go index abb7575..651b319 100644 --- a/internal/lab/machine/machine_test.go +++ b/internal/lab/machine/machine_test.go @@ -24,7 +24,7 @@ import ( "git.g3e.fr/syonad/two/internal/lab/topology" ) -const labKey = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFG/JMmjfko96WkJV8DiL6rip/H/q/R++y8s27Z+Cj6O two-lab" +const labKey = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFG/JMmjfko96WkJV8DiL6rip/H/q/R++y8s27Z+Cj6O labctl" type exitErr int diff --git a/internal/lab/provision/provision.go b/internal/lab/provision/provision.go index fe20c9f..4613fb1 100644 --- a/internal/lab/provision/provision.go +++ b/internal/lab/provision/provision.go @@ -16,7 +16,7 @@ import ( const ( KeyFile = "lab_ed25519" - KeyLabel = "two-lab" + KeyLabel = "labctl" DiskSize = "20G" SeedLabel = "cidata" diff --git a/internal/lab/provision/provision_test.go b/internal/lab/provision/provision_test.go index a837f05..057f529 100644 --- a/internal/lab/provision/provision_test.go +++ b/internal/lab/provision/provision_test.go @@ -15,7 +15,7 @@ import ( "git.g3e.fr/syonad/two/internal/lab/topology" ) -const generatedKey = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFG/JMmjfko96WkJV8DiL6rip/H/q/R++y8s27Z+Cj6O two-lab" +const generatedKey = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFG/JMmjfko96WkJV8DiL6rip/H/q/R++y8s27Z+Cj6O labctl" type fakeRunner struct { calls [][]string @@ -98,7 +98,7 @@ func TestPrepare_StagesEveryNode(t *testing.T) { base := filepath.Join(cache, "debian12", "debian-12-generic-amd64.qcow2") want := [][]string{ - {"ssh-keygen", "-q", "-t", "ed25519", "-N", "", "-C", "two-lab", "-f", filepath.Join(run, "lab_ed25519")}, + {"ssh-keygen", "-q", "-t", "ed25519", "-N", "", "-C", "labctl", "-f", filepath.Join(run, "lab_ed25519")}, } for _, n := range []string{"sw1", "rr1", "hv1", "hv2"} { dir := filepath.Join(run, n) @@ -332,7 +332,7 @@ func TestEnsureKey_WithTheRealSSHKeygen(t *testing.T) { if err != nil { t.Fatalf("EnsureKey: %v", err) } - if !strings.HasPrefix(key, "ssh-ed25519 ") || !strings.HasSuffix(key, " two-lab") { + if !strings.HasPrefix(key, "ssh-ed25519 ") || !strings.HasSuffix(key, " labctl") { t.Errorf("key = %q", key) } info, err := os.Stat(filepath.Join(dir, "lab_ed25519")) diff --git a/internal/lab/render/render_test.go b/internal/lab/render/render_test.go index fd6ea47..3f38a41 100644 --- a/internal/lab/render/render_test.go +++ b/internal/lab/render/render_test.go @@ -10,7 +10,7 @@ import ( "git.g3e.fr/syonad/two/internal/lab/topology" ) -const labKey = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFG/JMmjfko96WkJV8DiL6rip/H/q/R++y8s27Z+Cj6O two-lab-automation" +const labKey = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFG/JMmjfko96WkJV8DiL6rip/H/q/R++y8s27Z+Cj6O lab-automation" const twoHypervisors = `name: evpn-2hv images: diff --git a/scripts/lab-host.sh b/scripts/lab-host.sh index 5072f5f..db1e985 100755 --- a/scripts/lab-host.sh +++ b/scripts/lab-host.sh @@ -1,21 +1,21 @@ #!/usr/bin/env bash API_URL="${SCW_API_URL:-https://api.scaleway.com}" -CREDENTIALS_FILE="${LAB_CREDENTIALS_FILE:-${HOME}/.config/two-lab/scaleway.env}" +CREDENTIALS_FILE="${LAB_CREDENTIALS_FILE:-${HOME}/.config/labctl/scaleway.env}" OFFER_NAME="${LAB_OFFER:-EM-B420E-NVME}" ALL_ZONES="fr-par-1 fr-par-2 nl-ams-1 nl-ams-2 pl-waw-2 pl-waw-3" OS_NAME="${LAB_OS_NAME:-Debian}" OS_VERSION="${LAB_OS_VERSION:-12}" -LAB_NAME="${LAB_NAME:-two-lab}" -LAB_TAG="${LAB_TAG:-two-lab}" +LAB_NAME="${LAB_NAME:-labctl}" +LAB_TAG="${LAB_TAG:-labctl}" INSTALL_TIMEOUT="${LAB_INSTALL_TIMEOUT:-3600}" DELETE_TIMEOUT="${LAB_DELETE_TIMEOUT:-900}" SSH_TIMEOUT="${LAB_SSH_TIMEOUT:-600}" POLL_INTERVAL="${LAB_POLL_INTERVAL:-20}" HTTP_CONNECT_TIMEOUT="${LAB_HTTP_CONNECT_TIMEOUT:-10}" HTTP_TIMEOUT="${LAB_HTTP_TIMEOUT:-60}" -STATE_DIR="${LAB_STATE_DIR:-${HOME}/.cache/two-lab}" -SSH_KEY="${LAB_SSH_KEY:-${HOME}/.config/two-lab/ssh/lab_ed25519}" +STATE_DIR="${LAB_STATE_DIR:-${HOME}/.cache/labctl}" +SSH_KEY="${LAB_SSH_KEY:-${HOME}/.config/labctl/ssh/lab_ed25519}" REPO_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" CREATED_ID="" @@ -34,11 +34,11 @@ usage: ${0##*/} [arguments] status liste les serveurs de lab du projet, dans toutes les zones candidates ssh [commande] se connecte au serveur de lab ; avec une commande, un terminal n'est demandé que si l'entrée standard en est un - prepare installe sur le serveur ce dont lab a besoin (qemu, genisoimage), vérifie + prepare installe sur le serveur ce dont labctl a besoin (qemu, genisoimage), vérifie /dev/kvm, la virtualisation imbriquée et un CPU x86-64-v3 ; lancé aussi par up - push compile cmd/lab pour linux/amd64 et dépose sur le serveur ~/lab et le + push compile cmd/labctl pour linux/amd64 et dépose sur le serveur ~/labctl et le répertoire de la topologie dans ~/topology/ (avec les fichiers qu'elle - référence) ; ensuite : ssh './lab up topology/' + référence) ; ensuite : ssh './labctl up topology/' down supprime tous les serveurs de lab du projet, dans toutes les zones candidates, et attend leur disparition session [cmd] up, puis la commande distante (ou un shell), puis down quoi qu'il arrive @@ -170,7 +170,7 @@ build_request () { local KEYS="${3}" jq -nc --argjson offer "${OFFER}" --argjson os "${OS}" --argjson keys "${KEYS}" \ --arg project "${PROJECT_ID}" --arg name "${LAB_NAME}" --arg tag "${LAB_TAG}" \ - '{offer_id: $offer.id, project_id: $project, name: $name, description: "lab two (#50)", + '{offer_id: $offer.id, project_id: $project, name: $name, description: "labctl", tags: [$tag], install: {os_id: $os.id, hostname: $name, ssh_key_ids: $keys}}' } @@ -383,17 +383,17 @@ push_dir () { cmd_push () { local TOPOLOGY="${1:-}" local NAME="${TOPOLOGY##*/}" - local BINARY="${STATE_DIR}/lab" + local BINARY="${STATE_DIR}/labctl" [[ $# -eq 1 && -n "${TOPOLOGY}" ]] || usage [[ -f "${TOPOLOGY}" ]] || die "topologie introuvable : ${TOPOLOGY}" [[ "${NAME}" =~ ^[A-Za-z0-9._-]+$ ]] || die "nom de topologie refusé : ${NAME} (lettres, chiffres, '.', '_', '-')" require_known_server - info "compilation de lab (linux/amd64)" - (cd "${REPO_DIR}" && CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o "${BINARY}" ./cmd/lab) \ - || die "compilation de lab échouée" - push_file "${BINARY}" lab 755 || die "envoi de lab échoué" + info "compilation de labctl (linux/amd64)" + (cd "${REPO_DIR}" && CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o "${BINARY}" ./cmd/labctl) \ + || die "compilation de labctl échouée" + push_file "${BINARY}" labctl 755 || die "envoi de labctl échoué" push_dir "$(dirname "${TOPOLOGY}")" || die "envoi du répertoire de ${NAME} échoué" - info "déposés sur le serveur : ~/lab, ~/topology/ — ensuite : ${0##*/} ssh './lab up topology/${NAME}'" + info "déposés sur le serveur : ~/labctl, ~/topology/ — ensuite : ${0##*/} ssh './labctl up topology/${NAME}'" } delete_server () { diff --git a/scripts/lab-host_test.sh b/scripts/lab-host_test.sh index 8e8d848..ea9ec85 100755 --- a/scripts/lab-host_test.sh +++ b/scripts/lab-host_test.sh @@ -193,7 +193,7 @@ base_state () { ], keys: [{id: "key-1", disabled: false}, {id: "key-off", disabled: true}], servers: { - "foreign-1": {id: "foreign-1", name: "prod-db", project_id: $o, tags: ["two-lab"], status: "ready", install: {status: "completed"}, ips: []}, + "foreign-1": {id: "foreign-1", name: "prod-db", project_id: $o, tags: ["labctl"], status: "ready", install: {status: "completed"}, ips: []}, "foreign-2": {id: "foreign-2", name: "autre", project_id: $p, tags: ["autre"], status: "ready", install: {status: "completed"}, ips: []} } }' @@ -305,16 +305,16 @@ test_up_creates_and_waits_for_installation () { mutate '.progress = [["delivering","to_install"],["ready","installing"],["ready","completed"]]' run_lab up || fail "code de sortie $?" [[ $(jq -r '.offer_id' "${WORK}/create.json") == "${HOURLY_ID}" ]] || fail "offre créée incorrecte" - [[ $(jq -r '.tags | join(",")' "${WORK}/create.json") == "two-lab" ]] || fail "tag absent" + [[ $(jq -r '.tags | join(",")' "${WORK}/create.json") == "labctl" ]] || fail "tag absent" [[ $(jq -r '.project_id' "${WORK}/create.json") == "${PROJECT}" ]] || fail "projet incorrect" - [[ $(cat "${WORK}/.cache/two-lab/ip" 2>/dev/null) == "203.0.113.7" ]] || fail "IPv4 non retenue" - [[ $(cat "${WORK}/.cache/two-lab/user" 2>/dev/null) == "debian" ]] || fail "utilisateur non retenu" + [[ $(cat "${WORK}/.cache/labctl/ip" 2>/dev/null) == "203.0.113.7" ]] || fail "IPv4 non retenue" + [[ $(cat "${WORK}/.cache/labctl/user" 2>/dev/null) == "debian" ]] || fail "utilisateur non retenu" teardown } test_up_refuses_when_lab_server_exists () { setup "up : refus si un serveur de lab existe déjà" - mutate '.servers["srv-old"] = {id: "srv-old", name: "two-lab", project_id: "'"${PROJECT}"'", tags: ["two-lab"], status: "ready", install: {status: "completed"}, ips: []}' + mutate '.servers["srv-old"] = {id: "srv-old", name: "labctl", project_id: "'"${PROJECT}"'", tags: ["labctl"], status: "ready", install: {status: "completed"}, ips: []}' run_lab up && fail "up a réussi" grep -q "^POST" "${WORK}/calls.log" && fail "second serveur créé" teardown @@ -331,7 +331,7 @@ test_secret_never_in_argv () { test_down_deletes_only_lab_servers_of_project () { setup "down : ne supprime que les serveurs de lab du projet" - mutate '.servers["srv-lab"] = {id: "srv-lab", name: "two-lab", project_id: "'"${PROJECT}"'", tags: ["two-lab"], status: "ready", install: {status: "completed"}, ips: []}' + mutate '.servers["srv-lab"] = {id: "srv-lab", name: "labctl", project_id: "'"${PROJECT}"'", tags: ["labctl"], status: "ready", install: {status: "completed"}, ips: []}' run_lab down || fail "code de sortie $?" [[ $(remaining) == "foreign-1,foreign-2" ]] || fail "restants : $(remaining)" teardown @@ -339,7 +339,7 @@ test_down_deletes_only_lab_servers_of_project () { test_down_retries_refused_deletion () { setup "down : réessaie une suppression refusée" - mutate '.delete_refusals = 2 | .servers["srv-lab"] = {id: "srv-lab", name: "two-lab", project_id: "'"${PROJECT}"'", tags: ["two-lab"], status: "ready", install: {status: "installing"}, ips: []}' + mutate '.delete_refusals = 2 | .servers["srv-lab"] = {id: "srv-lab", name: "labctl", project_id: "'"${PROJECT}"'", tags: ["labctl"], status: "ready", install: {status: "installing"}, ips: []}' run_lab down || fail "code de sortie $?" [[ $(grep -c "^DELETE" "${WORK}/calls.log") -eq 3 ]] || fail "$(grep -c "^DELETE" "${WORK}/calls.log") DELETE au lieu de 3" [[ $(remaining) == "foreign-1,foreign-2" ]] || fail "restants : $(remaining)" @@ -348,7 +348,7 @@ test_down_retries_refused_deletion () { test_down_fails_loudly_when_deletion_keeps_failing () { setup "down : échec bruyant si la suppression n'aboutit jamais" - mutate '.delete_refusals = 1000 | .servers["srv-lab"] = {id: "srv-lab", name: "two-lab", project_id: "'"${PROJECT}"'", tags: ["two-lab"], status: "ready", install: {status: "installing"}, ips: []}' + mutate '.delete_refusals = 1000 | .servers["srv-lab"] = {id: "srv-lab", name: "labctl", project_id: "'"${PROJECT}"'", tags: ["labctl"], status: "ready", install: {status: "installing"}, ips: []}' LAB_DELETE_TIMEOUT=1 run_lab down && fail "down a réussi" grep -q "TOUJOURS FACTURÉ" "${WORK}/out.log" || fail "pas d'alerte de facturation" teardown @@ -356,7 +356,7 @@ test_down_fails_loudly_when_deletion_keeps_failing () { test_down_waits_until_server_is_gone () { setup "down : attend que le serveur ait disparu" - mutate '.linger = 3 | .servers["srv-lab"] = {id: "srv-lab", name: "two-lab", project_id: "'"${PROJECT}"'", tags: ["two-lab"], status: "ready", install: {status: "completed"}, ips: []}' + mutate '.linger = 3 | .servers["srv-lab"] = {id: "srv-lab", name: "labctl", project_id: "'"${PROJECT}"'", tags: ["labctl"], status: "ready", install: {status: "completed"}, ips: []}' run_lab down || fail "code de sortie $?" [[ $(grep -c "^GET /baremetal/v1/zones/fr-par-1/servers/srv-lab$" "${WORK}/calls.log") -ge 4 ]] || fail "disparition non attendue" [[ $(remaining) == "foreign-1,foreign-2" ]] || fail "restants : $(remaining)" @@ -365,7 +365,7 @@ test_down_waits_until_server_is_gone () { test_down_fails_loudly_when_server_never_disappears () { setup "down : échec bruyant si le serveur ne disparaît jamais" - mutate '.linger = 100000 | .servers["srv-lab"] = {id: "srv-lab", name: "two-lab", project_id: "'"${PROJECT}"'", tags: ["two-lab"], status: "ready", install: {status: "completed"}, ips: []}' + mutate '.linger = 100000 | .servers["srv-lab"] = {id: "srv-lab", name: "labctl", project_id: "'"${PROJECT}"'", tags: ["labctl"], status: "ready", install: {status: "completed"}, ips: []}' LAB_DELETE_TIMEOUT=1 run_lab down && fail "down a réussi" grep -q "TOUJOURS FACTURÉ" "${WORK}/out.log" || fail "pas d'alerte de facturation" teardown @@ -373,7 +373,7 @@ test_down_fails_loudly_when_server_never_disappears () { test_down_does_not_mistake_api_error_for_disappearance () { setup "down : une erreur de l'API n'est pas prise pour une disparition" - mutate '.linger = 100000 | .get_errors = 1 | .servers["srv-lab"] = {id: "srv-lab", name: "two-lab", project_id: "'"${PROJECT}"'", tags: ["two-lab"], status: "ready", install: {status: "completed"}, ips: []}' + mutate '.linger = 100000 | .get_errors = 1 | .servers["srv-lab"] = {id: "srv-lab", name: "labctl", project_id: "'"${PROJECT}"'", tags: ["labctl"], status: "ready", install: {status: "completed"}, ips: []}' LAB_DELETE_TIMEOUT=1 run_lab down && fail "down a réussi alors que le serveur existe encore" grep -q "TOUJOURS FACTURÉ" "${WORK}/out.log" || fail "pas d'alerte de facturation" teardown @@ -417,7 +417,7 @@ test_session_deletes_server_when_installation_times_out () { test_session_does_not_touch_existing_lab_server () { setup "session : ne supprime pas un serveur de lab lancé à côté" - mutate '.servers["srv-old"] = {id: "srv-old", name: "two-lab", project_id: "'"${PROJECT}"'", tags: ["two-lab"], status: "ready", install: {status: "completed"}, ips: []}' + mutate '.servers["srv-old"] = {id: "srv-old", name: "labctl", project_id: "'"${PROJECT}"'", tags: ["labctl"], status: "ready", install: {status: "completed"}, ips: []}' run_lab session true && fail "session a réussi" grep -q "^DELETE" "${WORK}/calls.log" && fail "suppression lancée" [[ $(remaining) == "foreign-1,foreign-2,srv-old" ]] || fail "restants : $(remaining)" @@ -432,8 +432,8 @@ test_missing_credentials_are_refused_before_any_call () { teardown } -LAB_SERVER='{id: "srv-lab", name: "two-lab", project_id: "'"${PROJECT}"'", tags: ["two-lab"], status: "ready", install: {status: "completed"}, ips: []}' -INSTALLING_LAB_SERVER='{id: "srv-lab", name: "two-lab", project_id: "'"${PROJECT}"'", tags: ["two-lab"], status: "ready", install: {status: "installing"}, ips: []}' +LAB_SERVER='{id: "srv-lab", name: "labctl", project_id: "'"${PROJECT}"'", tags: ["labctl"], status: "ready", install: {status: "completed"}, ips: []}' +INSTALLING_LAB_SERVER='{id: "srv-lab", name: "labctl", project_id: "'"${PROJECT}"'", tags: ["labctl"], status: "ready", install: {status: "installing"}, ips: []}' test_down_keeps_retrying_while_server_is_installing () { setup "down : réessaie au-delà du délai tant que le serveur s'installe" @@ -619,11 +619,11 @@ test_session_deletes_server_when_ssh_never_answers () { test_ssh_uses_dedicated_lab_key_only_when_present () { setup "ssh : clé dédiée du lab utilisée seule quand elle existe" mutate '.progress = [["ready","completed"]]' - mkdir -p "${WORK}/.config/two-lab/ssh" - : > "${WORK}/.config/two-lab/ssh/lab_ed25519" + mkdir -p "${WORK}/.config/labctl/ssh" + : > "${WORK}/.config/labctl/ssh/lab_ed25519" run_lab session uname || fail "code de sortie $?" grep -q " uname" "${WORK}/ssh.log" || fail "commande non lancée" - [[ $(grep -c -- "-i ${WORK}/.config/two-lab/ssh/lab_ed25519 -o IdentitiesOnly=yes -o IdentityAgent=none" "${WORK}/ssh.log") -eq $(wc -l < "${WORK}/ssh.log") ]] \ + [[ $(grep -c -- "-i ${WORK}/.config/labctl/ssh/lab_ed25519 -o IdentitiesOnly=yes -o IdentityAgent=none" "${WORK}/ssh.log") -eq $(wc -l < "${WORK}/ssh.log") ]] \ || fail "une connexion n'a pas utilisé la clé dédiée seule" teardown } @@ -638,10 +638,10 @@ test_ssh_falls_back_to_agent_without_lab_key () { } known_server () { - mkdir -p "${WORK}/.cache/two-lab" - echo 203.0.113.7 > "${WORK}/.cache/two-lab/ip" - echo debian > "${WORK}/.cache/two-lab/user" - : > "${WORK}/.cache/two-lab/known_hosts" + mkdir -p "${WORK}/.cache/labctl" + echo 203.0.113.7 > "${WORK}/.cache/labctl/ip" + echo debian > "${WORK}/.cache/labctl/user" + : > "${WORK}/.cache/labctl/known_hosts" } test_up_prepares_the_server_after_ssh () { @@ -691,7 +691,7 @@ test_prepare_without_known_server_is_refused () { } test_push_builds_for_linux_and_sends_binary_and_topology () { - setup "push : compile lab pour linux/amd64, envoie le binaire et le répertoire de la topologie" + setup "push : compile labctl pour linux/amd64, envoie le binaire et le répertoire de la topologie" known_server mkdir -p "${WORK}/conf/frr" printf 'name: evpn-2hv\n' > "${WORK}/conf/evpn-2hv.yml" @@ -700,9 +700,9 @@ test_push_builds_for_linux_and_sends_binary_and_topology () { run_lab push "${WORK}/conf/evpn-2hv.yml" || fail "code de sortie $?" local REPO LISTING REPO="$(cd "$(dirname "${SCRIPT}")/.." && pwd)" - [[ $(cat "${WORK}/go.log") == "${REPO}|build -o ${WORK}/.cache/two-lab/lab ./cmd/lab|CGO_ENABLED=0 GOOS=linux GOARCH=amd64" ]] \ + [[ $(cat "${WORK}/go.log") == "${REPO}|build -o ${WORK}/.cache/labctl/labctl ./cmd/labctl|CGO_ENABLED=0 GOOS=linux GOARCH=amd64" ]] \ || fail "compilation : $(cat "${WORK}/go.log")" - grep -q "debian@203.0.113.7 cat > 'lab.part' && chmod 755 'lab.part' && mv 'lab.part' 'lab'" "${WORK}/ssh.log" || fail "envoi de lab absent" + grep -q "debian@203.0.113.7 cat > 'labctl.part' && chmod 755 'labctl.part' && mv 'labctl.part' 'labctl'" "${WORK}/ssh.log" || fail "envoi de labctl absent" grep -q "debian@203.0.113.7 rm -rf topology.part && mkdir topology.part && tar -C topology.part --no-same-owner -xf - && rm -rf topology && mv topology.part topology" "${WORK}/ssh.log" \ || fail "envoi du répertoire absent" [[ $(cat "${WORK}/pushed.1") == "binaire-lab" ]] || fail "contenu de lab : $(cat "${WORK}/pushed.1")" @@ -711,7 +711,7 @@ test_push_builds_for_linux_and_sends_binary_and_topology () { grep -aq 'LIBARCHIVE.xattr' "${WORK}/pushed.2" && fail "attributs étendus macOS dans l'archive" mkdir "${WORK}/x" && tar -C "${WORK}/x" -xf "${WORK}/pushed.2" [[ $(cat "${WORK}/x/frr/rr1.conf") == "hostname rr1" ]] || fail "frr/rr1.conf altéré" - grep -q "ssh './lab up topology/evpn-2hv.yml'" "${WORK}/out.log" || fail "consigne finale absente" + grep -q "ssh './labctl up topology/evpn-2hv.yml'" "${WORK}/out.log" || fail "consigne finale absente" teardown } @@ -721,7 +721,7 @@ test_push_stops_when_the_build_fails () { printf 'name: x\n' > "${WORK}/x.yml" FAKE_GO_FAIL=1 run_lab push "${WORK}/x.yml" && fail "push a réussi" [[ -s "${WORK}/ssh.log" ]] && fail "ssh lancé" - grep -q "compilation de lab échouée" "${WORK}/out.log" || fail "message absent" + grep -q "compilation de labctl échouée" "${WORK}/out.log" || fail "message absent" teardown } @@ -730,7 +730,7 @@ test_push_fails_when_a_transfer_fails () { known_server printf 'name: x\n' > "${WORK}/x.yml" FAKE_PUSH_RC=1 run_lab push "${WORK}/x.yml" && fail "push a réussi" - grep -q "envoi de lab échoué" "${WORK}/out.log" || fail "message absent" + grep -q "envoi de labctl échoué" "${WORK}/out.log" || fail "message absent" teardown } @@ -753,8 +753,8 @@ test_push_refusals () { test_ssh_without_terminal_does_not_ask_for_one () { setup "ssh : pas de -t quand l'entrée n'est pas un terminal" known_server - run_lab ssh './lab status' < /dev/null || fail "code de sortie $?" - [[ $(cat "${WORK}/ssh.log") == *"debian@203.0.113.7 ./lab status" ]] || fail "commande : $(cat "${WORK}/ssh.log")" + run_lab ssh './labctl status' < /dev/null || fail "code de sortie $?" + [[ $(cat "${WORK}/ssh.log") == *"debian@203.0.113.7 ./labctl status" ]] || fail "commande : $(cat "${WORK}/ssh.log")" grep -q -- " -t " "${WORK}/ssh.log" && fail "-t demandé sans terminal" teardown } @@ -766,9 +766,9 @@ run_lab_without_env_credentials () { } write_credentials () { - mkdir -p "${WORK}/.config/two-lab" - printf '%s\n' "$@" > "${WORK}/.config/two-lab/scaleway.env" - chmod 600 "${WORK}/.config/two-lab/scaleway.env" + mkdir -p "${WORK}/.config/labctl" + printf '%s\n' "$@" > "${WORK}/.config/labctl/scaleway.env" + chmod 600 "${WORK}/.config/labctl/scaleway.env" } test_credentials_file_is_used_when_environment_is_empty () { @@ -782,9 +782,9 @@ test_credentials_file_is_used_when_environment_is_empty () { test_credentials_file_without_final_newline_is_read () { setup "identifiants : dernière ligne sans retour à la ligne lue quand même" - mkdir -p "${WORK}/.config/two-lab" - printf 'SCW_DEFAULT_PROJECT_ID=%s\nSCW_SECRET_KEY=%s' "${PROJECT}" "${SECRET}" > "${WORK}/.config/two-lab/scaleway.env" - chmod 600 "${WORK}/.config/two-lab/scaleway.env" + mkdir -p "${WORK}/.config/labctl" + printf 'SCW_DEFAULT_PROJECT_ID=%s\nSCW_SECRET_KEY=%s' "${PROJECT}" "${SECRET}" > "${WORK}/.config/labctl/scaleway.env" + chmod 600 "${WORK}/.config/labctl/scaleway.env" run_lab_without_env_credentials || fail "code de sortie $?" teardown } @@ -808,7 +808,7 @@ test_environment_value_kept_when_file_completes_the_rest () { test_credentials_file_readable_by_others_is_refused () { setup "identifiants : fichier lisible par d'autres refusé, sans aucun appel" write_credentials "SCW_SECRET_KEY=${SECRET}" "SCW_DEFAULT_PROJECT_ID=${PROJECT}" - chmod 644 "${WORK}/.config/two-lab/scaleway.env" + chmod 644 "${WORK}/.config/labctl/scaleway.env" run_lab_without_env_credentials && fail "plan a réussi" grep -q "chmod 600" "${WORK}/out.log" || fail "pas de consigne de droits" [[ -s "${WORK}/calls.log" ]] && fail "appel réseau avec un fichier exposé" @@ -892,9 +892,9 @@ test_no_zone_with_stock_is_refused_without_creation () { test_down_and_status_cover_every_candidate_zone () { setup "down et status : serveurs de lab de toutes les zones candidates" - mutate ".servers[\"lab-ams\"] = {id: \"lab-ams\", name: \"two-lab\", project_id: \"${PROJECT}\", tags: [\"two-lab\"], + mutate ".servers[\"lab-ams\"] = {id: \"lab-ams\", name: \"labctl\", project_id: \"${PROJECT}\", tags: [\"labctl\"], status: \"ready\", install: {status: \"completed\"}, ips: [], zone: \"nl-ams-2\", offer_name: \"EM-B420E-NVME\", created_at: \"now\"}" - mutate ".servers[\"lab-par\"] = {id: \"lab-par\", name: \"two-lab\", project_id: \"${PROJECT}\", tags: [\"two-lab\"], + mutate ".servers[\"lab-par\"] = {id: \"lab-par\", name: \"labctl\", project_id: \"${PROJECT}\", tags: [\"labctl\"], status: \"ready\", install: {status: \"completed\"}, ips: [], offer_name: \"EM-B212X-SSD\", created_at: \"now\"}" LAB_ZONES="fr-par-1 nl-ams-2" run_lab status grep -q '^nl-ams-2 lab-ams' "${WORK}/out.log" || fail "status : $(cat "${WORK}/out.log")" diff --git a/test/e2e/run.sh b/test/e2e/run.sh index 4b9e84d..3a34e7b 100755 --- a/test/e2e/run.sh +++ b/test/e2e/run.sh @@ -11,7 +11,7 @@ usage: ${0##*/} ... | all scénarios : $(cd "${SCENARIO_DIR}" && ls -- *.sh | sed 's/\.sh$//' | tr '\n' ' ') -Chaque scénario s'exécute depuis le Mac sur le lab en cours (lab-host.sh up, push, ./lab up). +Chaque scénario s'exécute depuis le Mac sur le lab en cours (lab-host.sh up, push, ./labctl up). Une ligne RÉUSSI ou ÉCHOUÉ par vérification ; code de sortie 1 si une vérification échoue ou si aucune n'a été faite. USAGE @@ -27,7 +27,7 @@ on () { done cat "${LAB_DIR}/lib/node.sh" cat - } | "${LAB_HOST}" ssh "./lab ssh ${node} 'sudo bash -s'" 2>&1 | tee -a "${SCENARIO_LOG}" + } | "${LAB_HOST}" ssh "./labctl ssh ${node} 'sudo bash -s'" 2>&1 | tee -a "${SCENARIO_LOG}" } run_scenario () { diff --git a/test/e2e/run_test.sh b/test/e2e/run_test.sh index 26393a9..9be98b1 100755 --- a/test/e2e/run_test.sh +++ b/test/e2e/run_test.sh @@ -46,7 +46,7 @@ test_on_sends_assignments_library_and_block_to_the_node () { setup "on : variables, bibliothèque et bloc envoyés au bon nœud" printf '%s\n' "on hv2 KEY='ssh-ed25519 AAAA x' NAME=vm <<'NODE'" 'echo "${NAME}"' 'NODE' > "${WORK}/scenarios/t1.sh" FAKE_OUT='RÉUSSI: un' run t1 || fail "code de sortie $?" - [[ $(cat "${WORK}/calls.log") == "ssh ./lab ssh hv2 'sudo bash -s'" ]] || fail "appel : $(cat "${WORK}/calls.log")" + [[ $(cat "${WORK}/calls.log") == "ssh ./labctl ssh hv2 'sudo bash -s'" ]] || fail "appel : $(cat "${WORK}/calls.log")" grep -q '^check () {' "${WORK}/payload.1" || fail "node.sh absent du bloc" [[ $(tail -n 1 "${WORK}/payload.1") == 'echo "${NAME}"' ]] || fail "bloc du scénario absent en fin d'envoi" [[ $(bash -c "$(grep '^export ' "${WORK}/payload.1"); printf '%s|%s' \"\${KEY}\" \"\${NAME}\"") == "ssh-ed25519 AAAA x|vm" ]] \ -- 2.52.0 From 8dc7721efe08c6b1c9b45c23eb161bbbe27d0753 Mon Sep 17 00:00:00 2001 From: GnomeZworc Date: Mon, 12 Oct 2026 21:21:41 +0200 Subject: [PATCH 4/5] =?UTF-8?q?f-55:=20lab:=20two=20utilise=20labctl=200.1?= =?UTF-8?q?.0rc001,=20t=C3=A9l=C3=A9charg=C3=A9=20et=20v=C3=A9rifi=C3=A9?= =?UTF-8?q?=20par=20test/e2e/labctl.sh=20#55?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: GnomeZworc --- test/e2e/labctl.sh | 46 ++++++++++++++++++++++++++++++++++++++++++++++ test/e2e/run.sh | 4 ++-- 2 files changed, 48 insertions(+), 2 deletions(-) create mode 100755 test/e2e/labctl.sh diff --git a/test/e2e/labctl.sh b/test/e2e/labctl.sh new file mode 100755 index 0000000..f229a1e --- /dev/null +++ b/test/e2e/labctl.sh @@ -0,0 +1,46 @@ +#!/usr/bin/env bash + +LABCTL_VERSION="0.1.0rc001" +LABCTL_URL="https://git.g3e.fr/syonad/labctl/releases/download/${LABCTL_VERSION}" +LABCTL_SUMS="e0c852a8f14f453dedb44e5ef70481293c72a63773dfef166cd298a4da4903e7 labctl_linux_amd64 +3bb13f2088360e332c2c071c7cf070f54956677c6387665b6bef6a58f9e2a631 lab-host.sh" +LABCTL_DIR="${LABCTL_DIR:-${HOME}/.cache/labctl/release/${LABCTL_VERSION}}" + +die () { echo "!! ${1}" >&2; exit 1; } + +sha256 () { + if command -v sha256sum >/dev/null 2>&1; then + sha256sum "$@" + else + shasum -a 256 "$@" + fi +} + +verify () { + (cd "${LABCTL_DIR}" && sha256 -c --quiet - <<< "${LABCTL_SUMS}") >&2 +} + +fetch () { + local asset part + mkdir -p "${LABCTL_DIR}" || return 1 + part="$(mktemp -d "${LABCTL_DIR}/.part.XXXXXX")" || return 1 + for asset in labctl_linux_amd64 lab-host.sh; do + echo "== téléchargement de ${asset} (labctl ${LABCTL_VERSION})" >&2 + curl -fsSL --proto '=https' -o "${part}/${asset}" "${LABCTL_URL}/${asset}" || { rm -rf "${part}"; return 1; } + done + (cd "${part}" && sha256 -c --quiet - <<< "${LABCTL_SUMS}") >&2 || { rm -rf "${part}"; return 1; } + chmod 755 "${part}/labctl_linux_amd64" "${part}/lab-host.sh" || { rm -rf "${part}"; return 1; } + mv "${part}/labctl_linux_amd64" "${part}/lab-host.sh" "${LABCTL_DIR}/" && rm -rf "${part}" +} + +main () { + if ! verify 2>/dev/null; then + fetch || die "labctl ${LABCTL_VERSION} : téléchargement ou vérification des sommes échoué" + verify || die "labctl ${LABCTL_VERSION} : sommes invalides dans ${LABCTL_DIR}" + fi + LABCTL_BIN="${LABCTL_DIR}/labctl_linux_amd64" exec "${LABCTL_DIR}/lab-host.sh" "$@" +} + +if [[ "${BASH_SOURCE[0]}" == "${0}" || -z "${BASH_SOURCE[0]}" ]]; then + main "$@" +fi diff --git a/test/e2e/run.sh b/test/e2e/run.sh index 3a34e7b..d01eb2d 100755 --- a/test/e2e/run.sh +++ b/test/e2e/run.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash LAB_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" -LAB_HOST="${LAB_HOST:-${LAB_DIR}/../../scripts/lab-host.sh}" +LAB_HOST="${LAB_HOST:-${LAB_DIR}/labctl.sh}" SCENARIO_DIR="${SCENARIO_DIR:-${LAB_DIR}/scenarios}" SCENARIO_LOG="" @@ -11,7 +11,7 @@ usage: ${0##*/} ... | all scénarios : $(cd "${SCENARIO_DIR}" && ls -- *.sh | sed 's/\.sh$//' | tr '\n' ' ') -Chaque scénario s'exécute depuis le Mac sur le lab en cours (lab-host.sh up, push, ./labctl up). +Chaque scénario s'exécute depuis le Mac sur le lab en cours (labctl.sh up, push, ./labctl up). Une ligne RÉUSSI ou ÉCHOUÉ par vérification ; code de sortie 1 si une vérification échoue ou si aucune n'a été faite. USAGE -- 2.52.0 From efc95284bb04253b9c9673686eb4f538425b895e Mon Sep 17 00:00:00 2001 From: GnomeZworc Date: Mon, 12 Oct 2026 21:21:48 +0200 Subject: [PATCH 5/5] =?UTF-8?q?f-55:=20lab:=20retrait=20de=20la=20copie=20?= =?UTF-8?q?de=20labctl,=20lab.rst=20r=C3=A9duit=20=C3=A0=20ce=20qui=20est?= =?UTF-8?q?=20propre=20=C3=A0=20two=20#55?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: GnomeZworc --- cmd/labctl/lifecycle.go | 193 ----- cmd/labctl/main.go | 169 ----- cmd/labctl/main_test.go | 371 --------- cmd/labctl/terminal.go | 14 - cmd/labctl/terminal_darwin.go | 5 - cmd/labctl/terminal_linux.go | 5 - cmd/labctl/terminal_other.go | 7 - docs/developpement/lab.rst | 719 ++---------------- go.mod | 2 +- internal/lab/machine/machine.go | 290 ------- internal/lab/machine/machine_test.go | 588 -------------- internal/lab/provision/image.go | 185 ----- internal/lab/provision/image_test.go | 334 -------- internal/lab/provision/provision.go | 207 ----- internal/lab/provision/provision_test.go | 450 ----------- internal/lab/render/frrouting.gpg | Bin 16112 -> 0 bytes internal/lab/render/qemu.go | 57 -- internal/lab/render/render.go | 150 ---- internal/lab/render/render_test.go | 480 ------------ internal/lab/render/roles_test.go | 312 -------- internal/lab/render/seed.go | 298 -------- internal/lab/topology/format.go | 82 -- internal/lab/topology/plan.go | 220 ------ internal/lab/topology/plan_test.go | 359 --------- internal/lab/topology/roles_test.go | 273 ------- internal/lab/topology/topology.go | 189 ----- internal/lab/topology/topology_test.go | 173 ----- internal/lab/topology/validate.go | 249 ------ scripts/lab-host.sh | 507 ------------- scripts/lab-host_test.sh | 925 ----------------------- 30 files changed, 57 insertions(+), 7756 deletions(-) delete mode 100644 cmd/labctl/lifecycle.go delete mode 100644 cmd/labctl/main.go delete mode 100644 cmd/labctl/main_test.go delete mode 100644 cmd/labctl/terminal.go delete mode 100644 cmd/labctl/terminal_darwin.go delete mode 100644 cmd/labctl/terminal_linux.go delete mode 100644 cmd/labctl/terminal_other.go delete mode 100644 internal/lab/machine/machine.go delete mode 100644 internal/lab/machine/machine_test.go delete mode 100644 internal/lab/provision/image.go delete mode 100644 internal/lab/provision/image_test.go delete mode 100644 internal/lab/provision/provision.go delete mode 100644 internal/lab/provision/provision_test.go delete mode 100644 internal/lab/render/frrouting.gpg delete mode 100644 internal/lab/render/qemu.go delete mode 100644 internal/lab/render/render.go delete mode 100644 internal/lab/render/render_test.go delete mode 100644 internal/lab/render/roles_test.go delete mode 100644 internal/lab/render/seed.go delete mode 100644 internal/lab/topology/format.go delete mode 100644 internal/lab/topology/plan.go delete mode 100644 internal/lab/topology/plan_test.go delete mode 100644 internal/lab/topology/roles_test.go delete mode 100644 internal/lab/topology/topology.go delete mode 100644 internal/lab/topology/topology_test.go delete mode 100644 internal/lab/topology/validate.go delete mode 100755 scripts/lab-host.sh delete mode 100755 scripts/lab-host_test.sh diff --git a/cmd/labctl/lifecycle.go b/cmd/labctl/lifecycle.go deleted file mode 100644 index 6bc6547..0000000 --- a/cmd/labctl/lifecycle.go +++ /dev/null @@ -1,193 +0,0 @@ -package main - -import ( - "context" - "flag" - "fmt" - "io" - "net/http" - "os" - "os/exec" - "os/signal" - "path/filepath" - "syscall" - "time" - - "git.g3e.fr/syonad/two/internal/lab/machine" - "git.g3e.fr/syonad/two/internal/lab/provision" -) - -const ( - topologyFile = "topology.yml" - pollInterval = 5 * time.Second - stopTimeout = 30 * time.Second -) - -var ( - execve = syscall.Exec - procDir = "/proc" -) - -func defaultDir(parts ...string) string { - home, err := os.UserHomeDir() - if err != nil { - return "" - } - return filepath.Join(append([]string{home}, parts...)...) -} - -func flags(name string, stderr io.Writer) (*flag.FlagSet, *string) { - fs := flag.NewFlagSet(name, flag.ContinueOnError) - fs.SetOutput(stderr) - fs.Usage = func() { fmt.Fprint(stderr, usage) } - return fs, fs.String("run", defaultDir("lab-run"), "run directory of the lab") -} - -func lab(runDir string, plan string, stdout, stderr io.Writer) (machine.Lab, bool) { - dir, err := filepath.Abs(runDir) - if err != nil { - fmt.Fprintf(stderr, "labctl: %v\n", err) - return machine.Lab{}, false - } - p, ok := load(plan, stderr) - if !ok { - return machine.Lab{}, false - } - return machine.Lab{ - Plan: p, - RunDir: dir, - ProcDir: procDir, - Runner: provision.ExecRunner{}, - Poll: pollInterval, - Stop: stopTimeout, - Out: stdout, - }, true -} - -func current(runDir string, stdout, stderr io.Writer) (machine.Lab, bool) { - saved := filepath.Join(runDir, topologyFile) - if _, err := os.Stat(saved); err != nil { - fmt.Fprintf(stderr, "labctl: no lab in %s: %v\n", runDir, err) - return machine.Lab{}, false - } - return lab(runDir, saved, stdout, stderr) -} - -func upCmd(args []string, stdout, stderr io.Writer) int { - fs, runDir := flags("up", stderr) - cacheDir := fs.String("cache", defaultDir(".cache", "labctl"), "image cache directory") - timeout := fs.Duration("timeout", 20*time.Minute, "how long to wait for the nodes to be ready") - if err := fs.Parse(args); err != nil || fs.NArg() != 1 { - fs.Usage() - return 2 - } - cache, err := filepath.Abs(*cacheDir) - if err != nil { - fmt.Fprintf(stderr, "labctl: %v\n", err) - return 1 - } - - if _, err := os.Stat(filepath.Join(*runDir, topologyFile)); err == nil { - previous, ok := current(*runDir, stdout, stderr) - if !ok { - return 1 - } - running, err := previous.Running() - if err != nil { - fmt.Fprintf(stderr, "labctl: %v\n", err) - return 1 - } - if len(running) > 0 { - fmt.Fprintf(stderr, "labctl: lab %s is still running in %s: 'lab down' first\n", previous.Plan.Name, previous.RunDir) - return 1 - } - } - - l, ok := lab(*runDir, fs.Arg(0), stdout, stderr) - if !ok { - return 1 - } - source, err := os.ReadFile(fs.Arg(0)) - if err != nil { - fmt.Fprintf(stderr, "labctl: %v\n", err) - return 1 - } - if err := os.MkdirAll(l.RunDir, 0o700); err != nil { - fmt.Fprintf(stderr, "labctl: %v\n", err) - return 1 - } - if err := os.WriteFile(filepath.Join(l.RunDir, topologyFile), source, 0o600); err != nil { - fmt.Fprintf(stderr, "labctl: %v\n", err) - return 1 - } - - ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM) - defer stop() - fetcher := provision.Fetcher{Client: &http.Client{}, CacheDir: cache} - if err := l.Up(ctx, fetcher, *timeout); err != nil { - fmt.Fprintf(stderr, "labctl: %v\nlab: started nodes keep running: 'lab status', 'lab down'\n", err) - return 1 - } - return 0 -} - -func statusCmd(args []string, stdout, stderr io.Writer) int { - fs, runDir := flags("status", stderr) - if err := fs.Parse(args); err != nil || fs.NArg() != 0 { - fs.Usage() - return 2 - } - l, ok := current(*runDir, stdout, stderr) - if !ok { - return 1 - } - if err := l.Status(stdout); err != nil { - fmt.Fprintf(stderr, "labctl: %v\n", err) - return 1 - } - return 0 -} - -func downCmd(args []string, stdout, stderr io.Writer) int { - fs, runDir := flags("down", stderr) - if err := fs.Parse(args); err != nil || fs.NArg() != 0 { - fs.Usage() - return 2 - } - l, ok := current(*runDir, stdout, stderr) - if !ok { - return 1 - } - if err := l.Down(context.Background()); err != nil { - fmt.Fprintf(stderr, "labctl: %v\n", err) - return 1 - } - return 0 -} - -func sshCmd(args []string, stdout, stderr io.Writer) int { - fs, runDir := flags("ssh", stderr) - if err := fs.Parse(args); err != nil || fs.NArg() < 1 { - fs.Usage() - return 2 - } - l, ok := current(*runDir, stdout, stderr) - if !ok { - return 1 - } - argv, err := l.SSH(fs.Arg(0), isTerminal(os.Stdin), fs.Args()[1:]) - if err != nil { - fmt.Fprintf(stderr, "labctl: %v\n", err) - return 1 - } - path, err := exec.LookPath(argv[0]) - if err != nil { - fmt.Fprintf(stderr, "labctl: %v\n", err) - return 1 - } - if err := execve(path, argv, os.Environ()); err != nil { - fmt.Fprintf(stderr, "labctl: %v\n", err) - return 1 - } - return 0 -} diff --git a/cmd/labctl/main.go b/cmd/labctl/main.go deleted file mode 100644 index b4bd2c9..0000000 --- a/cmd/labctl/main.go +++ /dev/null @@ -1,169 +0,0 @@ -package main - -import ( - "flag" - "fmt" - "io" - "os" - "path/filepath" - "strings" - - "git.g3e.fr/syonad/two/internal/lab/provision" - "git.g3e.fr/syonad/two/internal/lab/render" - "git.g3e.fr/syonad/two/internal/lab/topology" -) - -const usage = `usage: labctl [options] [dir] - - plan - validate the topology and print the deterministic plan: addresses, cables, ports - - render -key - write, for each node, //qemu.args (one argument per line) and the - cloud-init seed files meta-data, user-data and network-config - - up [-run dir] [-cache dir] [-timeout duration] - download and verify the images, create fresh disks and seeds, start every node - (switches first) and wait until cloud-init has finished on each of them; - the topology is kept in /topology.yml for the commands below - - status [-run dir] - list the nodes of the lab and whether their qemu process is running - - down [-run dir] - stop every qemu process of the lab (SIGTERM, then SIGKILL) - - ssh [-run dir] [command...] - open a shell on a node, or run a command on it, with the key generated by up - - defaults: -run $HOME/lab-run, -cache $HOME/.cache/labctl, -timeout 20m -` - -type keyFiles []string - -func (k *keyFiles) String() string { return strings.Join(*k, ",") } -func (k *keyFiles) Set(v string) error { *k = append(*k, v); return nil } - -func main() { - os.Exit(run(os.Args[1:], os.Stdout, os.Stderr)) -} - -func run(args []string, stdout, stderr io.Writer) int { - if len(args) == 0 { - fmt.Fprint(stderr, usage) - return 2 - } - switch args[0] { - case "plan": - if len(args) != 2 { - fmt.Fprint(stderr, usage) - return 2 - } - return plan(args[1], stdout, stderr) - case "render": - return renderCmd(args[1:], stdout, stderr) - case "up": - return upCmd(args[1:], stdout, stderr) - case "status": - return statusCmd(args[1:], stdout, stderr) - case "down": - return downCmd(args[1:], stdout, stderr) - case "ssh": - return sshCmd(args[1:], stdout, stderr) - default: - fmt.Fprint(stderr, usage) - return 2 - } -} - -func load(path string, stderr io.Writer) (*topology.Plan, bool) { - t, err := topology.Load(path) - if err != nil { - fmt.Fprintf(stderr, "labctl: %v\n", err) - return nil, false - } - p, err := topology.Compute(t) - if err != nil { - fmt.Fprintf(stderr, "labctl: %s:\n%v\n", path, err) - return nil, false - } - return p, true -} - -func plan(path string, stdout, stderr io.Writer) int { - p, ok := load(path, stderr) - if !ok { - return 1 - } - if err := p.Write(stdout); err != nil { - fmt.Fprintf(stderr, "labctl: %v\n", err) - return 1 - } - return 0 -} - -func renderCmd(args []string, stdout, stderr io.Writer) int { - fs := flag.NewFlagSet("render", flag.ContinueOnError) - fs.SetOutput(stderr) - fs.Usage = func() { fmt.Fprint(stderr, usage) } - var keys keyFiles - fs.Var(&keys, "key", "public key file allowed to log in, repeatable") - if err := fs.Parse(args); err != nil { - return 2 - } - if fs.NArg() != 2 || len(keys) == 0 { - fmt.Fprint(stderr, usage) - return 2 - } - - p, ok := load(fs.Arg(0), stderr) - if !ok { - return 1 - } - dir, err := filepath.Abs(fs.Arg(1)) - if err != nil { - fmt.Fprintf(stderr, "labctl: %v\n", err) - return 1 - } - authorized, err := readKeys(keys) - if err != nil { - fmt.Fprintf(stderr, "labctl: %v\n", err) - return 1 - } - opts := render.Options{RunDir: dir, AuthorizedKeys: authorized} - if err := provision.ReadInputs(p, &opts); err != nil { - fmt.Fprintf(stderr, "labctl: %v\n", err) - return 1 - } - nodes, err := render.Render(p, opts) - if err != nil { - fmt.Fprintf(stderr, "labctl: %v\n", err) - return 1 - } - for _, n := range nodes { - if err := provision.WriteFiles(n); err != nil { - fmt.Fprintf(stderr, "labctl: %v\n", err) - return 1 - } - fmt.Fprintf(stdout, "%s\n", n.Dir) - } - return 0 -} - -func readKeys(files []string) ([]string, error) { - var keys []string - for _, f := range files { - data, err := os.ReadFile(f) - if err != nil { - return nil, err - } - for _, line := range strings.Split(string(data), "\n") { - line = strings.TrimSpace(line) - if line == "" || strings.HasPrefix(line, "#") { - continue - } - keys = append(keys, line) - } - } - return keys, nil -} diff --git a/cmd/labctl/main_test.go b/cmd/labctl/main_test.go deleted file mode 100644 index 4f87a51..0000000 --- a/cmd/labctl/main_test.go +++ /dev/null @@ -1,371 +0,0 @@ -package main - -import ( - "bytes" - "os" - "os/exec" - "path/filepath" - "strconv" - "strings" - "syscall" - "testing" -) - -func runLab(args ...string) (int, string, string) { - var stdout, stderr bytes.Buffer - code := run(args, &stdout, &stderr) - return code, stdout.String(), stderr.String() -} - -func TestRun_UsageOnMissingArguments(t *testing.T) { - for _, args := range [][]string{nil, {"plan"}, {"deploy", "x.yml"}, {"plan", "a.yml", "b.yml"}, {"render", "a.yml", "dir"}, {"render", "-key", "k.pub", "a.yml"}, {"render", "-bogus"}} { - code, _, stderr := runLab(args...) - if code != 2 || !strings.Contains(stderr, "usage: lab") { - t.Errorf("args %v: code %d, stderr %q", args, code, stderr) - } - } -} - -func TestRun_PlanOfTheShippedExampleTopology(t *testing.T) { - code, stdout, stderr := runLab("plan", filepath.Join("..", "..", "test", "e2e", "topologies", "evpn-2hv.yml")) - if code != 0 { - t.Fatalf("code %d, stderr %s", code, stderr) - } - for _, want := range []string{ - "lab evpn-2hv: nodes 4, segments 1, cables 3", - "gateway 192.168.14.1", - "hv2 underlay 192.168.14.12/24 02:4c:00:03:00:00 20004 <-> sw1 p2", - "rr1 lo1 10.255.255.1/32 underlay 169.254.0.3/28 rr1.conf", - } { - if !strings.Contains(stdout, want) { - t.Errorf("output does not contain %q:\n%s", want, stdout) - } - } -} - -func TestRun_InvalidTopologyExitsWithErrors(t *testing.T) { - path := filepath.Join(t.TempDir(), "bad.yml") - doc := `name: bad -images: - deb: { url: https://example.invalid/a, sums: https://example.invalid/b } -segments: - under: { switch: sw, cidr: 10.0.0.0/31 } -nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512 } - rr: { role: router, image: deb, cpus: 1, memory: 512, segments: [under] } -` - if err := os.WriteFile(path, []byte(doc), 0o600); err != nil { - t.Fatal(err) - } - code, stdout, stderr := runLab("plan", path) - if code != 1 || stdout != "" { - t.Fatalf("code %d, stdout %q", code, stdout) - } - for _, want := range []string{path, `role "router"`, "prefix length out of range"} { - if !strings.Contains(stderr, want) { - t.Errorf("stderr does not mention %q:\n%s", want, stderr) - } - } -} - -func TestRun_MissingFile(t *testing.T) { - code, _, stderr := runLab("plan", filepath.Join(t.TempDir(), "absent.yml")) - if code != 1 || !strings.Contains(stderr, "absent.yml") { - t.Errorf("code %d, stderr %q", code, stderr) - } -} - -func TestRun_RenderWritesEveryNodeFiles(t *testing.T) { - dir := t.TempDir() - key := filepath.Join(dir, "lab.pub") - if err := os.WriteFile(key, []byte("# lab key\n\nssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFG/JMmjfko96WkJV8DiL6rip/H/q/R++y8s27Z+Cj6O lab-automation\n"), 0o600); err != nil { - t.Fatal(err) - } - out := filepath.Join(dir, "run") - code, stdout, stderr := runLab("render", "-key", key, filepath.Join("..", "..", "test", "e2e", "topologies", "evpn-2hv.yml"), out) - if code != 0 { - t.Fatalf("code %d, stderr %s", code, stderr) - } - for _, node := range []string{"sw1", "rr1", "hv1", "hv2"} { - if !strings.Contains(stdout, filepath.Join(out, node)) { - t.Errorf("stdout does not list %s:\n%s", node, stdout) - } - for _, f := range []string{"qemu.args", "meta-data", "user-data", "network-config"} { - info, err := os.Stat(filepath.Join(out, node, f)) - if err != nil { - t.Errorf("%s/%s: %v", node, f, err) - continue - } - if info.Mode().Perm() != 0o600 { - t.Errorf("%s/%s mode %o, want 600", node, f, info.Mode().Perm()) - } - } - } - args, err := os.ReadFile(filepath.Join(out, "hv1", "qemu.args")) - if err != nil { - t.Fatal(err) - } - if !strings.Contains(string(args), "\n-netdev\nuser,id=mgmt0,restrict=on,ipv6=off,hostfwd=tcp:127.0.0.1:2202-:22\n") { - t.Errorf("qemu.args is not one argument per line:\n%s", args) - } - userData, err := os.ReadFile(filepath.Join(out, "hv1", "user-data")) - if err != nil { - t.Fatal(err) - } - if !strings.Contains(string(userData), "lab-automation") || strings.Contains(string(userData), "# lab key") { - t.Errorf("keys not read as an authorized_keys file:\n%s", userData) - } -} - -func TestRun_RenderRefusesMissingKeyFile(t *testing.T) { - code, _, stderr := runLab("render", "-key", filepath.Join(t.TempDir(), "absent.pub"), filepath.Join("..", "..", "test", "e2e", "topologies", "evpn-2hv.yml"), t.TempDir()) - if code != 1 || !strings.Contains(stderr, "absent.pub") { - t.Errorf("code %d, stderr %q", code, stderr) - } -} - -func savedLab(t *testing.T) string { - t.Helper() - run := filepath.Join(t.TempDir(), "run") - if err := os.MkdirAll(run, 0o700); err != nil { - t.Fatal(err) - } - example, err := os.ReadFile(filepath.Join("..", "..", "test", "e2e", "topologies", "evpn-2hv.yml")) - if err != nil { - t.Fatal(err) - } - if err := os.WriteFile(filepath.Join(run, "topology.yml"), example, 0o600); err != nil { - t.Fatal(err) - } - return run -} - -func TestRun_LifecycleUsage(t *testing.T) { - for _, args := range [][]string{{"up"}, {"up", "a.yml", "b.yml"}, {"status", "x"}, {"down", "x"}, {"ssh"}, {"up", "-bogus", "a.yml"}} { - code, _, stderr := runLab(args...) - if code != 2 || !strings.Contains(stderr, "usage: lab") { - t.Errorf("args %v: code %d, stderr %q", args, code, stderr) - } - } -} - -func TestRun_CommandsWithoutALabInTheRunDir(t *testing.T) { - run := t.TempDir() - for _, cmd := range []string{"status", "down", "ssh"} { - args := []string{cmd, "-run", run} - if cmd == "ssh" { - args = append(args, "hv1") - } - code, _, stderr := runLab(args...) - if code != 1 || !strings.Contains(stderr, "labctl: no lab in "+run) { - t.Errorf("%s: code %d, stderr %q", cmd, code, stderr) - } - } -} - -func TestRun_StatusOfAStoppedLab(t *testing.T) { - code, stdout, stderr := runLab("status", "-run", savedLab(t)) - want := `node role state pid ssh -sw1 switch stopped - 127.0.0.1:2200 -rr1 rr stopped - 127.0.0.1:2201 -hv1 host stopped - 127.0.0.1:2202 -hv2 host stopped - 127.0.0.1:2203 -` - if code != 0 || stdout != want { - t.Errorf("code %d, stderr %q, stdout:\n%s", code, stderr, stdout) - } -} - -func TestRun_DownOfAStoppedLab(t *testing.T) { - code, stdout, stderr := runLab("down", "-run", savedLab(t)) - if code != 0 || stdout != "" || stderr != "" { - t.Errorf("code %d, stdout %q, stderr %q", code, stdout, stderr) - } -} - -func TestRun_SSHExecsSSHWithTheNodePort(t *testing.T) { - run := savedLab(t) - var gotPath string - var gotArgv []string - execve = func(path string, argv []string, env []string) error { - gotPath, gotArgv = path, argv - return nil - } - t.Cleanup(func() { execve = syscall.Exec }) - - code, _, stderr := runLab("ssh", "-run", run, "hv2", "ip", "-br", "a") - - if code != 0 { - t.Fatalf("code %d, stderr %q", code, stderr) - } - if filepath.Base(gotPath) != "ssh" { - t.Errorf("path = %q", gotPath) - } - want := []string{"ssh", - "-i", filepath.Join(run, "lab_ed25519"), - "-o", "IdentitiesOnly=yes", - "-o", "IdentityAgent=none", - "-o", "StrictHostKeyChecking=no", - "-o", "UserKnownHostsFile=/dev/null", - "-o", "LogLevel=ERROR", - "-p", "2203", - "debian@127.0.0.1", - "ip", "-br", "a", - } - if strings.Join(gotArgv, " ") != strings.Join(want, " ") { - t.Errorf("\n got %q\nwant %q", gotArgv, want) - } -} - -func TestRun_SSHUnknownNode(t *testing.T) { - code, _, stderr := runLab("ssh", "-run", savedLab(t), "hv9") - if code != 1 || !strings.Contains(stderr, `node "hv9" is not in lab evpn-2hv`) { - t.Errorf("code %d, stderr %q", code, stderr) - } -} - -func TestRun_UpRefusesAnInvalidTopologyAndKeepsTheSavedOne(t *testing.T) { - run := savedLab(t) - before, _ := os.ReadFile(filepath.Join(run, "topology.yml")) - bad := filepath.Join(t.TempDir(), "bad.yml") - if err := os.WriteFile(bad, []byte("name: x\n"), 0o600); err != nil { - t.Fatal(err) - } - - code, _, stderr := runLab("up", "-run", run, bad) - - if code != 1 || !strings.Contains(stderr, "at least one node is required") { - t.Errorf("code %d, stderr %q", code, stderr) - } - if after, _ := os.ReadFile(filepath.Join(run, "topology.yml")); string(after) != string(before) { - t.Error("the saved topology was replaced by an invalid one") - } -} - -func TestIsTerminal_DevNullAndPipesAreNotTerminals(t *testing.T) { - null, err := os.Open(os.DevNull) - if err != nil { - t.Fatal(err) - } - defer null.Close() - r, w, err := os.Pipe() - if err != nil { - t.Fatal(err) - } - defer r.Close() - defer w.Close() - for name, f := range map[string]*os.File{"/dev/null": null, "pipe": r} { - if isTerminal(f) { - t.Errorf("%s is detected as a terminal", name) - } - } -} - -func TestRun_UpRefusesToReplaceARunningLab(t *testing.T) { - run := savedLab(t) - before, _ := os.ReadFile(filepath.Join(run, "topology.yml")) - proc := t.TempDir() - procDir = proc - t.Cleanup(func() { procDir = "/proc" }) - - cmd := exec.Command("sleep", "30") - if err := cmd.Start(); err != nil { - t.Fatal(err) - } - t.Cleanup(func() { cmd.Process.Kill(); cmd.Wait() }) - pid := strconv.Itoa(cmd.Process.Pid) - if err := os.MkdirAll(filepath.Join(proc, pid), 0o755); err != nil { - t.Fatal(err) - } - if err := os.WriteFile(filepath.Join(proc, pid, "cmdline"), []byte("qemu-system-x86_64\x00-name\x00hv1\x00"), 0o644); err != nil { - t.Fatal(err) - } - if err := os.MkdirAll(filepath.Join(run, "hv1"), 0o700); err != nil { - t.Fatal(err) - } - if err := os.WriteFile(filepath.Join(run, "hv1", "qemu.pid"), []byte(pid+"\n"), 0o600); err != nil { - t.Fatal(err) - } - - other := filepath.Join(t.TempDir(), "other.yml") - if err := os.WriteFile(other, bytes.ReplaceAll(before, []byte("evpn-2hv"), []byte("other")), 0o600); err != nil { - t.Fatal(err) - } - code, _, stderr := runLab("up", "-run", run, other) - - if code != 1 || !strings.Contains(stderr, "lab evpn-2hv is still running in "+run) { - t.Errorf("code %d, stderr %q", code, stderr) - } - if after, _ := os.ReadFile(filepath.Join(run, "topology.yml")); string(after) != string(before) { - t.Error("the topology of a running lab was replaced") - } -} - -func TestRun_RenderShipsTheExampleFRRConfigs(t *testing.T) { - dir := t.TempDir() - key := filepath.Join(dir, "lab.pub") - if err := os.WriteFile(key, []byte("ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFG/JMmjfko96WkJV8DiL6rip/H/q/R++y8s27Z+Cj6O lab-automation\n"), 0o600); err != nil { - t.Fatal(err) - } - out := filepath.Join(dir, "run") - code, _, stderr := runLab("render", "-key", key, filepath.Join("..", "..", "test", "e2e", "topologies", "evpn-2hv.yml"), out) - if code != 0 { - t.Fatalf("code %d, stderr %s", code, stderr) - } - for node, wants := range map[string][]string{ - "sw1": {"router bgp 65100"}, - "rr1": {"bgp listen range 192.168.14.0/24 peer-group fabric"}, - "hv1": {"hostname hv1"}, - "hv2": {"hostname hv2"}, - } { - data, err := os.ReadFile(filepath.Join(out, node, "user-data")) - if err != nil { - t.Fatal(err) - } - for _, want := range wants { - if !strings.Contains(string(data), want) { - t.Errorf("%s user-data does not carry %q", node, want) - } - } - } - for _, node := range []string{"hv1", "hv2"} { - data, err := os.ReadFile(filepath.Join(out, node, "user-data")) - if err != nil { - t.Fatal(err) - } - if !strings.Contains(string(data), "mount -o ro LABEL=LABFILES /run/lab-files") { - t.Errorf("%s user-data does not mount its files", node) - } - } - for _, agent := range []string{"two.yml", "bgp.yml"} { - data, err := os.ReadFile(filepath.Join("..", "..", "test", "e2e", "topologies", "agent", agent)) - if err != nil || !strings.Contains(string(data), "route_reflectors: [10.255.255.1]") { - t.Errorf("agent/%s = %q, %v", agent, data, err) - } - } -} - -func TestRun_RenderReportsAMissingFRRConfig(t *testing.T) { - dir := t.TempDir() - key := filepath.Join(dir, "lab.pub") - if err := os.WriteFile(key, []byte("ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFG/JMmjfko96WkJV8DiL6rip/H/q/R++y8s27Z+Cj6O x\n"), 0o600); err != nil { - t.Fatal(err) - } - topo := filepath.Join(dir, "lab.yml") - doc := `name: x -images: - deb: { url: https://example.invalid/deb.qcow2, sums: https://example.invalid/SHA512SUMS } -segments: - underlay: { switch: sw1, cidr: 10.1.0.0/24 } -nodes: - sw1: { role: switch, image: deb, cpus: 1, memory: 512, frr: frr/absent.conf } - hv1: { role: host, image: deb, cpus: 1, memory: 512, segments: [underlay] } -` - if err := os.WriteFile(topo, []byte(doc), 0o600); err != nil { - t.Fatal(err) - } - code, _, stderr := runLab("render", "-key", key, topo, filepath.Join(dir, "run")) - if code != 1 || !strings.Contains(stderr, "node sw1: ") || !strings.Contains(stderr, filepath.Join(dir, "frr", "absent.conf")) { - t.Errorf("code %d, stderr %q", code, stderr) - } -} diff --git a/cmd/labctl/terminal.go b/cmd/labctl/terminal.go deleted file mode 100644 index fa2cb06..0000000 --- a/cmd/labctl/terminal.go +++ /dev/null @@ -1,14 +0,0 @@ -//go:build linux || darwin - -package main - -import ( - "os" - - "golang.org/x/sys/unix" -) - -func isTerminal(f *os.File) bool { - _, err := unix.IoctlGetTermios(int(f.Fd()), ioctlReadTermios) - return err == nil -} diff --git a/cmd/labctl/terminal_darwin.go b/cmd/labctl/terminal_darwin.go deleted file mode 100644 index 4c493c7..0000000 --- a/cmd/labctl/terminal_darwin.go +++ /dev/null @@ -1,5 +0,0 @@ -package main - -import "golang.org/x/sys/unix" - -const ioctlReadTermios = unix.TIOCGETA diff --git a/cmd/labctl/terminal_linux.go b/cmd/labctl/terminal_linux.go deleted file mode 100644 index ba4230d..0000000 --- a/cmd/labctl/terminal_linux.go +++ /dev/null @@ -1,5 +0,0 @@ -package main - -import "golang.org/x/sys/unix" - -const ioctlReadTermios = unix.TCGETS diff --git a/cmd/labctl/terminal_other.go b/cmd/labctl/terminal_other.go deleted file mode 100644 index a929525..0000000 --- a/cmd/labctl/terminal_other.go +++ /dev/null @@ -1,7 +0,0 @@ -//go:build !linux && !darwin - -package main - -import "os" - -func isTerminal(*os.File) bool { return false } diff --git a/docs/developpement/lab.rst b/docs/developpement/lab.rst index ffe98ab..5e6fe2b 100644 --- a/docs/developpement/lab.rst +++ b/docs/developpement/lab.rst @@ -13,322 +13,61 @@ comment s'en servir. .. note:: - État actuel : le lab de #50 est livré — serveur loué à l'heure (``scripts/lab-host.sh``), - topologie déclarative et plan déterministe (``labctl plan``), VM rendues et lancées sur le - serveur (``labctl render``, ``labctl up`` / ``status`` / ``down`` / ``ssh``), rôles installés au - démarrage (FRR sur le switch et le route reflector, two par ``deploy.sh`` sur les - hyperviseurs) et scénarios versionnés (``test/e2e/run.sh``). La redondance du plan de - contrôle — deux route reflectors, deux switchs — est l'objet de - `#54 `_. + État actuel : le lab de #50 est livré et l'outil en est sorti (#55) : c'est + `labctl `_, un dépôt à part, dont two épingle une release. + Ce dépôt garde ce qui est propre à two — ses topologies, l'installation de two sur les + hyperviseurs, les scénarios et leurs résultats. La redondance du plan de contrôle — deux route + reflectors, deux switchs — est l'objet de `#54 `_. -Le serveur de lab ------------------ +L'outil +------- -Un serveur **Scaleway Elastic Metal**, créé pour une campagne de tests puis supprimé. +``labctl`` monte un lab de VM QEMU à partir d'une topologie YAML et s'exécute sur un hôte Linux +avec KVM ; son ``lab-host.sh`` loue cet hôte à l'heure chez Scaleway (Elastic Metal), le prépare, +y dépose ``labctl`` et la topologie, puis le supprime. Prérequis Scaleway, fichiers locaux +(``~/.config/labctl/``), commandes, format de topologie, rendu des VM, garanties de facturation et +diagnostic : voir le `guide de labctl `_. -.. list-table:: - :widths: 25 75 +two n'en garde aucune copie. ``test/e2e/labctl.sh`` épingle une release : - * - Offre - - ``EM-B212X-SSD``, zone ``fr-par-1``, **facturation horaire** : 0,321 € HT de l'heure, sans - frais de mise en service - * - Matériel - - 2 × Xeon E5-2620 v4 *or equivalent*, 256 Go, 2 × 1 To SSD - * - Système - - Debian 12, installé par Scaleway à la création - * - Pourquoi Intel - - lab3 est en Intel : two lance ses VM en ``-cpu host``, et KVM a deux implémentations - distinctes (``kvm_intel``, ``kvm_amd``) +* au premier appel, il télécharge ``labctl_linux_amd64`` et ``lab-host.sh`` dans + ``~/.cache/labctl/release//`` et les vérifie contre des sommes SHA-256 **écrites dans + le script** — une release modifiée après coup est refusée ; un fichier altéré dans le cache est + retéléchargé ; +* il lance ensuite ``lab-host.sh`` avec ses arguments et ``LABCTL_BIN`` pointé sur le binaire : + ``push`` dépose ce binaire au lieu de compiler. -*Or equivalent* n'est pas une clause de style : le premier serveur livré était un -**Xeon E5-2640 v3** (Haswell, la génération de lab3), pas le E5-2620 v4 annoncé. Relever -``lscpu`` au début de chaque campagne. +Changer de version : ``LABCTL_VERSION`` et les deux lignes de ``LABCTL_SUMS`` dans +``test/e2e/labctl.sh``, relevées dans le ``SHA256SUMS`` de la release **et** recalculées sur les +fichiers téléchargés. -Prérequis côté Scaleway ------------------------ - -#. **Un projet dédié au lab**, séparé de toute autre ressource. ``lab-host.sh down`` supprime - tout serveur de lab du projet : il ne doit rien y avoir d'autre. -#. **Une clé d'API limitée à ce projet**, avec les droits Elastic Metal et la lecture des clés SSH - du projet. Rien d'autre. -#. **Les clés SSH publiques enregistrées dans le projet**, injectées à l'installation : sans elle, - le serveur serait facturé sans que personne puisse s'y connecter, et ``plan`` refuse de - continuer. -#. **Le quota Elastic Metal.** L'``EM-B212X-SSD`` exige un compte dont le moyen de paiement *et* - l'identité sont validés ; le quota est alors de 2. Vérifier dans la console : Organisation → - Quotas → Elastic Metal. Voir `les quotas Scaleway - `_. - -Fichiers locaux ---------------- - -Tout ce dont le script a besoin vit sous ``~/.config/labctl/``, hors du dépôt. - -``~/.config/labctl/scaleway.env`` - Identifiants Scaleway, une ligne ``CLÉ=valeur`` chacun : - - .. code-block:: bash - - SCW_SECRET_KEY= - SCW_DEFAULT_PROJECT_ID= - SCW_DEFAULT_ZONE=fr-par-1 - - * le fichier doit être en ``0600`` : le script refuse de s'en servir s'il est lisible par - d'autres que son propriétaire ; - * il est **lu, jamais exécuté** — pas de ``source`` ; seules ces trois clés sont reconnues ; - * une variable d'environnement du même nom l'emporte sur le fichier ; - * la clé d'accès (``SCW…``) n'est pas nécessaire : l'API REST n'authentifie que par la clé - secrète, dans l'en-tête ``X-Auth-Token``. - - Pour changer de clé, remplacer la ligne ``SCW_SECRET_KEY=`` ; rien d'autre à modifier. - -``~/.config/labctl/ssh/lab_ed25519`` - Clé SSH dédiée au lab, **sans phrase de passe**, pour que les sessions tournent sans - intervention. Sa partie publique doit être enregistrée dans le projet. Quand elle existe, le - script l'utilise **seule** (``IdentitiesOnly``, agent désactivé) ; sinon il retombe sur - l'agent SSH. - - Elle ne doit ouvrir que les serveurs éphémères du projet de lab : **ne jamais l'installer sur - lab3 ni sur une machine durable**. En cas de doute, la retirer du projet et en générer une - autre : - - .. code-block:: bash - - mkdir -p ~/.config/labctl/ssh && chmod 700 ~/.config/labctl ~/.config/labctl/ssh - ssh-keygen -t ed25519 -N '' -C lab-automation -f ~/.config/labctl/ssh/lab_ed25519 - -``~/.cache/labctl/`` - État de la session en cours : adresse et utilisateur du serveur, ``known_hosts`` dédié. Vidé - par ``down``. - -Commandes ---------- +Une campagne, depuis le Mac : .. code-block:: text - usage: lab-host.sh [arguments] - - plan résout l'offre horaire, l'OS et les clés SSH, affiche la requête de création - et le prix ; ne crée rien - up crée le serveur de lab, attend la fin de son installation et son SSH, - puis le prépare (voir prepare) - status liste les serveurs de lab du projet, dans toutes les zones candidates - ssh [commande] se connecte au serveur de lab ; avec une commande, un terminal n'est demandé - que si l'entrée standard en est un - prepare installe sur le serveur ce dont labctl a besoin (qemu, genisoimage), vérifie - /dev/kvm, la virtualisation imbriquée et un CPU x86-64-v3 ; lancé aussi par up - push compile cmd/labctl pour linux/amd64 et dépose sur le serveur ~/labctl et le - répertoire de la topologie dans ~/topology/ (avec les fichiers qu'elle - référence) ; ensuite : ssh './labctl up topology/' - down supprime tous les serveurs de lab du projet, dans toutes les zones candidates, - et attend leur disparition - session [cmd] up, puis la commande distante (ou un shell), puis down quoi qu'il arrive - -``plan`` et ``status`` sont **gratuits** ; ``up`` et ``session`` **créent un serveur facturé**. - -Toujours commencer par ``plan``. Il valide la clé d'API, le quota d'offre, l'OS et les clés SSH, -et montre exactement ce qui serait commandé : - -.. code-block:: text - - $ scripts/lab-host.sh plan - !! fr-par-1 : offre EM-B420E-NVME en rupture de stock en fr-par-1 - !! fr-par-2 : offre EM-B420E-NVME en rupture de stock en fr-par-2 - !! nl-ams-1 : offre horaire EM-B420E-NVME : 0 correspondance(s) en nl-ams-1, une seule attendue - == zone : nl-ams-2 - == offre : EM-B420E-NVME (d14eef5e-3279-42db-bb57-bb2bbe6a5b28), AMD EPYC 7272, facturation hourly, stock available - == prix : 0.444 EUR HT par heure, frais de mise en service 0 EUR - == os : Debian 12 (Bookworm) (83640d93-a0b8-45ad-9c9f-30cae48380a4), utilisateur root - == clés : 2 clé(s) SSH du projet - == requête : POST /baremetal/v1/zones/nl-ams-2/servers - -**Offre et zone.** L'offre par défaut est ``EM-B420E-NVME`` (AMD EPYC 7272, 12 cœurs, 119 Gio) : -son modèle de CPU est exact et atteint **x86-64-v3**, le minimum de RHEL 10 et Rocky 10. Les offres -« Xeon … or equivalent » ne garantissent rien : ``EM-B212X-SSD`` (« E5-2620 v4 or equivalent ») a -livré le 2026-10-11 un E5-2670 de 2012, x86-64-v2, sur lequel Rocky 10 ne démarre pas. -``prepare`` refuse donc un serveur sans x86-64-v3 — dans une ``session``, il est aussitôt -supprimé. La zone n'est pas imposée : ``plan`` et ``up`` prennent la première zone de -``LAB_ZONES`` (par défaut toutes les zones Elastic Metal) où l'offre est en stock, ``SCW_DEFAULT_ZONE`` -passant en tête ; ``status`` et ``down`` couvrent toutes ces zones. Une zone dont la liste échoue -est signalée sans masquer les autres : ``status`` affiche ce qui a répondu, ``down`` supprime les -serveurs listés, et tous deux sortent en erreur ; ``up`` refuse de créer tant qu'une zone reste -inconnue. - -``session`` est la forme normale d'usage : le serveur est supprimé à la fin, que la commande -réussisse, échoue, ou que la session soit interrompue (Ctrl-C, ``TERM``, fermeture du terminal). - -.. code-block:: text - - $ scripts/lab-host.sh session 'uname -a; lscpu | grep -E "Model name|^CPU\(s\)|Virtualization"; free -g | head -2; echo "nested=$(cat /sys/module/kvm_intel/parameters/nested)"; ls -l /dev/kvm' - == création de two-lab (EM-B212X-SSD, 0.321 EUR/h HT) - == serveur 2ecc1e6a-0de8-48c0-a198-93857eee5957 créé, facturé jusqu'à 'lab-host.sh down' - == serveur 2ecc1e6a-0de8-48c0-a198-93857eee5957 : ordered, installation to_install - == serveur 2ecc1e6a-0de8-48c0-a198-93857eee5957 : ready, installation installing - … - == serveur 2ecc1e6a-0de8-48c0-a198-93857eee5957 : ready, installation completed - == SSH pas encore joignable, nouvel essai dans 20s - … - == prêt : root@ - Linux two-lab 6.1.0-53-amd64 #1 SMP PREEMPT_DYNAMIC Debian 6.1.187-1 (2026-09-07) x86_64 GNU/Linux - CPU(s): 32 - Model name: Intel(R) Xeon(R) CPU E5-2640 v3 @ 2.60GHz - … - Virtualization: VT-x - total used free shared buff/cache available - Mem: 251 1 250 0 0 249 - nested=Y - crw-rw---- 1 root kvm 10, 232 Oct 3 17:23 /dev/kvm - == session terminée (code 0), suppression du serveur - == suppression de 2ecc1e6a-0de8-48c0-a198-93857eee5957 - == aucun serveur de lab ne reste dans le projet - -Extrait de la première campagne (lignes répétées remplacées par ``…``). Compter **environ 15 minutes** entre la création et le SSH disponible : 13 min 30 à la première -campagne, suppression comprise. SSH ne répond pas tout de suite après la fin de l'installation — -environ 100 secondes la première fois — d'où l'attente intégrée à ``up``. Le code de sortie de -``session`` est celui de la commande distante. - -``up``, ``ssh`` et ``down`` séparément servent au debug interactif — et laissent la suppression -à la charge de l'utilisateur. - -Une campagne sur le lab enchaîne ces commandes depuis le Mac ; ``labctl`` s'exécute sur le serveur -(voir `Lancement des VM`_) : - -.. code-block:: text - - scripts/lab-host.sh up - scripts/lab-host.sh push test/e2e/topologies/evpn-2hv.yml - scripts/lab-host.sh ssh './labctl up topology/evpn-2hv.yml' - scripts/lab-host.sh ssh './labctl ssh hv1' # shell interactif sur hv1 - scripts/lab-host.sh ssh './labctl ssh hv1 ip -br a' # commande, code de retour propagé - scripts/lab-host.sh down - -``push`` transfère par la connexion SSH du script — mêmes options, même clé, même -``known_hosts`` que ``ssh`` : le binaire par ``cat``, le répertoire de la topologie par ``tar`` -(sans les métadonnées macOS), chacun renommé une fois complet. Tout le répertoire part, pour que -les fichiers que la topologie référence (``frr/*.conf``) arrivent avec elle. - -Topologie ---------- - -Un lab est décrit par un fichier YAML : des **nœuds** (les VM) et des **segments** (des réseaux L2 -portés par un switch). Exemple livré, ``test/e2e/topologies/evpn-2hv.yml`` : - -.. literalinclude:: ../../test/e2e/topologies/evpn-2hv.yml - :language: yaml - -Chaque nœud non-switch est relié au switch de chacun de ses segments par un câble virtuel QEMU ; -le switch met ces câbles dans un bridge et porte la passerelle du segment. - -Ce que le fichier déclare : - -``images`` - ``url`` de l'image qcow2 et ``sums`` du fichier de sommes à vérifier, tous deux en ``https://``. - -``segments`` - ``switch`` (un nœud de rôle ``switch``), ``cidr`` IPv4 entre ``/8`` et ``/30``, ``mtu`` - facultatif — 9000 par défaut, entre 1280 et 9000. Nom : 12 caractères au plus, minuscules et - chiffres, parce qu'il devient le nom d'interface dans les VM et, préfixé de ``br-``, celui du - bridge (15 caractères au plus sous Linux). - -``nodes`` - ``role`` (``switch``, ``rr`` ou ``host``), ``image``, ``cpus``, ``memory`` en Mio - (256 au moins), ``segments`` auxquels le nœud est relié, et ``addresses`` pour fixer - l'adresse d'un nœud sur un segment (``addresses: {underlay: 192.168.14.50}``). Un switch ne - déclare ni ``segments`` ni ``addresses`` : il porte ceux dont il est le ``switch``. - - Champs de rôle, facultatifs : - - * ``secondary`` — des adresses supplémentaires par segment, avec leur longueur de préfixe - (``secondary: {underlay: [169.254.0.3/28]}``), posées sur la même interface que l'adresse - principale : même L2, même MAC. Elles doivent être **hors** du CIDR du segment, pour ne - jamais croiser l'attribution automatique. Sur un switch, elles vont sur le bridge du - segment ; - * ``loopback`` — une adresse sur une interface ``dummy`` nommée ``lo1`` - (``loopback: 10.255.255.1/32``) ; - * ``frr`` — le chemin d'un ``frr.conf``, relatif au fichier de topologie : FRR est installé - au démarrage et la configuration déposée **telle quelle** (voir `Rôles`_). - * ``provision`` — le chemin d'un script, relatif au fichier de topologie, exécuté au premier - démarrage **avant** FRR ; - * ``post_provision`` — un second script, exécuté **après** FRR ; - * ``files`` — des fichiers **ou répertoires** déposés dans ``/etc/lab/files/`` avant les - scripts, sous la forme ``{: }`` (``files: {agent.yml: agent/two.yml, bin: bin}``). - Ils voyagent dans un ``files.iso`` propre au nœud (volume ``LABFILES``), attaché comme second - lecteur et recopié au premier démarrage : la taille n'est pas limitée par cloud-init, et un - binaire de plusieurs dizaines de Mio passe ; - * ``services`` — les unités systemd que ``labctl up`` vérifie actives sur le nœud. - - Les scripts reçoivent ``LAB_NODE`` (nom du nœud), ``LAB_UPLINK`` (interface de son premier - segment, qui porte la route par défaut) et ``LAB_FILES`` (``/etc/lab/files``). L'outil ne sait - rien de ce qu'ils installent : l'installation de two est une provision de - ``test/e2e/topologies/`` (voir `Rôles`_). - - ``mgmt0`` et ``lo1`` sont réservés : aucun segment ne peut porter ces noms. - -Ce que l'outil en déduit, de façon déterministe — même fichier, même plan : - -.. list-table:: - :widths: 30 70 - - * - Passerelle d'un segment - - la première adresse du CIDR, portée par le switch sur ``br-`` - * - Adresse d'un nœud - - les suivantes, **dans l'ordre de déclaration des nœuds** ; une adresse fixée par - ``addresses`` est réservée d'abord et sautée par l'attribution automatique - * - Câbles - - un par couple (segment, nœud), segments puis nœuds dans l'ordre de déclaration ; le - câble *i* utilise les ports UDP ``20000 + 2i`` (côté nœud) et ``20001 + 2i`` (côté switch) - * - MAC - - ``02:4c::::`` — préfixe localement administré, rang du nœud - sur deux octets, rang du segment, ``00`` côté nœud et ``01`` côté switch - * - Interfaces - - côté nœud, le nom du segment ; côté switch, ``p``, du rang du câble - * - SSH d'administration - - ``127.0.0.1:<2200 + rang du nœud>`` sur l'hôte du lab + test/e2e/labctl.sh plan # gratuit : offre, zone, prix + test/e2e/labctl.sh up # crée le serveur, facturé à l'heure + test/e2e/labctl.sh push test/e2e/topologies/evpn-3hv.yml + test/e2e/labctl.sh ssh './labctl up -timeout 25m topology/evpn-3hv.yml' + test/e2e/run.sh all + test/e2e/labctl.sh ssh './labctl ssh hv1' # shell interactif sur hv1 + test/e2e/labctl.sh down # supprime le serveur .. warning:: - Réordonner les nœuds ou les segments dans le fichier **change les adresses, les MAC et les - ports**. C'est assumé pour un lab ; ``labctl plan`` montre le résultat avant tout lancement. + Un serveur Elastic Metal est facturé **de sa création à sa suppression**, chaque heure + entamée comme une heure pleine. En cas de doute (session interrompue, poste mis en veille) : + ``test/e2e/labctl.sh status`` puis ``down``. **Ne jamais lancer** ``lab-host.sh`` **sous** + ``bash -x`` : la trace afficherait la clé d'API. -Limites : 1000 nœuds, 256 segments, et autant de câbles que la plage UDP le permet (22 768). +Topologies +---------- -``labctl plan`` valide le fichier et affiche le plan, sans rien lancer : +Les topologies de two vivent dans ``test/e2e/topologies/`` : ``evpn-2hv.yml`` (deux hyperviseurs) +et ``evpn-3hv.yml`` (trois, pour ``s8`` et ``s9``). Le format est celui de ``labctl`` : -.. code-block:: text - - $ go run ./cmd/labctl plan test/e2e/topologies/evpn-2hv.yml - lab evpn-2hv: nodes 4, segments 1, cables 3 - - nodes - name role image cpus memory ssh - sw1 switch debian12 2 1024 MiB 127.0.0.1:2200 - rr1 rr debian12 1 1024 MiB 127.0.0.1:2201 - hv1 host debian12 4 16384 MiB 127.0.0.1:2202 - hv2 host debian12 4 16384 MiB 127.0.0.1:2203 - - roles - name loopback secondary frr provision post_provision files services - sw1 - underlay 169.254.0.1/28 sw1.conf - - - - - rr1 lo1 10.255.255.1/32 underlay 169.254.0.3/28 rr1.conf - - - - - hv1 - - hv1.conf hypervisor.sh hypervisor-post.sh agent.yml agent.service - hv2 - - hv2.conf hypervisor.sh hypervisor-post.sh agent.yml agent.service - - segment underlay: 192.168.14.0/24, mtu 9000, switch sw1, bridge br-underlay, gateway 192.168.14.1 - node interface address mac udp switch port mac udp - rr1 underlay 192.168.14.2/24 02:4c:00:01:00:00 20000 <-> sw1 p0 02:4c:00:01:00:01 20001 - hv1 underlay 192.168.14.11/24 02:4c:00:02:00:00 20002 <-> sw1 p1 02:4c:00:02:00:01 20003 - hv2 underlay 192.168.14.12/24 02:4c:00:03:00:00 20004 <-> sw1 p2 02:4c:00:03:00:01 20005 - -Un fichier invalide est refusé avec **toutes** ses erreurs à la fois, et un code de sortie 1. Les -champs inconnus et les clés en double sont refusés aussi : - -.. code-block:: text - - $ labctl plan cassee.yml - labctl: cassee.yml: - segment underlay: rr1 is a rr, not a switch - segment underlay: cidr 10.250.0.0/31 prefix length out of range [/8, /30] - node sw1: switch carries no segment +.. literalinclude:: ../../test/e2e/topologies/evpn-2hv.yml + :language: yaml Les ASN, la loopback du route reflector, le lien ``169.254.0.0/28`` et le subnet des hyperviseurs de l'exemple sont **ceux de la production** (décision du 2026-10-04, #50) : les fichiers de @@ -350,25 +89,8 @@ reflector : .. literalinclude:: ../../test/e2e/topologies/frr/rr1.conf :language: text -Au premier démarrage, cloud-init installe FRR (``frr-stable`` de ``deb.frrouting.org``, sans les -paquets recommandés), active ``bgpd`` — et ``bfdd`` sur le switch et le route reflector —, puis -dépose le ``frr.conf`` du nœud et redémarre FRR. La mise à jour des index de paquets est réessayée -pendant cinq minutes : un nœud peut démarrer avant que le switch, par lequel il sort, n'ait posé -son NAT. - -La **clé du dépôt FRR** n'est pas téléchargée au démarrage : elle est enregistrée dans ``labctl`` -(``internal/lab/render/frrouting.gpg``) et déposée par cloud-init. Elle a été récupérée le -2026-10-04 sur ``deb.frrouting.org`` ; les empreintes de ses clés primaires sont publiées sous la -même valeur sur ``keys.openpgp.org`` et ``keyserver.ubuntu.com`` : - -.. code-block:: text - - 3D99 68AC 9AE7 BE11 6928 8DDB 1FD5 8398 95F5 7FDA David Lamparter - 4A56 C773 8BB3 F815 95A8 05D2 A832 7699 08F1 3ED1 FRRouting Debian Repository - A90F C36D 9429 4097 98E9 C2D8 74DE ED43 AB19 4DBF Jafar Al-Gharaibeh - -Une clé renouvelée par FRR fera échouer l'installation (signature inconnue) : remplacer le fichier -après avoir vérifié les nouvelles empreintes. +FRR est installé par ``labctl`` au premier démarrage (``frr-stable`` de ``deb.frrouting.org``, +clé du dépôt embarquée dans l'outil) : voir la section FRR du guide de ``labctl``. **Hyperviseurs.** Ce sont des nœuds ``host`` dont la provision installe two comme en production. ``test/e2e/topologies/provision/hypervisor.sh`` dépose ``agent.yml`` (fichier @@ -400,8 +122,8 @@ le répertoire : le lab suivant teste la release seule. .. code-block:: text test/e2e/build.sh # binaires de l'arbre courant - scripts/lab-host.sh push test/e2e/topologies/evpn-3hv.yml - scripts/lab-host.sh ssh './labctl up topology/evpn-3hv.yml' + test/e2e/labctl.sh push test/e2e/topologies/evpn-3hv.yml + test/e2e/labctl.sh ssh './labctl up topology/evpn-3hv.yml' test/e2e/build.sh --clean # retour à la release seule FRR est installé **après** la provision : il démarre sur le réseau final. Démarré @@ -411,18 +133,6 @@ avant la migration, zebra peut perdre la route par défaut quand elle passe de l démarrer tant que FRR n'est pas là : son premier démarrage par ``deploy.sh`` échoue, et ``provision/hypervisor-post.sh`` (``post_provision``) le **redémarre** une fois FRR installé. -**Un seul script de provisionnement par nœud.** cloud-init exécute ``runcmd`` comme un script -``sh`` sans ``set -e`` : seule la dernière commande compte, et un ``deploy.sh`` en échec suivi d'un -FRR installé avec succès passerait pour un démarrage réussi. Chaque nœud reçoit donc -``/usr/local/sbin/lab-provision``, en ``set -eu``, qui enchaîne ses étapes — script du switch ou -de la loopback, ``provision``, FRR, ``post_provision`` ; ``runcmd`` n'appelle -que lui, et la première étape en échec met cloud-init en erreur. - -**Ce que vérifie** ``labctl up``, une fois cloud-init terminé sans erreur : les ``services`` déclarés -par chaque nœud (``agent.service`` sur les hyperviseurs), et ``frr`` sur chaque nœud qui en a un. Ce contrôle couvre ce que -cloud-init ne voit pas — si la migration réseau échoue, ``deploy.sh`` arme un redémarrage de -secours, et la VM redémarrée ne rejoue pas ``runcmd``. - .. warning:: **Un hyperviseur du lab ne survit pas à un redémarrage.** En production, la racine est en @@ -434,7 +144,7 @@ Vérifié le 2026-10-04 sur le serveur de lab, topologie ``evpn-2hv``, release ` .. code-block:: text - $ scripts/lab-host.sh ssh './labctl up -timeout 25m topology/evpn-2hv.yml' + $ test/e2e/labctl.sh ssh './labctl up -timeout 25m topology/evpn-2hv.yml' sw1: started rr1: started hv1: started @@ -478,248 +188,6 @@ Vérifié le 2026-10-04 sur le serveur de lab, topologie ``evpn-2hv``, release ` déploie l'infrastructure (MikroTik aujourd'hui ; Cisco, Juniper, Arista… demain) : il n'a besoin que de BGP et d'EVPN, et sa configuration propre au constructeur n'a pas sa place dans le lab. -Rendu des VM ------------- - -``labctl render`` produit, pour chaque nœud, ce qu'il faut pour démarrer sa VM — sans rien lancer : - -.. code-block:: text - - $ go run ./cmd/labctl render -key ~/.config/labctl/ssh/lab_ed25519.pub test/e2e/topologies/evpn-2hv.yml - -``//`` reçoit : - -``qemu.args`` - Les arguments de ``qemu-system-x86_64``, **un par ligne** : rien à échapper, rien à - interpréter par un shell. - -``meta-data``, ``user-data``, ``network-config`` - Les trois fichiers NoCloud de cloud-init, à mettre dans une image de volume ``cidata``. - -Les chemins de la VM (``disk.qcow2``, ``seed.iso``, ``console.log``, ``qmp.sock``, ``qemu.pid``) -sont ceux du répertoire du nœud ; ``-key`` peut être répété, et accepte un fichier -``authorized_keys`` (lignes vides et commentaires ignorés). Les fichiers sont créés en ``0600``. - -Ce que contiennent les arguments QEMU d'un hyperviseur — extrait réel, côté réseau : - -.. code-block:: text - - -netdev - user,id=mgmt0,restrict=on,ipv6=off,hostfwd=tcp:127.0.0.1:2202-:22 - -device - virtio-net-pci,netdev=mgmt0,mac=02:4d:00:02:00:00,romfile= - -netdev - dgram,id=underlay,local.type=inet,local.host=127.0.0.1,local.port=20002,remote.type=inet,remote.host=127.0.0.1,remote.port=20003 - -device - virtio-net-pci,netdev=underlay,mac=02:4c:00:02:00:00,host_mtu=9000,romfile= - -Les choix qui s'y lisent : - -* **machine** ``q35``, ``-accel kvm -cpu host`` — le KVM imbriqué des hyperviseurs du lab en - dépend ; ``-nodefaults`` pour qu'aucun périphérique implicite ne s'ajoute ; -* **administration** (``mgmt0``) : le NAT de QEMU, MAC ``02:4d:::00:00``, SSH redirigé - sur la boucle locale de l'hôte. ``restrict=on`` pour tous les nœuds **sauf le switch** : un - nœud isolé ne joint ni l'hôte ni l'extérieur par là, seule la redirection SSH passe. - ``ipv6=off`` partout (voir plus bas) ; -* **câbles** : ``dgram`` sur ``127.0.0.1``, les deux extrémités d'un câble se répondent - (port local de l'une = port distant de l'autre), ``host_mtu`` annonce le MTU du segment au - guest ; -* ``romfile=`` vide sur toutes les cartes : pas de ROM de démarrage réseau, donc pas de repli - sur un démarrage PXE si le firmware ne trouve pas le disque. Pendant les essais de #50, une VM - restée bloquée sans rien écrire sur sa console, CPU au repos, avait toutes les apparences de - ce repli ; la cause n'a pas été isolée, l'option est une précaution. - -Ce que fait cloud-init : - -* **toutes les VM** : interfaces nommées d'après leur MAC (``mgmt0``, nom du segment, ``p``), - ``dhcp4: false`` partout, ``mgmt0`` en ``10.0.2.15/24`` **sans passerelle** ; connexion SSH par - clé seulement, utilisateur ``debian``, ``root`` désactivé, mot de passe refusé ; -* **un nœud** : adresse sur chaque segment, MTU du segment, route par défaut et DNS - (``1.1.1.1``, ``8.8.8.8``) sur son **premier** segment — la sortie Internet passe par le - switch ; -* **le switch** : route par défaut par ``mgmt0`` ; un service ``lab-switch`` crée un bridge - ``br-`` par segment (STP désactivé, MTU du segment), y branche ses ports, porte la - passerelle, active le routage et masque (NAT nftables) les segments vers ``mgmt0``. Le - service est rejoué à chaque démarrage. - -Vérifié sur de vraies VM -~~~~~~~~~~~~~~~~~~~~~~~~ - -Le switch et le route reflector n'ont pas besoin de KVM imbriqué : ``sw1`` et ``rr1`` de -l'exemple ont été démarrés **sur un Mac**, en émulation (TCG), avec Debian 12 ``generic`` et -les fichiers produits par ``labctl render``. - -.. list-table:: - :header-rows: 1 - :widths: 60 40 - - * - Vérification - - Résultat - * - interfaces nommées et adressées, bridge ``br-underlay`` en ``10.250.0.1/24`` - - conforme - * - service ``lab-switch`` actif, y compris après redémarrage - - conforme - * - ``ping -M do -s 8972`` de ``rr1`` vers le switch (MTU 9000, sans fragmentation) - - passe - * - ``ping -M do -s 8973`` (MTU 9001) - - refusé : ``message too long, mtu=9000`` - * - Internet depuis ``rr1`` en IPv4 - - passe, par ``10.250.0.1`` - * - ``rr1`` vers un service TCP de l'hôte par ``mgmt0`` — le switch, témoin, y parvient - - bloqué - * - ``rr1`` vers Internet par ``mgmt0`` - - bloqué - -Un défaut trouvé par cet essai, et corrigé : sans ``ipv6=off``, le NAT de QEMU annonce un -préfixe IPv6 et ``mgmt0`` reçoit une **route IPv6 par défaut** — vers une impasse, puisque -``restrict=on`` bloque tout. Pas de fuite, mais chaque programme qui tente l'IPv6 d'abord (le DNS -renvoie d'abord des adresses IPv6) attend un délai avant de se rabattre sur l'IPv4. - -.. note:: - - Un ``ping`` vers ``10.0.2.2`` n'est pas un test d'isolation : c'est la passerelle virtuelle de - QEMU qui répond elle-même, ``restrict=on`` ou non. Seule une connexion vers un vrai service de - l'hôte, avec un témoin qui y parvient, le prouve. - -Reste à vérifier sur le serveur de lab : les hyperviseurs, qui exigent KVM imbriqué. - -Lancement des VM ----------------- - -``labctl`` s'exécute **sur le serveur de lab**. Il garde l'état du lab dans un répertoire -(``-run``, par défaut ``~/lab-run``) : ``status``, ``down`` et ``ssh`` n'ont donc pas besoin de la -topologie. - -.. code-block:: text - - lab up [-run dir] [-cache dir] [-timeout 20m] - lab status [-run dir] - lab down [-run dir] - lab ssh [-run dir] [commande…] - -``labctl up`` - 1. refuse de continuer si un lab tourne déjà dans le répertoire ; - 2. télécharge chaque image dans le cache (``-cache``, par défaut ``~/.cache/labctl``) et la - vérifie contre ``SHA512SUMS`` ; une image déjà présente et toujours conforme n'est pas - retéléchargée, la liste des sommes est relue à chaque fois ; - 3. génère une paire de clés SSH dans le répertoire du lab, si elle n'existe pas encore ; - 4. pour chaque nœud : fichiers de ``labctl render``, disque **neuf** en overlay qcow2 sur - l'image (``qemu-img create -b``, 20 Gio annoncés), image ``cidata`` (``genisoimage``) ; - 5. démarre les QEMU, **switchs d'abord**, détachés (``-daemonize``) : ils survivent à la - session SSH qui les a lancés ; - 6. attend sur chaque nœud la fin de cloud-init (``cloud-init status --wait`` par SSH), - jusqu'au délai ``-timeout``. - - La topologie est copiée dans ``/topology.yml``. Un échec laisse les nœuds démarrés en - place : ``labctl status``, puis ``labctl down``. - -``labctl status`` - Pour chaque nœud : rôle, état du processus QEMU, PID, port SSH sur la boucle locale. - -``labctl down`` - Arrête chaque QEMU par ``SIGTERM``, puis ``SIGKILL`` au bout de 30 s. Les disques sont - conservés jusqu'au prochain ``up``, qui les recrée. - -``labctl ssh`` - Ouvre un shell sur un nœud, ou y exécute une commande, avec la clé générée par ``up``. ``labctl`` - cède la place à ``ssh``, dont le code de retour est donc celui de la commande. Un terminal - n'est demandé (``-t``) que si l'entrée de ``labctl`` en est un : depuis un script, ni - pseudo-terminal ni ``\r\n`` dans la sortie. - - Comme ``ssh``, ``labctl ssh`` recolle ses arguments par des espaces et les confie à un shell - distant — et depuis le Mac, il y en a **deux** : celui du serveur, puis celui de la VM. - Une commande qui contient elle-même des guillemets se passe en une seule chaîne : - - .. code-block:: text - - $ echo | scripts/lab-host.sh ssh './labctl ssh hv1 sh -c "exit 42"'; echo "rc 42=$?" - rc 42=0 - $ echo | scripts/lab-host.sh ssh "./labctl ssh hv1 'sh -c \"exit 42\"'"; echo "rc 42=$?" - rc 42=42 - - Dans le premier cas, la VM reçoit ``sh -c exit 42`` : ``exit`` sans argument, ``42`` en - ``$0``. Pour plus d'une commande, passer un script sur l'entrée standard : - ``scripts/lab-host.sh ssh "./labctl ssh hv1 'sudo bash -s'" < script.sh``. - -Un processus n'est tenu pour celui d'un nœud que si son PID, lu dans ``qemu.pid``, désigne un -processus vivant dont la ligne de commande (``/proc//cmdline``) contient ``-name ``. -Un PID réutilisé par un autre programme n'est donc jamais signalé. - -.. warning:: - - Le cache range une image sous son nom de fichier, et l'URL de Debian est ``latest`` : une - nouvelle publication remplace le fichier, et les overlays existants pointeraient sur une - base différente. ``up`` recrée toujours les disques, ce qui suffit avec un lab par serveur ; - **ne pas relancer un QEMU à la main** à partir d'un ``qemu.args`` après un ``up`` ultérieur. - -Une campagne réelle, de la création du serveur à la première commande sur une VM — sorties du -2026-10-04 : - -.. code-block:: text - - $ scripts/lab-host.sh up - == création de two-lab (EM-B212X-SSD, 0.321 EUR/h HT) - … - == préparation du serveur : qemu, genisoimage, KVM imbriqué - … - qemu QEMU emulator version 7.2.22 (Debian 1:7.2+dfsg-7+deb12u18+b3), nested=Y - == prêt : root@ - $ scripts/lab-host.sh push test/e2e/topologies/evpn-2hv.yml - == compilation de lab (linux/amd64) - == déposés sur le serveur : ~/lab, ~/evpn-2hv.yml — ensuite : lab-host.sh ssh './lab up evpn-2hv.yml' - $ scripts/lab-host.sh ssh './labctl up evpn-2hv.yml' - sw1: started - rr1: started - hv1: started - hv2: started - sw1: ready - rr1: ready - hv1: ready - hv2: ready - $ scripts/lab-host.sh ssh './labctl status' - node role state pid ssh - sw1 switch running 5158 127.0.0.1:2200 - rr1 rr running 5171 127.0.0.1:2201 - hv1 hypervisor running 5182 127.0.0.1:2202 - hv2 hypervisor running 5196 127.0.0.1:2203 - -``labctl up`` a pris **49 secondes**, téléchargement et vérification de l'image (427 Mio) compris ; -l'essentiel du temps d'une campagne est la livraison du serveur (environ 25 minutes avec -``prepare``). - -Vérifié sur le serveur de lab -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Le 2026-10-04, sur un Xeon E5-2640 v3, Debian 12 et QEMU 7.2 sur le serveur, topologie -``evpn-2hv`` : - -.. list-table:: - :header-rows: 1 - :widths: 60 40 - - * - Vérification - - Résultat - * - ``ping -M do -s 8972`` de hv1 à hv2 à travers le switch - - passe - * - ``ping -M do -s 8973`` - - refusé : ``message too long, mtu=9000`` - * - sortie Internet de hv1 - - par ``10.250.0.1`` (le switch), HTTPS 200 ; aucune route IPv6 globale - * - hv1 vers un service TCP du serveur par ``mgmt0`` — sw1, témoin, y parvient (200) - - refusé - * - hv1 vers Internet par ``mgmt0``, route forcée via ``10.0.2.2`` — sw1 y parvient - - refusé - * - ``/dev/kvm`` et ``nested`` dans hv1 - - présent, ``Y`` - * - racine de hv1 (overlay de 20 Gio) - - 20 Go : ``growpart`` agrandit la partition au premier démarrage - * - code de retour à travers ``lab-host.sh ssh`` et ``labctl ssh``, sans terminal - - propagé jusqu'au Mac - * - ``scripts/lab-host.sh ssh './labctl ssh hv1'`` depuis un terminal - - shell interactif - * - ``labctl down`` puis ``labctl up`` d'une autre topologie - - conforme - Scénarios --------- @@ -906,14 +374,14 @@ Les VM sont accessibles depuis le netns de leur VPC, sur l'hyperviseur, avec l'u .. code-block:: text - scripts/lab-host.sh ssh "./labctl ssh hv1 'sudo ip netns exec vp-s4 ssh -i /root/.ssh/lab-vm syonad@10.240.1.10'" + test/e2e/labctl.sh ssh "./labctl ssh hv1 'sudo ip netns exec vp-s4 ssh -i /root/.ssh/lab-vm syonad@10.240.1.10'" Écrire un scénario ~~~~~~~~~~~~~~~~~~ Le lab sert à qualifier des comportements qui ne se voient qu'à plusieurs hyperviseurs — la campagne L3VNI de `#41 `_ en est le prochain exemple. Un -scénario est un fichier ``test/e2e/scenarios/-.sh``, exécuté par ``scenario.sh`` sur le +scénario est un fichier ``test/e2e/scenarios/-.sh``, exécuté par ``run.sh`` sur le Mac ; il envoie des blocs aux nœuds : .. code-block:: bash @@ -945,105 +413,30 @@ Les règles qui ont fait leurs preuves en E5 : ``all`` les enchaîne sur le même lab ; un scénario qui dépend d'un autre le vérifie en tête (``check "prérequis : …"``) ; * variables vers un nœud : ``on hv1 NOM=valeur <<'NODE'`` (valeurs échappées par - ``scenario.sh``) ; + ``run.sh``) ; * ``bash test/e2e/run_test.sh`` vérifie la syntaxe de chaque bloc réellement envoyé — à lancer avant toute session. -Facturation ------------ - -.. warning:: - - Un serveur Elastic Metal est facturé **de sa création à sa suppression, éteint compris**. - Éteindre ne suffit pas : il faut supprimer. La granularité n'est pas documentée par Scaleway — - compter chaque heure entamée comme une heure pleine. - -Ce que le script garantit : - -* il ne commande **jamais** d'offre mensuelle : il exige une seule offre au nom demandé, en - facturation horaire, en stock et sans frais de mise en service, sinon il refuse avant toute - création. La CLI ``scw`` n'est pas utilisée pour cette raison : son ``server create type=…`` - choisit l'offre par son seul nom et peut tomber sur la mensuelle, qui engage un mois ; -* il refuse de créer un second serveur si un serveur de lab existe déjà ; -* ``down`` agit sur **tous** les serveurs portant le tag ``labctl`` dans le projet, et - ``session`` y ajoute l'identifiant reçu à la création : un serveur créé juste avant une - interruption est rattrapé ; -* une suppression refusée pendant la livraison ou l'installation est réessayée tant qu'elle dure, - dans la limite du délai d'installation augmenté du délai de suppression ; -* le serveur n'est déclaré supprimé qu'au 404 de l'API, jamais sur une erreur passagère ; -* un échec de suppression se termine par ``SERVEUR(S) DE LAB TOUJOURS FACTURÉ(S)`` et un code - d'erreur. - -Ce qu'il ne peut pas garantir : un ``SIGKILL``, une coupure de courant ou une mise en veille du -poste qui lance la session. En cas de doute, toujours : - -.. code-block:: bash - - scripts/lab-host.sh status - scripts/lab-host.sh down - -Diagnostic ----------- - -``aucune clé SSH active dans le projet`` - Aucune clé SSH n'est enregistrée dans le projet de lab. En ajouter une dans la console (projet - → Clés SSH). - -``offre horaire EM-B212X-SSD : 0 correspondance(s)`` - L'offre n'existe pas dans la zone en facturation horaire. Vérifier ``SCW_DEFAULT_ZONE``. - -``création incertaine`` - La création a échoué ou n'a pas rendu d'identifiant. Le serveur a pu être créé malgré tout — - cas typique : le quota (identité non validée), ou une réponse perdue. Le script indique s'il - voit un serveur de lab ; dans tous les cas, lancer ``status`` puis ``down``. - -``SSH injoignable`` - L'installation est terminée mais SSH ne répond pas après 10 minutes. Avec une clé matérielle - (Yubikey), chaque connexion demande un PIN ou un toucher : utiliser la clé dédiée du lab. Le - serveur est toujours facturé : ``down``. - -``SERVEUR(S) DE LAB TOUJOURS FACTURÉ(S)`` - La suppression n'a pas abouti dans les délais. Relancer ``down`` ; si l'erreur persiste, - supprimer depuis la console Scaleway. - -``HTTP 403 insufficient permissions`` - La clé d'API est authentifiée mais n'a pas le droit demandé — en général la lecture des clés - SSH du projet. Compléter la politique de la clé, limitée au projet. - Sécurité -------- -* La clé secrète n'apparaît ni dans les arguments des processus (elle est passée à ``curl`` par - un descripteur de fichier), ni dans les journaux, ni dans l'environnement de ``ssh``. -* **Ne jamais lancer le script sous** ``bash -x`` : la trace afficherait la clé. -* Le serveur n'expose que SSH, par clé. Le lab n'a aucune donnée personnelle ni secret de - production. -* Une clé secrète qui a circulé ailleurs que dans ``scaleway.env`` (conversation, terminal - partagé, capture d'écran) se régénère. -* **Clé SSH des VM** : générée par ``labctl up`` sur le serveur, c'est la seule clé autorisée dans - les VM. Elle ne quitte jamais le serveur, n'ouvre que les VM du lab — qui n'écoutent qu'en - boucle locale — et disparaît avec lui. La clé publique du Mac n'est jamais envoyée aux VM. -* **Clés d'hôte des VM non vérifiées** par ``labctl ssh`` (``known_hosts`` jetable) : elles changent - à chaque ``up``. Acceptable uniquement parce que la connexion reste sur la boucle locale d'un - serveur auquel on s'est authentifié. +Propre à two — celle de l'outil (clé d'API, clés SSH des VM, images) est décrite dans le guide de +``labctl`` : + +* ``labctl`` et ``lab-host.sh`` sont vérifiés contre des sommes épinglées dans + ``test/e2e/labctl.sh``, pas contre le ``SHA256SUMS`` téléchargé avec eux. * **Code exécuté sans épinglage par** ``deploy.sh`` : la bibliothèque ``shflags`` est récupérée par ``curl`` sur la branche ``main`` d'un autre dépôt (``H6N/tools``) et exécutée par ``eval``, sans vérification d'intégrité — dans le lab comme en production. Les artefacts de la release sont, eux, vérifiés contre ``SHA256SUMS``. -* **Image** : ``SHA512SUMS`` vient de la même origine que l'image, en HTTPS. La vérification - protège contre la corruption, pas contre une origine compromise ; la signature GPG de Debian - (``SHA512SUMS.sign``) n'est pas encore vérifiée. +* Le lab n'a aucune donnée personnelle ni secret de production. Tests ----- .. code-block:: bash - bash scripts/lab-host_test.sh bash test/e2e/run_test.sh - go test ./internal/lab/... ./cmd/labctl/ -Environ une minute et demie, sans réseau : la suite remplace ``curl`` par une fausse API Scaleway -qui se place dans le pire cas (offre mensuelle listée avant l'horaire, serveurs d'autres projets, -suppressions refusées, erreurs 503, serveur qui tarde à disparaître) et ``ssh`` par un faux client. -Elle tourne sous bash 5 comme sous le bash 3.2 de macOS. +Sans réseau : vérifie la syntaxe de chaque bloc réellement envoyé aux nœuds par les scénarios et +les fonctions de ``test/e2e/lib/node.sh``. Les tests de l'outil sont dans le dépôt ``labctl``. diff --git a/go.mod b/go.mod index 9bcc86b..0e59eb9 100644 --- a/go.mod +++ b/go.mod @@ -13,7 +13,6 @@ require ( github.com/spf13/viper v1.21.0 github.com/vishvananda/netlink v1.3.1 github.com/vishvananda/netns v0.0.5 - go.yaml.in/yaml/v3 v3.0.4 golang.org/x/sys v0.45.0 ) @@ -47,6 +46,7 @@ require ( go.opentelemetry.io/otel/metric v1.37.0 // indirect go.opentelemetry.io/otel/trace v1.37.0 // indirect go.yaml.in/yaml/v2 v2.4.2 // indirect + go.yaml.in/yaml/v3 v3.0.4 // indirect golang.org/x/net v0.55.0 // indirect golang.org/x/text v0.37.0 // indirect google.golang.org/protobuf v1.36.8 // indirect diff --git a/internal/lab/machine/machine.go b/internal/lab/machine/machine.go deleted file mode 100644 index a88c386..0000000 --- a/internal/lab/machine/machine.go +++ /dev/null @@ -1,290 +0,0 @@ -package machine - -import ( - "bytes" - "context" - "errors" - "fmt" - "io" - "os" - "path/filepath" - "strconv" - "strings" - "syscall" - "text/tabwriter" - "time" - - "git.g3e.fr/syonad/two/internal/lab/provision" - "git.g3e.fr/syonad/two/internal/lab/render" - "git.g3e.fr/syonad/two/internal/lab/topology" -) - -const ( - User = "debian" - - sshUnreachable = 255 - cloudInitRecoverable = 2 -) - -type Lab struct { - Plan *topology.Plan - RunDir string - ProcDir string - Runner provision.Runner - Poll time.Duration - Stop time.Duration - Out io.Writer - - signal func(pid int, sig syscall.Signal) error -} - -func (l Lab) node(name string) (topology.NodePlan, error) { - for _, n := range l.Plan.Nodes { - if n.Name == name { - return n, nil - } - } - return topology.NodePlan{}, fmt.Errorf("node %q is not in lab %s", name, l.Plan.Name) -} - -func (l Lab) pidFile(name string) string { - return filepath.Join(l.RunDir, name, render.PIDFile) -} - -func (l Lab) PID(name string) (int, error) { - data, err := os.ReadFile(l.pidFile(name)) - if errors.Is(err, os.ErrNotExist) { - return 0, nil - } - if err != nil { - return 0, err - } - pid, err := strconv.Atoi(strings.TrimSpace(string(data))) - if err != nil || pid <= 0 { - return 0, fmt.Errorf("%s: not a pid: %q", l.pidFile(name), data) - } - if !l.runs(pid, name) { - return 0, nil - } - return pid, nil -} - -func (l Lab) runs(pid int, name string) bool { - if err := syscall.Kill(pid, 0); err != nil && !errors.Is(err, syscall.EPERM) { - return false - } - cmdline, err := os.ReadFile(filepath.Join(l.ProcDir, strconv.Itoa(pid), "cmdline")) - if err != nil { - return false - } - return bytes.Contains(cmdline, []byte("\x00-name\x00"+name+"\x00")) -} - -func (l Lab) Running() ([]string, error) { - var running []string - for _, n := range l.Plan.Nodes { - pid, err := l.PID(n.Name) - if err != nil { - return nil, err - } - if pid != 0 { - running = append(running, n.Name) - } - } - return running, nil -} - -func (l Lab) Up(ctx context.Context, fetcher provision.Fetcher, timeout time.Duration) error { - running, err := l.Running() - if err != nil { - return err - } - if len(running) > 0 { - return fmt.Errorf("lab %s is already running (%s): 'lab down' first", l.Plan.Name, strings.Join(running, ", ")) - } - - nodes, err := provision.Prepare(ctx, l.Plan, provision.Options{RunDir: l.RunDir, Fetcher: fetcher, Runner: l.Runner}) - if err != nil { - return err - } - for _, n := range switchesFirst(l.Plan, nodes) { - if err := os.Remove(l.pidFile(n.Name)); err != nil && !errors.Is(err, os.ErrNotExist) { - return err - } - if err := l.Runner.Run(ctx, render.QEMUBinary, append(n.QEMU, "-daemonize")...); err != nil { - return fmt.Errorf("node %s: %w", n.Name, err) - } - fmt.Fprintf(l.Out, "%s: started\n", n.Name) - } - - ctx, cancel := context.WithTimeout(ctx, timeout) - defer cancel() - var errs []error - for _, n := range l.Plan.Nodes { - if err := l.waitReady(ctx, n); err != nil { - errs = append(errs, fmt.Errorf("node %s: %w", n.Name, err)) - continue - } - if err := l.checkServices(ctx, n); err != nil { - errs = append(errs, fmt.Errorf("node %s: %w", n.Name, err)) - continue - } - fmt.Fprintf(l.Out, "%s: ready\n", n.Name) - } - return errors.Join(errs...) -} - -func switchesFirst(p *topology.Plan, nodes []render.Node) []render.Node { - var first, rest []render.Node - for i, n := range nodes { - if p.Nodes[i].Role == topology.RoleSwitch { - first = append(first, n) - } else { - rest = append(rest, n) - } - } - return append(first, rest...) -} - -func (l Lab) waitReady(ctx context.Context, n topology.NodePlan) error { - args := l.sshArgs(n, true, []string{"cloud-init", "status", "--wait"}) - for { - err := l.Runner.Run(ctx, "ssh", args...) - switch code := exitCode(err); { - case err == nil: - return nil - case code == cloudInitRecoverable: - fmt.Fprintf(l.Out, "%s: cloud-init finished with recoverable errors: %v\n", n.Name, err) - return nil - case code != sshUnreachable: - return fmt.Errorf("cloud-init failed: %w", err) - } - select { - case <-ctx.Done(): - return fmt.Errorf("not reachable over ssh: %w", ctx.Err()) - case <-time.After(l.Poll): - } - } -} - -func services(n topology.NodePlan) []string { - units := append([]string(nil), n.Services...) - if n.FRR != "" { - units = append(units, "frr.service") - } - return units -} - -func (l Lab) checkServices(ctx context.Context, n topology.NodePlan) error { - for _, unit := range services(n) { - if err := l.Runner.Run(ctx, "ssh", l.sshArgs(n, true, []string{"systemctl", "is-active", "--quiet", unit})...); err != nil { - return fmt.Errorf("%s is not active: %w", unit, err) - } - } - return nil -} - -func exitCode(err error) int { - var coded interface{ ExitCode() int } - if errors.As(err, &coded) { - return coded.ExitCode() - } - return -1 -} - -func (l Lab) sshArgs(n topology.NodePlan, batch bool, command []string) []string { - args := []string{ - "-i", filepath.Join(l.RunDir, provision.KeyFile), - "-o", "IdentitiesOnly=yes", - "-o", "IdentityAgent=none", - "-o", "StrictHostKeyChecking=no", - "-o", "UserKnownHostsFile=/dev/null", - "-o", "LogLevel=ERROR", - "-p", strconv.Itoa(n.SSHPort), - } - if batch { - args = append(args, "-o", "BatchMode=yes", "-o", "ConnectTimeout=5") - } - args = append(args, User+"@127.0.0.1") - return append(args, command...) -} - -func (l Lab) SSH(name string, terminal bool, command []string) ([]string, error) { - n, err := l.node(name) - if err != nil { - return nil, err - } - args := []string{"ssh"} - if terminal && len(command) > 0 { - args = append(args, "-t") - } - return append(args, l.sshArgs(n, false, command)...), nil -} - -func (l Lab) Status(w io.Writer) error { - tw := tabwriter.NewWriter(w, 0, 0, 2, ' ', 0) - fmt.Fprintf(tw, "node\trole\tstate\tpid\tssh\n") - for _, n := range l.Plan.Nodes { - pid, err := l.PID(n.Name) - if err != nil { - return err - } - state, shown := "stopped", "-" - if pid != 0 { - state, shown = "running", strconv.Itoa(pid) - } - fmt.Fprintf(tw, "%s\t%s\t%s\t%s\t127.0.0.1:%d\n", n.Name, n.Role, state, shown, n.SSHPort) - } - return tw.Flush() -} - -func (l Lab) Down(ctx context.Context) error { - var errs []error - for _, n := range l.Plan.Nodes { - pid, err := l.PID(n.Name) - if err != nil { - errs = append(errs, err) - continue - } - if pid == 0 { - continue - } - if err := l.stop(ctx, n.Name, pid); err != nil { - errs = append(errs, fmt.Errorf("node %s: %w", n.Name, err)) - continue - } - if err := os.Remove(l.pidFile(n.Name)); err != nil && !errors.Is(err, os.ErrNotExist) { - errs = append(errs, err) - continue - } - fmt.Fprintf(l.Out, "%s: stopped\n", n.Name) - } - return errors.Join(errs...) -} - -func (l Lab) stop(ctx context.Context, name string, pid int) error { - if pid <= 0 { - return fmt.Errorf("refusing to signal pid %d", pid) - } - send := l.signal - if send == nil { - send = syscall.Kill - } - for _, sig := range []syscall.Signal{syscall.SIGTERM, syscall.SIGKILL} { - if err := send(pid, sig); err != nil && !errors.Is(err, syscall.ESRCH) { - return err - } - deadline := time.Now().Add(l.Stop) - for l.runs(pid, name) && time.Now().Before(deadline) { - select { - case <-ctx.Done(): - return ctx.Err() - case <-time.After(l.Poll): - } - } - if !l.runs(pid, name) { - return nil - } - } - return fmt.Errorf("pid %d still running after SIGKILL", pid) -} diff --git a/internal/lab/machine/machine_test.go b/internal/lab/machine/machine_test.go deleted file mode 100644 index 651b319..0000000 --- a/internal/lab/machine/machine_test.go +++ /dev/null @@ -1,588 +0,0 @@ -package machine - -import ( - "bytes" - "context" - "crypto/sha512" - "encoding/hex" - "errors" - "fmt" - "net/http" - "net/http/httptest" - "os" - "os/exec" - "path/filepath" - "reflect" - "strconv" - "strings" - "sync" - "syscall" - "testing" - "time" - - "git.g3e.fr/syonad/two/internal/lab/provision" - "git.g3e.fr/syonad/two/internal/lab/topology" -) - -const labKey = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFG/JMmjfko96WkJV8DiL6rip/H/q/R++y8s27Z+Cj6O labctl" - -type exitErr int - -func (e exitErr) Error() string { return "exit status " + strconv.Itoa(int(e)) } -func (e exitErr) ExitCode() int { return int(e) } - -type fakeRunner struct { - mu sync.Mutex - calls [][]string - fail string - ssh map[string][]error - always map[string]error - inactive string -} - -func (f *fakeRunner) Run(_ context.Context, name string, args ...string) error { - f.mu.Lock() - defer f.mu.Unlock() - f.calls = append(f.calls, append([]string{name}, args...)) - if name == f.fail { - return errors.New(name + " failed") - } - switch name { - case "ssh-keygen": - private := args[len(args)-1] - if err := os.WriteFile(private, []byte("private"), 0o600); err != nil { - return err - } - return os.WriteFile(private+".pub", []byte(labKey+"\n"), 0o644) - case "ssh": - port := args[indexOf(args, "-p")+1] - if args[len(args)-1] == f.inactive { - return exitErr(3) - } - answers := f.ssh[port] - if len(answers) == 0 { - return f.always[port] - } - f.ssh[port] = answers[1:] - return answers[0] - } - return nil -} - -func (f *fakeRunner) commands(name string) [][]string { - f.mu.Lock() - defer f.mu.Unlock() - var out [][]string - for _, c := range f.calls { - if c[0] == name { - out = append(out, c) - } - } - return out -} - -func indexOf(list []string, value string) int { - for i, v := range list { - if v == value { - return i - } - } - return -1 -} - -func mirror(t *testing.T) (*httptest.Server, string) { - t.Helper() - content := []byte("qcow2 image") - h := sha512.Sum512(content) - server := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - if strings.HasSuffix(r.URL.Path, "SHA512SUMS") { - fmt.Fprintf(w, "%s deb.qcow2\n", hex.EncodeToString(h[:])) - return - } - w.Write(content) - })) - t.Cleanup(server.Close) - return server, server.URL -} - -func labPlan(t *testing.T, base, nodes string) *topology.Plan { - t.Helper() - doc := `name: evpn-2hv -images: - deb: - url: ` + base + `/deb.qcow2 - sums: ` + base + `/SHA512SUMS -segments: - underlay: { switch: sw1, cidr: 10.250.0.0/24, mtu: 9000 } -nodes: -` + nodes - topo, err := topology.Parse([]byte(doc)) - if err != nil { - t.Fatalf("Parse: %v", err) - } - p, err := topology.Compute(topo) - if err != nil { - t.Fatalf("Compute: %v", err) - } - return p -} - -const switchLast = ` rr1: { role: rr, image: deb, cpus: 1, memory: 1024, segments: [underlay] } - hv1: { role: host, image: deb, cpus: 4, memory: 16384, segments: [underlay], services: [agent.service] } - sw1: { role: switch, image: deb, cpus: 2, memory: 1024 } -` - -type fixture struct { - lab Lab - runner *fakeRunner - out *bytes.Buffer - fetcher provision.Fetcher -} - -func newFixture(t *testing.T, nodes string) *fixture { - t.Helper() - server, base := mirror(t) - root := t.TempDir() - runner := &fakeRunner{ssh: map[string][]error{}, always: map[string]error{}} - out := &bytes.Buffer{} - return &fixture{ - lab: Lab{ - Plan: labPlan(t, base, nodes), - RunDir: filepath.Join(root, "run"), - ProcDir: filepath.Join(root, "proc"), - Runner: runner, - Poll: time.Millisecond, - Stop: 500 * time.Millisecond, - Out: out, - }, - runner: runner, - out: out, - fetcher: provision.Fetcher{Client: server.Client(), CacheDir: filepath.Join(root, "cache")}, - } -} - -func (f *fixture) process(t *testing.T, node, script string, cmdline ...string) int { - t.Helper() - cmd := exec.Command("sh", "-c", script) - if err := cmd.Start(); err != nil { - t.Fatal(err) - } - done := make(chan struct{}) - go func() { cmd.Wait(); close(done) }() - t.Cleanup(func() { - cmd.Process.Kill() - <-done - }) - pid := cmd.Process.Pid - proc := filepath.Join(f.lab.ProcDir, strconv.Itoa(pid)) - if err := os.MkdirAll(proc, 0o755); err != nil { - t.Fatal(err) - } - if err := os.WriteFile(filepath.Join(proc, "cmdline"), []byte(strings.Join(cmdline, "\x00")+"\x00"), 0o644); err != nil { - t.Fatal(err) - } - f.pidFile(t, node, strconv.Itoa(pid)+"\n") - return pid -} - -func (f *fixture) pidFile(t *testing.T, node, content string) { - t.Helper() - dir := filepath.Join(f.lab.RunDir, node) - if err := os.MkdirAll(dir, 0o700); err != nil { - t.Fatal(err) - } - if err := os.WriteFile(filepath.Join(dir, "qemu.pid"), []byte(content), 0o600); err != nil { - t.Fatal(err) - } -} - -func qemu(node string) []string { - return []string{"qemu-system-x86_64", "-name", node, "-machine", "q35"} -} - -func alive(pid int) bool { - err := syscall.Kill(pid, 0) - return err == nil || errors.Is(err, syscall.EPERM) -} - -func waitDead(t *testing.T, pid int) { - t.Helper() - deadline := time.Now().Add(2 * time.Second) - for alive(pid) && time.Now().Before(deadline) { - time.Sleep(5 * time.Millisecond) - } - if alive(pid) { - t.Errorf("pid %d is still alive", pid) - } -} - -func TestPID_NoPidFileMeansStopped(t *testing.T) { - f := newFixture(t, switchLast) - if pid, err := f.lab.PID("hv1"); pid != 0 || err != nil { - t.Errorf("PID = %d, %v", pid, err) - } -} - -func TestPID_RefusesACorruptedPidFile(t *testing.T) { - for _, content := range []string{"", "abc", "0", "-12"} { - f := newFixture(t, switchLast) - f.pidFile(t, "hv1", content) - if _, err := f.lab.PID("hv1"); err == nil || !strings.Contains(err.Error(), "not a pid") { - t.Errorf("pid file %q: error = %v", content, err) - } - } -} - -func TestPID_RecognisesTheNodeProcess(t *testing.T) { - f := newFixture(t, switchLast) - want := f.process(t, "hv1", "sleep 30", qemu("hv1")...) - if pid, err := f.lab.PID("hv1"); pid != want || err != nil { - t.Errorf("PID = %d, %v, want %d", pid, err, want) - } -} - -func TestPID_IgnoresAPidReusedByAnotherProcess(t *testing.T) { - cases := map[string][]string{ - "another program": {"/usr/sbin/sshd", "-D"}, - "another node": qemu("hv10"), - "name as a value": {"qemu-system-x86_64", "-serial", "-name", "-name", "hv2"}, - } - for name, cmdline := range cases { - t.Run(name, func(t *testing.T) { - f := newFixture(t, switchLast) - f.process(t, "hv1", "sleep 30", cmdline...) - if pid, err := f.lab.PID("hv1"); pid != 0 || err != nil { - t.Errorf("PID = %d, %v, want 0", pid, err) - } - }) - } -} - -func TestPID_IgnoresADeadProcess(t *testing.T) { - f := newFixture(t, switchLast) - pid := f.process(t, "hv1", "exit 0", qemu("hv1")...) - waitDead(t, pid) - if got, err := f.lab.PID("hv1"); got != 0 || err != nil { - t.Errorf("PID = %d, %v, want 0", got, err) - } -} - -func TestStatus(t *testing.T) { - f := newFixture(t, switchLast) - pid := strconv.Itoa(f.process(t, "hv1", "sleep 30", qemu("hv1")...)) - var out bytes.Buffer - if err := f.lab.Status(&out); err != nil { - t.Fatal(err) - } - w := len(pid) - if w < 3 { - w = 3 - } - want := fmt.Sprintf("node role state %-*s ssh\n", w, "pid") + - fmt.Sprintf("rr1 rr stopped %-*s 127.0.0.1:2200\n", w, "-") + - fmt.Sprintf("hv1 host running %-*s 127.0.0.1:2201\n", w, pid) + - fmt.Sprintf("sw1 switch stopped %-*s 127.0.0.1:2202\n", w, "-") - if out.String() != want { - t.Errorf("status:\n%s\nwant:\n%s", out.String(), want) - } -} - -func TestDown_StopsWithSIGTERM(t *testing.T) { - f := newFixture(t, switchLast) - pid := f.process(t, "hv1", "sleep 30", qemu("hv1")...) - - if err := f.lab.Down(context.Background()); err != nil { - t.Fatalf("Down: %v", err) - } - - waitDead(t, pid) - if _, err := os.Stat(filepath.Join(f.lab.RunDir, "hv1", "qemu.pid")); !os.IsNotExist(err) { - t.Errorf("pid file still there: %v", err) - } - if f.out.String() != "hv1: stopped\n" { - t.Errorf("output = %q", f.out.String()) - } -} - -func TestDown_FallsBackToSIGKILL(t *testing.T) { - f := newFixture(t, switchLast) - f.lab.Stop = 100 * time.Millisecond - pid := f.process(t, "hv1", `trap "" TERM; while :; do sleep 0.05; done`, qemu("hv1")...) - time.Sleep(50 * time.Millisecond) - - start := time.Now() - if err := f.lab.Down(context.Background()); err != nil { - t.Fatalf("Down: %v", err) - } - - waitDead(t, pid) - if elapsed := time.Since(start); elapsed < 100*time.Millisecond { - t.Errorf("SIGKILL after %v, want at least the 100ms grace period", elapsed) - } -} - -func TestDown_NeverSignalsAProcessThatIsNotTheNode(t *testing.T) { - f := newFixture(t, switchLast) - pid := f.process(t, "hv1", "sleep 30", "/usr/sbin/sshd", "-D") - - if err := f.lab.Down(context.Background()); err != nil { - t.Fatalf("Down: %v", err) - } - - time.Sleep(50 * time.Millisecond) - if !alive(pid) { - t.Error("a process that is not the node was killed") - } - if f.out.Len() != 0 { - t.Errorf("output = %q", f.out.String()) - } -} - -func TestDown_ReportsACorruptedPidFileAndStopsTheOthers(t *testing.T) { - f := newFixture(t, switchLast) - f.pidFile(t, "rr1", "garbage") - pid := f.process(t, "hv1", "sleep 30", qemu("hv1")...) - - err := f.lab.Down(context.Background()) - - if err == nil || !strings.Contains(err.Error(), "not a pid") { - t.Errorf("error = %v", err) - } - waitDead(t, pid) -} - -func TestSSH_Arguments(t *testing.T) { - f := newFixture(t, switchLast) - key := filepath.Join(f.lab.RunDir, "lab_ed25519") - base := []string{ - "-i", key, - "-o", "IdentitiesOnly=yes", - "-o", "IdentityAgent=none", - "-o", "StrictHostKeyChecking=no", - "-o", "UserKnownHostsFile=/dev/null", - "-o", "LogLevel=ERROR", - "-p", "2201", - "debian@127.0.0.1", - } - cases := map[string]struct { - terminal bool - command []string - want []string - }{ - "interactive shell": {true, nil, append([]string{"ssh"}, base...)}, - "command from a terminal": {true, []string{"top"}, append(append([]string{"ssh", "-t"}, base...), "top")}, - "command from a script": {false, []string{"ip", "-br", "a"}, append(append([]string{"ssh"}, base...), "ip", "-br", "a")}, - "shell from a script": {false, nil, append([]string{"ssh"}, base...)}, - } - for name, c := range cases { - t.Run(name, func(t *testing.T) { - got, err := f.lab.SSH("hv1", c.terminal, c.command) - if err != nil { - t.Fatal(err) - } - if !reflect.DeepEqual(got, c.want) { - t.Errorf("\n got %q\nwant %q", got, c.want) - } - }) - } -} - -func TestSSH_UnknownNode(t *testing.T) { - f := newFixture(t, switchLast) - if _, err := f.lab.SSH("hv9", true, nil); err == nil || !strings.Contains(err.Error(), `node "hv9" is not in lab evpn-2hv`) { - t.Errorf("error = %v", err) - } -} - -func TestUp_StartsSwitchesFirstAndWaitsForEveryNode(t *testing.T) { - f := newFixture(t, switchLast) - - if err := f.lab.Up(context.Background(), f.fetcher, time.Second); err != nil { - t.Fatalf("Up: %v", err) - } - - var started []string - for _, c := range f.runner.commands("qemu-system-x86_64") { - if c[len(c)-1] != "-daemonize" { - t.Errorf("qemu not daemonized: %q", c) - } - started = append(started, c[indexOf(c, "-name")+1]) - } - if !reflect.DeepEqual(started, []string{"sw1", "rr1", "hv1"}) { - t.Errorf("start order = %v, want the switch first", started) - } - - ssh := f.runner.commands("ssh") - if len(ssh) != 4 { - t.Fatalf("%d ssh calls, want 4", len(ssh)) - } - want := []string{"ssh", - "-i", filepath.Join(f.lab.RunDir, "lab_ed25519"), - "-o", "IdentitiesOnly=yes", - "-o", "IdentityAgent=none", - "-o", "StrictHostKeyChecking=no", - "-o", "UserKnownHostsFile=/dev/null", - "-o", "LogLevel=ERROR", - "-p", "2200", - "-o", "BatchMode=yes", - "-o", "ConnectTimeout=5", - "debian@127.0.0.1", - "cloud-init", "status", "--wait", - } - if !reflect.DeepEqual(ssh[0], want) { - t.Errorf("readiness check:\n got %q\nwant %q", ssh[0], want) - } - if f.out.String() != "sw1: started\nrr1: started\nhv1: started\nrr1: ready\nhv1: ready\nsw1: ready\n" { - t.Errorf("output = %q", f.out.String()) - } -} - -func TestUp_RetriesWhileSSHIsUnreachable(t *testing.T) { - f := newFixture(t, switchLast) - f.runner.ssh["2201"] = []error{exitErr(255), exitErr(255), nil} - - if err := f.lab.Up(context.Background(), f.fetcher, time.Second); err != nil { - t.Fatalf("Up: %v", err) - } - if n := len(f.runner.commands("ssh")); n != 6 { - t.Errorf("%d ssh calls, want 6", n) - } -} - -func TestUp_ReadinessFailures(t *testing.T) { - cases := map[string]struct { - answers []error - want string - }{ - "cloud-init error": {[]error{exitErr(1)}, "node hv1: cloud-init failed: exit status 1"}, - "not an exit status": {[]error{errors.New("fork failed")}, "node hv1: cloud-init failed: fork failed"}, - "ssh never reachable": {nil, "node hv1: not reachable over ssh: context deadline exceeded"}, - } - for name, c := range cases { - t.Run(name, func(t *testing.T) { - f := newFixture(t, switchLast) - f.lab.Poll = 10 * time.Millisecond - f.runner.ssh["2201"] = c.answers - f.runner.always["2201"] = exitErr(255) - - err := f.lab.Up(context.Background(), f.fetcher, 300*time.Millisecond) - - if err == nil || err.Error() != c.want { - t.Errorf("error = %v, want %q", err, c.want) - } - if !strings.Contains(f.out.String(), "rr1: ready\n") || !strings.Contains(f.out.String(), "sw1: ready\n") { - t.Errorf("the other nodes were not waited for: %q", f.out.String()) - } - }) - } -} - -func TestUp_RecoverableCloudInitErrorsAreReportedNotFatal(t *testing.T) { - f := newFixture(t, switchLast) - f.runner.ssh["2201"] = []error{exitErr(2)} - - if err := f.lab.Up(context.Background(), f.fetcher, time.Second); err != nil { - t.Fatalf("Up: %v", err) - } - if !strings.Contains(f.out.String(), "hv1: cloud-init finished with recoverable errors: exit status 2\nhv1: ready\n") { - t.Errorf("output = %q", f.out.String()) - } -} - -func TestUp_RefusesARunningLab(t *testing.T) { - f := newFixture(t, switchLast) - f.process(t, "hv1", "sleep 30", qemu("hv1")...) - - err := f.lab.Up(context.Background(), f.fetcher, time.Second) - - if err == nil || err.Error() != "lab evpn-2hv is already running (hv1): 'lab down' first" { - t.Errorf("error = %v", err) - } - if len(f.runner.calls) != 0 { - t.Errorf("commands ran: %q", f.runner.calls) - } -} - -func TestUp_RemovesAStalePidFileBeforeStarting(t *testing.T) { - f := newFixture(t, switchLast) - pid := f.process(t, "hv1", "exit 0", qemu("hv1")...) - waitDead(t, pid) - - if err := f.lab.Up(context.Background(), f.fetcher, time.Second); err != nil { - t.Fatalf("Up: %v", err) - } - if _, err := os.Stat(filepath.Join(f.lab.RunDir, "hv1", "qemu.pid")); !os.IsNotExist(err) { - t.Errorf("stale pid file kept: %v", err) - } -} - -func TestUp_StopsAtTheFirstQEMUFailure(t *testing.T) { - f := newFixture(t, switchLast) - f.runner.fail = "qemu-system-x86_64" - - err := f.lab.Up(context.Background(), f.fetcher, time.Second) - - if err == nil || err.Error() != "node sw1: qemu-system-x86_64 failed" { - t.Errorf("error = %v", err) - } - if n := len(f.runner.commands("qemu-system-x86_64")); n != 1 { - t.Errorf("%d qemu starts, want 1", n) - } - if n := len(f.runner.commands("ssh")); n != 0 { - t.Errorf("%d ssh calls after a failed start", n) - } -} - -func TestStop_RefusesPidsThatTargetAGroup(t *testing.T) { - f := newFixture(t, switchLast) - f.lab.signal = func(pid int, sig syscall.Signal) error { - t.Fatalf("signal %v sent to pid %d", sig, pid) - return nil - } - for _, pid := range []int{0, -1} { - if err := f.lab.stop(context.Background(), "hv1", pid); err == nil || err.Error() != fmt.Sprintf("refusing to signal pid %d", pid) { - t.Errorf("pid %d: error = %v", pid, err) - } - } -} - -func TestUp_ChecksTheServicesOfEachRole(t *testing.T) { - f := newFixture(t, switchLast) - conf := filepath.Join(t.TempDir(), "sw1.conf") - if err := os.WriteFile(conf, []byte("hostname sw1\n"), 0o600); err != nil { - t.Fatal(err) - } - f.lab.Plan.Nodes[2].FRR = conf - - if err := f.lab.Up(context.Background(), f.fetcher, time.Second); err != nil { - t.Fatalf("Up: %v", err) - } - - var checks []string - for _, c := range f.runner.commands("ssh") { - if c[len(c)-4] == "systemctl" { - checks = append(checks, c[indexOf(c, "-p")+1]+" "+strings.Join(c[len(c)-4:], " ")) - } - } - want := []string{ - "2201 systemctl is-active --quiet agent.service", - "2202 systemctl is-active --quiet frr.service", - } - if !reflect.DeepEqual(checks, want) { - t.Errorf("checks = %q, want %q", checks, want) - } -} - -func TestUp_ReportsAnInactiveServiceAndWaitsForTheOthers(t *testing.T) { - f := newFixture(t, switchLast) - f.runner.inactive = "agent.service" - - err := f.lab.Up(context.Background(), f.fetcher, time.Second) - - if err == nil || err.Error() != "node hv1: agent.service is not active: exit status 3" { - t.Errorf("error = %v", err) - } - if !strings.Contains(f.out.String(), "rr1: ready\n") || !strings.Contains(f.out.String(), "sw1: ready\n") || strings.Contains(f.out.String(), "hv1: ready") { - t.Errorf("output = %q", f.out.String()) - } -} diff --git a/internal/lab/provision/image.go b/internal/lab/provision/image.go deleted file mode 100644 index c4e8347..0000000 --- a/internal/lab/provision/image.go +++ /dev/null @@ -1,185 +0,0 @@ -package provision - -import ( - "bufio" - "bytes" - "context" - "crypto/sha512" - "encoding/hex" - "errors" - "fmt" - "io" - "net/http" - "net/url" - "os" - "path" - "path/filepath" - "regexp" - "strings" - - "git.g3e.fr/syonad/two/internal/lab/topology" -) - -const maxSumsSize = 1 << 20 - -var sha512Pattern = regexp.MustCompile(`^[0-9a-f]{128}$`) - -type Fetcher struct { - Client *http.Client - CacheDir string -} - -func (f Fetcher) Image(ctx context.Context, img topology.Image) (string, error) { - if !filepath.IsAbs(f.CacheDir) { - return "", fmt.Errorf("image cache dir %q must be an absolute path", f.CacheDir) - } - name, err := fileName(img.URL) - if err != nil { - return "", fmt.Errorf("image %s: %w", img.Name, err) - } - - sums, err := f.get(ctx, img.Sums, maxSumsSize) - if err != nil { - return "", fmt.Errorf("image %s: sums: %w", img.Name, err) - } - want, err := expectedSum(sums, name) - if err != nil { - return "", fmt.Errorf("image %s: %s: %w", img.Name, img.Sums, err) - } - - dir := filepath.Join(f.CacheDir, img.Name) - target := filepath.Join(dir, name) - if got, err := fileSum(target); err == nil && got == want { - return target, nil - } else if err != nil && !errors.Is(err, os.ErrNotExist) { - return "", fmt.Errorf("image %s: %w", img.Name, err) - } - - if err := os.MkdirAll(dir, 0o755); err != nil { - return "", err - } - if err := f.download(ctx, img.URL, dir, target, want); err != nil { - return "", fmt.Errorf("image %s: %w", img.Name, err) - } - return target, nil -} - -func (f Fetcher) client() *http.Client { - if f.Client != nil { - return f.Client - } - return http.DefaultClient -} - -func (f Fetcher) open(ctx context.Context, rawURL string) (*http.Response, error) { - req, err := http.NewRequestWithContext(ctx, http.MethodGet, rawURL, nil) - if err != nil { - return nil, err - } - resp, err := f.client().Do(req) - if err != nil { - return nil, err - } - if resp.StatusCode != http.StatusOK { - resp.Body.Close() - return nil, fmt.Errorf("GET %s: %s", rawURL, resp.Status) - } - return resp, nil -} - -func (f Fetcher) get(ctx context.Context, rawURL string, limit int64) ([]byte, error) { - resp, err := f.open(ctx, rawURL) - if err != nil { - return nil, err - } - defer resp.Body.Close() - data, err := io.ReadAll(io.LimitReader(resp.Body, limit+1)) - if err != nil { - return nil, err - } - if int64(len(data)) > limit { - return nil, fmt.Errorf("GET %s: larger than %d bytes", rawURL, limit) - } - return data, nil -} - -func (f Fetcher) download(ctx context.Context, rawURL, dir, target, want string) error { - resp, err := f.open(ctx, rawURL) - if err != nil { - return err - } - defer resp.Body.Close() - - tmp, err := os.CreateTemp(dir, filepath.Base(target)+".part-*") - if err != nil { - return err - } - defer os.Remove(tmp.Name()) - - h := sha512.New() - if _, err := io.Copy(io.MultiWriter(tmp, h), resp.Body); err != nil { - tmp.Close() - return fmt.Errorf("GET %s: %w", rawURL, err) - } - if err := tmp.Close(); err != nil { - return err - } - if got := hex.EncodeToString(h.Sum(nil)); got != want { - return fmt.Errorf("GET %s: sha512 %s, want %s", rawURL, got, want) - } - if err := os.Chmod(tmp.Name(), 0o644); err != nil { - return err - } - return os.Rename(tmp.Name(), target) -} - -func fileName(rawURL string) (string, error) { - u, err := url.Parse(rawURL) - if err != nil { - return "", err - } - name := path.Base(u.Path) - if name == "" || name == "." || name == "/" { - return "", fmt.Errorf("url %q does not name a file", rawURL) - } - return name, nil -} - -func expectedSum(sums []byte, name string) (string, error) { - var found []string - sc := bufio.NewScanner(bytes.NewReader(sums)) - for sc.Scan() { - fields := strings.Fields(sc.Text()) - if len(fields) != 2 || strings.TrimPrefix(fields[1], "*") != name { - continue - } - sum := strings.ToLower(fields[0]) - if !sha512Pattern.MatchString(sum) { - return "", fmt.Errorf("entry for %s is not a sha512 sum", name) - } - found = append(found, sum) - } - if err := sc.Err(); err != nil { - return "", err - } - switch { - case len(found) == 0: - return "", fmt.Errorf("no sum for %s", name) - case len(found) > 1: - return "", fmt.Errorf("%d sums for %s", len(found), name) - } - return found[0], nil -} - -func fileSum(p string) (string, error) { - file, err := os.Open(p) - if err != nil { - return "", err - } - defer file.Close() - h := sha512.New() - if _, err := io.Copy(h, file); err != nil { - return "", err - } - return hex.EncodeToString(h.Sum(nil)), nil -} diff --git a/internal/lab/provision/image_test.go b/internal/lab/provision/image_test.go deleted file mode 100644 index cd1ab20..0000000 --- a/internal/lab/provision/image_test.go +++ /dev/null @@ -1,334 +0,0 @@ -package provision - -import ( - "context" - "crypto/sha512" - "encoding/hex" - "net/http" - "net/http/httptest" - "os" - "path/filepath" - "strings" - "sync" - "testing" - - "git.g3e.fr/syonad/two/internal/lab/topology" -) - -const imageName = "debian-12-generic-amd64.qcow2" - -type mirror struct { - mu sync.Mutex - files map[string][]byte - status map[string]int - hits map[string]int - server *httptest.Server -} - -func newMirror(t *testing.T) *mirror { - t.Helper() - m := &mirror{files: map[string][]byte{}, status: map[string]int{}, hits: map[string]int{}} - m.server = httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - m.mu.Lock() - defer m.mu.Unlock() - m.hits[r.URL.Path]++ - if code := m.status[r.URL.Path]; code != 0 { - w.WriteHeader(code) - return - } - data, ok := m.files[r.URL.Path] - if !ok { - http.NotFound(w, r) - return - } - w.Write(data) - })) - t.Cleanup(m.server.Close) - return m -} - -func (m *mirror) put(path string, data []byte) { - m.mu.Lock() - defer m.mu.Unlock() - m.files[path] = data -} - -func (m *mirror) count(path string) int { - m.mu.Lock() - defer m.mu.Unlock() - return m.hits[path] -} - -func (m *mirror) image() topology.Image { - return topology.Image{ - Name: "debian12", - URL: m.server.URL + "/bookworm/latest/" + imageName, - Sums: m.server.URL + "/bookworm/latest/SHA512SUMS", - } -} - -func sum(data []byte) string { - h := sha512.Sum512(data) - return hex.EncodeToString(h[:]) -} - -func publish(m *mirror, content []byte) { - m.put("/bookworm/latest/"+imageName, content) - m.put("/bookworm/latest/SHA512SUMS", []byte( - sum([]byte("other"))+" debian-12-genericcloud-amd64.qcow2\n"+ - sum(content)+" "+imageName+"\n"+ - sum([]byte("raw"))+" debian-12-generic-amd64.raw\n")) -} - -func fetch(t *testing.T, m *mirror, cache string) string { - t.Helper() - got, err := Fetcher{Client: m.server.Client(), CacheDir: cache}.Image(context.Background(), m.image()) - if err != nil { - t.Fatalf("Image: %v", err) - } - return got -} - -func fetchError(t *testing.T, m *mirror, cache string) string { - t.Helper() - _, err := Fetcher{Client: m.server.Client(), CacheDir: cache}.Image(context.Background(), m.image()) - if err == nil { - t.Fatal("Image: no error") - } - return err.Error() -} - -func entries(t *testing.T, dir string) []string { - t.Helper() - list, err := os.ReadDir(dir) - if err != nil && !os.IsNotExist(err) { - t.Fatal(err) - } - var names []string - for _, e := range list { - names = append(names, e.Name()) - } - return names -} - -func TestImage_DownloadsAndVerifies(t *testing.T) { - m := newMirror(t) - publish(m, []byte("qcow2 image")) - cache := t.TempDir() - - got := fetch(t, m, cache) - - if want := filepath.Join(cache, "debian12", "debian-12-generic-amd64.qcow2"); got != want { - t.Errorf("path = %s, want %s", got, want) - } - data, err := os.ReadFile(got) - if err != nil || string(data) != "qcow2 image" { - t.Errorf("content = %q, %v", data, err) - } - info, err := os.Stat(got) - if err != nil || info.Mode().Perm() != 0o644 { - t.Errorf("mode = %v, %v", info.Mode().Perm(), err) - } - if names := entries(t, filepath.Join(cache, "debian12")); len(names) != 1 { - t.Errorf("cache dir holds %v, want only the image", names) - } -} - -func TestImage_ReusesAVerifiedCacheButAlwaysRereadsTheSums(t *testing.T) { - m := newMirror(t) - publish(m, []byte("qcow2 image")) - cache := t.TempDir() - - fetch(t, m, cache) - fetch(t, m, cache) - - if n := m.count("/bookworm/latest/" + imageName); n != 1 { - t.Errorf("image downloaded %d times, want 1", n) - } - if n := m.count("/bookworm/latest/SHA512SUMS"); n != 2 { - t.Errorf("sums read %d times, want 2", n) - } -} - -func TestImage_ReplacesACorruptedCache(t *testing.T) { - m := newMirror(t) - publish(m, []byte("qcow2 image")) - cache := t.TempDir() - path := fetch(t, m, cache) - if err := os.WriteFile(path, []byte("bit rot"), 0o644); err != nil { - t.Fatal(err) - } - - fetch(t, m, cache) - - if data, _ := os.ReadFile(path); string(data) != "qcow2 image" { - t.Errorf("content = %q, want the published image", data) - } - if n := m.count("/bookworm/latest/" + imageName); n != 2 { - t.Errorf("image downloaded %d times, want 2", n) - } -} - -func TestImage_FollowsANewReleaseOfTheSameFile(t *testing.T) { - m := newMirror(t) - publish(m, []byte("release 1")) - cache := t.TempDir() - path := fetch(t, m, cache) - - publish(m, []byte("release 2")) - fetch(t, m, cache) - - if data, _ := os.ReadFile(path); string(data) != "release 2" { - t.Errorf("content = %q, want release 2", data) - } -} - -func TestImage_RejectsAMismatchAndLeavesNothing(t *testing.T) { - m := newMirror(t) - publish(m, []byte("qcow2 image")) - m.put("/bookworm/latest/"+imageName, []byte("tampered")) - cache := t.TempDir() - - msg := fetchError(t, m, cache) - - if !strings.Contains(msg, "sha512") { - t.Errorf("error = %q, want a sha512 mismatch", msg) - } - if names := entries(t, filepath.Join(cache, "debian12")); len(names) != 0 { - t.Errorf("cache dir holds %v after a mismatch, want nothing", names) - } -} - -func TestImage_KeepsTheVerifiedCacheWhenANewDownloadFails(t *testing.T) { - m := newMirror(t) - publish(m, []byte("release 1")) - cache := t.TempDir() - path := fetch(t, m, cache) - - publish(m, []byte("release 2")) - m.put("/bookworm/latest/"+imageName, []byte("truncated")) - fetchError(t, m, cache) - - if data, _ := os.ReadFile(path); string(data) != "release 1" { - t.Errorf("content = %q, want release 1 kept", data) - } - if names := entries(t, filepath.Join(cache, "debian12")); len(names) != 1 { - t.Errorf("cache dir holds %v, want only the image", names) - } -} - -func TestImage_AcceptsBinaryModeSumLines(t *testing.T) { - m := newMirror(t) - content := []byte("qcow2 image") - m.put("/bookworm/latest/"+imageName, content) - m.put("/bookworm/latest/SHA512SUMS", []byte(strings.ToUpper(sum(content))+" *"+imageName+"\n")) - - fetch(t, m, t.TempDir()) -} - -func TestImage_SumsRejections(t *testing.T) { - content := []byte("qcow2 image") - cases := map[string]struct { - sums string - want string - }{ - "no entry": {sum(content) + " debian-12-generic-arm64.qcow2\n", "no sum for " + imageName}, - "two entries": {sum(content) + " " + imageName + "\n" + sum(content) + " " + imageName + "\n", "2 sums for " + imageName}, - "not sha512": {"d41d8cd98f00b204e9800998ecf8427e " + imageName + "\n", "is not a sha512 sum"}, - "prefix of name": {sum(content) + " " + imageName + ".sig\n", "no sum for " + imageName}, - "name in directory": {sum(content) + " nested/" + imageName + "\n", "no sum for " + imageName}, - } - for name, c := range cases { - t.Run(name, func(t *testing.T) { - m := newMirror(t) - m.put("/bookworm/latest/"+imageName, content) - m.put("/bookworm/latest/SHA512SUMS", []byte(c.sums)) - if msg := fetchError(t, m, t.TempDir()); !strings.Contains(msg, c.want) { - t.Errorf("error = %q, want %q", msg, c.want) - } - if n := m.count("/bookworm/latest/" + imageName); n != 0 { - t.Errorf("image downloaded %d times before the sums were trusted", n) - } - }) - } -} - -func TestImage_RefusesOversizedSums(t *testing.T) { - m := newMirror(t) - m.put("/bookworm/latest/SHA512SUMS", make([]byte, 1<<20+1)) - if msg := fetchError(t, m, t.TempDir()); !strings.Contains(msg, "larger than 1048576 bytes") { - t.Errorf("error = %q", msg) - } -} - -func TestImage_AcceptsSumsOfExactlyTheLimit(t *testing.T) { - m := newMirror(t) - content := []byte("qcow2 image") - line := sum(content) + " " + imageName + "\n" - m.put("/bookworm/latest/"+imageName, content) - m.put("/bookworm/latest/SHA512SUMS", []byte(strings.Repeat("\n", 1<<20-len(line))+line)) - - fetch(t, m, t.TempDir()) -} - -func TestImage_HTTPErrors(t *testing.T) { - for _, path := range []string{"/bookworm/latest/SHA512SUMS", "/bookworm/latest/" + imageName} { - t.Run(path, func(t *testing.T) { - m := newMirror(t) - publish(m, []byte("qcow2 image")) - m.status[path] = http.StatusServiceUnavailable - cache := t.TempDir() - if msg := fetchError(t, m, cache); !strings.Contains(msg, "503") { - t.Errorf("error = %q, want the http status", msg) - } - if names := entries(t, filepath.Join(cache, "debian12")); len(names) != 0 { - t.Errorf("cache dir holds %v, want nothing", names) - } - }) - } -} - -func TestImage_RefusesARelativeCacheDir(t *testing.T) { - m := newMirror(t) - publish(m, []byte("qcow2 image")) - if msg := fetchError(t, m, "cache"); !strings.Contains(msg, "must be an absolute path") { - t.Errorf("error = %q", msg) - } - if n := m.count("/bookworm/latest/SHA512SUMS"); n != 0 { - t.Errorf("sums read %d times", n) - } -} - -func TestImage_RefusesAURLWithoutFileName(t *testing.T) { - m := newMirror(t) - img := m.image() - img.URL = m.server.URL + "/" - _, err := Fetcher{Client: m.server.Client(), CacheDir: t.TempDir()}.Image(context.Background(), img) - if err == nil || !strings.Contains(err.Error(), "does not name a file") { - t.Errorf("error = %v", err) - } -} - -func TestImage_RejectsAnInterruptedDownloadAndLeavesNothing(t *testing.T) { - content := []byte("qcow2 image") - server := httptest.NewTLSServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { - if strings.HasSuffix(r.URL.Path, "SHA512SUMS") { - w.Write([]byte(sum(content) + " " + imageName + "\n")) - return - } - w.Header().Set("Content-Length", "1000") - w.Write(content[:4]) - })) - defer server.Close() - cache := t.TempDir() - img := topology.Image{Name: "debian12", URL: server.URL + "/" + imageName, Sums: server.URL + "/SHA512SUMS"} - - _, err := Fetcher{Client: server.Client(), CacheDir: cache}.Image(context.Background(), img) - - if err == nil || !strings.Contains(err.Error(), "unexpected EOF") { - t.Errorf("error = %v, want an interrupted transfer", err) - } - if names := entries(t, filepath.Join(cache, "debian12")); len(names) != 0 { - t.Errorf("cache dir holds %v, want nothing", names) - } -} diff --git a/internal/lab/provision/provision.go b/internal/lab/provision/provision.go deleted file mode 100644 index 4613fb1..0000000 --- a/internal/lab/provision/provision.go +++ /dev/null @@ -1,207 +0,0 @@ -package provision - -import ( - "context" - "errors" - "fmt" - "os" - "os/exec" - "path/filepath" - "sort" - "strings" - - "git.g3e.fr/syonad/two/internal/lab/render" - "git.g3e.fr/syonad/two/internal/lab/topology" -) - -const ( - KeyFile = "lab_ed25519" - KeyLabel = "labctl" - DiskSize = "20G" - SeedLabel = "cidata" - - ArgsFile = "qemu.args" -) - -var SeedFiles = []string{"user-data", "meta-data", "network-config"} - -type Runner interface { - Run(ctx context.Context, name string, args ...string) error -} - -type ExecRunner struct{} - -func (ExecRunner) Run(ctx context.Context, name string, args ...string) error { - out, err := exec.CommandContext(ctx, name, args...).CombinedOutput() - if err != nil { - return fmt.Errorf("%s: %w: %s", name, err, strings.TrimSpace(string(out))) - } - return nil -} - -type Options struct { - RunDir string - Fetcher Fetcher - Runner Runner -} - -func Prepare(ctx context.Context, p *topology.Plan, o Options) ([]render.Node, error) { - if !filepath.IsAbs(o.RunDir) { - return nil, fmt.Errorf("run dir %q must be an absolute path", o.RunDir) - } - if err := os.MkdirAll(o.RunDir, 0o700); err != nil { - return nil, err - } - - images := map[string]string{} - for _, n := range p.Nodes { - if _, ok := images[n.Image]; ok { - continue - } - img, ok := imageNamed(p, n.Image) - if !ok { - return nil, fmt.Errorf("node %s: image %q is not declared", n.Name, n.Image) - } - base, err := o.Fetcher.Image(ctx, img) - if err != nil { - return nil, err - } - images[n.Image] = base - } - - key, err := EnsureKey(ctx, o.Runner, o.RunDir) - if err != nil { - return nil, err - } - opts := render.Options{RunDir: o.RunDir, AuthorizedKeys: []string{key}} - if err := ReadInputs(p, &opts); err != nil { - return nil, err - } - nodes, err := render.Render(p, opts) - if err != nil { - return nil, err - } - for i, n := range nodes { - if err := Stage(ctx, o.Runner, n, images[p.Nodes[i].Image]); err != nil { - return nil, fmt.Errorf("node %s: %w", n.Name, err) - } - } - return nodes, nil -} - -func ReadInputs(p *topology.Plan, o *render.Options) error { - var err error - if o.FRR, err = readNodeFiles(p, func(n topology.NodePlan) string { return n.FRR }); err != nil { - return err - } - if o.Provision, err = readNodeFiles(p, func(n topology.NodePlan) string { return n.Provision }); err != nil { - return err - } - if o.PostProvision, err = readNodeFiles(p, func(n topology.NodePlan) string { return n.PostProvision }); err != nil { - return err - } - for _, n := range p.Nodes { - for name, src := range n.Files { - if _, err := os.Stat(src); err != nil { - return fmt.Errorf("node %s: file %s: %w", n.Name, name, err) - } - } - } - return nil -} - -func readNodeFiles(p *topology.Plan, path func(topology.NodePlan) string) (map[string]string, error) { - files := map[string]string{} - for _, n := range p.Nodes { - if path(n) == "" { - continue - } - data, err := os.ReadFile(path(n)) - if err != nil { - return nil, fmt.Errorf("node %s: %w", n.Name, err) - } - files[n.Name] = string(data) - } - return files, nil -} - -func EnsureKey(ctx context.Context, r Runner, dir string) (string, error) { - private := filepath.Join(dir, KeyFile) - if _, err := os.Stat(private); errors.Is(err, os.ErrNotExist) { - if err := r.Run(ctx, "ssh-keygen", "-q", "-t", "ed25519", "-N", "", "-C", KeyLabel, "-f", private); err != nil { - return "", err - } - } else if err != nil { - return "", err - } - data, err := os.ReadFile(private + ".pub") - if err != nil { - return "", err - } - key := strings.TrimSpace(string(data)) - if key == "" || strings.ContainsAny(key, "\r\n") { - return "", fmt.Errorf("%s.pub: not a single public key", private) - } - return key, nil -} - -func WriteFiles(n render.Node) error { - if err := os.MkdirAll(n.Dir, 0o700); err != nil { - return err - } - files := map[string][]byte{ - ArgsFile: []byte(strings.Join(n.QEMU, "\n") + "\n"), - "meta-data": n.MetaData, - "user-data": n.UserData, - "network-config": n.NetworkConfig, - } - for name, content := range files { - if err := os.WriteFile(filepath.Join(n.Dir, name), content, 0o600); err != nil { - return err - } - } - return nil -} - -func Stage(ctx context.Context, r Runner, n render.Node, base string) error { - if !filepath.IsAbs(base) { - return fmt.Errorf("base image %q must be an absolute path", base) - } - if err := WriteFiles(n); err != nil { - return err - } - disk := filepath.Join(n.Dir, render.DiskFile) - seed := filepath.Join(n.Dir, render.SeedFile) - if err := r.Run(ctx, "qemu-img", "create", "-q", "-f", "qcow2", "-F", "qcow2", "-b", base, disk, DiskSize); err != nil { - return err - } - args := []string{"-quiet", "-output", seed, "-volid", SeedLabel, "-joliet", "-rock"} - for _, f := range SeedFiles { - args = append(args, filepath.Join(n.Dir, f)) - } - if err := r.Run(ctx, "genisoimage", args...); err != nil { - return err - } - if len(n.Files) == 0 { - return nil - } - names := make([]string, 0, len(n.Files)) - for name := range n.Files { - names = append(names, name) - } - sort.Strings(names) - args = []string{"-quiet", "-output", filepath.Join(n.Dir, render.FilesISO), "-volid", render.FilesLabel, "-joliet", "-rock", "-graft-points"} - for _, name := range names { - args = append(args, name+"="+n.Files[name]) - } - return r.Run(ctx, "genisoimage", args...) -} - -func imageNamed(p *topology.Plan, name string) (topology.Image, bool) { - for _, i := range p.Images { - if i.Name == name { - return i, true - } - } - return topology.Image{}, false -} diff --git a/internal/lab/provision/provision_test.go b/internal/lab/provision/provision_test.go deleted file mode 100644 index 057f529..0000000 --- a/internal/lab/provision/provision_test.go +++ /dev/null @@ -1,450 +0,0 @@ -package provision - -import ( - "context" - "errors" - "os" - "path/filepath" - "reflect" - "strings" - "testing" - - "go.yaml.in/yaml/v3" - - "git.g3e.fr/syonad/two/internal/lab/render" - "git.g3e.fr/syonad/two/internal/lab/topology" -) - -const generatedKey = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFG/JMmjfko96WkJV8DiL6rip/H/q/R++y8s27Z+Cj6O labctl" - -type fakeRunner struct { - calls [][]string - fail string -} - -func (f *fakeRunner) Run(_ context.Context, name string, args ...string) error { - f.calls = append(f.calls, append([]string{name}, args...)) - if name == f.fail { - return errors.New(name + " failed") - } - if name == "ssh-keygen" { - private := args[len(args)-1] - if err := os.WriteFile(private, []byte("private"), 0o600); err != nil { - return err - } - return os.WriteFile(private+".pub", []byte(generatedKey+"\n"), 0o644) - } - return nil -} - -func (f *fakeRunner) commands(name string) [][]string { - var out [][]string - for _, c := range f.calls { - if c[0] == name { - out = append(out, c) - } - } - return out -} - -func labPlan(t *testing.T, m *mirror) *topology.Plan { - t.Helper() - img := m.image() - doc := `name: evpn-2hv -images: - debian12: - url: ` + img.URL + ` - sums: ` + img.Sums + ` -segments: - underlay: { switch: sw1, cidr: 10.250.0.0/24, mtu: 9000 } -nodes: - sw1: { role: switch, image: debian12, cpus: 2, memory: 1024 } - rr1: { role: rr, image: debian12, cpus: 1, memory: 1024, segments: [underlay] } - hv1: { role: host, image: debian12, cpus: 4, memory: 16384, segments: [underlay] } - hv2: { role: host, image: debian12, cpus: 4, memory: 16384, segments: [underlay] } -` - topo, err := topology.Parse([]byte(doc)) - if err != nil { - t.Fatalf("Parse: %v", err) - } - p, err := topology.Compute(topo) - if err != nil { - t.Fatalf("Compute: %v", err) - } - return p -} - -func prepare(t *testing.T, runner *fakeRunner) (string, string, *mirror, []render.Node, error) { - t.Helper() - m := newMirror(t) - publish(m, []byte("qcow2 image")) - root := t.TempDir() - run := filepath.Join(root, "run") - cache := filepath.Join(root, "cache") - nodes, err := Prepare(context.Background(), labPlan(t, m), Options{ - RunDir: run, - Fetcher: Fetcher{Client: m.server.Client(), CacheDir: cache}, - Runner: runner, - }) - return run, cache, m, nodes, err -} - -func TestPrepare_StagesEveryNode(t *testing.T) { - runner := &fakeRunner{} - run, cache, _, nodes, err := prepare(t, runner) - if err != nil { - t.Fatalf("Prepare: %v", err) - } - - base := filepath.Join(cache, "debian12", "debian-12-generic-amd64.qcow2") - want := [][]string{ - {"ssh-keygen", "-q", "-t", "ed25519", "-N", "", "-C", "labctl", "-f", filepath.Join(run, "lab_ed25519")}, - } - for _, n := range []string{"sw1", "rr1", "hv1", "hv2"} { - dir := filepath.Join(run, n) - want = append(want, - []string{"qemu-img", "create", "-q", "-f", "qcow2", "-F", "qcow2", "-b", base, filepath.Join(dir, "disk.qcow2"), "20G"}, - []string{"genisoimage", "-quiet", "-output", filepath.Join(dir, "seed.iso"), "-volid", "cidata", "-joliet", "-rock", - filepath.Join(dir, "user-data"), filepath.Join(dir, "meta-data"), filepath.Join(dir, "network-config")}, - ) - } - if !reflect.DeepEqual(runner.calls, want) { - t.Errorf("commands:\n got %q\nwant %q", runner.calls, want) - } - - var names []string - for _, n := range nodes { - names = append(names, n.Name) - } - if !reflect.DeepEqual(names, []string{"sw1", "rr1", "hv1", "hv2"}) { - t.Errorf("nodes = %v", names) - } - if info, err := os.Stat(run); err != nil || info.Mode().Perm() != 0o700 { - t.Errorf("run dir mode = %v, %v", info.Mode().Perm(), err) - } -} - -func TestPrepare_DownloadsASharedImageOnce(t *testing.T) { - _, _, m, _, err := prepare(t, &fakeRunner{}) - if err != nil { - t.Fatalf("Prepare: %v", err) - } - if n := m.count("/bookworm/latest/" + imageName); n != 1 { - t.Errorf("image downloaded %d times for four nodes, want 1", n) - } - if n := m.count("/bookworm/latest/SHA512SUMS"); n != 1 { - t.Errorf("sums read %d times for four nodes, want 1", n) - } -} - -func TestPrepare_TheGeneratedKeyIsTheOnlyAuthorizedKey(t *testing.T) { - _, _, _, nodes, err := prepare(t, &fakeRunner{}) - if err != nil { - t.Fatalf("Prepare: %v", err) - } - for _, n := range nodes { - data, err := os.ReadFile(filepath.Join(n.Dir, "user-data")) - if err != nil { - t.Fatal(err) - } - var cfg struct { - Keys []string `yaml:"ssh_authorized_keys"` - } - if err := yaml.Unmarshal(data, &cfg); err != nil { - t.Fatalf("%s user-data: %v", n.Name, err) - } - if !reflect.DeepEqual(cfg.Keys, []string{generatedKey}) { - t.Errorf("%s authorized keys = %q, want only the generated key", n.Name, cfg.Keys) - } - } -} - -func TestPrepare_WritesTheRenderedFilesPrivately(t *testing.T) { - run, _, _, nodes, err := prepare(t, &fakeRunner{}) - if err != nil { - t.Fatalf("Prepare: %v", err) - } - hv1 := filepath.Join(run, "hv1") - if nodes[2].Dir != hv1 { - t.Fatalf("hv1 dir = %s, want %s", nodes[2].Dir, hv1) - } - for _, f := range []string{"qemu.args", "user-data", "meta-data", "network-config"} { - info, err := os.Stat(filepath.Join(hv1, f)) - if err != nil || info.Mode().Perm() != 0o600 { - t.Errorf("%s mode = %v, %v", f, info.Mode().Perm(), err) - } - } - args, err := os.ReadFile(filepath.Join(hv1, "qemu.args")) - if err != nil || !strings.HasPrefix(string(args), "-name\nhv1\n") || !strings.HasSuffix(string(args), "\n") { - t.Errorf("qemu.args = %q, %v", args, err) - } -} - -func TestPrepare_StopsAtTheFirstFailedCommand(t *testing.T) { - runner := &fakeRunner{fail: "qemu-img"} - _, _, _, _, err := prepare(t, runner) - if err == nil || !strings.Contains(err.Error(), "node sw1: qemu-img failed") { - t.Errorf("error = %v", err) - } - if n := len(runner.commands("genisoimage")); n != 0 { - t.Errorf("genisoimage ran %d times after qemu-img failed", n) - } -} - -func TestPrepare_StopsBeforeAnyCommandWhenTheImageIsWrong(t *testing.T) { - m := newMirror(t) - publish(m, []byte("qcow2 image")) - m.put("/bookworm/latest/"+imageName, []byte("tampered")) - runner := &fakeRunner{} - root := t.TempDir() - _, err := Prepare(context.Background(), labPlan(t, m), Options{ - RunDir: filepath.Join(root, "run"), - Fetcher: Fetcher{Client: m.server.Client(), CacheDir: filepath.Join(root, "cache")}, - Runner: runner, - }) - if err == nil || !strings.Contains(err.Error(), "sha512") { - t.Errorf("error = %v", err) - } - if len(runner.calls) != 0 { - t.Errorf("commands ran after a bad image: %q", runner.calls) - } -} - -func TestPrepare_RefusesARelativeRunDir(t *testing.T) { - m := newMirror(t) - publish(m, []byte("qcow2 image")) - runner := &fakeRunner{} - _, err := Prepare(context.Background(), labPlan(t, m), Options{ - RunDir: "run", - Fetcher: Fetcher{Client: m.server.Client(), CacheDir: t.TempDir()}, - Runner: runner, - }) - if err == nil || !strings.Contains(err.Error(), `run dir "run" must be an absolute path`) { - t.Errorf("error = %v", err) - } - if n := m.count("/bookworm/latest/SHA512SUMS"); n != 0 { - t.Errorf("sums read %d times before the run dir was checked", n) - } -} - -func TestPrepare_RefusesAnUndeclaredImage(t *testing.T) { - m := newMirror(t) - p := labPlan(t, m) - p.Images = nil - _, err := Prepare(context.Background(), p, Options{RunDir: t.TempDir(), Runner: &fakeRunner{}}) - if err == nil || !strings.Contains(err.Error(), `node sw1: image "debian12" is not declared`) { - t.Errorf("error = %v", err) - } -} - -func TestEnsureKey_GeneratesOnlyOnce(t *testing.T) { - dir := t.TempDir() - runner := &fakeRunner{} - - for i := 0; i < 2; i++ { - key, err := EnsureKey(context.Background(), runner, dir) - if err != nil || key != generatedKey { - t.Fatalf("EnsureKey #%d = %q, %v", i+1, key, err) - } - } - if n := len(runner.commands("ssh-keygen")); n != 1 { - t.Errorf("ssh-keygen ran %d times, want 1", n) - } -} - -func TestEnsureKey_Rejections(t *testing.T) { - cases := map[string]string{ - "empty": "\n", - "two keys": generatedKey + "\n" + generatedKey + "\n", - "stray break": "ssh-ed25519\rAAAA", - } - for name, pub := range cases { - t.Run(name, func(t *testing.T) { - dir := t.TempDir() - if err := os.WriteFile(filepath.Join(dir, "lab_ed25519"), []byte("private"), 0o600); err != nil { - t.Fatal(err) - } - if err := os.WriteFile(filepath.Join(dir, "lab_ed25519.pub"), []byte(pub), 0o644); err != nil { - t.Fatal(err) - } - if _, err := EnsureKey(context.Background(), &fakeRunner{}, dir); err == nil || !strings.Contains(err.Error(), "not a single public key") { - t.Errorf("error = %v", err) - } - }) - } -} - -func TestEnsureKey_ReportsAFailedGeneration(t *testing.T) { - if _, err := EnsureKey(context.Background(), &fakeRunner{fail: "ssh-keygen"}, t.TempDir()); err == nil || !strings.Contains(err.Error(), "ssh-keygen failed") { - t.Errorf("error = %v", err) - } -} - -func TestStage_BurnsTheNodeFilesIntoTheirOwnISO(t *testing.T) { - runner := &fakeRunner{} - dir := t.TempDir() - n := render.Node{Name: "hv1", Dir: dir, Files: map[string]string{"bin": "/src/bin", "agent.yml": "/src/two.yml"}} - if err := Stage(context.Background(), runner, n, "/cache/deb.qcow2"); err != nil { - t.Fatalf("Stage: %v", err) - } - isos := runner.commands("genisoimage") - want := []string{"genisoimage", "-quiet", "-output", filepath.Join(dir, "files.iso"), "-volid", "LABFILES", "-joliet", "-rock", "-graft-points", - "agent.yml=/src/two.yml", "bin=/src/bin"} - if len(isos) != 2 || !reflect.DeepEqual(isos[1], want) { - t.Errorf("genisoimage calls:\n%q\nwant second:\n%q", isos, want) - } -} - -func TestStage_NoFilesNoFilesISO(t *testing.T) { - runner := &fakeRunner{} - if err := Stage(context.Background(), runner, render.Node{Name: "rr1", Dir: t.TempDir()}, "/cache/deb.qcow2"); err != nil { - t.Fatalf("Stage: %v", err) - } - if n := len(runner.commands("genisoimage")); n != 1 { - t.Errorf("genisoimage ran %d times, want only the seed", n) - } -} - -func TestStage_RefusesARelativeBaseImage(t *testing.T) { - runner := &fakeRunner{} - err := Stage(context.Background(), runner, render.Node{Name: "hv1", Dir: t.TempDir()}, "debian.qcow2") - if err == nil || !strings.Contains(err.Error(), "must be an absolute path") { - t.Errorf("error = %v", err) - } - if len(runner.calls) != 0 { - t.Errorf("commands ran: %q", runner.calls) - } -} - -func TestExecRunner_ReportsTheCommandOutput(t *testing.T) { - err := ExecRunner{}.Run(context.Background(), "sh", "-c", "echo boom >&2; exit 3") - if err == nil || !strings.Contains(err.Error(), "sh: exit status 3: boom") { - t.Errorf("error = %v", err) - } - if err := (ExecRunner{}).Run(context.Background(), "true"); err != nil { - t.Errorf("true: %v", err) - } -} - -func TestEnsureKey_WithTheRealSSHKeygen(t *testing.T) { - dir := t.TempDir() - key, err := EnsureKey(context.Background(), ExecRunner{}, dir) - if err != nil { - t.Fatalf("EnsureKey: %v", err) - } - if !strings.HasPrefix(key, "ssh-ed25519 ") || !strings.HasSuffix(key, " labctl") { - t.Errorf("key = %q", key) - } - info, err := os.Stat(filepath.Join(dir, "lab_ed25519")) - if err != nil || info.Mode().Perm() != 0o600 { - t.Errorf("private key mode = %v, %v", info.Mode().Perm(), err) - } -} - -func TestReadInputs_ReadsOnlyTheFRRConfigsDeclared(t *testing.T) { - dir := t.TempDir() - conf := filepath.Join(dir, "rr1.conf") - if err := os.WriteFile(conf, []byte("hostname rr1\n"), 0o600); err != nil { - t.Fatal(err) - } - m := newMirror(t) - p := labPlan(t, m) - p.Nodes[1].FRR = conf - - var o render.Options - err := ReadInputs(p, &o) - - if err != nil || !reflect.DeepEqual(o.FRR, map[string]string{"rr1": "hostname rr1\n"}) { - t.Errorf("FRR = %q, %v", o.FRR, err) - } -} - -func TestReadInputs_NamesTheNodeOfAMissingFRRConfig(t *testing.T) { - m := newMirror(t) - p := labPlan(t, m) - p.Nodes[2].FRR = filepath.Join(t.TempDir(), "absent.conf") - - if err := ReadInputs(p, &render.Options{}); err == nil || !strings.Contains(err.Error(), "node hv1: ") || !strings.Contains(err.Error(), "absent.conf") { - t.Errorf("error = %v", err) - } -} - -func TestPrepare_PutsTheFRRConfigIntoTheSeed(t *testing.T) { - m := newMirror(t) - publish(m, []byte("qcow2 image")) - root := t.TempDir() - conf := filepath.Join(root, "hv1.conf") - if err := os.WriteFile(conf, []byte("hostname hv1\n"), 0o600); err != nil { - t.Fatal(err) - } - p := labPlan(t, m) - p.Nodes[2].FRR = conf - - nodes, err := Prepare(context.Background(), p, Options{ - RunDir: filepath.Join(root, "run"), - Fetcher: Fetcher{Client: m.server.Client(), CacheDir: filepath.Join(root, "cache")}, - Runner: &fakeRunner{}, - }) - if err != nil { - t.Fatalf("Prepare: %v", err) - } - data, err := os.ReadFile(filepath.Join(nodes[2].Dir, "user-data")) - if err != nil { - t.Fatal(err) - } - var cfg struct { - Files []struct { - Path string `yaml:"path"` - Content string `yaml:"content"` - } `yaml:"write_files"` - } - if err := yaml.Unmarshal(data, &cfg); err != nil { - t.Fatal(err) - } - for _, f := range cfg.Files { - if f.Path == "/etc/lab/frr.conf" { - if f.Content != "hostname hv1\n" { - t.Errorf("frr.conf = %q", f.Content) - } - return - } - } - t.Errorf("hv1 user-data has no /etc/lab/frr.conf:\n%s", data) -} - -func TestReadInputs_ReadsTheScriptsAndChecksTheFiles(t *testing.T) { - dir := t.TempDir() - write := func(name, content string) string { - path := filepath.Join(dir, name) - if err := os.WriteFile(path, []byte(content), 0o600); err != nil { - t.Fatal(err) - } - return path - } - m := newMirror(t) - p := labPlan(t, m) - p.Nodes[2].Provision = write("hv.sh", "#!/bin/sh\necho provision\n") - p.Nodes[2].PostProvision = write("hv-post.sh", "#!/bin/sh\necho post\n") - p.Nodes[2].Files = map[string]string{"agent.yml": write("two.yml", "dhcp:\n backend: two\n")} - - if err := os.Mkdir(filepath.Join(dir, "bin"), 0o700); err != nil { - t.Fatal(err) - } - p.Nodes[2].Files["bin"] = filepath.Join(dir, "bin") - - var o render.Options - if err := ReadInputs(p, &o); err != nil { - t.Fatal(err) - } - if !reflect.DeepEqual(o.Provision, map[string]string{"hv1": "#!/bin/sh\necho provision\n"}) { - t.Errorf("provision = %q", o.Provision) - } - if !reflect.DeepEqual(o.PostProvision, map[string]string{"hv1": "#!/bin/sh\necho post\n"}) { - t.Errorf("post_provision = %q", o.PostProvision) - } - - p.Nodes[3].Files = map[string]string{"agent.yml": filepath.Join(dir, "absent.yml")} - if err := ReadInputs(p, &render.Options{}); err == nil || !strings.Contains(err.Error(), "node hv2: file agent.yml: ") { - t.Errorf("error = %v", err) - } -} diff --git a/internal/lab/render/frrouting.gpg b/internal/lab/render/frrouting.gpg deleted file mode 100644 index c38f82b554920a929fc607fab1dfab32bd278c9c..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 16112 zcmeI2Q*Dac}aniBPj%_=q*IIjxz0de@#<^d&bJV<< zqw1~qshVj3I8d#bf_7j;prH>1d_nYht$^bUPK%tTwoObKg~P2_)seHHGDf-+Zgpg$ z6M{O(l|7F;Q7^~+MiucT_@E~#@teCIs>C9c8cH;W%I*FfKcLX9SKCs@N^#xsO!|E9 z956(#;>P!jZg2H+Nq*jPx4cCo`$}8kD18VpMx$>A8Cl47TBWLKcRIp)oB7I4Jyoe` zrXW)z{VB%}j#YF0RylX)`kal~2)d47NE>VPNg`UWZpR+}ZgcsK7;tip>SxUYm2JO( zCFV4h(K57g4xpS-BwA^?G(l*njmbo+2~m62_wEbL=wR7)@VqSE&xq+;@9zZKKSz2I z3>-CSKVX{IHyNpDkvoA?3!FXji?0)q5%*c0n8Ahzuf6Gmf&)C3I;E5y_ua}IzNj5Z z+b~fAl@FQkI{DVh<3c9Z<~mE%Nh_0p5#iXHDT{;)Mm{i!>FN{5d7{WGup@4zTpm-4 zk#Z5zv=A5I=zL>y@_K6AD2Pm$G7F3deV3a^0)U-95oL{Pk`J1J*du@iOZm%t>`G;6 z71Z6iF3<#vS@=m6i(@DHl6N;Kui=D?&4ahi#`Z56PB==o|5DM=^sf#gu`@r2n(sXj z>GDy@!p+1hT!>a6H=;W9m8P}ALZakE*gnS{pI;-Gcl6wXd3Rmk(*dZ!?P4V{(!)@d zr#{FpXPTnkiU1)20|7VEh#I(97!%4E*nBf^a58Zq zVrHecHF4q(2gre<07C+Cq7#AgrI}ZzA9f*GP)4s2ECi+|-}|nD0scrW01hx13=|{; z02~bx3K|9giVgq)2H*n&F#Ld^p%DKLmc>W-RH0iVB%MI!JkY_BaOtZTpQvQl^>=>& zY2Cd!S_rGEF{jHsnzwN`{l!S2IEL#di=gHu7_hq3`R))ze>RzE9GbnLQ&-)!1|HQH&01S^FoA;|RG4J)5?M#PvSaijt zVQnBuJe)NH<#A~K^)FI*t2CNvE5ML*CL+WFI&pEa4#?g2Ra#6SyU~m>n)R+*En|$F4@$Z z8F`o1blYoylTV4pVwWst5+Lm2Y8Q7>h8iri)xM%1C%tsu3_B>*EdkRs+?%x%wCRjU z24#7h(j*st*tnU_&nQ?x)jP|O>rD8-KLB$cO**TAoRZ5#l3E#LZ01bj6%)H0I`GA) zrW<{urKg;+DV-Hv3$G1C+R13EZke3QpwznZmbNLnU22{nzaDX>>)TLEMKBS%S3P|3 zR#6%~_AZqTd#st49||y~vPF#YW!ixMRHLomIn_P^=F~{B)6)dG=#|V^GFz!l&h)7^ zrq2YYu!7Tjl?dy&f)1`X%QJ<(NBTp=ktlWrw^fzhM|RFJwy zjM#rN@(hVC{9ST)*1>1+#8Ut668aNB}}E zCXgZmQG*5o<9jR4AQvpPFyZ1zc6ybUzgC7$EQJ9&Qjz!?t;Ov27LED717kIdZxXQA0D9Y921*4;&XG%)Sb03WT*wg-Mw zSw`K}Oh-Qp0$b*>Np?xbl`(JPr|0v^|E$WbKT7ZKll1_IPibeJJ8b_EEWqgQ zSRWvTeq*#YGJ-R&^F{jzgf6+ZpfsI^j>nBPVkzef8ay_rUzI|4Rr$;`@1>Q)@I|lK z!(FR(nV=ZSh?>;$lFP*xg0ZYp>NFFAG=NezLDU!Hb^)K>_8+Y9Mftgpp2|twXBZom zCa7+oIMB!l5Y+tj!%gMqQRs%d%^}2e8 zfP(Ysvy07z^>c~>wG$?Cq3tXBst)mTR2*FiiQ2fX6U{y1H3~5!D=WqLFUxi>2Dkh} z4{Z=r5d~CWVGGcJs5au!77=&LWQ~_^*w{cdgeK}`&kF)ZM@yNAKy8{~BN&yI`s(># z?>#-fL{Vjt@gfZO+PEkkd|eh&u`Sx|!F*({bYmZub;eAo*J*86q-RgdKZ+iw;PqV` zTJ{)x5l@iInN9DcxT_y&wV_L~|Z z+1Cv*3y4O|GFx*y0hTf-+IZ|RQ0%ch-@xz3Znb_7(^x5Uc1-PU1n%$qY&Sn;E8N7@ z>I>V~Rk8uhSFmpdk;EQL$o`gu`8$2?f+dAgo5s@f!AQfWa_S;xr*I&xd^aOt`pFOz zKAVYU1te-nMxkc?{#L`1Lmfi_7EfYDu|Q_U42jM5-2%V9toCNydC{K$wH_F=DZJpn zjHR|6DGq=|PsxIhqju`Z+KW%H4%8O#&TUIEO){5-xY(?J+17Ee^dv)J-NzB(+ENG3 z2voaXVS{Paw#mhlz8~xes{oX9M9whRvtQrGJ8e|*t|-%SZn}-ykI9<&LKbyuV2CEv zLtfS04W@ZzQCq78!90R+hhP5+mr6xzgfObgEA>IP&D#GyGdzL^ zCob~jDgSt{${~%TXs6fRug`;CZ(~EAi_bt?HnHtuBDH77{b5?}t@%ZFPN*9-aeaD* zDnX9wFquj)z;ClcYZJC5Dl3AUJvwoV=qyX44=+LiV+zu}MUFR;LGul*ew;H}A$8 z+jaX!oD9OEPv8if4UBcOJj0O$27jy;Vjl)avcU!k=RCi01<|BcQ_>bfrBZXN>I+Ob z4ZUECf;%{p%)5<}lx}{{*PobL3uS`XSP1S-bx(c!w#)T_Pfx{{{JH8CmD#GuTAHa= zUR>lGv_^_+Mi>2PUdr48I<0MI?<(L>!o|Q%S^5JUQ~3w>+gCd&rdBf{l+GAaLK01E zTiYm4LU2{zy$q0CC{HJWCh#Rx!)UIElk4GBlAQvm&mmrx(Q%0%=m$rmw~*&%#L^w@ z;TL994Z$@SG0zad8`S9N-u2{ z-j^w2QZ$xiY^)RGgW(;c?FHgghAnf(k8|AG3ezjh!UNbAqr!c3%+AoJR=BT&{K)C&7qGBTZ`VX_FJzYGm!#{rCrv{Y z-0|bjNgDg*tT97zIuf(F6UoJy z_M0lSgSAP2Q^jUB_%Bh?{GX*~;QZTJI3%#cdA1No$=_Qo2X)>O4R+DW8*&;%PFLjD z$y!s|gCn-kY}*GOr`^DhmNXR~I^)?Tis{U|ZXg~yWx!K%u=rd)gCmj7MODdTTd^Nc z2$BqCXZOh(rZXFhAVG+FbIBH^_)Dyp-@@~Oy6ep^F%1IUYHjXctG94GJpnF5&ybtB zV!Xje{N8?sLQcgL?sHwHz_aR@Z?qYq2Kt^GP(;b4?gnMv-i{%0rKBdqS_bu;%1BH> z0PFIqYV%BZNkq9&$VQHNX<+{ve=yvsVjjUO?;Irhn!HKj4G`jQ>PDtvE_=63lHl%i z9`3pI8kANr6Wl^!Q*DuR(1nTc!TQuBQl14_E9!ywJ=E>b;z@!1xC|5KMx$H&vv4Ka zNKzUIvnuh=*3RX&vk0^4NgKiAMNLvgp#(HP?3@M^&6xa1{u|69HUw3GPREd z^;v&jB)gCm!>+M52Dm?+THZIAo+!MciO% z`Lmv>$RK0KZ`y=av72-P&scC6+)`Ef4$E;aV;w6$2>NIYFacm%kx*6ZNX@vj7If)0 z1A~821)I2{qMfsog{>K(=${xtsA%%d&e6ij&cU6K*Vx2G(AvV$$&udF!QrnkdOHWR z|BElAREHcR8=laTOTlJKnO)K#ulZ-d0DmOefA9q~6y$&5i@$?oZ4f>kD>l@-6H9l? zx(x*L_0zoR%$d4Sb$s+xa?=8{v}BDitBqncI5LY7eS^g(2(m{6l{m5?3$@5CY(;v? zVd;KGi8T1x>iIP%cg%@$1;IFO7y0kgm|VgZsOmOO2Z~C^O}0h`rRTbzN+-G9T4H>D zr;-HmZv=C+7m)4Fe9rEH4bvhD98(ymC7+iLZkxj9@hM_H;3a8_y!|T9do`}kjGGc# zt`N*72IiA@f@L!HQ>hVTrK?6AJ`AEp%|&UPE`L&TGAMp--#J*TUGahO_1X=Y!`mr9 zAvMilWfoV&Z{AH!iis<(*h;xS`aU^JV)P)5{Ii?53~Bvl`TS*-X16t_-olMyQ@$pN zsq-@*9&}shCoHi1jC?&xI(1qpoJ9gg0QeDEC;WNm@{(_r#=wCYTzM5O@Tw%iz^MHy zSZ)J}C5|A|tRJ1AQWwEJY4j{V1cIyzQ?J3DH>Sy+lSd5XQr?h(1n3}$Dyi9KD^Qa* zQa(GagdRQa{G&auLM*(!4S^@da*WzeU%V>1s4c4Ql8(@$W3Y?#qONg0O>s^~c{q5k z`x+DenQqdz*{SoiTZ-A=>c>FuR^w1|WiDL~&c>f9Qx(QLszOzbIG+aJ0Vw%hhwm&S(NS6&Ph z+)&)!5bfJJmt zfJVx&G?Z(i%EolcVPCPw3U+jVzPlYNCb974kqivpLd|Fi=$YVEhjf!}`6_Sr7TC4c z>b``;*enwRe@hynn^Bxyzv~)Rvhz=IejqK0qe0;W)C^gmxHsUDWT5 z!i7VM#>L>KF=}92Fg5`dz$Mbt0OQ`4$_$0ZF`u>Z9i?AFn`hCej-?e@)>;u)HN(DA z4j{Tx9=kpzm}BAIayVN2=`kXnJjD?tx1WaE4{ffale1HmS_VVSNtKK{A}NOm``LP> zTXc_DQk_8f%lFjl*Z5xZ^#NQ?@ZH<)86rXnGy%1`m&O)m%0ZD}E)fS4rbd~^bYf9B zQ=Jk^gmf0#d8%ag9FKT1IAo|7HiptN7qDlbfnxr3x~9f}Vn<*jK@N22lkw+xzDf=L zqSJWHPh0H~-K$NPN}Z64m+_E?j`O& z;w7=si9m$mZOQHO@A0m9WG{R#c+(SeY>YTOOIdpbU0x*1Ln0o} zGY*mK==*I@?p!UM-{sT>(@w|}h3%_&;L4NiA>hSFmH3V@yuto5IH3RLtN%e@erL;X zz5@K_tG|V$_docmWWtzykQ^Q5SmJcNV6+*3z_V`pw<`U<^oJ$-`y?k3;e&NZ_^q4e zBhgM4xh0X~nEQ6h3d#r?1S&!^6_vx+tb19*h9p>>m3E)U;u(X#yZ)JuS~TjGw? z8?+FoMr-E%Pss>r#atfQ&`jNXjiP=>S}7*Kn6fWzWW(ATj@lfj&2`sPDSQhc?n=SyNOi< zwmLFup7>!;57aF3X8B+I)b*uWgopa{sy(~Z`HIu*WsB*tXqT8P%GboUy}HYbsU4Zh z1*2|BA7&enMbJrh-MOH5X45hA&G+7IPnx*MEXxZnVVy=Q>La#0uALRk9N@f@U4E|& zHcrO>wbQ+B(QxYAz49hz@)AR{x)+HC&8B6?2vAFt_(X-~K+aoBgYdy_OetEJiW6Nt zSG8Gb9s|tXmjI0Rctoq~z-+6&w&9Y2b8n8R)6^$fZNNi5sNbd~ZYGw&r!t}4W_jsf z*H-_+Ts{c|yEvBLBbPFw2=BD9Et{jdCZx5K(#~Y&<&x~*N58czh16M&P&}#~VX1kv z6`inL@W{RLf#P9qjoaz%9b)^(SkHiu?#P5GMiBu&E1-3(!{D9^wSj|mx#K- zHu5RjFcT!Fx;ZK(aUh53-55$BABIZ3rB4j(20$~BVV7<-p%<@IFrMnDSUgxORU20INW4gbPtago{Uu--RZ9QL3iMPm@AU;byo z$uD`HfedolhB4%$)*iJqG?6>*v$^Pv-8M(35Rx}WsGDCvHhJe2X9 zM~!tU5?B3*+mr_mrUhtQ036Rb9JWRRNat8)K&SinY7VmI<{EEcmOgvDSDXyw8hE%k-yu|_%QfE+6(tk zOSg-5*9a6F_@tnQt>#!O-6a<1rNjOv;N4ZS2HX8&0nmt>iDf>sD zFhXW9=0@AV-0kXwiQl&}GT5_E%_!<^-mbbm1`(7T_+}#8aI%%5{DHmDZbr@!SlTKu9>&S&bs0ke`i(T>8YG^ND9>fxg}H z(A`E`9cL(bAVpllfbrANyas>VDWuaw9Dyuvd}B8gMeRDL9+wB2I!DS7BHSdUs=`uu z$5+qYO%c~Ac3tf1`^ppI0Q&F28JRqFZtM4ph89HVFYoA`xbV;&j?%2oz>Kp}1f?d_ zr;o=jm72~NUz3Ap*O3{j^!XlHl3{o??Z-yVf7+WDS3ACp+WcjUS)>e14IBuCtm!1o z4IB(C3{A`lDXk5hZH>&o85mO$@;cekTmBIuXl7$zVNGvjXY(&p4E^WOy$qq>CW%V$ zd+KrDveV|dNClQ`_wV-eJH-GvAb$_t|2tFsckmA$gioiAp98X{rW5F%b%=Vy8+V3i zTR(*5p@@V1ye0NfI|)p>RDyW3O^)+4t(7uiR3o7dlgoHk!7eZ2UqPB{+|6H}sWEtP z^;;%fZxRd2UlVi}WLdne5u*ZhH_=zhB`=){k^z;|5{ddu-i%-L=EtzAk!ha{<+Ps{ zTpbLxIEL*WN8qzO^Sh#+PKEm)RB9D*KjlDnp~bjgIH%`^6Fg-E>GOOR=V!--f*Rwe z*Ds#ovVUL}VssMliI;b47dhXCrGDZ{CNqzji&!cI_wIK;F~yH< zXV=GV=yYd)pX4wj);nZrZs==VK>si_+XTh&9snx=K{B4~~r>hTkcnk6GC zTvirCdUO%Rd=O4Qz*iyGWiqZJ-|4qHShMZy=Ij`%=S_k5`b?W>jq5rNnZF|QN#eGk zjSDb5`^;y(9V^N1<1iAYm^r?Qzn8CK^>c^O6-o2yd?D~6TQ}}AW~R4M+`YN# zqn+jOXle@FN)oU2$liP2Y_agM-moPEwr1r|Q~Z}I-J+h}(sWpK&6=JN&>_&u5zoMzWI(lJV%EZ%fnL!GRFjBZp$?OUBqAGzn z6e`{eJ+Y#~n*nTD;$MPn+wZR^RjMqq>n4mIzRnhsz%}X8`8j|jmu!Tx7%6LJ8f3_x zL#O*I%TUh2u4EvH2jV`2^iXvxf-;0Xi1CxLso$({{3V>=ffa%q9iKw08qwG!`C-Wolvx|9)?1D&{W_Q>ke?toGUysLcNIuZtL!HyC8=J5v z;60id#OqOhX~nk7VzLKpn7HrHDCv=i@cqZs5Bkrg!~Z5Qe@^}W7Ls^wgbyk=m-{Hj zq}F1v3)n|S*{67y7sJr!+~GF+KLrBLAhRW7HGe6@}zl&XeJ_p6fh*v!_=z^lv2!Bu<4@SYLst3 zAzNEbX*Eiz8CaIkRSVZ@Y3a&xm0Qz@S7B?-elqPE_xA7CfTmM%||T-{!f2?Wjj1|4yB{#YCLF84#D1780}&92cLwAz}r z;C9}r(pG36^+OH^}9P?wu-p}=3yVbsH0=u2osz!z&2xztQO_y*8|plJJ(-*~DAe+J~R}VM=Q$rrs|U zLN9tUcHQOlI*<^JBlwt_bnf>bvN_>Yb^zBJHx}0V+J4((F~$3+R`uc+$Iy+0mXq=> zMO?_Egj0%xxYCPwmtkwu=pru<7I?}Qg3Xd12U784up(FyI77ilzD#wdB2Tj;>Qww{(-tx+T$P}5)3E@lh%vs@>P``8+ji~8=!I84yO2yz=$3CPIr-RU7SWV`z~45PRCWf* z6*ij-d{z92+Mimhe6xswXN8}YfV97COvBb3OvklO42=IOorabqOw9fGRnYsE*LwfP z^ie^`N7A8#3vABTu8yc4u)#PHo)%6KQNpAkvnQJ#jW`5(7s3*!!Ly-4&SnY`hQ1WT z1x^>iPHejjObYQ0)D)!1!<9Sw@haOcw2|Xd?!`^4H(&!I4B~Mas2>17mIT5VgBNen z?xPPosA}^l|Kmq)`gMi>0Y7K(Qga`pDrC>bp!EV(qZb^io~|wiOcKjzoosxT3|Hg0 z6L$eLI#m%MspQKc!|6LAB|N@yeuQdek4AXSAy$|1IhZ3Ss7##<5pAkre2WYF%eOi> zvutC8zz`8#yw8FGw;5i16DAUubCxjn3#@7&sGFHO;0MbSjNA(C1%kiq4aI+BZ~kXX z^VdIuj*-f;8Ah`F-jGjUC;WuGhu!a5V1Pf;>TgQ}0*3a7r2+fn8v)S2{}KEhTt|!W zj<*YO97bRmwyYlU8N4XRM;-lY-!yr45t+mM-6KFK386$AlRAs>OQ;u|-ke{B5D$;! z=X7V)JJ4Y5(gml4&R#K!0m2-x?|MAF!N{=0y*!`ed8oUo1HyQ#Xv8(HC;~Lq!cA&g zknLuqCm4@+PYw0HQ@os4JY) zrR%X*483npfY2#EuL1?(=5R?Cb&K749` z?FB-8&bp+uJ*HfEh3ggv(VQ1KD)-MjV$MgmO&L!4GL*;>^cuosApKI|hw`eYsqm-? zAdeL*;MTsq>1sT^4}md&Q%PrbM9p* z(ZNy$Y1jtbkCh`LoS1b7+;gYFrC6h16*EC91jr6`Fx@Yj&^I8Zj%$Wg*t}aeKzR89 zZN&X9BdK!bUO^m^tr6~d$O$>k-j}jF=t*?G9s_hzLQ;GnSDzq?y7~&ZW+P5X^w;8r5RRS_4g$LNc5hc*8QO|$)mJ@YCFo6#|iq6 zl@i-aU}6>75=}_=4h!A(w(Vn+*nE}1Z^c#EpRAn>pG}k`zGI6s%D@8lvw!CF^ueHM zkgM38DH=W}zGh89LWW&kyHYbe7kL$FMEe=d8cxp#aAYw%S;qx`DU3|YN1BC?Vgtct z&alS6l`r@SHw}(Rp*oL=Bz{$zH>;8!Z}2ivMFAc>4fSh)(a(vGjsR17R9R9z5(wKz z@{J-5gC$sURvRv9b6&FB4@zy7caX+mg@>gzHFU_uriJgY8_Tt+;%U~|k4z&9jMV$s(a?#=AV|jdpxFoy46xo?Qc(LB!Fb zt%m(Ye80rVM{V^Nw2h6G%*xvWnm7Be6+Slhbpb+BkOKY!p#)1_rB)1oDN*=;EHeK$ zf%(hQ{7ZGp91wxp-)on)yxT6a5YN{xc`NVbT$+d>4uMj!FuB46dop>6h}t)k2BHIH zh>Sr5Pl)Zbbn3B%4IKm<=WVXt{2WVLX4lTdm6Z7?Qen8dFrf}P5xIv`;>qadb>p?U zT^O~ z80Omf!IV-8IqNAtel*8&7jJdw2p(}*;jqWyfKtVgl8XGzSe;xk&x-=EpFvb1tz

FmpBWJH_)EkUgb^EF8h$>Y$XZPeB}$4 z-vI%Q1>iZzfVRpz+wdGQ#)IQjib#frHS4txgKPB`{?#l1DzQg}pj4(_W)>f4FM4!O zjXbK1it_3>Uq;|HrRsAnIVpMIQjnc(CA&Wle26x{V!IdTEitIp%WS-9?%b>ve@m9} zp$l%yqynjh?n{f&*h0R8aG^{r6Ia#r2cU^H2;5OqrijvYMK&@7%ZhrX+8_@$Ag0J1= z*T<5QQ1ndj!E>^LWVdO*n{tV85S`aWpZV2WOEH9v%VD%|+tGdxxwo;9iL*($#%>@6 zJKhCa_&l%x$iD8cJ(LvL_)B*)D_u>`UP}=xmjlyH!3<(>XlF^%%*40_$d7!4QPu)Y zuBXB?8albQ#Wwwx$V_=fM__=##cZU;p%Ke2*6yV;@S7=PA?Fk8+MxhkEdYtYHvQ<3 zm3otd@|>VKVx{<3Iyaj$l569WlB|OMu<2FnslUz2h$rGMn5E&n%QVf}7)z zxR`J8ffOdmI;?(DaX%x6SL0@7t+nfVF0GoM#}+kWRZAxC+=Ij0$EGN3_yq zMH+NH44whePkU+C5oN2-Vb)IKY#Em~HPXKB%R;<;I7CC5Z!$x(g%x(7h&y zi1SXb@TeqeH}f11@%CI#tAQeT1n}hO;fxx=qK4Z^qb%3cV0X?u#l zY70?o4%Q=~WrdKe>x%u7)L*D8eAhXn1uRHRxoU|A$0yDOjzgxpag8c6>{>%AFsR&8 zUJ!{UfUHzvNf`1ztn*w1AkO-C%yg!hz0s3KQKHZmPN9)bYSXa{UoeVZNnkT53;Ddp zOC&u0mxaOqBqRZ$|5_OQ?MVJ}VbG7<%myTIZDI_Bzq`+=tWiwpi}HuP2?+gTVet1! zqdFo`hXZf^hlbY!rg+$vSMDQUt6(T!Dg-GwE|5(5=~*nvw@R}#1~kPKrUiKmREM$V z4v691b>;i<5Pdh$6m|)|MygvdcUZR$bV+G|^Xq0jk=_-lBPFtFj1bGH%(&!)+?LVJ z`-_)9j09GUS?zADSDlQrO5zVVmHu21Lrwl7#U&s^jGR5U5Ll(>5;mI~hML8a69`5w z1csKN2uyXrKCZOI>eNsa7~S~(y3F^U`C559(oz=w#-W5m&QxZ1NR^uK9yy3PA{>gI zEo8ei|NGQ9STnJbP46O z<_jw--acb=ftUFp%avj+2ZMyh^8DupcsHno$S%0>j3G}rXubKw)Fs}G;))J(IWWLO z;t1Fy!t3N~BJa414@&N2;wyL#2F>I$=6{l{0gxx(W77IIv+~x~^q?`72pm>7TwO-fPsZDou%RIU^{earlwPDV0dU{A9-2z5woQMRE<_Pmz{~~f~e6E zl|k!<%YpG9qM4!2z)U4IG&tH9QB`qb4@GGMx6G#UiHY2?3Cv@mXJD$JQ%$_fSA1G& z7a)>Z`H7}s0Un#63DkOcXXwrdY!2F1)oYb$aR?&A9Y+IoZ>;p6kf?iA6N@ z1e;BvP{+9Qp;F>6o^Yc>0y6mE8pj5!{OaBZUXq9c&(zb^DdQ~$(#mU61j9%bM)(bz z;54$B`_(2|>mhL`kDXoNUg;aY*X@$S;ieY_!aM*3Q)OK&6IlW!s?#!anK ztTaq8vsE2EvJGgng4BpF@OK#;)(=-#fs42vRF{f;X?nzk_HOVA@n~~Y;(v(xAEN$; tsQ)4Ae~9`YqW*`d{~_vsi25I*{)ec)YyCsi{}A;*MEws@|Nj&9{{amGE{p&G diff --git a/internal/lab/render/qemu.go b/internal/lab/render/qemu.go deleted file mode 100644 index 4c380c8..0000000 --- a/internal/lab/render/qemu.go +++ /dev/null @@ -1,57 +0,0 @@ -package render - -import ( - "fmt" - "path/filepath" - "strconv" - - "git.g3e.fr/syonad/two/internal/lab/topology" -) - -const loopback = "127.0.0.1" - -func qemuArgs(p *topology.Plan, n topology.NodePlan, index int, dir string) []string { - args := []string{ - "-name", n.Name, - "-machine", "q35", - "-accel", "kvm", - "-cpu", "host", - "-smp", strconv.Itoa(n.CPUs), - "-m", strconv.Itoa(n.Memory), - "-nodefaults", - "-display", "none", - "-serial", "file:" + filepath.Join(dir, ConsoleFile), - "-qmp", "unix:" + filepath.Join(dir, QMPFile) + ",server=on,wait=off", - "-pidfile", filepath.Join(dir, PIDFile), - "-drive", "file=" + filepath.Join(dir, DiskFile) + ",if=virtio,format=qcow2", - "-drive", "file=" + filepath.Join(dir, SeedFile) + ",media=cdrom,readonly=on", - } - if len(n.Files) > 0 { - args = append(args, "-drive", "file="+filepath.Join(dir, FilesISO)+",media=cdrom,readonly=on") - } - - restrict := "on" - if n.Role == topology.RoleSwitch { - restrict = "off" - } - args = append(args, - "-netdev", fmt.Sprintf("user,id=%s,restrict=%s,ipv6=off,hostfwd=tcp:%s:%d-:22", AdminInterface, restrict, loopback, n.SSHPort), - "-device", fmt.Sprintf("virtio-net-pci,netdev=%s,mac=%s,romfile=", AdminInterface, adminMAC(index)), - ) - - for _, c := range nodeCables(p, n.Name) { - args = append(args, cable(c.NodeInterface, c.NodePort, c.SwitchPort, c.NodeMAC.String(), c.MTU)...) - } - for _, c := range switchCables(p, n.Name) { - args = append(args, cable(c.SwitchInterface, c.SwitchPort, c.NodePort, c.SwitchMAC.String(), c.MTU)...) - } - return args -} - -func cable(id string, local, remote int, mac string, mtu int) []string { - return []string{ - "-netdev", fmt.Sprintf("dgram,id=%s,local.type=inet,local.host=%s,local.port=%d,remote.type=inet,remote.host=%s,remote.port=%d", - id, loopback, local, loopback, remote), - "-device", fmt.Sprintf("virtio-net-pci,netdev=%s,mac=%s,host_mtu=%d,romfile=", id, mac, mtu), - } -} diff --git a/internal/lab/render/render.go b/internal/lab/render/render.go deleted file mode 100644 index 7fbe3b7..0000000 --- a/internal/lab/render/render.go +++ /dev/null @@ -1,150 +0,0 @@ -package render - -import ( - "errors" - "fmt" - "net" - "path/filepath" - "strings" - - "git.g3e.fr/syonad/two/internal/lab/topology" -) - -const ( - QEMUBinary = "qemu-system-x86_64" - - AdminInterface = topology.ReservedInterface - AdminAddress = "10.0.2.15/24" - AdminGateway = "10.0.2.2" - AdminDNS = "10.0.2.3" - - DiskFile = "disk.qcow2" - SeedFile = "seed.iso" - FilesISO = "files.iso" - FilesLabel = "LABFILES" - ConsoleFile = "console.log" - QMPFile = "qmp.sock" - PIDFile = "qemu.pid" -) - -var Nameservers = []string{"1.1.1.1", "8.8.8.8"} - -type Options struct { - RunDir string - AuthorizedKeys []string - FRR map[string]string - Provision map[string]string - PostProvision map[string]string -} - -type Node struct { - Name string - Dir string - Files map[string]string - QEMU []string - MetaData []byte - UserData []byte - NetworkConfig []byte -} - -func Render(p *topology.Plan, o Options) ([]Node, error) { - if err := o.validate(); err != nil { - return nil, err - } - for _, n := range p.Nodes { - if _, ok := o.FRR[n.Name]; n.FRR != "" && !ok { - return nil, fmt.Errorf("node %s: frr configuration %s was not read", n.Name, n.FRR) - } - if _, ok := o.Provision[n.Name]; n.Provision != "" && !ok { - return nil, fmt.Errorf("node %s: provision script %s was not read", n.Name, n.Provision) - } - if _, ok := o.PostProvision[n.Name]; n.PostProvision != "" && !ok { - return nil, fmt.Errorf("node %s: post_provision script %s was not read", n.Name, n.PostProvision) - } - } - var nodes []Node - for index, n := range p.Nodes { - dir := filepath.Join(o.RunDir, n.Name) - meta, err := metaData(p, n) - if err != nil { - return nil, err - } - user, err := userData(p, n, o) - if err != nil { - return nil, err - } - network, err := networkConfig(p, n, index) - if err != nil { - return nil, err - } - nodes = append(nodes, Node{ - Name: n.Name, - Dir: dir, - Files: n.Files, - QEMU: qemuArgs(p, n, index, dir), - MetaData: meta, - UserData: user, - NetworkConfig: network, - }) - } - return nodes, nil -} - -func (o Options) validate() error { - var errs []error - if !filepath.IsAbs(o.RunDir) { - errs = append(errs, fmt.Errorf("run dir %q must be an absolute path", o.RunDir)) - } - if len(o.AuthorizedKeys) == 0 { - errs = append(errs, errors.New("at least one authorized ssh key is required")) - } - for i, k := range o.AuthorizedKeys { - if strings.ContainsAny(k, "\r\n") { - errs = append(errs, fmt.Errorf("authorized key %d spans several lines", i+1)) - continue - } - fields := strings.Fields(k) - if len(fields) < 2 || !validKeyType(fields[0]) { - errs = append(errs, fmt.Errorf("authorized key %d is not an ssh public key", i+1)) - } - } - return errors.Join(errs...) -} - -func validKeyType(t string) bool { - return strings.HasPrefix(t, "ssh-") || strings.HasPrefix(t, "ecdsa-sha2-") || strings.HasPrefix(t, "sk-") -} - -func adminMAC(index int) net.HardwareAddr { - return net.HardwareAddr{0x02, 0x4d, byte(index >> 8), byte(index), 0x00, 0x00} -} - -func nodeCables(p *topology.Plan, name string) []topology.Cable { - var out []topology.Cable - for _, c := range p.Cables { - if c.Node == name { - out = append(out, c) - } - } - return out -} - -func switchCables(p *topology.Plan, name string) []topology.Cable { - var out []topology.Cable - for _, c := range p.Cables { - if c.Switch == name { - out = append(out, c) - } - } - return out -} - -func switchSegments(p *topology.Plan, name string) []topology.SegmentPlan { - var out []topology.SegmentPlan - for _, s := range p.Segments { - if s.Switch == name { - out = append(out, s) - } - } - return out -} diff --git a/internal/lab/render/render_test.go b/internal/lab/render/render_test.go deleted file mode 100644 index 3f38a41..0000000 --- a/internal/lab/render/render_test.go +++ /dev/null @@ -1,480 +0,0 @@ -package render - -import ( - "reflect" - "strings" - "testing" - - "go.yaml.in/yaml/v3" - - "git.g3e.fr/syonad/two/internal/lab/topology" -) - -const labKey = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIFG/JMmjfko96WkJV8DiL6rip/H/q/R++y8s27Z+Cj6O lab-automation" - -const twoHypervisors = `name: evpn-2hv -images: - deb: - url: https://example.invalid/deb.qcow2 - sums: https://example.invalid/SHA512SUMS -segments: - underlay: { switch: sw1, cidr: 10.250.0.0/24, mtu: 9000 } -nodes: - sw1: { role: switch, image: deb, cpus: 2, memory: 1024 } - rr1: { role: rr, image: deb, cpus: 1, memory: 1024, segments: [underlay] } - hv1: { role: host, image: deb, cpus: 4, memory: 16384, segments: [underlay] } - hv2: { role: host, image: deb, cpus: 4, memory: 16384, segments: [underlay] } -` - -const twoSegments = `name: two-seg -images: - deb: - url: https://example.invalid/deb.qcow2 - sums: https://example.invalid/SHA512SUMS -segments: - red: { switch: sw, cidr: 10.1.0.0/24 } - blue: { switch: sw, cidr: 10.2.0.0/24, mtu: 1500 } -nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512 } - hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [blue, red] } -` - -func plan(t *testing.T, doc string) *topology.Plan { - t.Helper() - topo, err := topology.Parse([]byte(doc)) - if err != nil { - t.Fatalf("Parse: %v", err) - } - p, err := topology.Compute(topo) - if err != nil { - t.Fatalf("Compute: %v", err) - } - return p -} - -func renderAll(t *testing.T, doc string) map[string]Node { - t.Helper() - nodes, err := Render(plan(t, doc), Options{RunDir: "/srv/lab", AuthorizedKeys: []string{labKey}}) - if err != nil { - t.Fatalf("Render: %v", err) - } - out := map[string]Node{} - for _, n := range nodes { - out[n.Name] = n - } - return out -} - -func nodeNamed(t *testing.T, nodes map[string]Node, name string) Node { - t.Helper() - n, ok := nodes[name] - if !ok { - t.Fatalf("no rendered node %s", name) - } - return n -} - -func value(t *testing.T, args []string, flag string) []string { - t.Helper() - var out []string - for i := 0; i+1 < len(args); i++ { - if args[i] == flag { - out = append(out, args[i+1]) - } - } - if len(out) == 0 { - t.Fatalf("no %s in %v", flag, args) - } - return out -} - -func hasValue(args []string, flag, want string) bool { - for i := 0; i+1 < len(args); i++ { - if args[i] == flag && args[i+1] == want { - return true - } - } - return false -} - -func network(t *testing.T, n Node) networkDoc { - t.Helper() - var doc networkDoc - if err := yaml.Unmarshal(n.NetworkConfig, &doc); err != nil { - t.Fatalf("network-config of %s is not yaml: %v", n.Name, err) - } - return doc -} - -func iface(t *testing.T, doc networkDoc, name string) ethernet { - t.Helper() - e, ok := doc.Ethernets[name] - if !ok { - t.Fatalf("no interface %s in %v", name, doc.Ethernets) - } - return e -} - -func user(t *testing.T, n Node) cloudConfig { - t.Helper() - if !strings.HasPrefix(string(n.UserData), "#cloud-config\n") { - t.Fatalf("user-data of %s does not start with #cloud-config", n.Name) - } - var cfg cloudConfig - if err := yaml.Unmarshal(n.UserData, &cfg); err != nil { - t.Fatalf("user-data of %s is not yaml: %v", n.Name, err) - } - return cfg -} - -func fileAt(t *testing.T, cfg cloudConfig, path string) writeFile { - t.Helper() - for _, f := range cfg.WriteFiles { - if f.Path == path { - return f - } - } - t.Fatalf("no write_files entry %s", path) - return writeFile{} -} - -func TestQEMU_HypervisorArguments(t *testing.T) { - hv := nodeNamed(t, renderAll(t, twoHypervisors), "hv1") - for flag, want := range map[string]string{ - "-name": "hv1", - "-machine": "q35", - "-accel": "kvm", - "-cpu": "host", - "-smp": "4", - "-m": "16384", - "-display": "none", - "-serial": "file:/srv/lab/hv1/console.log", - "-qmp": "unix:/srv/lab/hv1/qmp.sock,server=on,wait=off", - "-pidfile": "/srv/lab/hv1/qemu.pid", - } { - if !hasValue(hv.QEMU, flag, want) { - t.Errorf("%s %s missing from %v", flag, want, hv.QEMU) - } - } - for _, want := range []string{ - "file=/srv/lab/hv1/disk.qcow2,if=virtio,format=qcow2", - "file=/srv/lab/hv1/seed.iso,media=cdrom,readonly=on", - } { - if !hasValue(hv.QEMU, "-drive", want) { - t.Errorf("-drive %s missing", want) - } - } - if hv.Dir != "/srv/lab/hv1" { - t.Errorf("Dir = %s", hv.Dir) - } - nodefaults := 0 - for _, a := range hv.QEMU { - if a == "-nodefaults" { - nodefaults++ - } - } - if nodefaults != 1 { - t.Errorf("-nodefaults appears %d times", nodefaults) - } -} - -func TestQEMU_HypervisorNetwork(t *testing.T) { - hv := nodeNamed(t, renderAll(t, twoHypervisors), "hv1") - wantNetdevs := []string{ - "user,id=mgmt0,restrict=on,ipv6=off,hostfwd=tcp:127.0.0.1:2202-:22", - "dgram,id=underlay,local.type=inet,local.host=127.0.0.1,local.port=20002,remote.type=inet,remote.host=127.0.0.1,remote.port=20003", - } - wantDevices := []string{ - "virtio-net-pci,netdev=mgmt0,mac=02:4d:00:02:00:00,romfile=", - "virtio-net-pci,netdev=underlay,mac=02:4c:00:02:00:00,host_mtu=9000,romfile=", - } - if got := value(t, hv.QEMU, "-netdev"); !reflect.DeepEqual(got, wantNetdevs) { - t.Errorf("netdevs = %v\nwant %v", got, wantNetdevs) - } - if got := value(t, hv.QEMU, "-device"); !reflect.DeepEqual(got, wantDevices) { - t.Errorf("devices = %v\nwant %v", got, wantDevices) - } -} - -func TestQEMU_SwitchNetwork(t *testing.T) { - sw := nodeNamed(t, renderAll(t, twoHypervisors), "sw1") - wantNetdevs := []string{ - "user,id=mgmt0,restrict=off,ipv6=off,hostfwd=tcp:127.0.0.1:2200-:22", - "dgram,id=p0,local.type=inet,local.host=127.0.0.1,local.port=20001,remote.type=inet,remote.host=127.0.0.1,remote.port=20000", - "dgram,id=p1,local.type=inet,local.host=127.0.0.1,local.port=20003,remote.type=inet,remote.host=127.0.0.1,remote.port=20002", - "dgram,id=p2,local.type=inet,local.host=127.0.0.1,local.port=20005,remote.type=inet,remote.host=127.0.0.1,remote.port=20004", - } - if got := value(t, sw.QEMU, "-netdev"); !reflect.DeepEqual(got, wantNetdevs) { - t.Errorf("netdevs = %v\nwant %v", got, wantNetdevs) - } - if !hasValue(sw.QEMU, "-device", "virtio-net-pci,netdev=p2,mac=02:4c:00:03:00:01,host_mtu=9000,romfile=") { - t.Errorf("p2 device missing: %v", sw.QEMU) - } -} - -func TestQEMU_OnlyTheSwitchReachesTheOutsideThroughAdministration(t *testing.T) { - for name, n := range renderAll(t, twoHypervisors) { - admin := value(t, n.QEMU, "-netdev")[0] - wantRestrict := "restrict=on" - if name == "sw1" { - wantRestrict = "restrict=off" - } - if !strings.Contains(admin, ","+wantRestrict+",") { - t.Errorf("%s admin netdev %q, want %s", name, admin, wantRestrict) - } - if !strings.Contains(admin, "hostfwd=tcp:127.0.0.1:") { - t.Errorf("%s ssh forward not bound to loopback: %q", name, admin) - } - } -} - -func TestQEMU_EveryCableEndsMatch(t *testing.T) { - ends := map[string]int{} - for _, n := range renderAll(t, twoHypervisors) { - for _, nd := range value(t, n.QEMU, "-netdev") { - if !strings.HasPrefix(nd, "dgram,") { - continue - } - var local, remote string - for _, kv := range strings.Split(nd, ",") { - if v, ok := strings.CutPrefix(kv, "local.port="); ok { - local = v - } - if v, ok := strings.CutPrefix(kv, "remote.port="); ok { - remote = v - } - } - ends[local+">"+remote]++ - } - } - for pair, count := range ends { - local, remote, _ := strings.Cut(pair, ">") - if count != 1 || ends[remote+">"+local] != 1 { - t.Errorf("cable end %s has no single matching end", pair) - } - } - if len(ends) != 6 { - t.Errorf("%d cable ends, want 6", len(ends)) - } -} - -func TestNetworkConfig_Hypervisor(t *testing.T) { - doc := network(t, nodeNamed(t, renderAll(t, twoHypervisors), "hv1")) - if doc.Version != 2 || len(doc.Ethernets) != 2 { - t.Fatalf("network-config = %+v", doc) - } - admin := iface(t, doc, "mgmt0") - if admin.Match.MACAddress != "02:4d:00:02:00:00" || admin.SetName != "mgmt0" || - !reflect.DeepEqual(admin.Addresses, []string{"10.0.2.15/24"}) || len(admin.Routes) != 0 || admin.Nameservers != nil { - t.Errorf("mgmt0 = %+v", admin) - } - under := iface(t, doc, "underlay") - if under.Match.MACAddress != "02:4c:00:02:00:00" || under.SetName != "underlay" || under.MTU != 9000 || - !reflect.DeepEqual(under.Addresses, []string{"10.250.0.3/24"}) { - t.Errorf("underlay = %+v", under) - } - if !reflect.DeepEqual(under.Routes, []route{{To: "0.0.0.0/0", Via: "10.250.0.1"}}) { - t.Errorf("underlay routes = %+v", under.Routes) - } - if under.Nameservers == nil || !reflect.DeepEqual(under.Nameservers.Addresses, []string{"1.1.1.1", "8.8.8.8"}) { - t.Errorf("underlay nameservers = %+v", under.Nameservers) - } -} - -func TestNetworkConfig_DHCPIsExplicitlyOffEverywhere(t *testing.T) { - for name, n := range renderAll(t, twoHypervisors) { - if c := strings.Count(string(n.NetworkConfig), "dhcp4: false"); c != len(network(t, n).Ethernets) { - t.Errorf("%s: %d explicit dhcp4: false for %d interfaces", name, c, len(network(t, n).Ethernets)) - } - } -} - -func TestNetworkConfig_Switch(t *testing.T) { - doc := network(t, nodeNamed(t, renderAll(t, twoHypervisors), "sw1")) - admin := iface(t, doc, "mgmt0") - if !reflect.DeepEqual(admin.Routes, []route{{To: "0.0.0.0/0", Via: "10.0.2.2"}}) || - admin.Nameservers == nil || !reflect.DeepEqual(admin.Nameservers.Addresses, []string{"10.0.2.3"}) { - t.Errorf("switch mgmt0 = %+v", admin) - } - for port, mac := range map[string]string{"p0": "02:4c:00:01:00:01", "p1": "02:4c:00:02:00:01", "p2": "02:4c:00:03:00:01"} { - e := iface(t, doc, port) - if e.Match.MACAddress != mac || e.SetName != port || e.MTU != 9000 || len(e.Addresses) != 0 || len(e.Routes) != 0 { - t.Errorf("%s = %+v", port, e) - } - } -} - -func TestNetworkConfig_DefaultRouteOnlyOnFirstSegment(t *testing.T) { - doc := network(t, nodeNamed(t, renderAll(t, twoSegments), "hv")) - red, blue := iface(t, doc, "red"), iface(t, doc, "blue") - if !reflect.DeepEqual(red.Routes, []route{{To: "0.0.0.0/0", Via: "10.1.0.1"}}) || red.Nameservers == nil { - t.Errorf("red = %+v", red) - } - if len(blue.Routes) != 0 || blue.Nameservers != nil || blue.MTU != 1500 { - t.Errorf("blue = %+v", blue) - } -} - -func TestUserData_HostWithoutProvision(t *testing.T) { - cfg := user(t, nodeNamed(t, renderAll(t, twoHypervisors), "hv1")) - if cfg.Hostname != "hv1" || !cfg.DisableRoot || len(cfg.Packages) != 0 || cfg.Runcmd != nil || len(cfg.WriteFiles) != 0 { - t.Errorf("hv1 user-data = %+v", cfg) - } - if !reflect.DeepEqual(cfg.SSHAuthorizedKeys, []string{labKey}) { - t.Errorf("keys = %v", cfg.SSHAuthorizedKeys) - } -} - -func TestUserData_PasswordLoginIsExplicitlyOff(t *testing.T) { - for name, n := range renderAll(t, twoHypervisors) { - if !strings.Contains(string(n.UserData), "\nssh_pwauth: false\n") || !strings.Contains(string(n.UserData), "\ndisable_root: true\n") { - t.Errorf("%s user-data:\n%s", name, n.UserData) - } - } -} - -func TestUserData_SwitchBuildsBridgeGatewayAndNAT(t *testing.T) { - cfg := user(t, nodeNamed(t, renderAll(t, twoHypervisors), "sw1")) - if !reflect.DeepEqual(cfg.Packages, []string{"nftables"}) { - t.Errorf("packages = %v", cfg.Packages) - } - script := fileAt(t, cfg, "/usr/local/sbin/lab-switch") - if script.Permissions != "0755" { - t.Errorf("script permissions = %s", script.Permissions) - } - wantScript := `#!/bin/sh -set -eu -sysctl -qw net.ipv4.ip_forward=1 -ip link add br-underlay type bridge stp_state 0 2>/dev/null || true -ip link set dev p0 master br-underlay -ip link set dev p0 up -ip link set dev p1 master br-underlay -ip link set dev p1 up -ip link set dev p2 master br-underlay -ip link set dev p2 up -ip link set dev br-underlay mtu 9000 -ip addr replace 10.250.0.1/24 dev br-underlay -ip link set dev br-underlay up -nft -f /etc/lab-switch.nft -` - if script.Content != wantScript { - t.Errorf("script:\n%s\nwant:\n%s", script.Content, wantScript) - } - nft := fileAt(t, cfg, "/etc/lab-switch.nft").Content - for _, want := range []string{ - "add table ip lab_nat\ndelete table ip lab_nat\n", - "type nat hook postrouting priority srcnat;", - `ip saddr { 10.250.0.0/24 } oifname "mgmt0" masquerade`, - } { - if !strings.Contains(nft, want) { - t.Errorf("nft rules miss %q:\n%s", want, nft) - } - } - unit := fileAt(t, cfg, "/etc/systemd/system/lab-switch.service").Content - for _, want := range []string{"Type=oneshot", "RemainAfterExit=yes", "ExecStart=/usr/local/sbin/lab-switch", "After=network-online.target", "WantedBy=multi-user.target"} { - if !strings.Contains(unit, want) { - t.Errorf("unit misses %q", want) - } - } - if !reflect.DeepEqual(cfg.Runcmd, [][]string{{"/usr/local/sbin/lab-provision"}}) { - t.Errorf("runcmd = %v", cfg.Runcmd) - } - if got := fileAt(t, cfg, "/usr/local/sbin/lab-provision").Content; got != "#!/bin/sh\nset -eu\nsystemctl daemon-reload\nsystemctl enable --now lab-switch.service\n" { - t.Errorf("lab-provision:\n%s", got) - } -} - -func TestUserData_SwitchWithTwoSegments(t *testing.T) { - cfg := user(t, nodeNamed(t, renderAll(t, twoSegments), "sw")) - script := fileAt(t, cfg, "/usr/local/sbin/lab-switch").Content - for _, want := range []string{ - "ip link set dev p0 master br-red\n", - "ip link set dev p1 master br-blue\n", - "ip link set dev br-blue mtu 1500\n", - "ip addr replace 10.2.0.1/24 dev br-blue\n", - } { - if !strings.Contains(script, want) { - t.Errorf("script misses %q:\n%s", want, script) - } - } - if strings.Contains(script, "p1 master br-red") || strings.Contains(script, "p0 master br-blue") { - t.Errorf("port bridged on the wrong segment:\n%s", script) - } - if nft := fileAt(t, cfg, "/etc/lab-switch.nft").Content; !strings.Contains(nft, "ip saddr { 10.1.0.0/24, 10.2.0.0/24 }") { - t.Errorf("nft:\n%s", nft) - } -} - -func TestMetaData(t *testing.T) { - var doc metaDoc - if err := yaml.Unmarshal(nodeNamed(t, renderAll(t, twoHypervisors), "hv2").MetaData, &doc); err != nil { - t.Fatal(err) - } - if doc.InstanceID != "evpn-2hv-hv2" || doc.LocalHostname != "hv2" { - t.Errorf("meta-data = %+v", doc) - } -} - -func TestRender_AdminMacsAreUniqueAndApartFromCableMacs(t *testing.T) { - seen := map[string]string{} - for name, n := range renderAll(t, twoHypervisors) { - for _, d := range value(t, n.QEMU, "-device") { - for _, kv := range strings.Split(d, ",") { - if mac, ok := strings.CutPrefix(kv, "mac="); ok { - if other, dup := seen[mac]; dup { - t.Errorf("mac %s used by %s and %s", mac, other, name) - } - seen[mac] = name - } - } - } - } - if len(seen) != 10 { - t.Errorf("%d distinct macs, want 10", len(seen)) - } -} - -func TestRender_IsStable(t *testing.T) { - first := renderAll(t, twoHypervisors) - for i := 0; i < 20; i++ { - if again := renderAll(t, twoHypervisors); !reflect.DeepEqual(first, again) { - t.Fatalf("render differs on run %d", i) - } - } -} - -func TestRender_RejectsBadOptions(t *testing.T) { - p := plan(t, twoHypervisors) - cases := []struct { - name string - opts Options - want string - }{ - {"relative run dir", Options{RunDir: "lab", AuthorizedKeys: []string{labKey}}, `run dir "lab" must be an absolute path`}, - {"no key", Options{RunDir: "/srv/lab"}, "at least one authorized ssh key"}, - {"multi-line key", Options{RunDir: "/srv/lab", AuthorizedKeys: []string{labKey + "\nssh-rsa AAAA x"}}, "authorized key 1 spans several lines"}, - {"not a key", Options{RunDir: "/srv/lab", AuthorizedKeys: []string{"hello world"}}, "authorized key 1 is not an ssh public key"}, - {"type only", Options{RunDir: "/srv/lab", AuthorizedKeys: []string{"ssh-ed25519"}}, "authorized key 1 is not an ssh public key"}, - } - for _, c := range cases { - t.Run(c.name, func(t *testing.T) { - _, err := Render(p, c.opts) - if err == nil || !strings.Contains(err.Error(), c.want) { - t.Fatalf("err = %v, want %q", err, c.want) - } - }) - } -} - -func TestRender_AcceptsUsualKeyTypes(t *testing.T) { - p := plan(t, twoHypervisors) - for _, k := range []string{ - "ssh-rsa AAAAB3NzaC1yc2E user", - "ecdsa-sha2-nistp256 AAAAE2VjZHNh user", - "sk-ssh-ed25519@openssh.com AAAAGnNr user", - } { - if _, err := Render(p, Options{RunDir: "/srv/lab", AuthorizedKeys: []string{k}}); err != nil { - t.Errorf("%s rejected: %v", strings.Fields(k)[0], err) - } - } -} diff --git a/internal/lab/render/roles_test.go b/internal/lab/render/roles_test.go deleted file mode 100644 index 686b3b5..0000000 --- a/internal/lab/render/roles_test.go +++ /dev/null @@ -1,312 +0,0 @@ -package render - -import ( - "crypto/sha256" - "encoding/base64" - "encoding/hex" - "reflect" - "strings" - "testing" -) - -const withRoles = `name: evpn-2hv -images: - deb: - url: https://example.invalid/deb.qcow2 - sums: https://example.invalid/SHA512SUMS -segments: - underlay: { switch: sw1, cidr: 192.168.14.0/24 } -nodes: - sw1: { role: switch, image: deb, cpus: 2, memory: 1024, secondary: { underlay: [169.254.0.1/28] }, frr: sw1.conf } - rr1: { role: rr, image: deb, cpus: 1, memory: 1024, segments: [underlay], secondary: { underlay: [169.254.0.3/28] }, loopback: 10.255.255.1/32, frr: rr1.conf } - hv1: { role: host, image: deb, cpus: 4, memory: 16384, segments: [underlay], frr: hv1.conf, provision: hv.sh, post_provision: hv-post.sh, files: { agent.yml: two.yml }, services: [agent.service] } - hv2: { role: host, image: deb, cpus: 4, memory: 16384, segments: [underlay] } -` - -var frrConfigs = map[string]string{ - "sw1": "hostname sw1\nrouter bgp 65100\n", - "rr1": "hostname rr1\nrouter bgp 65000\n", - "hv1": "hostname hv1\nrouter bgp 64600\n", -} - -func roleOptions() Options { - return Options{ - RunDir: "/srv/lab", - AuthorizedKeys: []string{labKey}, - FRR: frrConfigs, - Provision: map[string]string{"hv1": "#!/bin/sh\necho provision\n"}, - PostProvision: map[string]string{"hv1": "#!/bin/sh\necho post\n"}, - } -} - -func renderRoles(t *testing.T) map[string]Node { - t.Helper() - nodes, err := Render(plan(t, withRoles), roleOptions()) - if err != nil { - t.Fatalf("Render: %v", err) - } - out := map[string]Node{} - for _, n := range nodes { - out[n.Name] = n - } - return out -} - -func runcmd(t *testing.T, n Node) []string { - t.Helper() - var out []string - for _, c := range user(t, n).Runcmd { - out = append(out, strings.Join(c, " ")) - } - return out -} - -const frrScriptHead = `#!/bin/sh -set -eu -export DEBIAN_FRONTEND=noninteractive -. /etc/os-release -echo "deb [signed-by=/usr/share/keyrings/frrouting.gpg] https://deb.frrouting.org/frr ${VERSION_CODENAME} frr-stable" > /etc/apt/sources.list.d/frr.list -n=0 -until apt-get update -qq --error-on=any; do - n=$((n + 1)) - [ "$n" -lt 30 ] || exit 1 - sleep 10 -done -apt-get install -y -qq --no-install-recommends frr frr-pythontools -sed -i 's/^bgpd=no/bgpd=yes/' /etc/frr/daemons -` - -func TestRoles_SecondaryAddressFollowsThePrimaryOnTheNode(t *testing.T) { - doc := network(t, nodeNamed(t, renderRoles(t), "rr1")) - got := iface(t, doc, "underlay").Addresses - if !reflect.DeepEqual(got, []string{"192.168.14.2/24", "169.254.0.3/28"}) { - t.Errorf("rr1 underlay addresses = %v", got) - } -} - -func TestRoles_SwitchCarriesItsSecondaryOnTheBridge(t *testing.T) { - script := fileAt(t, user(t, nodeNamed(t, renderRoles(t), "sw1")), "/usr/local/sbin/lab-switch").Content - want := "ip addr replace 192.168.14.1/24 dev br-underlay\nip addr replace 169.254.0.1/28 dev br-underlay\nip link set dev br-underlay up\n" - if !strings.Contains(script, want) { - t.Errorf("lab-switch:\n%s\ndoes not contain:\n%s", script, want) - } -} - -func TestRoles_LoopbackOnADummyInterfaceReplayedAtBoot(t *testing.T) { - rr1 := nodeNamed(t, renderRoles(t), "rr1") - cfg := user(t, rr1) - - script := fileAt(t, cfg, "/usr/local/sbin/lab-node") - want := "#!/bin/sh\nset -eu\nip link add lo1 type dummy 2>/dev/null || true\nip addr replace 10.255.255.1/32 dev lo1\nip link set dev lo1 up\n" - if script.Content != want || script.Permissions != "0755" { - t.Errorf("lab-node (%s):\n%s", script.Permissions, script.Content) - } - unit := fileAt(t, cfg, "/etc/systemd/system/lab-node.service").Content - if !strings.Contains(unit, "ExecStart=/usr/local/sbin/lab-node\n") || !strings.Contains(unit, "WantedBy=multi-user.target\n") { - t.Errorf("lab-node.service:\n%s", unit) - } - want = "#!/bin/sh\nset -eu\nsystemctl daemon-reload\nsystemctl enable --now lab-node.service\n/usr/local/sbin/lab-frr\n" - if got := fileAt(t, cfg, "/usr/local/sbin/lab-provision").Content; got != want { - t.Errorf("lab-provision:\n%s\nwant:\n%s", got, want) - } -} - -func TestRoles_FRRConfigIsWrittenVerbatimAndPrivately(t *testing.T) { - for _, name := range []string{"sw1", "rr1", "hv1"} { - f := fileAt(t, user(t, nodeNamed(t, renderRoles(t), name)), "/etc/lab/frr.conf") - if f.Content != frrConfigs[name] || f.Permissions != "0640" { - t.Errorf("%s frr.conf (%s) = %q", name, f.Permissions, f.Content) - } - } -} - -func TestRoles_FRRDaemonsDependOnTheRole(t *testing.T) { - tail := "install -o frr -g frr -m 0640 /etc/lab/frr.conf /etc/frr/frr.conf\nsystemctl restart frr\n" - bfd := "sed -i 's/^bfdd=no/bfdd=yes/' /etc/frr/daemons\n" - nodes := renderRoles(t) - for name, want := range map[string]string{ - "sw1": frrScriptHead + bfd + tail, - "rr1": frrScriptHead + bfd + tail, - "hv1": frrScriptHead + tail, - } { - f := fileAt(t, user(t, nodeNamed(t, nodes, name)), "/usr/local/sbin/lab-frr") - if f.Content != want || f.Permissions != "0755" { - t.Errorf("%s lab-frr (%s):\n%s\nwant:\n%s", name, f.Permissions, f.Content, want) - } - } -} - -func TestRoles_FRRKeyIsThePinnedRepositoryKey(t *testing.T) { - f := fileAt(t, user(t, nodeNamed(t, renderRoles(t), "hv1")), "/usr/share/keyrings/frrouting.gpg") - if f.Encoding != "b64" || f.Permissions != "0644" { - t.Errorf("key file: encoding %q, permissions %q", f.Encoding, f.Permissions) - } - key, err := base64.StdEncoding.DecodeString(f.Content) - if err != nil { - t.Fatal(err) - } - sum := sha256.Sum256(key) - if got := hex.EncodeToString(sum[:]); got != "bf10935b9296e2ce7c5d9855fa29ef30c35810b0fc4b1f53005494a04a33554d" { - t.Errorf("key sha256 = %s", got) - } -} - -func TestRoles_ProvisioningIsOneScriptThatStopsAtTheFirstFailure(t *testing.T) { - nodes := renderRoles(t) - env := "LAB_NODE=hv1 LAB_UPLINK=underlay LAB_FILES=/etc/lab/files " - files := "mkdir -p /etc/lab/files /run/lab-files\nmount -o ro LABEL=LABFILES /run/lab-files\ncp -R /run/lab-files/. /etc/lab/files/\numount /run/lab-files\n" - for name, steps := range map[string]string{ - "sw1": "systemctl daemon-reload\nsystemctl enable --now lab-switch.service\n/usr/local/sbin/lab-frr\n", - "hv1": files + env + "/usr/local/sbin/lab-node-provision\n/usr/local/sbin/lab-frr\n" + env + "/usr/local/sbin/lab-node-post-provision\n", - } { - cfg := user(t, nodeNamed(t, nodes, name)) - if !reflect.DeepEqual(cfg.Runcmd, [][]string{{"/usr/local/sbin/lab-provision"}}) { - t.Errorf("%s runcmd = %q", name, cfg.Runcmd) - } - f := fileAt(t, cfg, "/usr/local/sbin/lab-provision") - if f.Content != "#!/bin/sh\nset -eu\n"+steps || f.Permissions != "0755" { - t.Errorf("%s lab-provision (%s):\n%s", name, f.Permissions, f.Content) - } - } - if cfg := user(t, nodeNamed(t, nodes, "hv2")); cfg.Runcmd != nil { - t.Errorf("hv2 has nothing to provision, runcmd = %q", cfg.Runcmd) - } -} - -func TestRoles_FilesTravelOnASecondCDROM(t *testing.T) { - nodes := renderRoles(t) - hv1 := nodeNamed(t, nodes, "hv1") - if !reflect.DeepEqual(hv1.Files, map[string]string{"agent.yml": "two.yml"}) { - t.Errorf("hv1 files = %v", hv1.Files) - } - drive := "file=/srv/lab/hv1/files.iso,media=cdrom,readonly=on" - if !strings.Contains(strings.Join(hv1.QEMU, " "), "-drive "+drive) { - t.Errorf("hv1 qemu lacks %s:\n%s", drive, strings.Join(hv1.QEMU, "\n")) - } - for _, f := range user(t, hv1).WriteFiles { - if strings.HasPrefix(f.Path, "/etc/lab/files/") { - t.Errorf("hv1 user-data carries %s, files belong to the ISO", f.Path) - } - } - for _, name := range []string{"sw1", "rr1", "hv2"} { - if n := nodeNamed(t, nodes, name); strings.Contains(strings.Join(n.QEMU, " "), "files.iso") || n.Files != nil { - t.Errorf("%s gets a files ISO", name) - } - } -} - -func TestRoles_HostReceivesItsScripts(t *testing.T) { - cfg := user(t, nodeNamed(t, renderRoles(t), "hv1")) - for path, want := range map[string]struct { - content string - permissions string - }{ - "/usr/local/sbin/lab-node-provision": {"#!/bin/sh\necho provision\n", "0755"}, - "/usr/local/sbin/lab-node-post-provision": {"#!/bin/sh\necho post\n", "0755"}, - } { - f := fileAt(t, cfg, path) - got, err := base64.StdEncoding.DecodeString(f.Content) - if err != nil { - t.Fatal(err) - } - if f.Encoding != "b64" || f.Permissions != want.permissions || string(got) != want.content { - t.Errorf("%s: encoding %q, permissions %q, content %q", path, f.Encoding, f.Permissions, got) - } - } -} - -func TestRoles_UplinkIsTheInterfaceCarryingTheDefaultRoute(t *testing.T) { - p := plan(t, twoSegments) - hv := nodeNamed(t, renderAll(t, twoSegments), "hv") - var withDefault []string - for name, e := range network(t, hv).Ethernets { - for _, r := range e.Routes { - if r.To == "0.0.0.0/0" { - withDefault = append(withDefault, name) - } - } - } - if !reflect.DeepEqual(withDefault, []string{"red"}) { - t.Fatalf("default route on %v, want [red]", withDefault) - } - for _, n := range p.Nodes { - if n.Name == "hv" { - if got := provisionEnv(p, n); got != "LAB_NODE=hv LAB_UPLINK=red LAB_FILES=/etc/lab/files " { - t.Errorf("provision environment = %q", got) - } - } - } -} - -func TestRoles_NodesWithoutProvisionReceiveNoProvisionFiles(t *testing.T) { - nodes := renderRoles(t) - for _, name := range []string{"sw1", "rr1", "hv2"} { - for _, f := range user(t, nodeNamed(t, nodes, name)).WriteFiles { - if strings.HasPrefix(f.Path, "/etc/lab/files/") || strings.HasPrefix(f.Path, "/usr/local/sbin/lab-node-") { - t.Errorf("%s receives %s", name, f.Path) - } - } - } -} - -func TestRoles_FRRDaemons(t *testing.T) { - p := plan(t, withRoles) - want := map[string][]string{"sw1": {"bgpd", "bfdd"}, "rr1": {"bgpd", "bfdd"}, "hv1": {"bgpd"}} - for _, n := range p.Nodes { - if w, ok := want[n.Name]; ok && !reflect.DeepEqual(frrDaemons(n), w) { - t.Errorf("%s daemons = %v, want %v", n.Name, frrDaemons(n), w) - } - } -} - -func TestRoles_NodeWithoutRoleFieldsGetsNoFRR(t *testing.T) { - for _, f := range user(t, nodeNamed(t, renderRoles(t), "hv2")).WriteFiles { - if strings.Contains(f.Path, "frr") { - t.Errorf("hv2 receives %s", f.Path) - } - } -} - -func TestRoles_RefusesAnUnreadFRRConfig(t *testing.T) { - configs := map[string]string{"sw1": "x", "rr1": "y"} - _, err := Render(plan(t, withRoles), Options{RunDir: "/srv/lab", AuthorizedKeys: []string{labKey}, FRR: configs}) - if err == nil || err.Error() != "node hv1: frr configuration hv1.conf was not read" { - t.Errorf("error = %v", err) - } -} - -func TestRoles_SwitchLoopbackIsCreatedByTheSwitchScript(t *testing.T) { - doc := strings.Replace(withRoles, "secondary: { underlay: [169.254.0.1/28] }, frr: sw1.conf", "secondary: { underlay: [169.254.0.1/28] }, loopback: 10.255.254.1/32, frr: sw1.conf", 1) - nodes, err := Render(plan(t, doc), roleOptions()) - if err != nil { - t.Fatalf("Render: %v", err) - } - var sw1 Node - for _, n := range nodes { - if n.Name == "sw1" { - sw1 = n - } - } - script := fileAt(t, user(t, sw1), "/usr/local/sbin/lab-switch").Content - want := "ip link set dev br-underlay up\nip link add lo1 type dummy 2>/dev/null || true\nip addr replace 10.255.254.1/32 dev lo1\nip link set dev lo1 up\nnft -f /etc/lab-switch.nft\n" - if !strings.HasSuffix(script, want) { - t.Errorf("lab-switch:\n%s\ndoes not end with:\n%s", script, want) - } -} - -func TestRoles_RefusesUnreadProvisionInputs(t *testing.T) { - cases := map[string]struct { - mutate func(*Options) - want string - }{ - "provision": {func(o *Options) { o.Provision = nil }, "node hv1: provision script hv.sh was not read"}, - "post": {func(o *Options) { o.PostProvision = nil }, "node hv1: post_provision script hv-post.sh was not read"}, - } - for name, c := range cases { - o := roleOptions() - c.mutate(&o) - if _, err := Render(plan(t, withRoles), o); err == nil || err.Error() != c.want { - t.Errorf("%s: error = %v, want %q", name, err, c.want) - } - } -} diff --git a/internal/lab/render/seed.go b/internal/lab/render/seed.go deleted file mode 100644 index 948fe5d..0000000 --- a/internal/lab/render/seed.go +++ /dev/null @@ -1,298 +0,0 @@ -package render - -import ( - _ "embed" - "encoding/base64" - "fmt" - "strings" - - "go.yaml.in/yaml/v3" - - "git.g3e.fr/syonad/two/internal/lab/topology" -) - -const ( - SwitchScript = "/usr/local/sbin/lab-switch" - SwitchNFT = "/etc/lab-switch.nft" - SwitchUnit = "/etc/systemd/system/lab-switch.service" - - NodeScript = "/usr/local/sbin/lab-node" - NodeUnit = "/etc/systemd/system/lab-node.service" - - FRRKey = "/usr/share/keyrings/frrouting.gpg" - FRRConfig = "/etc/lab/frr.conf" - FRRScript = "/usr/local/sbin/lab-frr" - FRRSuite = "frr-stable" - FRRRepo = "https://deb.frrouting.org/frr" - FRRPackages = "frr frr-pythontools" - - ProvisionScript = "/usr/local/sbin/lab-provision" - NodeProvision = "/usr/local/sbin/lab-node-provision" - NodePostProvision = "/usr/local/sbin/lab-node-post-provision" - FilesDir = "/etc/lab/files" - FilesMount = "/run/lab-files" -) - -//go:embed frrouting.gpg -var frrKey []byte - -type metaDoc struct { - InstanceID string `yaml:"instance-id"` - LocalHostname string `yaml:"local-hostname"` -} - -type writeFile struct { - Path string `yaml:"path"` - Permissions string `yaml:"permissions"` - Encoding string `yaml:"encoding,omitempty"` - Content string `yaml:"content"` -} - -type cloudConfig struct { - Hostname string `yaml:"hostname"` - SSHPwauth bool `yaml:"ssh_pwauth"` - DisableRoot bool `yaml:"disable_root"` - SSHAuthorizedKeys []string `yaml:"ssh_authorized_keys"` - Packages []string `yaml:"packages,omitempty"` - WriteFiles []writeFile `yaml:"write_files,omitempty"` - Runcmd [][]string `yaml:"runcmd,omitempty"` -} - -type match struct { - MACAddress string `yaml:"macaddress"` -} - -type route struct { - To string `yaml:"to"` - Via string `yaml:"via"` -} - -type nameservers struct { - Addresses []string `yaml:"addresses"` -} - -type ethernet struct { - Match match `yaml:"match"` - SetName string `yaml:"set-name"` - DHCP4 bool `yaml:"dhcp4"` - MTU int `yaml:"mtu,omitempty"` - Addresses []string `yaml:"addresses,omitempty"` - Routes []route `yaml:"routes,omitempty"` - Nameservers *nameservers `yaml:"nameservers,omitempty"` -} - -type networkDoc struct { - Version int `yaml:"version"` - Ethernets map[string]ethernet `yaml:"ethernets"` -} - -func metaData(p *topology.Plan, n topology.NodePlan) ([]byte, error) { - return yaml.Marshal(metaDoc{InstanceID: p.Name + "-" + n.Name, LocalHostname: n.Name}) -} - -func userData(p *topology.Plan, n topology.NodePlan, o Options) ([]byte, error) { - cfg := cloudConfig{ - Hostname: n.Name, - SSHPwauth: false, - DisableRoot: true, - SSHAuthorizedKeys: o.AuthorizedKeys, - } - var steps []string - switch { - case n.Role == topology.RoleSwitch: - cfg.Packages = []string{"nftables"} - cfg.WriteFiles = []writeFile{ - {Path: SwitchScript, Permissions: "0755", Content: switchScript(p, n)}, - {Path: SwitchNFT, Permissions: "0644", Content: switchNFT(p, n.Name)}, - {Path: SwitchUnit, Permissions: "0644", Content: unit("Lab switch: bridges, gateways and NAT", SwitchScript)}, - } - steps = append(steps, "systemctl daemon-reload", "systemctl enable --now lab-switch.service") - case n.Loopback.IsValid(): - cfg.WriteFiles = []writeFile{ - {Path: NodeScript, Permissions: "0755", Content: "#!/bin/sh\nset -eu\n" + loopbackLines(n)}, - {Path: NodeUnit, Permissions: "0644", Content: unit("Lab node: loopback", NodeScript)}, - } - steps = append(steps, "systemctl daemon-reload", "systemctl enable --now lab-node.service") - } - if len(n.Files) > 0 { - steps = append(steps, - "mkdir -p "+FilesDir+" "+FilesMount, - "mount -o ro LABEL="+FilesLabel+" "+FilesMount, - "cp -R "+FilesMount+"/. "+FilesDir+"/", - "umount "+FilesMount, - ) - } - if n.Provision != "" { - cfg.WriteFiles = append(cfg.WriteFiles, writeFile{Path: NodeProvision, Permissions: "0755", Encoding: "b64", Content: base64.StdEncoding.EncodeToString([]byte(o.Provision[n.Name]))}) - steps = append(steps, provisionEnv(p, n)+NodeProvision) - } - if n.FRR != "" { - cfg.WriteFiles = append(cfg.WriteFiles, - writeFile{Path: FRRKey, Permissions: "0644", Encoding: "b64", Content: base64.StdEncoding.EncodeToString(frrKey)}, - writeFile{Path: FRRConfig, Permissions: "0640", Content: o.FRR[n.Name]}, - writeFile{Path: FRRScript, Permissions: "0755", Content: frrScript(n)}, - ) - steps = append(steps, FRRScript) - } - if n.PostProvision != "" { - cfg.WriteFiles = append(cfg.WriteFiles, writeFile{Path: NodePostProvision, Permissions: "0755", Encoding: "b64", Content: base64.StdEncoding.EncodeToString([]byte(o.PostProvision[n.Name]))}) - steps = append(steps, provisionEnv(p, n)+NodePostProvision) - } - if len(steps) > 0 { - cfg.WriteFiles = append(cfg.WriteFiles, - writeFile{Path: ProvisionScript, Permissions: "0755", Content: "#!/bin/sh\nset -eu\n" + strings.Join(steps, "\n") + "\n"}, - ) - cfg.Runcmd = [][]string{{ProvisionScript}} - } - body, err := yaml.Marshal(cfg) - if err != nil { - return nil, err - } - return append([]byte("#cloud-config\n"), body...), nil -} - -func retry(command string) string { - return "n=0\nuntil " + command + "; do\n n=$((n + 1))\n [ \"$n\" -lt 30 ] || exit 1\n sleep 10\ndone\n" -} - -func provisionEnv(p *topology.Plan, n topology.NodePlan) string { - uplink := "" - if cables := nodeCables(p, n.Name); len(cables) > 0 { - uplink = cables[0].NodeInterface - } - return fmt.Sprintf("LAB_NODE=%s LAB_UPLINK=%s LAB_FILES=%s ", n.Name, uplink, FilesDir) -} - -func frrDaemons(n topology.NodePlan) []string { - if n.Role == topology.RoleHost { - return []string{"bgpd"} - } - return []string{"bgpd", "bfdd"} -} - -func frrScript(n topology.NodePlan) string { - var b strings.Builder - b.WriteString("#!/bin/sh\nset -eu\nexport DEBIAN_FRONTEND=noninteractive\n. /etc/os-release\n") - fmt.Fprintf(&b, "echo \"deb [signed-by=%s] %s ${VERSION_CODENAME} %s\" > /etc/apt/sources.list.d/frr.list\n", FRRKey, FRRRepo, FRRSuite) - b.WriteString(retry("apt-get update -qq --error-on=any")) - fmt.Fprintf(&b, "apt-get install -y -qq --no-install-recommends %s\n", FRRPackages) - for _, d := range frrDaemons(n) { - fmt.Fprintf(&b, "sed -i 's/^%s=no/%s=yes/' /etc/frr/daemons\n", d, d) - } - fmt.Fprintf(&b, "install -o frr -g frr -m 0640 %s /etc/frr/frr.conf\n", FRRConfig) - b.WriteString("systemctl restart frr\n") - return b.String() -} - -func loopbackLines(n topology.NodePlan) string { - if !n.Loopback.IsValid() { - return "" - } - return fmt.Sprintf("ip link add %s type dummy 2>/dev/null || true\nip addr replace %s dev %s\nip link set dev %s up\n", - topology.LoopbackInterface, n.Loopback, topology.LoopbackInterface, topology.LoopbackInterface) -} - -func networkConfig(p *topology.Plan, n topology.NodePlan, index int) ([]byte, error) { - doc := networkDoc{Version: 2, Ethernets: map[string]ethernet{}} - admin := ethernet{ - Match: match{MACAddress: adminMAC(index).String()}, - SetName: AdminInterface, - Addresses: []string{AdminAddress}, - } - if n.Role == topology.RoleSwitch { - admin.Routes = []route{{To: "0.0.0.0/0", Via: AdminGateway}} - admin.Nameservers = &nameservers{Addresses: []string{AdminDNS}} - for _, c := range switchCables(p, n.Name) { - doc.Ethernets[c.SwitchInterface] = ethernet{ - Match: match{MACAddress: c.SwitchMAC.String()}, - SetName: c.SwitchInterface, - MTU: c.MTU, - } - } - } - doc.Ethernets[AdminInterface] = admin - - for i, c := range nodeCables(p, n.Name) { - e := ethernet{ - Match: match{MACAddress: c.NodeMAC.String()}, - SetName: c.NodeInterface, - MTU: c.MTU, - Addresses: []string{c.NodeAddress.String()}, - } - for _, prefix := range n.Secondary[c.Segment] { - e.Addresses = append(e.Addresses, prefix.String()) - } - if i == 0 { - e.Routes = []route{{To: "0.0.0.0/0", Via: gatewayOf(p, c.Segment)}} - e.Nameservers = &nameservers{Addresses: Nameservers} - } - doc.Ethernets[c.NodeInterface] = e - } - return yaml.Marshal(doc) -} - -func gatewayOf(p *topology.Plan, segment string) string { - for _, s := range p.Segments { - if s.Name == segment { - return s.Gateway.String() - } - } - return "" -} - -func switchScript(p *topology.Plan, n topology.NodePlan) string { - name := n.Name - var b strings.Builder - b.WriteString("#!/bin/sh\nset -eu\nsysctl -qw net.ipv4.ip_forward=1\n") - for _, s := range switchSegments(p, name) { - fmt.Fprintf(&b, "ip link add %s type bridge stp_state 0 2>/dev/null || true\n", s.Bridge) - for _, c := range switchCables(p, name) { - if c.Segment != s.Name { - continue - } - fmt.Fprintf(&b, "ip link set dev %s master %s\n", c.SwitchInterface, s.Bridge) - fmt.Fprintf(&b, "ip link set dev %s up\n", c.SwitchInterface) - } - fmt.Fprintf(&b, "ip link set dev %s mtu %d\n", s.Bridge, s.MTU) - fmt.Fprintf(&b, "ip addr replace %s/%d dev %s\n", s.Gateway, s.Network.Bits(), s.Bridge) - for _, prefix := range n.Secondary[s.Name] { - fmt.Fprintf(&b, "ip addr replace %s dev %s\n", prefix, s.Bridge) - } - fmt.Fprintf(&b, "ip link set dev %s up\n", s.Bridge) - } - b.WriteString(loopbackLines(n)) - fmt.Fprintf(&b, "nft -f %s\n", SwitchNFT) - return b.String() -} - -func switchNFT(p *topology.Plan, name string) string { - var networks []string - for _, s := range switchSegments(p, name) { - networks = append(networks, s.Network.String()) - } - return fmt.Sprintf(`add table ip lab_nat -delete table ip lab_nat -table ip lab_nat { - chain postrouting { - type nat hook postrouting priority srcnat; policy accept; - ip saddr { %s } oifname "%s" masquerade - } -} -`, strings.Join(networks, ", "), AdminInterface) -} - -func unit(description, script string) string { - return fmt.Sprintf(`[Unit] -Description=%s -Wants=network-online.target -After=network-online.target - -[Service] -Type=oneshot -RemainAfterExit=yes -ExecStart=%s - -[Install] -WantedBy=multi-user.target -`, description, script) -} diff --git a/internal/lab/topology/format.go b/internal/lab/topology/format.go deleted file mode 100644 index 5f9e992..0000000 --- a/internal/lab/topology/format.go +++ /dev/null @@ -1,82 +0,0 @@ -package topology - -import ( - "fmt" - "io" - "path/filepath" - "sort" - "strings" - "text/tabwriter" -) - -func (p *Plan) Write(w io.Writer) error { - tw := tabwriter.NewWriter(w, 0, 0, 2, ' ', 0) - - fmt.Fprintf(tw, "lab %s: nodes %d, segments %d, cables %d\n", p.Name, len(p.Nodes), len(p.Segments), len(p.Cables)) - - fmt.Fprintf(tw, "\nnodes\n") - fmt.Fprintf(tw, " name\trole\timage\tcpus\tmemory\tssh\n") - for _, n := range p.Nodes { - fmt.Fprintf(tw, " %s\t%s\t%s\t%d\t%d MiB\t127.0.0.1:%d\n", n.Name, n.Role, n.Image, n.CPUs, n.Memory, n.SSHPort) - } - - var extras []NodePlan - for _, n := range p.Nodes { - if len(n.Secondary) > 0 || n.Loopback.IsValid() || n.FRR != "" || n.Provision != "" || n.PostProvision != "" || len(n.Files) > 0 || len(n.Services) > 0 { - extras = append(extras, n) - } - } - if len(extras) > 0 { - fmt.Fprintf(tw, "\nroles\n") - fmt.Fprintf(tw, " name\tloopback\tsecondary\tfrr\tprovision\tpost_provision\tfiles\tservices\n") - for _, n := range extras { - fmt.Fprintf(tw, " %s\t%s\t%s\t%s\t%s\t%s\t%s\t%s\n", n.Name, orDash(loopback(n)), orDash(secondary(n)), - orDash(filepath.Base(n.FRR)), orDash(filepath.Base(n.Provision)), orDash(filepath.Base(n.PostProvision)), - orDash(strings.Join(sortedKeys(n.Files), ",")), orDash(strings.Join(n.Services, ","))) - } - } - - for _, s := range p.Segments { - fmt.Fprintf(tw, "\nsegment %s: %s, mtu %d, switch %s, bridge %s, gateway %s\n", - s.Name, s.Network, s.MTU, s.Switch, s.Bridge, s.Gateway) - fmt.Fprintf(tw, " node\tinterface\taddress\tmac\tudp\t\tswitch port\tmac\tudp\n") - for _, c := range p.Cables { - if c.Segment != s.Name { - continue - } - fmt.Fprintf(tw, " %s\t%s\t%s\t%s\t%d\t<->\t%s %s\t%s\t%d\n", - c.Node, c.NodeInterface, c.NodeAddress, c.NodeMAC, c.NodePort, - c.Switch, c.SwitchInterface, c.SwitchMAC, c.SwitchPort) - } - } - return tw.Flush() -} - -func loopback(n NodePlan) string { - if !n.Loopback.IsValid() { - return "" - } - return LoopbackInterface + " " + n.Loopback.String() -} - -func secondary(n NodePlan) string { - segments := make([]string, 0, len(n.Secondary)) - for s := range n.Secondary { - segments = append(segments, s) - } - sort.Strings(segments) - var parts []string - for _, s := range segments { - for _, prefix := range n.Secondary[s] { - parts = append(parts, s+" "+prefix.String()) - } - } - return strings.Join(parts, ", ") -} - -func orDash(s string) string { - if s == "" || s == "." { - return "-" - } - return s -} diff --git a/internal/lab/topology/plan.go b/internal/lab/topology/plan.go deleted file mode 100644 index c0b1a39..0000000 --- a/internal/lab/topology/plan.go +++ /dev/null @@ -1,220 +0,0 @@ -package topology - -import ( - "errors" - "fmt" - "net" - "net/netip" - "strconv" -) - -const ( - SSHBasePort = 2200 - CableBasePort = 20000 - - maxNodes = 1000 - maxSegments = 256 -) - -type Plan struct { - Name string - Images []Image - Segments []SegmentPlan - Nodes []NodePlan - Cables []Cable -} - -type SegmentPlan struct { - Name string - Switch string - Bridge string - Network netip.Prefix - Gateway netip.Addr - MTU int -} - -type NodePlan struct { - Name string - Role string - Image string - CPUs int - Memory int - SSHPort int - Secondary map[string][]netip.Prefix - Loopback netip.Prefix - FRR string - Provision string - PostProvision string - Files map[string]string - Services []string -} - -type Cable struct { - Segment string - MTU int - - Node string - NodeInterface string - NodeMAC net.HardwareAddr - NodeAddress netip.Prefix - NodePort int - - Switch string - SwitchInterface string - SwitchMAC net.HardwareAddr - SwitchPort int -} - -func Compute(t *Topology) (*Plan, error) { - if err := t.Validate(); err != nil { - return nil, err - } - - p := &Plan{Name: t.Name, Images: append([]Image(nil), t.Images...)} - for i, n := range t.Nodes { - node := NodePlan{ - Name: n.Name, - Role: n.Role, - Image: n.Image, - CPUs: n.CPUs, - Memory: n.Memory, - SSHPort: SSHBasePort + i, - FRR: n.FRR, - Provision: n.Provision, - PostProvision: n.PostProvision, - Files: n.Files, - Services: n.Services, - } - for segment, raws := range n.Secondary { - for _, raw := range raws { - if node.Secondary == nil { - node.Secondary = map[string][]netip.Prefix{} - } - node.Secondary[segment] = append(node.Secondary[segment], netip.MustParsePrefix(raw)) - } - } - if n.Loopback != "" { - node.Loopback = netip.MustParsePrefix(n.Loopback) - } - p.Nodes = append(p.Nodes, node) - } - - var errs []error - for segIndex, s := range t.Segments { - network := netip.MustParsePrefix(s.CIDR) - gateway := network.Addr().Next() - p.Segments = append(p.Segments, SegmentPlan{ - Name: s.Name, - Switch: s.Switch, - Bridge: "br-" + s.Name, - Network: network, - Gateway: gateway, - MTU: s.MTU, - }) - - addresses, err := allocate(t, s, network, gateway) - if err != nil { - errs = append(errs, err) - continue - } - - for nodeIndex, n := range t.Nodes { - address, ok := addresses[n.Name] - if !ok { - continue - } - cable := len(p.Cables) - p.Cables = append(p.Cables, Cable{ - Segment: s.Name, - MTU: s.MTU, - Node: n.Name, - NodeInterface: s.Name, - NodeMAC: mac(nodeIndex, segIndex, 0), - NodeAddress: netip.PrefixFrom(address, network.Bits()), - NodePort: CableBasePort + 2*cable, - Switch: s.Switch, - SwitchInterface: "p" + strconv.Itoa(cable), - SwitchMAC: mac(nodeIndex, segIndex, 1), - SwitchPort: CableBasePort + 2*cable + 1, - }) - } - } - - if last := CableBasePort + 2*len(p.Cables) - 1; last > 65535 { - errs = append(errs, fmt.Errorf("cables: %d cables need udp ports up to %d, beyond 65535", len(p.Cables), last)) - } - if len(errs) > 0 { - return nil, errors.Join(errs...) - } - return p, nil -} - -func allocate(t *Topology, s Segment, network netip.Prefix, gateway netip.Addr) (map[string]netip.Addr, error) { - broadcast := lastAddr(network) - used := map[netip.Addr]string{gateway: s.Switch + " (gateway)"} - result := map[string]netip.Addr{} - var errs []error - - var auto []string - for _, n := range t.Nodes { - if !contains(n.Segments, s.Name) { - continue - } - raw, ok := n.Addresses[s.Name] - if !ok { - auto = append(auto, n.Name) - continue - } - addr := netip.MustParseAddr(raw) - switch { - case !network.Contains(addr): - errs = append(errs, fmt.Errorf("node %s: address %s is outside segment %s (%s)", n.Name, addr, s.Name, network)) - case addr == network.Addr() || addr == broadcast: - errs = append(errs, fmt.Errorf("node %s: address %s is the network or broadcast address of segment %s", n.Name, addr, s.Name)) - case used[addr] != "": - errs = append(errs, fmt.Errorf("node %s: address %s on segment %s is already taken by %s", n.Name, addr, s.Name, used[addr])) - default: - used[addr] = n.Name - result[n.Name] = addr - } - } - - next := gateway.Next() - for _, name := range auto { - for next != broadcast && used[next] != "" { - next = next.Next() - } - if next == broadcast { - errs = append(errs, fmt.Errorf("segment %s: no address left in %s for node %s", s.Name, network, name)) - break - } - used[next] = name - result[name] = next - next = next.Next() - } - - if len(errs) > 0 { - return nil, errors.Join(errs...) - } - return result, nil -} - -func lastAddr(network netip.Prefix) netip.Addr { - a := network.Addr().As4() - host := uint32(1)<<(32-network.Bits()) - 1 - v := (uint32(a[0])<<24 | uint32(a[1])<<16 | uint32(a[2])<<8 | uint32(a[3])) | host - return netip.AddrFrom4([4]byte{byte(v >> 24), byte(v >> 16), byte(v >> 8), byte(v)}) -} - -func mac(node, segment, side int) net.HardwareAddr { - return net.HardwareAddr{0x02, 0x4c, byte(node >> 8), byte(node), byte(segment), byte(side)} -} - -func contains(list []string, value string) bool { - for _, v := range list { - if v == value { - return true - } - } - return false -} diff --git a/internal/lab/topology/plan_test.go b/internal/lab/topology/plan_test.go deleted file mode 100644 index 6fb4279..0000000 --- a/internal/lab/topology/plan_test.go +++ /dev/null @@ -1,359 +0,0 @@ -package topology - -import ( - "bytes" - "fmt" - "net/netip" - "reflect" - "strings" - "testing" -) - -func compute(t *testing.T, doc string) *Plan { - t.Helper() - p, err := Compute(parse(t, doc)) - if err != nil { - t.Fatalf("Compute: %v", err) - } - return p -} - -func computeError(t *testing.T, doc string) string { - t.Helper() - _, err := Compute(parse(t, doc)) - if err == nil { - t.Fatalf("Compute accepted:\n%s", doc) - } - return err.Error() -} - -func cableOf(t *testing.T, p *Plan, node, segment string) Cable { - t.Helper() - for _, c := range p.Cables { - if c.Node == node && c.Segment == segment { - return c - } - } - t.Fatalf("no cable for %s on %s", node, segment) - return Cable{} -} - -func nodeOf(t *testing.T, p *Plan, name string) NodePlan { - t.Helper() - for _, n := range p.Nodes { - if n.Name == name { - return n - } - } - t.Fatalf("no node %s", name) - return NodePlan{} -} - -const twoHypervisors = header + ` -segments: - underlay: { switch: sw1, cidr: 10.250.0.0/24, mtu: 9000 } -nodes: - sw1: { role: switch, image: deb, cpus: 2, memory: 1024 } - rr1: { role: rr, image: deb, cpus: 1, memory: 1024, segments: [underlay] } - hv1: { role: host, image: deb, cpus: 4, memory: 16384, segments: [underlay] } - hv2: { role: host, image: deb, cpus: 4, memory: 16384, segments: [underlay] } -` - -func TestCompute_TwoHypervisorsPlan(t *testing.T) { - p := compute(t, twoHypervisors) - - if len(p.Segments) != 1 { - t.Fatalf("%d segments, want 1", len(p.Segments)) - } - s := p.Segments[0] - if s.Bridge != "br-underlay" || s.Gateway != netip.MustParseAddr("10.250.0.1") || s.MTU != 9000 || s.Switch != "sw1" { - t.Errorf("segment = %+v", s) - } - - want := []struct { - node, address, nodeMAC, switchMAC, switchIface string - nodePort, switchPort int - }{ - {"rr1", "10.250.0.2/24", "02:4c:00:01:00:00", "02:4c:00:01:00:01", "p0", 20000, 20001}, - {"hv1", "10.250.0.3/24", "02:4c:00:02:00:00", "02:4c:00:02:00:01", "p1", 20002, 20003}, - {"hv2", "10.250.0.4/24", "02:4c:00:03:00:00", "02:4c:00:03:00:01", "p2", 20004, 20005}, - } - if len(p.Cables) != len(want) { - t.Fatalf("%d cables, want %d", len(p.Cables), len(want)) - } - for _, w := range want { - c := cableOf(t, p, w.node, "underlay") - if c.NodeAddress.String() != w.address { - t.Errorf("%s address = %s, want %s", w.node, c.NodeAddress, w.address) - } - if c.NodeMAC.String() != w.nodeMAC || c.SwitchMAC.String() != w.switchMAC { - t.Errorf("%s macs = %s / %s, want %s / %s", w.node, c.NodeMAC, c.SwitchMAC, w.nodeMAC, w.switchMAC) - } - if c.NodePort != w.nodePort || c.SwitchPort != w.switchPort { - t.Errorf("%s ports = %d / %d, want %d / %d", w.node, c.NodePort, c.SwitchPort, w.nodePort, w.switchPort) - } - if c.NodeInterface != "underlay" || c.SwitchInterface != w.switchIface || c.Switch != "sw1" || c.MTU != 9000 { - t.Errorf("%s cable = %+v", w.node, c) - } - } - - for name, port := range map[string]int{"sw1": 2200, "rr1": 2201, "hv1": 2202, "hv2": 2203} { - if got := nodeOf(t, p, name).SSHPort; got != port { - t.Errorf("%s ssh port = %d, want %d", name, got, port) - } - } - if hv := nodeOf(t, p, "hv1"); hv.Role != "host" || hv.CPUs != 4 || hv.Memory != 16384 || hv.Image != "deb" { - t.Errorf("hv1 = %+v", hv) - } -} - -func TestCompute_CarriesTheDeclaredImages(t *testing.T) { - p := compute(t, twoHypervisors) - want := []Image{{Name: "deb", URL: "https://example.invalid/deb.qcow2", Sums: "https://example.invalid/SHA512SUMS"}} - if !reflect.DeepEqual(p.Images, want) { - t.Errorf("images = %+v, want %+v", p.Images, want) - } -} - -func TestCompute_IsStableAcrossRuns(t *testing.T) { - first := compute(t, twoHypervisors) - for i := 0; i < 20; i++ { - if again := compute(t, twoHypervisors); !reflect.DeepEqual(first, again) { - t.Fatalf("plan differs on run %d", i) - } - } -} - -func TestCompute_AddressesFollowDeclarationOrderNotNames(t *testing.T) { - p := compute(t, header+` -segments: - under: { switch: sw, cidr: 10.0.0.0/24 } -nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512 } - zeta: { role: rr, image: deb, cpus: 1, memory: 512, segments: [under] } - alfa: { role: rr, image: deb, cpus: 1, memory: 512, segments: [under] } -`) - if got := cableOf(t, p, "zeta", "under").NodeAddress.String(); got != "10.0.0.2/24" { - t.Errorf("zeta = %s, want 10.0.0.2/24", got) - } - if got := cableOf(t, p, "alfa", "under").NodeAddress.String(); got != "10.0.0.3/24" { - t.Errorf("alfa = %s, want 10.0.0.3/24", got) - } -} - -func TestCompute_ExplicitAddressIsKeptAndSkippedByAllocation(t *testing.T) { - p := compute(t, header+` -segments: - under: { switch: sw, cidr: 10.0.0.0/24 } -nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512 } - a: { role: rr, image: deb, cpus: 1, memory: 512, segments: [under] } - b: { role: rr, image: deb, cpus: 1, memory: 512, segments: [under], addresses: {under: 10.0.0.3} } - c: { role: rr, image: deb, cpus: 1, memory: 512, segments: [under] } -`) - for node, want := range map[string]string{"a": "10.0.0.2/24", "b": "10.0.0.3/24", "c": "10.0.0.4/24"} { - if got := cableOf(t, p, node, "under").NodeAddress.String(); got != want { - t.Errorf("%s = %s, want %s", node, got, want) - } - } -} - -func TestCompute_TwoSegmentsCableOrderMacsAndPorts(t *testing.T) { - p := compute(t, header+` -segments: - red: { switch: sw, cidr: 10.1.0.0/24 } - blue: { switch: sw, cidr: 10.2.0.0/24, mtu: 1500 } -nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512 } - hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [blue, red] } - rr: { role: rr, image: deb, cpus: 1, memory: 512, segments: [red] } -`) - got := make([]string, 0, len(p.Cables)) - for _, c := range p.Cables { - got = append(got, c.Segment+"/"+c.Node+"/"+c.SwitchInterface) - } - if strings.Join(got, ",") != "red/hv/p0,red/rr/p1,blue/hv/p2" { - t.Errorf("cable order = %v", got) - } - blue := cableOf(t, p, "hv", "blue") - if blue.NodeMAC.String() != "02:4c:00:01:01:00" || blue.NodePort != 20004 || blue.MTU != 1500 || blue.NodeAddress.String() != "10.2.0.2/24" { - t.Errorf("hv on blue = %+v", blue) - } - if red := cableOf(t, p, "hv", "red"); red.NodeMAC.String() != "02:4c:00:01:00:00" { - t.Errorf("hv on red mac = %s", red.NodeMAC) - } -} - -func TestCompute_EveryMacAndPortIsUnique(t *testing.T) { - p := compute(t, header+` -segments: - a: { switch: sw, cidr: 10.1.0.0/24 } - b: { switch: sw, cidr: 10.2.0.0/24 } -nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512 } - n1: { role: rr, image: deb, cpus: 1, memory: 512, segments: [a, b] } - n2: { role: rr, image: deb, cpus: 1, memory: 512, segments: [a, b] } - n3: { role: host, image: deb, cpus: 1, memory: 512, segments: [b, a] } -`) - macs := map[string]bool{} - ports := map[int]bool{} - for _, n := range p.Nodes { - ports[n.SSHPort] = true - } - for _, c := range p.Cables { - for _, m := range []string{c.NodeMAC.String(), c.SwitchMAC.String()} { - if macs[m] { - t.Errorf("mac %s used twice", m) - } - macs[m] = true - } - for _, port := range []int{c.NodePort, c.SwitchPort} { - if ports[port] { - t.Errorf("port %d used twice", port) - } - ports[port] = true - } - } - if len(macs) != 12 { - t.Errorf("%d distinct macs, want 12", len(macs)) - } -} - -func TestCompute_MacsAreLocallyAdministeredUnicast(t *testing.T) { - for _, c := range compute(t, twoHypervisors).Cables { - for _, m := range []string{c.NodeMAC.String(), c.SwitchMAC.String()} { - if !strings.HasPrefix(m, "02:") { - t.Errorf("mac %s is not locally administered unicast", m) - } - } - } -} - -func TestCompute_AddressRejections(t *testing.T) { - base := func(addresses string) string { - return header + ` -segments: - under: { switch: sw, cidr: 10.0.0.0/29 } -nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512 } - a: { role: rr, image: deb, cpus: 1, memory: 512, segments: [under]` + addresses + ` } - b: { role: rr, image: deb, cpus: 1, memory: 512, segments: [under], addresses: {under: 10.0.0.5} } -` - } - cases := []struct{ name, addresses, want string }{ - {"outside", ", addresses: {under: 10.0.1.2}", "node a: address 10.0.1.2 is outside segment under"}, - {"network", ", addresses: {under: 10.0.0.0}", "node a: address 10.0.0.0 is the network or broadcast"}, - {"broadcast", ", addresses: {under: 10.0.0.7}", "node a: address 10.0.0.7 is the network or broadcast"}, - {"gateway", ", addresses: {under: 10.0.0.1}", "node a: address 10.0.0.1 on segment under is already taken by sw (gateway)"}, - {"duplicate", ", addresses: {under: 10.0.0.5}", "node b: address 10.0.0.5 on segment under is already taken by a"}, - } - for _, c := range cases { - t.Run(c.name, func(t *testing.T) { - requireContains(t, computeError(t, base(c.addresses)), c.want) - }) - } -} - -func TestCompute_ReportsExhaustedSegment(t *testing.T) { - got := computeError(t, header+` -segments: - tiny: { switch: sw, cidr: 10.0.0.0/30 } -nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512 } - a: { role: rr, image: deb, cpus: 1, memory: 512, segments: [tiny] } - b: { role: rr, image: deb, cpus: 1, memory: 512, segments: [tiny] } -`) - requireContains(t, got, "segment tiny: no address left in 10.0.0.0/30 for node b") -} - -func TestCompute_FillsSegmentExactly(t *testing.T) { - p := compute(t, header+` -segments: - tiny: { switch: sw, cidr: 10.0.0.0/29 } -nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512 } - a: { role: rr, image: deb, cpus: 1, memory: 512, segments: [tiny] } - b: { role: rr, image: deb, cpus: 1, memory: 512, segments: [tiny] } - c: { role: rr, image: deb, cpus: 1, memory: 512, segments: [tiny] } - d: { role: rr, image: deb, cpus: 1, memory: 512, segments: [tiny] } - e: { role: rr, image: deb, cpus: 1, memory: 512, segments: [tiny] } -`) - if got := cableOf(t, p, "e", "tiny").NodeAddress.String(); got != "10.0.0.6/29" { - t.Errorf("last node = %s, want 10.0.0.6/29", got) - } -} - -func TestCompute_RefusesInvalidTopology(t *testing.T) { - requireContains(t, computeError(t, strings.Replace(valid, "role: rr", "role: router", 1)), `role "router"`) -} - -func TestLastAddr(t *testing.T) { - for cidr, want := range map[string]string{ - "10.0.0.0/24": "10.0.0.255", - "10.0.0.0/30": "10.0.0.3", - "10.250.0.0/16": "10.250.255.255", - "192.168.4.8/29": "192.168.4.15", - } { - if got := lastAddr(netip.MustParsePrefix(cidr)).String(); got != want { - t.Errorf("lastAddr(%s) = %s, want %s", cidr, got, want) - } - } -} - -func TestWrite_TwoHypervisorsPlan(t *testing.T) { - var buf bytes.Buffer - if err := compute(t, twoHypervisors).Write(&buf); err != nil { - t.Fatalf("Write: %v", err) - } - want := `lab lab-test: nodes 4, segments 1, cables 3 - -nodes - name role image cpus memory ssh - sw1 switch deb 2 1024 MiB 127.0.0.1:2200 - rr1 rr deb 1 1024 MiB 127.0.0.1:2201 - hv1 host deb 4 16384 MiB 127.0.0.1:2202 - hv2 host deb 4 16384 MiB 127.0.0.1:2203 - -segment underlay: 10.250.0.0/24, mtu 9000, switch sw1, bridge br-underlay, gateway 10.250.0.1 - node interface address mac udp switch port mac udp - rr1 underlay 10.250.0.2/24 02:4c:00:01:00:00 20000 <-> sw1 p0 02:4c:00:01:00:01 20001 - hv1 underlay 10.250.0.3/24 02:4c:00:02:00:00 20002 <-> sw1 p1 02:4c:00:02:00:01 20003 - hv2 underlay 10.250.0.4/24 02:4c:00:03:00:00 20004 <-> sw1 p2 02:4c:00:03:00:01 20005 -` - if buf.String() != want { - t.Errorf("output:\n%s\nwant:\n%s", buf.String(), want) - } -} - -func generated(segments, nodes int) string { - var b strings.Builder - b.WriteString(header + "segments:\n") - names := make([]string, segments) - for i := range names { - names[i] = fmt.Sprintf("s%d", i) - fmt.Fprintf(&b, " %s: { switch: sw, cidr: 10.%d.0.0/16 }\n", names[i], i%250) - } - b.WriteString("nodes:\n sw: { role: switch, image: deb, cpus: 1, memory: 512 }\n") - for i := 1; i < nodes; i++ { - fmt.Fprintf(&b, " n%d: { role: rr, image: deb, cpus: 1, memory: 512, segments: [%s] }\n", i, strings.Join(names, ", ")) - } - return b.String() -} - -func TestValidate_RejectsTooManyNodes(t *testing.T) { - requireContains(t, validationError(t, generated(1, 1001)), "nodes: 1001 declared, at most 1000") -} - -func TestValidate_AcceptsExactlyMaxNodes(t *testing.T) { - if err := parse(t, generated(1, 1000)).Validate(); err != nil { - t.Fatalf("1000 nodes rejected: %v", err) - } -} - -func TestValidate_RejectsTooManySegments(t *testing.T) { - requireContains(t, validationError(t, generated(257, 2)), "segments: 257 declared, at most 256") -} - -func TestCompute_RejectsCablesBeyondUDPPortRange(t *testing.T) { - requireContains(t, computeError(t, generated(23, 1000)), "cables: 22977 cables need udp ports up to 65953, beyond 65535") -} diff --git a/internal/lab/topology/roles_test.go b/internal/lab/topology/roles_test.go deleted file mode 100644 index 0be43ee..0000000 --- a/internal/lab/topology/roles_test.go +++ /dev/null @@ -1,273 +0,0 @@ -package topology - -import ( - "bytes" - "net/netip" - "os" - "path/filepath" - "reflect" - "testing" -) - -const withRoles = header + ` -segments: - underlay: { switch: sw1, cidr: 192.168.14.0/24 } -nodes: - sw1: { role: switch, image: deb, cpus: 2, memory: 1024, secondary: { underlay: [169.254.0.1/28] }, frr: frr/sw1.conf } - rr1: { role: rr, image: deb, cpus: 1, memory: 1024, segments: [underlay], secondary: { underlay: [169.254.0.3/28] }, loopback: 10.255.255.1/32, frr: frr/rr1.conf } - hv1: { role: host, image: deb, cpus: 4, memory: 16384, segments: [underlay], frr: /etc/lab/hv1.conf, provision: provision/hv.sh, post_provision: /opt/lab/post.sh, files: { agent.yml: agent/two.yml, deploy.sh: /opt/deploy.sh }, services: [agent.service] } -` - -func TestCompute_CarriesTheRoleFields(t *testing.T) { - p := compute(t, withRoles) - - rr1 := nodeOf(t, p, "rr1") - if !reflect.DeepEqual(rr1.Secondary, map[string][]netip.Prefix{"underlay": {netip.MustParsePrefix("169.254.0.3/28")}}) { - t.Errorf("rr1 secondary = %v", rr1.Secondary) - } - if rr1.Loopback != netip.MustParsePrefix("10.255.255.1/32") { - t.Errorf("rr1 loopback = %v", rr1.Loopback) - } - if rr1.FRR != "frr/rr1.conf" { - t.Errorf("rr1 frr = %q", rr1.FRR) - } - hv1 := nodeOf(t, p, "hv1") - if hv1.Secondary != nil || hv1.Loopback.IsValid() { - t.Errorf("hv1 = %+v, want no secondary and no loopback", hv1) - } -} - -func TestLoad_ResolvesFRRPathsAgainstTheTopologyFile(t *testing.T) { - dir := t.TempDir() - path := filepath.Join(dir, "lab.yml") - if err := os.WriteFile(path, []byte(withRoles), 0o600); err != nil { - t.Fatal(err) - } - - topo, err := Load(path) - if err != nil { - t.Fatalf("Load: %v", err) - } - - want := map[string]string{ - "sw1": filepath.Join(dir, "frr", "sw1.conf"), - "rr1": filepath.Join(dir, "frr", "rr1.conf"), - "hv1": "/etc/lab/hv1.conf", - } - for _, n := range topo.Nodes { - if n.FRR != want[n.Name] { - t.Errorf("%s frr = %q, want %q", n.Name, n.FRR, want[n.Name]) - } - } -} - -func TestValidate_RoleFieldRejections(t *testing.T) { - cases := map[string]struct { - node string - want string - }{ - "secondary on a segment not attached": { - `rr1: { role: rr, image: deb, cpus: 1, memory: 512, segments: [red], secondary: { blue: [169.254.0.3/28] } }`, - "node rr1: secondary address given for segment blue it is not attached to", - }, - "secondary without prefix length": { - `rr1: { role: rr, image: deb, cpus: 1, memory: 512, segments: [red], secondary: { red: [169.254.0.3] } }`, - `node rr1: secondary address "169.254.0.3" on red`, - }, - "secondary in IPv6": { - `rr1: { role: rr, image: deb, cpus: 1, memory: 512, segments: [red], secondary: { red: ["fd00::3/64"] } }`, - "node rr1: secondary address fd00::3/64 on red is not IPv4", - }, - "secondary inside the segment": { - `rr1: { role: rr, image: deb, cpus: 1, memory: 512, segments: [red], secondary: { red: [10.1.0.9/24] } }`, - "node rr1: secondary address 10.1.0.9/24 is inside segment red (10.1.0.0/24), use addresses instead", - }, - "loopback without prefix length": { - `rr1: { role: rr, image: deb, cpus: 1, memory: 512, segments: [red], loopback: 10.255.255.1 }`, - `node rr1: loopback "10.255.255.1"`, - }, - "loopback in IPv6": { - `rr1: { role: rr, image: deb, cpus: 1, memory: 512, segments: [red], loopback: "fd00::1/128" }`, - "node rr1: loopback fd00::1/128 is not IPv4", - }, - } - for name, c := range cases { - t.Run(name, func(t *testing.T) { - doc := header + ` -segments: - red: { switch: sw, cidr: 10.1.0.0/24 } - blue: { switch: sw, cidr: 10.2.0.0/24 } -nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512 } - hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [red, blue] } - ` + c.node + ` -` - requireContains(t, validationError(t, doc), c.want) - }) - } -} - -func TestValidate_SwitchSecondaryOnlyOnItsOwnSegments(t *testing.T) { - doc := header + ` -segments: - red: { switch: sw, cidr: 10.1.0.0/24 } - blue: { switch: other, cidr: 10.2.0.0/24 } -nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512, secondary: { red: [169.254.0.1/28], blue: [169.254.1.1/28] } } - other: { role: switch, image: deb, cpus: 1, memory: 512 } - hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [red, blue] } -` - msg := validationError(t, doc) - requireContains(t, msg, "node sw: secondary address given for segment blue it is not attached to") - if bytes.Contains([]byte(msg), []byte("segment red")) { - t.Errorf("the switch's own segment was refused:\n%s", msg) - } -} - -func TestValidate_LoopbackInterfaceNameIsReserved(t *testing.T) { - doc := header + ` -segments: - lo1: { switch: sw, cidr: 10.1.0.0/24 } -nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512 } - hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [lo1] } -` - requireContains(t, validationError(t, doc), "segment lo1: name is reserved for the loopback interface") -} - -func TestWrite_ShowsTheRoles(t *testing.T) { - var buf bytes.Buffer - if err := compute(t, withRoles).Write(&buf); err != nil { - t.Fatalf("Write: %v", err) - } - want := ` -roles - name loopback secondary frr provision post_provision files services - sw1 - underlay 169.254.0.1/28 sw1.conf - - - - - rr1 lo1 10.255.255.1/32 underlay 169.254.0.3/28 rr1.conf - - - - - hv1 - - hv1.conf hv.sh post.sh agent.yml,deploy.sh agent.service -` - if !bytes.Contains(buf.Bytes(), []byte(want)) { - t.Errorf("plan:\n%s\ndoes not contain:\n%s", buf.String(), want) - } -} - -func TestWrite_NoRolesSectionWithoutRoleFields(t *testing.T) { - var buf bytes.Buffer - doc := header + ` -segments: - underlay: { switch: sw1, cidr: 10.250.0.0/24 } -nodes: - sw1: { role: switch, image: deb, cpus: 1, memory: 512 } - rr1: { role: rr, image: deb, cpus: 1, memory: 512, segments: [underlay] } -` - if err := compute(t, doc).Write(&buf); err != nil { - t.Fatalf("Write: %v", err) - } - if bytes.Contains(buf.Bytes(), []byte("roles")) { - t.Errorf("plan shows a roles section:\n%s", buf.String()) - } -} - -func TestValidate_ProvisionRejections(t *testing.T) { - cases := map[string]struct { - node string - want string - }{ - "the hypervisor role is gone": { - `hv: { role: hypervisor, image: deb, cpus: 1, memory: 512, segments: [red] }`, - `node hv: role "hypervisor" must be one of switch, rr, host`, - }, - "file name leaving the files directory": { - `hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [red], files: { ../etc/passwd: a.yml } }`, - `node hv: file name "../etc/passwd" must match`, - }, - "file without source": { - `hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [red], files: { agent.yml: "" } }`, - "node hv: file agent.yml has no source", - }, - "file source with an equals sign": { - `hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [red], files: { bin: "a=b" } }`, - `node hv: file bin: source "a=b" must not contain '='`, - }, - "service with shell characters": { - `hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [red], services: ["agent.service; reboot"] }`, - `node hv: service "agent.service; reboot" must match`, - }, - "service listed twice": { - `hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [red], services: [agent.service, agent.service] }`, - "node hv: service agent.service listed twice", - }, - } - for name, c := range cases { - t.Run(name, func(t *testing.T) { - doc := header + ` -segments: - red: { switch: sw, cidr: 10.1.0.0/24 } -nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512 } - ` + c.node + ` -` - requireContains(t, validationError(t, doc), c.want) - }) - } -} - -func TestValidate_ProvisionIsAllowedOnEveryRole(t *testing.T) { - doc := header + ` -segments: - red: { switch: sw, cidr: 10.1.0.0/24 } -nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512, provision: sw.sh, files: { a.conf: a.conf }, services: [lab-switch.service] } - rr: { role: rr, image: deb, cpus: 1, memory: 512, segments: [red], provision: rr.sh, post_provision: rr-post.sh } - hv: { role: host, image: deb, cpus: 1, memory: 512, segments: [red], files: { agent.yml: agent.yml }, services: [agent.service] } -` - compute(t, doc) -} - -func TestCompute_CarriesTheProvision(t *testing.T) { - hv1 := nodeOf(t, compute(t, withRoles), "hv1") - if hv1.Provision != "provision/hv.sh" || hv1.PostProvision != "/opt/lab/post.sh" { - t.Errorf("hv1 provision = %q, post_provision = %q", hv1.Provision, hv1.PostProvision) - } - if !reflect.DeepEqual(hv1.Files, map[string]string{"agent.yml": "agent/two.yml", "deploy.sh": "/opt/deploy.sh"}) { - t.Errorf("hv1 files = %v", hv1.Files) - } - if !reflect.DeepEqual(hv1.Services, []string{"agent.service"}) { - t.Errorf("hv1 services = %v", hv1.Services) - } - rr1 := nodeOf(t, compute(t, withRoles), "rr1") - if rr1.Provision != "" || rr1.PostProvision != "" || rr1.Files != nil || rr1.Services != nil { - t.Errorf("rr1 = %+v, want no provision", rr1) - } -} - -func TestLoad_ResolvesProvisionPathsAgainstTheTopologyFile(t *testing.T) { - dir := t.TempDir() - path := filepath.Join(dir, "lab.yml") - if err := os.WriteFile(path, []byte(withRoles), 0o600); err != nil { - t.Fatal(err) - } - topo, err := Load(path) - if err != nil { - t.Fatalf("Load: %v", err) - } - p, err := Compute(topo) - if err != nil { - t.Fatal(err) - } - hv1 := nodeOf(t, p, "hv1") - if hv1.Provision != filepath.Join(dir, "provision", "hv.sh") { - t.Errorf("provision = %q", hv1.Provision) - } - if hv1.PostProvision != "/opt/lab/post.sh" { - t.Errorf("post_provision = %q, an absolute path must be kept", hv1.PostProvision) - } - want := map[string]string{"agent.yml": filepath.Join(dir, "agent", "two.yml"), "deploy.sh": "/opt/deploy.sh"} - if !reflect.DeepEqual(hv1.Files, want) { - t.Errorf("files = %v, want %v", hv1.Files, want) - } - if rr1 := nodeOf(t, p, "rr1"); rr1.Provision != "" || rr1.Files != nil { - t.Errorf("rr1 = %+v", rr1) - } -} diff --git a/internal/lab/topology/topology.go b/internal/lab/topology/topology.go deleted file mode 100644 index a5a4296..0000000 --- a/internal/lab/topology/topology.go +++ /dev/null @@ -1,189 +0,0 @@ -package topology - -import ( - "bytes" - "errors" - "fmt" - "os" - "path/filepath" - - "go.yaml.in/yaml/v3" -) - -const ( - RoleSwitch = "switch" - RoleRR = "rr" - RoleHost = "host" - - DefaultMTU = 9000 -) - -type Topology struct { - Name string - Images []Image - Segments []Segment - Nodes []Node -} - -type Image struct { - Name string - URL string - Sums string -} - -type Segment struct { - Name string - Switch string - CIDR string - MTU int -} - -type Node struct { - Name string - Role string - Image string - CPUs int - Memory int - Segments []string - Addresses map[string]string - Secondary map[string][]string - Loopback string - FRR string - Provision string - PostProvision string - Files map[string]string - Services []string -} - -type fileImage struct { - URL string `yaml:"url"` - Sums string `yaml:"sums"` -} - -type fileSegment struct { - Switch string `yaml:"switch"` - CIDR string `yaml:"cidr"` - MTU int `yaml:"mtu"` -} - -type fileNode struct { - Role string `yaml:"role"` - Image string `yaml:"image"` - CPUs int `yaml:"cpus"` - Memory int `yaml:"memory"` - Segments []string `yaml:"segments"` - Addresses map[string]string `yaml:"addresses"` - Secondary map[string][]string `yaml:"secondary"` - Loopback string `yaml:"loopback"` - FRR string `yaml:"frr"` - Provision string `yaml:"provision"` - PostProvision string `yaml:"post_provision"` - Files map[string]string `yaml:"files"` - Services []string `yaml:"services"` -} - -type file struct { - Name string `yaml:"name"` - Images map[string]fileImage `yaml:"images"` - Segments map[string]fileSegment `yaml:"segments"` - Nodes map[string]fileNode `yaml:"nodes"` -} - -func Load(path string) (*Topology, error) { - data, err := os.ReadFile(path) - if err != nil { - return nil, err - } - t, err := Parse(data) - if err != nil { - return nil, fmt.Errorf("%s: %w", path, err) - } - dir := filepath.Dir(path) - for i, n := range t.Nodes { - t.Nodes[i].FRR = relativeTo(dir, n.FRR) - t.Nodes[i].Provision = relativeTo(dir, n.Provision) - t.Nodes[i].PostProvision = relativeTo(dir, n.PostProvision) - for name, src := range n.Files { - t.Nodes[i].Files[name] = relativeTo(dir, src) - } - } - return t, nil -} - -func relativeTo(dir, path string) string { - if path == "" || filepath.IsAbs(path) { - return path - } - return filepath.Join(dir, path) -} - -func Parse(data []byte) (*Topology, error) { - var f file - dec := yaml.NewDecoder(bytes.NewReader(data)) - dec.KnownFields(true) - if err := dec.Decode(&f); err != nil { - return nil, fmt.Errorf("yaml: %w", err) - } - - var root yaml.Node - if err := yaml.Unmarshal(data, &root); err != nil { - return nil, fmt.Errorf("yaml: %w", err) - } - order, err := keyOrder(&root) - if err != nil { - return nil, err - } - - t := &Topology{Name: f.Name} - for _, name := range order["images"] { - i := f.Images[name] - t.Images = append(t.Images, Image{Name: name, URL: i.URL, Sums: i.Sums}) - } - for _, name := range order["segments"] { - s := f.Segments[name] - mtu := s.MTU - if mtu == 0 { - mtu = DefaultMTU - } - t.Segments = append(t.Segments, Segment{Name: name, Switch: s.Switch, CIDR: s.CIDR, MTU: mtu}) - } - for _, name := range order["nodes"] { - n := f.Nodes[name] - t.Nodes = append(t.Nodes, Node{ - Name: name, - Role: n.Role, - Image: n.Image, - CPUs: n.CPUs, - Memory: n.Memory, - Segments: n.Segments, - Addresses: n.Addresses, - Secondary: n.Secondary, - Loopback: n.Loopback, - FRR: n.FRR, - Provision: n.Provision, - PostProvision: n.PostProvision, - Files: n.Files, - Services: n.Services, - }) - } - return t, nil -} - -func keyOrder(root *yaml.Node) (map[string][]string, error) { - order := map[string][]string{} - if root.Kind != yaml.DocumentNode || len(root.Content) != 1 || root.Content[0].Kind != yaml.MappingNode { - return nil, errors.New("yaml: the document must be a mapping") - } - top := root.Content[0] - for i := 0; i+1 < len(top.Content); i += 2 { - section := top.Content[i].Value - value := top.Content[i+1] - if value.Kind != yaml.MappingNode { - continue - } - for j := 0; j+1 < len(value.Content); j += 2 { - order[section] = append(order[section], value.Content[j].Value) - } - } - return order, nil -} diff --git a/internal/lab/topology/topology_test.go b/internal/lab/topology/topology_test.go deleted file mode 100644 index d050a0f..0000000 --- a/internal/lab/topology/topology_test.go +++ /dev/null @@ -1,173 +0,0 @@ -package topology - -import ( - "strings" - "testing" -) - -const header = `name: lab-test -images: - deb: - url: https://example.invalid/deb.qcow2 - sums: https://example.invalid/SHA512SUMS -` - -func parse(t *testing.T, doc string) *Topology { - t.Helper() - topo, err := Parse([]byte(doc)) - if err != nil { - t.Fatalf("Parse: %v", err) - } - return topo -} - -func validationError(t *testing.T, doc string) string { - t.Helper() - err := parse(t, doc).Validate() - if err == nil { - t.Fatalf("Validate accepted an invalid topology:\n%s", doc) - } - return err.Error() -} - -func requireContains(t *testing.T, got, want string) { - t.Helper() - if !strings.Contains(got, want) { - t.Fatalf("error does not mention %q:\n%s", want, got) - } -} - -func TestParse_KeepsDeclarationOrderOfNodesAndSegments(t *testing.T) { - topo := parse(t, header+` -segments: - zulu: { switch: sw, cidr: 10.0.1.0/24 } - alpha: { switch: sw, cidr: 10.0.2.0/24 } -nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512 } - zeta: { role: rr, image: deb, cpus: 1, memory: 512, segments: [zulu, alpha] } - beta: { role: rr, image: deb, cpus: 1, memory: 512, segments: [zulu] } -`) - var nodes, segments []string - for _, n := range topo.Nodes { - nodes = append(nodes, n.Name) - } - for _, s := range topo.Segments { - segments = append(segments, s.Name) - } - if got := strings.Join(nodes, ","); got != "sw,zeta,beta" { - t.Errorf("node order = %s, want sw,zeta,beta", got) - } - if got := strings.Join(segments, ","); got != "zulu,alpha" { - t.Errorf("segment order = %s, want zulu,alpha", got) - } -} - -func TestParse_DefaultsMTUTo9000(t *testing.T) { - topo := parse(t, header+` -segments: - under: { switch: sw, cidr: 10.0.0.0/24 } -nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512 } -`) - if topo.Segments[0].MTU != 9000 { - t.Errorf("MTU = %d, want 9000", topo.Segments[0].MTU) - } -} - -func TestParse_RejectsUnknownField(t *testing.T) { - _, err := Parse([]byte(header + ` -nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512, ram: 4 } -`)) - if err == nil || !strings.Contains(err.Error(), "ram") { - t.Fatalf("unknown field not rejected: %v", err) - } -} - -func TestParse_RejectsDuplicateNode(t *testing.T) { - _, err := Parse([]byte(header + ` -nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512 } - sw: { role: rr, image: deb, cpus: 1, memory: 512 } -`)) - if err == nil || !strings.Contains(err.Error(), "already defined") { - t.Fatalf("duplicate node not rejected: %v", err) - } -} - -func TestParse_RejectsNonMappingDocument(t *testing.T) { - if _, err := Parse([]byte("- a\n- b\n")); err == nil { - t.Fatal("a list document was accepted") - } -} - -func TestLoad_ReportsPathOnError(t *testing.T) { - if _, err := Load("/nonexistent/lab.yml"); err == nil { - t.Fatal("missing file accepted") - } -} - -const valid = header + ` -segments: - under: { switch: sw, cidr: 10.0.0.0/24 } -nodes: - sw: { role: switch, image: deb, cpus: 1, memory: 512 } - rr: { role: rr, image: deb, cpus: 1, memory: 512, segments: [under] } -` - -func TestValidate_AcceptsMinimalTopology(t *testing.T) { - if err := parse(t, valid).Validate(); err != nil { - t.Fatalf("Validate: %v", err) - } -} - -func TestValidate_Rejections(t *testing.T) { - cases := []struct { - name, doc, want string - }{ - {"bad lab name", strings.Replace(valid, "name: lab-test", "name: Lab_Test", 1), `name "Lab_Test"`}, - {"image url not https", strings.Replace(valid, "url: https://", "url: http://", 1), "image deb: url"}, - {"image sums not https", strings.Replace(valid, "sums: https://", "sums: ftp://", 1), "image deb: sums"}, - {"no node", header + "\nsegments: {}\nnodes: {}\n", "at least one node"}, - {"segment switch missing", strings.Replace(valid, "switch: sw, cidr", "cidr", 1), "segment under: switch is required"}, - {"segment switch unknown", strings.Replace(valid, "switch: sw, cidr", "switch: ghost, cidr", 1), "switch ghost is not a declared node"}, - {"segment switch not a switch", strings.Replace(valid, "switch: sw, cidr", "switch: rr, cidr", 1), "rr is a rr, not a switch"}, - {"segment name too long", strings.ReplaceAll(valid, "under", "underlayunder"), "segment underlayunder: name must match"}, - {"segment named like the admin interface", strings.ReplaceAll(valid, "under", "mgmt0"), "segment mgmt0: name is reserved"}, - {"segment name with dash", strings.ReplaceAll(valid, "under", "un-der"), "segment un-der: name must match"}, - {"mtu too high", strings.Replace(valid, "cidr: 10.0.0.0/24", "cidr: 10.0.0.0/24, mtu: 9001", 1), "mtu 9001 out of range"}, - {"mtu too low", strings.Replace(valid, "cidr: 10.0.0.0/24", "cidr: 10.0.0.0/24, mtu: 1279", 1), "mtu 1279 out of range"}, - {"cidr unparsable", strings.Replace(valid, "10.0.0.0/24", "10.0.0/24", 1), `cidr "10.0.0/24"`}, - {"cidr ipv6", strings.Replace(valid, "10.0.0.0/24", "fd00::/64", 1), "is not IPv4"}, - {"cidr host bits", strings.Replace(valid, "10.0.0.0/24", "10.0.0.5/24", 1), "network is 10.0.0.0/24"}, - {"cidr too small", strings.Replace(valid, "10.0.0.0/24", "10.0.0.0/31", 1), "prefix length out of range"}, - {"cidr too large", strings.Replace(valid, "10.0.0.0/24", "10.0.0.0/7", 1), "prefix length out of range"}, - {"bad node name", strings.Replace(valid, " rr: {", " RR: {", 1), "node RR: name must match"}, - {"bad role", strings.Replace(valid, "role: rr", "role: router", 1), `role "router"`}, - {"unknown image", strings.Replace(valid, "role: rr, image: deb", "role: rr, image: ubuntu", 1), `image "ubuntu" is not declared`}, - {"no cpu", strings.Replace(valid, "role: rr, image: deb, cpus: 1", "role: rr, image: deb, cpus: 0", 1), "node rr: cpus must be at least 1"}, - {"memory too low", strings.Replace(valid, "cpus: 1, memory: 512, segments", "cpus: 1, memory: 255, segments", 1), "node rr: memory must be at least 256"}, - {"switch with segments", strings.Replace(valid, "role: switch, image: deb, cpus: 1, memory: 512 }", "role: switch, image: deb, cpus: 1, memory: 512, segments: [under] }", 1), "node sw: a switch carries its segments"}, - {"switch with addresses", strings.Replace(valid, "role: switch, image: deb, cpus: 1, memory: 512 }", "role: switch, image: deb, cpus: 1, memory: 512, addresses: {under: 10.0.0.9} }", 1), "node sw: a switch carries its segments"}, - {"switch without segment", valid + " sw2: { role: switch, image: deb, cpus: 1, memory: 512 }\n", "node sw2: switch carries no segment"}, - {"node without segment", valid + " rr2: { role: rr, image: deb, cpus: 1, memory: 512 }\n", "node rr2: must be attached to at least one segment"}, - {"node on unknown segment", strings.Replace(valid, "segments: [under]", "segments: [over]", 1), "node rr: segment over is not declared"}, - {"node on segment twice", strings.Replace(valid, "segments: [under]", "segments: [under, under]", 1), "node rr: segment under listed twice"}, - {"segment without node", strings.Replace(valid, " under: { switch: sw, cidr: 10.0.0.0/24 }", " under: { switch: sw, cidr: 10.0.0.0/24 }\n empty: { switch: sw, cidr: 10.0.9.0/24 }", 1), "segment empty: no node is attached"}, - {"address on foreign segment", strings.Replace(valid, "segments: [under]", "segments: [under], addresses: {over: 10.0.0.9}", 1), "address given for segment over"}, - {"address unparsable", strings.Replace(valid, "segments: [under]", "segments: [under], addresses: {under: 10.0.0}", 1), `address "10.0.0" on under`}, - } - for _, c := range cases { - t.Run(c.name, func(t *testing.T) { - requireContains(t, validationError(t, c.doc), c.want) - }) - } -} - -func TestValidate_ReportsEveryErrorAtOnce(t *testing.T) { - doc := strings.Replace(valid, "role: rr", "role: router", 1) - doc = strings.Replace(doc, "10.0.0.0/24", "10.0.0.0/31", 1) - got := validationError(t, doc) - requireContains(t, got, `role "router"`) - requireContains(t, got, "prefix length out of range") -} diff --git a/internal/lab/topology/validate.go b/internal/lab/topology/validate.go deleted file mode 100644 index 7161b1f..0000000 --- a/internal/lab/topology/validate.go +++ /dev/null @@ -1,249 +0,0 @@ -package topology - -import ( - "errors" - "fmt" - "net/netip" - "regexp" - "sort" - "strings" -) - -const ( - MinMTU = 1280 - MaxMTU = 9000 - MinMemory = 256 - MaxPrefix = 30 - MinPrefix = 8 - - ReservedInterface = "mgmt0" - LoopbackInterface = "lo1" -) - -var ( - namePattern = regexp.MustCompile(`^[a-z][a-z0-9-]{0,14}$`) - segmentPattern = regexp.MustCompile(`^[a-z][a-z0-9]{0,11}$`) - filePattern = regexp.MustCompile(`^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$`) - unitPattern = regexp.MustCompile(`^[A-Za-z0-9][A-Za-z0-9@._:-]{0,127}$`) -) - -func (t *Topology) Validate() error { - var errs []error - add := func(format string, args ...any) { - errs = append(errs, fmt.Errorf(format, args...)) - } - - if !namePattern.MatchString(t.Name) { - add("name %q: must match %s", t.Name, namePattern) - } - - images := map[string]bool{} - for _, i := range t.Images { - images[i.Name] = true - if !strings.HasPrefix(i.URL, "https://") { - add("image %s: url must be an https:// URL", i.Name) - } - if !strings.HasPrefix(i.Sums, "https://") { - add("image %s: sums must be an https:// URL", i.Name) - } - } - - nodes := map[string]Node{} - for _, n := range t.Nodes { - nodes[n.Name] = n - } - if len(t.Nodes) == 0 { - add("nodes: at least one node is required") - } - if len(t.Segments) > maxSegments { - add("segments: %d declared, at most %d", len(t.Segments), maxSegments) - } - if len(t.Nodes) > maxNodes { - add("nodes: %d declared, at most %d", len(t.Nodes), maxNodes) - } - - segments := map[string]Segment{} - for _, s := range t.Segments { - segments[s.Name] = s - if !segmentPattern.MatchString(s.Name) { - add("segment %s: name must match %s", s.Name, segmentPattern) - } - if s.Name == ReservedInterface { - add("segment %s: name is reserved for the administration interface", s.Name) - } - if s.Name == LoopbackInterface { - add("segment %s: name is reserved for the loopback interface", s.Name) - } - sw, ok := nodes[s.Switch] - switch { - case s.Switch == "": - add("segment %s: switch is required", s.Name) - case !ok: - add("segment %s: switch %s is not a declared node", s.Name, s.Switch) - case sw.Role != RoleSwitch: - add("segment %s: %s is a %s, not a switch", s.Name, s.Switch, sw.Role) - } - if s.MTU < MinMTU || s.MTU > MaxMTU { - add("segment %s: mtu %d out of range [%d, %d]", s.Name, s.MTU, MinMTU, MaxMTU) - } - prefix, err := netip.ParsePrefix(s.CIDR) - switch { - case err != nil: - add("segment %s: cidr %q: %v", s.Name, s.CIDR, err) - case !prefix.Addr().Is4(): - add("segment %s: cidr %s is not IPv4", s.Name, s.CIDR) - case prefix.Masked() != prefix: - add("segment %s: cidr %s has host bits set, network is %s", s.Name, s.CIDR, prefix.Masked()) - case prefix.Bits() < MinPrefix || prefix.Bits() > MaxPrefix: - add("segment %s: cidr %s prefix length out of range [/%d, /%d]", s.Name, s.CIDR, MinPrefix, MaxPrefix) - } - } - - attached := map[string]int{} - hosting := map[string]int{} - for _, s := range t.Segments { - hosting[s.Switch]++ - } - for _, n := range t.Nodes { - if !namePattern.MatchString(n.Name) { - add("node %s: name must match %s", n.Name, namePattern) - } - switch n.Role { - case RoleSwitch, RoleRR, RoleHost: - default: - add("node %s: role %q must be one of %s, %s, %s", n.Name, n.Role, RoleSwitch, RoleRR, RoleHost) - } - if !images[n.Image] { - add("node %s: image %q is not declared", n.Name, n.Image) - } - if n.CPUs < 1 { - add("node %s: cpus must be at least 1", n.Name) - } - if n.Memory < MinMemory { - add("node %s: memory must be at least %d MiB", n.Name, MinMemory) - } - validateExtras(n, segments, add) - if n.Role == RoleSwitch { - if len(n.Segments) > 0 || len(n.Addresses) > 0 { - add("node %s: a switch carries its segments through segments..switch, not through segments or addresses", n.Name) - } - if hosting[n.Name] == 0 { - add("node %s: switch carries no segment", n.Name) - } - continue - } - if len(n.Segments) == 0 { - add("node %s: must be attached to at least one segment", n.Name) - } - seen := map[string]bool{} - for _, name := range n.Segments { - if seen[name] { - add("node %s: segment %s listed twice", n.Name, name) - continue - } - seen[name] = true - if _, ok := segments[name]; !ok { - add("node %s: segment %s is not declared", n.Name, name) - continue - } - attached[name]++ - } - for _, name := range sortedKeys(n.Addresses) { - address := n.Addresses[name] - if !seen[name] { - add("node %s: address given for segment %s it is not attached to", n.Name, name) - continue - } - if _, err := netip.ParseAddr(address); err != nil { - add("node %s: address %q on %s: %v", n.Name, address, name, err) - } - } - } - - for _, s := range t.Segments { - if attached[s.Name] == 0 { - add("segment %s: no node is attached", s.Name) - } - } - - if len(errs) > 0 { - return errors.Join(errs...) - } - return nil -} - -func validateExtras(n Node, segments map[string]Segment, add func(string, ...any)) { - carried := map[string]bool{} - if n.Role == RoleSwitch { - for name, s := range segments { - if s.Switch == n.Name { - carried[name] = true - } - } - } else { - for _, name := range n.Segments { - carried[name] = true - } - } - names := make([]string, 0, len(n.Secondary)) - for name := range n.Secondary { - names = append(names, name) - } - sort.Strings(names) - for _, name := range names { - if !carried[name] { - add("node %s: secondary address given for segment %s it is not attached to", n.Name, name) - continue - } - network, _ := netip.ParsePrefix(segments[name].CIDR) - for _, raw := range n.Secondary[name] { - prefix, err := netip.ParsePrefix(raw) - switch { - case err != nil: - add("node %s: secondary address %q on %s: %v", n.Name, raw, name, err) - case !prefix.Addr().Is4(): - add("node %s: secondary address %s on %s is not IPv4", n.Name, raw, name) - case network.IsValid() && network.Contains(prefix.Addr()): - add("node %s: secondary address %s is inside segment %s (%s), use addresses instead", n.Name, raw, name, network) - } - } - } - for _, name := range sortedKeys(n.Files) { - switch { - case !filePattern.MatchString(name): - add("node %s: file name %q must match %s", n.Name, name, filePattern) - case n.Files[name] == "": - add("node %s: file %s has no source", n.Name, name) - case strings.Contains(n.Files[name], "="): - add("node %s: file %s: source %q must not contain '='", n.Name, name, n.Files[name]) - } - } - seenUnits := map[string]bool{} - for _, unit := range n.Services { - switch { - case !unitPattern.MatchString(unit): - add("node %s: service %q must match %s", n.Name, unit, unitPattern) - case seenUnits[unit]: - add("node %s: service %s listed twice", n.Name, unit) - } - seenUnits[unit] = true - } - if n.Loopback != "" { - prefix, err := netip.ParsePrefix(n.Loopback) - switch { - case err != nil: - add("node %s: loopback %q: %v", n.Name, n.Loopback, err) - case !prefix.Addr().Is4(): - add("node %s: loopback %s is not IPv4", n.Name, n.Loopback) - } - } -} - -func sortedKeys(m map[string]string) []string { - keys := make([]string, 0, len(m)) - for k := range m { - keys = append(keys, k) - } - sort.Strings(keys) - return keys -} diff --git a/scripts/lab-host.sh b/scripts/lab-host.sh deleted file mode 100755 index db1e985..0000000 --- a/scripts/lab-host.sh +++ /dev/null @@ -1,507 +0,0 @@ -#!/usr/bin/env bash - -API_URL="${SCW_API_URL:-https://api.scaleway.com}" -CREDENTIALS_FILE="${LAB_CREDENTIALS_FILE:-${HOME}/.config/labctl/scaleway.env}" -OFFER_NAME="${LAB_OFFER:-EM-B420E-NVME}" -ALL_ZONES="fr-par-1 fr-par-2 nl-ams-1 nl-ams-2 pl-waw-2 pl-waw-3" -OS_NAME="${LAB_OS_NAME:-Debian}" -OS_VERSION="${LAB_OS_VERSION:-12}" -LAB_NAME="${LAB_NAME:-labctl}" -LAB_TAG="${LAB_TAG:-labctl}" -INSTALL_TIMEOUT="${LAB_INSTALL_TIMEOUT:-3600}" -DELETE_TIMEOUT="${LAB_DELETE_TIMEOUT:-900}" -SSH_TIMEOUT="${LAB_SSH_TIMEOUT:-600}" -POLL_INTERVAL="${LAB_POLL_INTERVAL:-20}" -HTTP_CONNECT_TIMEOUT="${LAB_HTTP_CONNECT_TIMEOUT:-10}" -HTTP_TIMEOUT="${LAB_HTTP_TIMEOUT:-60}" -STATE_DIR="${LAB_STATE_DIR:-${HOME}/.cache/labctl}" -SSH_KEY="${LAB_SSH_KEY:-${HOME}/.config/labctl/ssh/lab_ed25519}" -REPO_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" -CREATED_ID="" - -info () { echo "== ${1}" >&2; } -warn () { echo "!! ${1}" >&2; } -die () { echo "!! ${1}" >&2; exit 1; } - -usage () { - cat >&2 < [arguments] - - plan résout l'offre horaire, l'OS et les clés SSH, affiche la requête de création - et le prix ; ne crée rien - up crée le serveur de lab, attend la fin de son installation et son SSH, - puis le prépare (voir prepare) - status liste les serveurs de lab du projet, dans toutes les zones candidates - ssh [commande] se connecte au serveur de lab ; avec une commande, un terminal n'est demandé - que si l'entrée standard en est un - prepare installe sur le serveur ce dont labctl a besoin (qemu, genisoimage), vérifie - /dev/kvm, la virtualisation imbriquée et un CPU x86-64-v3 ; lancé aussi par up - push compile cmd/labctl pour linux/amd64 et dépose sur le serveur ~/labctl et le - répertoire de la topologie dans ~/topology/ (avec les fichiers qu'elle - référence) ; ensuite : ssh './labctl up topology/' - down supprime tous les serveurs de lab du projet, dans toutes les zones candidates, - et attend leur disparition - session [cmd] up, puis la commande distante (ou un shell), puis down quoi qu'il arrive - -environnement : SCW_SECRET_KEY et SCW_DEFAULT_PROJECT_ID (requis, à défaut lus dans ${CREDENTIALS_FILE}, - fichier en 0600, lignes CLÉ=valeur), LAB_ZONES (zones candidates, dans l'ordre : - ${ZONES} ; SCW_DEFAULT_ZONE passe en tête), LAB_OFFER (${OFFER_NAME}), LAB_OS_NAME (${OS_NAME}), LAB_OS_VERSION (${OS_VERSION}), - LAB_SSH_KEY (${SSH_KEY} ; à défaut, l'agent SSH) - -ne jamais lancer sous 'bash -x' : la trace afficherait SCW_SECRET_KEY. -EOF - exit 2 -} - -load_credentials () { - local KEY VALUE - if [[ -z "${SCW_SECRET_KEY:-}" || -z "${SCW_DEFAULT_PROJECT_ID:-}" ]] && [[ -f "${CREDENTIALS_FILE}" ]]; then - [[ $(ls -l "${CREDENTIALS_FILE}" | cut -c5-10) == "------" ]] \ - || die "${CREDENTIALS_FILE} est lisible par d'autres que son propriétaire : chmod 600" - while IFS='=' read -r KEY VALUE || [[ -n "${KEY}" ]]; do - case "${KEY}" in - SCW_SECRET_KEY) [[ -n "${SCW_SECRET_KEY:-}" ]] || SCW_SECRET_KEY="${VALUE}" ;; - SCW_DEFAULT_PROJECT_ID) [[ -n "${SCW_DEFAULT_PROJECT_ID:-}" ]] || SCW_DEFAULT_PROJECT_ID="${VALUE}" ;; - SCW_DEFAULT_ZONE) [[ -n "${SCW_DEFAULT_ZONE:-}" ]] || SCW_DEFAULT_ZONE="${VALUE}" ;; - esac - done < "${CREDENTIALS_FILE}" - fi - ZONES=$(candidate_zones "${SCW_DEFAULT_ZONE:-}" "${LAB_ZONES:-${ALL_ZONES}}") - ZONE="${ZONES%% *}" - PROJECT_ID="${SCW_DEFAULT_PROJECT_ID:-}" -} - -candidate_zones () { - local PREFERRED="${1}" LIST="${2}" Z OUT="${1}" - for Z in ${LIST}; do - [[ " ${OUT} " == *" ${Z} "* ]] || OUT="${OUT:+${OUT} }${Z}" - done - printf '%s\n' "${OUT}" -} - -require_env () { - [[ -n "${SCW_SECRET_KEY:-}" ]] || die "SCW_SECRET_KEY absent de l'environnement" - [[ -n "${PROJECT_ID}" ]] || die "SCW_DEFAULT_PROJECT_ID absent de l'environnement" - command -v jq >/dev/null 2>&1 || die "jq est requis" - command -v curl >/dev/null 2>&1 || die "curl est requis" -} - -http_code () { - cat "${STATE_DIR}/last_http_code" 2>/dev/null -} - -api () { - local METHOD="${1}" - local URL_PATH="${2}" - local BODY="${3:-}" - local OUT CODE - local -a ARGS=(-sS -X "${METHOD}" -H "Content-Type: application/json" -w '\n%{http_code}' - --connect-timeout "${HTTP_CONNECT_TIMEOUT}" --max-time "${HTTP_TIMEOUT}") - - : > "${STATE_DIR}/last_http_code" - [[ -n "${BODY}" ]] && ARGS+=(--data "${BODY}") - OUT=$(curl "${ARGS[@]}" -H @<(printf 'X-Auth-Token: %s\n' "${SCW_SECRET_KEY}") "${API_URL}${URL_PATH}") \ - || { warn "${METHOD} ${URL_PATH} : échec réseau"; return 1; } - CODE="${OUT##*$'\n'}" - OUT="${OUT%$'\n'*}" - printf '%s' "${CODE}" > "${STATE_DIR}/last_http_code" - if [[ "${CODE}" -lt 200 || "${CODE}" -ge 300 ]]; then - warn "${METHOD} ${URL_PATH} : HTTP ${CODE} ${OUT}" - return 1 - fi - printf '%s\n' "${OUT}" -} - -http_failure_is_final () { - local CODE - CODE=$(http_code) - [[ "${CODE}" =~ ^4[0-9][0-9]$ && "${CODE}" != "429" ]] -} - -money () { - jq -r "${1} | if . == null then \"?\" else \"\\(.units + .nanos / 1000000000) \\(.currency_code)\" end" -} - -resolve_offer () { - local JSON OFFER COUNT - JSON=$(api GET "/baremetal/v1/zones/${ZONE}/offers?subscription_period=hourly&name=${OFFER_NAME}&page_size=100") \ - || die "impossible de lister les offres" - OFFER=$(jq -c --arg n "${OFFER_NAME}" \ - '[.offers[] | select(.name == $n and .subscription_period == "hourly")]' <<< "${JSON}") - COUNT=$(jq 'length' <<< "${OFFER}") - [[ "${COUNT}" -eq 1 ]] || die "offre horaire ${OFFER_NAME} : ${COUNT} correspondance(s) en ${ZONE}, une seule attendue" - OFFER=$(jq -c '.[0]' <<< "${OFFER}") - [[ $(jq -r '.enable' <<< "${OFFER}") == "true" ]] || die "offre ${OFFER_NAME} désactivée" - [[ $(jq -r '.stock' <<< "${OFFER}") != "empty" ]] || die "offre ${OFFER_NAME} en rupture de stock en ${ZONE}" - [[ $(jq -r '((.fee.units // 0) == 0) and ((.fee.nanos // 0) == 0)' <<< "${OFFER}") == "true" ]] \ - || die "offre ${OFFER_NAME} : frais de mise en service non nuls ($(money '.fee' <<< "${OFFER}")), refus" - jq -c --arg z "${ZONE}" '. + {zone: $z}' <<< "${OFFER}" -} - -resolve_os () { - local OFFER_ID="${1}" - local JSON OS COUNT - JSON=$(api GET "/baremetal/v1/zones/${ZONE}/os?offer_id=${OFFER_ID}&page_size=100") \ - || die "impossible de lister les OS" - OS=$(jq -c --arg n "${OS_NAME}" --arg v "${OS_VERSION}" \ - '[.os[] | select(.enabled and .allowed and (.name | ascii_downcase | contains($n | ascii_downcase)) - and (.version | split(" ")[0] | split(".")[0]) == $v)]' <<< "${JSON}") - COUNT=$(jq 'length' <<< "${OS}") - if [[ "${COUNT}" -ne 1 ]]; then - warn "OS disponibles pour ${OFFER_NAME} :" - jq -r '.os[] | " \(.name) \(.version) (\(.id))"' <<< "${JSON}" >&2 - die "OS ${OS_NAME} ${OS_VERSION} : ${COUNT} correspondance(s), une seule attendue" - fi - jq -c '.[0]' <<< "${OS}" -} - -resolve_ssh_keys () { - local JSON - JSON=$(api GET "/iam/v1alpha1/ssh-keys?project_id=${PROJECT_ID}&disabled=false&page_size=100") \ - || die "impossible de lister les clés SSH du projet" - JSON=$(jq -c '[.ssh_keys[] | select(.disabled | not) | .id]' <<< "${JSON}") - [[ $(jq 'length' <<< "${JSON}") -gt 0 ]] || die "aucune clé SSH active dans le projet ${PROJECT_ID}" - printf '%s\n' "${JSON}" -} - -build_request () { - local OFFER="${1}" - local OS="${2}" - local KEYS="${3}" - jq -nc --argjson offer "${OFFER}" --argjson os "${OS}" --argjson keys "${KEYS}" \ - --arg project "${PROJECT_ID}" --arg name "${LAB_NAME}" --arg tag "${LAB_TAG}" \ - '{offer_id: $offer.id, project_id: $project, name: $name, description: "labctl", - tags: [$tag], install: {os_id: $os.id, hostname: $name, ssh_key_ids: $keys}}' -} - -lab_servers () { - local JSON Z ALL="[]" RC=0 - for Z in ${ZONES}; do - if ! JSON=$(api GET "/baremetal/v1/zones/${Z}/servers?project_id=${PROJECT_ID}&tags=${LAB_TAG}&page_size=100"); then - warn "zone ${Z} : liste des serveurs de lab indisponible" - RC=1 - continue - fi - ALL=$(jq -c --argjson all "${ALL}" --arg p "${PROJECT_ID}" --arg t "${LAB_TAG}" --arg z "${Z}" \ - '$all + [.servers[] | select(.project_id == $p and (.tags | index($t))) | . + {zone: $z}]' <<< "${JSON}") - done - printf '%s\n' "${ALL}" - return "${RC}" -} - -server_ip () { - jq -r '[.ips[] | select(.version == "IPv4") | .address][0] // empty' -} - -server_is_installing () { - jq -e '.status == "delivering" or .status == "ordered" - or (.install.status // "") == "to_install" or (.install.status // "") == "installing"' >/dev/null -} - -select_zone () { - local Z OUT - for Z in ${ZONES}; do - if OUT=$(ZONE="${Z}" resolve_offer 2>&1); then - printf '%s\n' "${OUT}" - return 0 - fi - warn "${Z} : ${OUT##*!! }" - done - die "offre horaire ${OFFER_NAME} disponible dans aucune zone candidate (${ZONES})" -} - -cmd_plan () { - local OFFER OS KEYS - OFFER=$(select_zone) || exit 1 - ZONE=$(jq -r '.zone' <<< "${OFFER}") - OS=$(resolve_os "$(jq -r '.id' <<< "${OFFER}")") || exit 1 - KEYS=$(resolve_ssh_keys) || exit 1 - info "zone : ${ZONE}" - info "offre : ${OFFER_NAME} ($(jq -r '.id' <<< "${OFFER}")), $(jq -r '[.cpus[]?.name] | unique | join(", ") | if . == "" then "CPU ?" else . end' <<< "${OFFER}"), facturation $(jq -r '.subscription_period' <<< "${OFFER}"), stock $(jq -r '.stock' <<< "${OFFER}")" - info "prix : $(money '.price_per_hour' <<< "${OFFER}") HT par heure, frais de mise en service $(money '.fee' <<< "${OFFER}")" - info "os : $(jq -r '"\(.name) \(.version) (\(.id))"' <<< "${OS}"), utilisateur $(jq -r '.user.default_value // "?"' <<< "${OS}")" - info "clés : $(jq -r 'length' <<< "${KEYS}") clé(s) SSH du projet" - info "requête : POST /baremetal/v1/zones/${ZONE}/servers" - build_request "${OFFER}" "${OS}" "${KEYS}" | jq . -} - -wait_installed () { - local ID="${1}" - local DEADLINE=$(( SECONDS + INSTALL_TIMEOUT )) - local JSON STATUS INSTALL - while (( SECONDS < DEADLINE )); do - if ! JSON=$(api GET "/baremetal/v1/zones/${ZONE}/servers/${ID}"); then - if http_failure_is_final; then - warn "erreur définitive HTTP $(http_code) en attendant l'installation" - return 1 - fi - sleep "${POLL_INTERVAL}" - continue - fi - STATUS=$(jq -r '.status' <<< "${JSON}") - INSTALL=$(jq -r '.install.status // "none"' <<< "${JSON}") - info "serveur ${ID} : ${STATUS}, installation ${INSTALL}" - case "${STATUS}/${INSTALL}" in - ready/completed) printf '%s\n' "${JSON}"; return 0 ;; - error/*|*/error|out_of_stock/*|locked/*|deleting/*|stopped/*|stopping/*) - warn "état terminal en échec : ${STATUS}/${INSTALL}"; return 1 ;; - esac - sleep "${POLL_INTERVAL}" - done - warn "installation non terminée après ${INSTALL_TIMEOUT}s" - return 1 -} - -ssh_run () { - local -a OPTS=() - while [[ $# -gt 0 && "${1}" != "--" ]]; do - OPTS+=("${1}") - shift - done - [[ "${1:-}" == "--" ]] && shift - [[ -f "${SSH_KEY}" ]] && OPTS+=(-i "${SSH_KEY}" -o IdentitiesOnly=yes -o IdentityAgent=none) - env -u SCW_SECRET_KEY ssh -o StrictHostKeyChecking=accept-new -o UserKnownHostsFile="${STATE_DIR}/known_hosts" \ - "${OPTS[@]}" "$(cat "${STATE_DIR}/user")@$(cat "${STATE_DIR}/ip")" "$@" -} - -wait_ssh () { - local DEADLINE=$(( SECONDS + SSH_TIMEOUT )) - while (( SECONDS < DEADLINE )); do - ssh_run -o BatchMode=yes -o ConnectTimeout=5 -- true >/dev/null 2>&1 && return 0 - info "SSH pas encore joignable, nouvel essai dans ${POLL_INTERVAL}s" - sleep "${POLL_INTERVAL}" - done - return 1 -} - -require_no_lab_server () { - local EXISTING - EXISTING=$(lab_servers) || die "impossible de lister les serveurs de lab" - [[ $(jq 'length' <<< "${EXISTING}") -eq 0 ]] \ - || die "un serveur de lab existe déjà dans le projet ; '${0##*/} status' puis '${0##*/} down'" -} - -report_uncertain_creation () { - local FOUND - FOUND=$(lab_servers) - if [[ $(jq 'length' <<< "${FOUND}") -gt 0 ]]; then - warn "un serveur de lab existe bien : $(jq -r '[.[].id] | join(", ")' <<< "${FOUND}")" - fi - die "création incertaine : le serveur a pu être créé et être facturé ; '${0##*/} status' puis '${0##*/} down'" -} - -cmd_up () { - local OFFER OS KEYS BODY JSON ID IP SSH_USER - require_no_lab_server - OFFER=$(select_zone) || exit 1 - ZONE=$(jq -r '.zone' <<< "${OFFER}") - OS=$(resolve_os "$(jq -r '.id' <<< "${OFFER}")") || exit 1 - KEYS=$(resolve_ssh_keys) || exit 1 - BODY=$(build_request "${OFFER}" "${OS}" "${KEYS}") - info "création de ${LAB_NAME} (${OFFER_NAME}, ${ZONE}, $(money '.price_per_hour' <<< "${OFFER}")/h HT)" - JSON=$(api POST "/baremetal/v1/zones/${ZONE}/servers" "${BODY}") || report_uncertain_creation - ID=$(jq -r '.id // empty' <<< "${JSON}" 2>/dev/null) - [[ -n "${ID}" ]] || report_uncertain_creation - CREATED_ID="${ZONE} ${ID}" - info "serveur ${ID} créé, facturé jusqu'à '${0##*/} down'" - JSON=$(wait_installed "${ID}") || die "serveur ${ID} inutilisable — il est toujours facturé : '${0##*/} down'" - IP=$(server_ip <<< "${JSON}") - [[ -n "${IP}" ]] || die "serveur ${ID} sans IPv4 publique — il est toujours facturé : '${0##*/} down'" - SSH_USER=$(jq -r '.user.default_value // empty' <<< "${OS}") - printf '%s\n' "${IP}" > "${STATE_DIR}/ip" - printf '%s\n' "${SSH_USER:-root}" > "${STATE_DIR}/user" - : > "${STATE_DIR}/known_hosts" - wait_ssh || die "SSH injoignable après ${SSH_TIMEOUT}s — le serveur est toujours facturé : '${0##*/} down'" - cmd_prepare || die "préparation du serveur échouée — il est toujours facturé : '${0##*/} down'" - info "prêt : ${SSH_USER:-root}@${IP}" -} - -cmd_status () { - local SERVERS RC=0 - SERVERS=$(lab_servers) || RC=1 - if [[ $(jq 'length' <<< "${SERVERS}") -eq 0 ]]; then - [[ "${RC}" -eq 0 ]] && info "aucun serveur de lab dans le projet ${PROJECT_ID} (${ZONES})" - else - jq -r '.[] | "\(.zone) \(.id) \(.name) \(.offer_name) \(.status) installation \(.install.status // "none") \(.created_at) \([.ips[] | select(.version == "IPv4") | .address] | join(","))"' <<< "${SERVERS}" - fi - [[ "${RC}" -eq 0 ]] || die "liste incomplète : des serveurs de lab peuvent exister dans les zones en erreur" -} - -require_known_server () { - [[ -s "${STATE_DIR}/ip" ]] || die "aucun serveur de lab connu ; '${0##*/} up' d'abord" -} - -cmd_ssh () { - require_known_server - if [[ $# -gt 0 && -t 0 ]]; then - ssh_run -t -- "$@" - else - ssh_run -- "$@" - fi -} - -prepare_script () { - cat <<'EOF' -set -eu -SUDO= -[ "$(id -u)" -eq 0 ] || SUDO=sudo -$SUDO env DEBIAN_FRONTEND=noninteractive apt-get update -qq -$SUDO env DEBIAN_FRONTEND=noninteractive apt-get install -y -qq --no-install-recommends qemu-system-x86 qemu-utils genisoimage -[ "$(id -u)" -eq 0 ] || $SUDO usermod -aG kvm "$(id -un)" -[ -c /dev/kvm ] || { echo "/dev/kvm absent" >&2; exit 1; } -NESTED=$(cat /sys/module/kvm_intel/parameters/nested 2>/dev/null || cat /sys/module/kvm_amd/parameters/nested 2>/dev/null || true) -case "${NESTED}" in - Y|1) ;; - *) echo "virtualisation imbriquée désactivée (nested=${NESTED:-absent})" >&2; exit 1 ;; -esac -LD=$(ls /lib64/ld-linux-x86-64.so.2 /lib/x86_64-linux-gnu/ld-linux-x86-64.so.2 2>/dev/null | head -n 1) -if ! "${LD}" --help 2>/dev/null | grep -q 'x86-64-v3 (supported'; then - echo "CPU sans x86-64-v3 :$(grep -m 1 'model name' /proc/cpuinfo | cut -d: -f2) — Rocky 10 / RHEL 10 n'y démarrent pas" >&2 - exit 1 -fi -echo "qemu $(qemu-system-x86_64 --version | head -n 1), nested=${NESTED},$(grep -m 1 'model name' /proc/cpuinfo | cut -d: -f2)" -EOF -} - -cmd_prepare () { - require_known_server - info "préparation du serveur : qemu, genisoimage, KVM imbriqué, CPU x86-64-v3" - prepare_script | ssh_run -- bash -s -} - -push_file () { - local SOURCE="${1}" TARGET="${2}" MODE="${3}" - ssh_run -- "cat > '${TARGET}.part' && chmod ${MODE} '${TARGET}.part' && mv '${TARGET}.part' '${TARGET}'" < "${SOURCE}" -} - -push_dir () { - local SOURCE="${1}" - COPYFILE_DISABLE=1 tar --no-xattrs -C "${SOURCE}" -cf - . \ - | ssh_run -- "rm -rf topology.part && mkdir topology.part && tar -C topology.part --no-same-owner -xf - && rm -rf topology && mv topology.part topology" -} - -cmd_push () { - local TOPOLOGY="${1:-}" - local NAME="${TOPOLOGY##*/}" - local BINARY="${STATE_DIR}/labctl" - [[ $# -eq 1 && -n "${TOPOLOGY}" ]] || usage - [[ -f "${TOPOLOGY}" ]] || die "topologie introuvable : ${TOPOLOGY}" - [[ "${NAME}" =~ ^[A-Za-z0-9._-]+$ ]] || die "nom de topologie refusé : ${NAME} (lettres, chiffres, '.', '_', '-')" - require_known_server - info "compilation de labctl (linux/amd64)" - (cd "${REPO_DIR}" && CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o "${BINARY}" ./cmd/labctl) \ - || die "compilation de labctl échouée" - push_file "${BINARY}" labctl 755 || die "envoi de labctl échoué" - push_dir "$(dirname "${TOPOLOGY}")" || die "envoi du répertoire de ${NAME} échoué" - info "déposés sur le serveur : ~/labctl, ~/topology/ — ensuite : ${0##*/} ssh './labctl up topology/${NAME}'" -} - -delete_server () { - local ID="${1}" - local DEADLINE=$(( SECONDS + DELETE_TIMEOUT )) - local HARD_DEADLINE=$(( SECONDS + DELETE_TIMEOUT + INSTALL_TIMEOUT )) - local JSON - while (( SECONDS < DEADLINE )); do - api DELETE "/baremetal/v1/zones/${ZONE}/servers/${ID}" >/dev/null && return 0 - [[ $(http_code) == "404" ]] && return 0 - if JSON=$(api GET "/baremetal/v1/zones/${ZONE}/servers/${ID}" 2>/dev/null) && server_is_installing <<< "${JSON}"; then - DEADLINE=$(( SECONDS + DELETE_TIMEOUT )) - (( DEADLINE > HARD_DEADLINE )) && DEADLINE="${HARD_DEADLINE}" - warn "suppression de ${ID} refusée pendant la livraison ou l'installation, nouvel essai dans ${POLL_INTERVAL}s" - else - warn "suppression de ${ID} refusée, nouvel essai dans ${POLL_INTERVAL}s" - fi - sleep "${POLL_INTERVAL}" - done - return 1 -} - -wait_gone () { - local ID="${1}" - local DEADLINE=$(( SECONDS + DELETE_TIMEOUT )) - while (( SECONDS < DEADLINE )); do - if ! api GET "/baremetal/v1/zones/${ZONE}/servers/${ID}" >/dev/null 2>&1; then - [[ $(http_code) == "404" ]] && return 0 - fi - sleep "${POLL_INTERVAL}" - done - return 1 -} - -lab_server_ids () { - local DEADLINE=$(( SECONDS + DELETE_TIMEOUT )) - local SERVERS="[]" - while (( SECONDS < DEADLINE )); do - if SERVERS=$(lab_servers); then - jq -r '.[] | "\(.zone) \(.id)"' <<< "${SERVERS}" - return 0 - fi - warn "liste des serveurs de lab incomplète, nouvel essai dans ${POLL_INTERVAL}s" - sleep "${POLL_INTERVAL}" - done - jq -r '.[] | "\(.zone) \(.id)"' <<< "${SERVERS}" - return 1 -} - -cmd_down () { - local IDS ID FAILED=0 - if ! IDS=$(lab_server_ids); then - warn "liste des serveurs de lab incomplète après ${DELETE_TIMEOUT}s : suppression de ceux qui sont listés" - FAILED=1 - fi - IDS=$(printf '%s\n%s\n' "${IDS}" "${CREATED_ID}" | grep -v '^$' | sort -u) - while read -r ZONE ID; do - [[ -n "${ID}" ]] || continue - info "suppression de ${ID} (${ZONE})" - if ! delete_server "${ID}"; then - warn "suppression de ${ID} toujours refusée" - FAILED=1 - continue - fi - if ! wait_gone "${ID}"; then - warn "${ID} toujours présent après ${DELETE_TIMEOUT}s" - FAILED=1 - fi - done <<< "${IDS}" - rm -f "${STATE_DIR}/ip" "${STATE_DIR}/user" "${STATE_DIR}/known_hosts" - [[ "${FAILED}" -eq 0 ]] || die "SERVEUR(S) DE LAB TOUJOURS FACTURÉ(S) — '${0##*/} status', puis la console Scaleway" - info "aucun serveur de lab ne reste dans le projet" -} - -cmd_session () { - local RC - require_no_lab_server - trap 'trap - EXIT; trap "" INT TERM HUP; cmd_down' EXIT - trap 'exit 130' INT - trap 'exit 143' TERM - trap 'exit 129' HUP - cmd_up - cmd_ssh "$@" - RC=$? - info "session terminée (code ${RC}), suppression du serveur" - return "${RC}" -} - -main () { - local COMMAND="${1:-}" - [[ $# -gt 0 ]] && shift - load_credentials - [[ -n "${COMMAND}" ]] || usage - mkdir -p "${STATE_DIR}" || die "impossible de créer ${STATE_DIR}" - chmod 700 "${STATE_DIR}" - case "${COMMAND}" in - plan) require_env; cmd_plan ;; - up) require_env; cmd_up ;; - status) require_env; cmd_status ;; - ssh) cmd_ssh "$@" ;; - prepare) cmd_prepare || die "préparation du serveur échouée" ;; - push) cmd_push "$@" ;; - down) require_env; cmd_down ;; - session) require_env; cmd_session "$@" ;; - *) usage ;; - esac -} - -if [[ "${BASH_SOURCE[0]}" == "${0}" || -z "${BASH_SOURCE[0]}" ]]; then - main "$@" -fi diff --git a/scripts/lab-host_test.sh b/scripts/lab-host_test.sh deleted file mode 100755 index ea9ec85..0000000 --- a/scripts/lab-host_test.sh +++ /dev/null @@ -1,925 +0,0 @@ -#!/usr/bin/env bash - -SCRIPT="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/lab-host.sh" -PASS=0 -FAIL=0 -SECRET="secret-de-test-a1b2c3" -PROJECT="11111111-1111-1111-1111-111111111111" -OTHER_PROJECT="22222222-2222-2222-2222-222222222222" -HOURLY_ID="offer-hourly-0001" -MONTHLY_ID="offer-monthly-0001" - -fail () { echo "FAIL: ${CURRENT}: ${1}"; FAIL=$(( FAIL + 1 )); CASE_OK=0; } - -write_fakes () { - local DIR="${1}" - mkdir -p "${DIR}/bin" - cat > "${DIR}/bin/curl" <<'PY' -#!/usr/bin/env python3 -import json, os, sys, time, urllib.parse - -d = os.environ["FAKE_DIR"] -args = sys.argv[1:] -with open(os.path.join(d, "argv.log"), "a") as f: - f.write(json.dumps(args) + "\n") - -method, body, headers, url = "GET", None, [], None -i = 0 -while i < len(args): - a = args[i] - if a == "-X": - method = args[i + 1]; i += 2; continue - if a == "-H": - h = args[i + 1] - if h.startswith("@"): - with open(h[1:]) as f: - headers += [l.strip() for l in f if l.strip()] - else: - headers.append(h) - i += 2; continue - if a == "--data": - body = args[i + 1]; i += 2; continue - if a in ("-w", "--max-time", "--connect-timeout"): - i += 2; continue - if a.startswith("-"): - i += 1; continue - url = a; i += 1 - -state_path = os.path.join(d, "state.json") -with open(state_path) as f: - st = json.load(f) - -def reply(code, obj): - with open(state_path, "w") as f: - json.dump(st, f) - sys.stdout.write(json.dumps(obj) + "\n" + str(code)) - sys.exit(0) - -u = urllib.parse.urlparse(url) -path = u.path -with open(os.path.join(d, "calls.log"), "a") as f: - f.write(method + " " + path + ("?" + u.query if u.query else "") + "\n") - -if "X-Auth-Token: " + os.environ["FAKE_SECRET"] not in headers: - reply(401, {"message": "unauthorized"}) - -zname = path.split("/")[4] if path.startswith("/baremetal/v1/zones/") else "" -zone = "/baremetal/v1/zones/" + zname -if method == "GET" and path == zone + "/offers": - offers = st.get("zones", {}).get(zname, {}).get("offers", st["offers"] if zname == "fr-par-1" else []) - reply(200, {"offers": offers, "total_count": len(offers)}) -if method == "GET" and path == zone + "/os": - reply(200, {"os": st["os"], "total_count": len(st["os"])}) -if method == "GET" and path == "/iam/v1alpha1/ssh-keys": - reply(200, {"ssh_keys": st["keys"], "total_count": len(st["keys"])}) -if method == "GET" and path == zone + "/servers": - if st.get("zones", {}).get(zname, {}).get("list_fail"): - reply(503, {"message": "service unavailable"}) - if st["list_errors"] > 0: - st["list_errors"] -= 1 - reply(503, {"message": "service unavailable"}) - listed = [v for v in st["servers"].values() if not v.get("hidden") and v.get("zone", "fr-par-1") == zname] - reply(200, {"servers": listed, "total_count": len(listed)}) -if method == "POST" and path == zone + "/servers": - req = json.loads(body) - with open(os.path.join(d, "create.json"), "w") as f: - json.dump(req, f) - st["seq"] += 1 - sid = "srv-%d" % st["seq"] - st["servers"][sid] = {"id": sid, "name": req["name"], "project_id": req["project_id"], - "tags": req["tags"], "offer_name": "EM-B212X-SSD", "status": "delivering", - "install": {"status": "to_install"}, "ips": [], "created_at": "now", "zone": zname, - "hidden": st["hide_from_list"]} - if st["post_fail_after_create"]: - reply(502, {"message": "bad gateway"}) - if st["post_no_id"]: - reply(200, {}) - reply(200, st["servers"][sid]) -if path.startswith(zone + "/servers/"): - sid = path.rsplit("/", 1)[1] - if sid not in st["servers"] or st["servers"][sid].get("zone", "fr-par-1") != zname: - reply(404, {"message": "not found"}) - srv = st["servers"][sid] - if method == "GET" and st["get_errors"] > 0: - st["get_errors"] -= 1 - reply(503, {"message": "service unavailable"}) - if method == "GET" and srv["status"] == "deleting": - if st["linger"] > 0: - st["linger"] -= 1 - reply(200, srv) - del st["servers"][sid] - reply(404, {"message": "not found"}) - if method == "GET" and st["vanish_after"] == 0: - del st["servers"][sid] - reply(404, {"message": "not found"}) - if method == "GET" and st["vanish_after"] > 0: - st["vanish_after"] -= 1 - if method == "GET": - if st["progress"]: - status, install = st["progress"].pop(0) - srv["status"] = status - srv["install"]["status"] = install - if status == "ready": - srv["ips"] = [{"address": "2001:db8::1", "version": "IPv6"}, - {"address": "203.0.113.7", "version": "IPv4"}] - reply(200, srv) - if method == "DELETE": - if time.time() < st["refuse_until"]: - reply(409, {"message": "server is installing"}) - if st["delete_refusals"] > 0: - st["delete_refusals"] -= 1 - reply(409, {"message": "server is installing"}) - if st["linger"] > 0: - srv["status"] = "deleting" - else: - del st["servers"][sid] - reply(200, srv) -reply(500, {"message": "route inconnue du faux serveur : " + method + " " + path}) -PY - cat > "${DIR}/bin/ssh" <<'SH' -#!/usr/bin/env bash -printf '%s\n' "$*" >> "${FAKE_DIR}/ssh.log" -printf 'key=%s\n' "${SCW_SECRET_KEY:-}" >> "${FAKE_DIR}/ssh-env.log" -case "$*" in - *BatchMode=yes*) - N=$(cat "${FAKE_DIR}/probe_fails" 2>/dev/null || echo 0) - if [ "${N}" -gt 0 ]; then - echo $(( N - 1 )) > "${FAKE_DIR}/probe_fails" - exit 255 - fi - exit 0 ;; - *"bash -s"*) - cat > "${FAKE_DIR}/prepare.sh" - exit "${FAKE_PREPARE_RC:-0}" ;; - *"cat > "*|*"-xf -"*) - N=$(ls "${FAKE_DIR}" | grep -c '^pushed\.') - cat > "${FAKE_DIR}/pushed.$(( N + 1 ))" - exit "${FAKE_PUSH_RC:-0}" ;; -esac -[ -n "${FAKE_SSH_SLEEP:-}" ] && sleep "${FAKE_SSH_SLEEP}" -exit "${FAKE_SSH_RC:-0}" -SH - cat > "${DIR}/bin/go" <<'SH' -#!/usr/bin/env bash -printf '%s|%s|CGO_ENABLED=%s GOOS=%s GOARCH=%s\n' "${PWD}" "$*" "${CGO_ENABLED:-}" "${GOOS:-}" "${GOARCH:-}" >> "${FAKE_DIR}/go.log" -[ -n "${FAKE_GO_FAIL:-}" ] && exit 1 -while [ $# -gt 0 ]; do - [ "${1}" = "-o" ] && printf 'binaire-lab\n' > "${2}" - shift -done -exit 0 -SH - chmod +x "${DIR}/bin/curl" "${DIR}/bin/ssh" "${DIR}/bin/go" -} - -base_state () { - jq -n --arg h "${HOURLY_ID}" --arg m "${MONTHLY_ID}" --arg p "${PROJECT}" --arg o "${OTHER_PROJECT}" '{ - seq: 0, progress: [], delete_refusals: 0, linger: 0, get_errors: 0, list_errors: 0, - hide_from_list: false, refuse_until: 0, post_fail_after_create: false, post_no_id: false, vanish_after: -1, - offers: [ - {id: $m, name: "EM-B212X-SSD", subscription_period: "monthly", enable: true, stock: "available", - price_per_hour: null, price_per_month: {currency_code: "EUR", units: 115, nanos: 990000000}, - fee: {currency_code: "EUR", units: 115, nanos: 990000000}}, - {id: "offer-other", name: "EM-A610R-NVMe", subscription_period: "hourly", enable: true, stock: "available", - price_per_hour: {currency_code: "EUR", units: 0, nanos: 110000000}, fee: {currency_code: "EUR", units: 0, nanos: 0}}, - {id: $h, name: "EM-B212X-SSD", subscription_period: "hourly", enable: true, stock: "available", - price_per_hour: {currency_code: "EUR", units: 0, nanos: 321000000}, fee: {currency_code: "EUR", units: 0, nanos: 0}} - ], - os: [ - {id: "os-deb11", name: "Debian", version: "11 (Bullseye)", enabled: true, allowed: true, user: {default_value: "debian"}}, - {id: "os-deb12", name: "Debian", version: "12 (Bookworm)", enabled: true, allowed: true, user: {default_value: "debian"}}, - {id: "os-deb13", name: "Debian", version: "13 (Trixie)", enabled: true, allowed: true, user: {default_value: "debian"}}, - {id: "os-ubu", name: "Ubuntu", version: "24.04 LTS (Noble Numbat)", enabled: true, allowed: true, user: {default_value: "ubuntu"}} - ], - keys: [{id: "key-1", disabled: false}, {id: "key-off", disabled: true}], - servers: { - "foreign-1": {id: "foreign-1", name: "prod-db", project_id: $o, tags: ["labctl"], status: "ready", install: {status: "completed"}, ips: []}, - "foreign-2": {id: "foreign-2", name: "autre", project_id: $p, tags: ["autre"], status: "ready", install: {status: "completed"}, ips: []} - } - }' -} - -setup () { - CURRENT="${1}" - CASE_OK=1 - WORK=$(mktemp -d "${TMPDIR:-/tmp}/labhost.XXXXXX") - write_fakes "${WORK}" - base_state > "${WORK}/state.json" - : > "${WORK}/calls.log" - : > "${WORK}/argv.log" - : > "${WORK}/ssh.log" - : > "${WORK}/ssh-env.log" -} - -mutate () { - local TMP - TMP=$(jq "${1}" "${WORK}/state.json") && printf '%s\n' "${TMP}" > "${WORK}/state.json" -} - -lab_env () { - local EXEC="" - [[ "${1}" == "exec" ]] && { EXEC="exec"; shift; } - ${EXEC} env -i PATH="${WORK}/bin:${PATH}" HOME="${WORK}" TMPDIR="${TMPDIR:-/tmp}" \ - FAKE_DIR="${WORK}" FAKE_SECRET="${SECRET}" FAKE_SSH_RC="${FAKE_SSH_RC:-0}" \ - FAKE_SSH_SLEEP="${FAKE_SSH_SLEEP:-}" FAKE_PREPARE_RC="${FAKE_PREPARE_RC:-0}" \ - FAKE_PUSH_RC="${FAKE_PUSH_RC:-0}" FAKE_GO_FAIL="${FAKE_GO_FAIL:-}" \ - SCW_API_URL="https://api.example.invalid" SCW_SECRET_KEY="${SECRET}" \ - SCW_DEFAULT_PROJECT_ID="${PROJECT}" LAB_POLL_INTERVAL="${LAB_POLL_INTERVAL:-0}" \ - LAB_INSTALL_TIMEOUT="${LAB_INSTALL_TIMEOUT:-60}" LAB_DELETE_TIMEOUT="${LAB_DELETE_TIMEOUT:-60}" \ - LAB_SSH_TIMEOUT="${LAB_SSH_TIMEOUT:-60}" LAB_ZONES="${LAB_ZONES:-fr-par-1}" \ - LAB_OFFER="${LAB_OFFER:-EM-B212X-SSD}" ${SCW_DEFAULT_ZONE:+SCW_DEFAULT_ZONE="${SCW_DEFAULT_ZONE}"} \ - "$@" -} - -run_lab () { - lab_env bash "${SCRIPT}" "$@" > "${WORK}/out.log" 2>&1 -} - -remaining () { - jq -r '.servers | keys | sort | join(",")' "${WORK}/state.json" -} - -teardown () { - [[ "${CASE_OK}" -eq 1 ]] && PASS=$(( PASS + 1 )) && echo "ok: ${CURRENT}" - [[ "${CASE_OK}" -eq 1 ]] || { echo " sortie :"; sed 's/^/ | /' "${WORK}/out.log"; } - rm -rf "${WORK}" -} - -test_plan_picks_hourly_offer_even_when_monthly_is_listed_first () { - setup "plan : offre horaire choisie même si la mensuelle est listée d'abord" - run_lab plan || fail "code de sortie $?" - grep -q "\"offer_id\": \"${HOURLY_ID}\"" "${WORK}/out.log" || fail "offre horaire absente de la requête" - grep -q "${MONTHLY_ID}" "${WORK}/out.log" && fail "offre mensuelle présente dans la sortie" - grep -q "^POST" "${WORK}/calls.log" && fail "plan a créé quelque chose" - teardown -} - -test_plan_selects_debian_12_only () { - setup "plan : Debian 12 et rien d'autre" - run_lab plan || fail "code de sortie $?" - grep -q '"os_id": "os-deb12"' "${WORK}/out.log" || fail "os-deb12 non retenu" - teardown -} - -test_plan_passes_only_enabled_ssh_keys () { - setup "plan : seules les clés SSH actives sont transmises" - run_lab plan || fail "code de sortie $?" - grep -q '"key-1"' "${WORK}/out.log" || fail "key-1 absente" - grep -q '"key-off"' "${WORK}/out.log" && fail "clé désactivée transmise" - teardown -} - -test_refuses_offer_with_setup_fee () { - setup "refus d'une offre horaire avec frais de mise en service" - mutate '(.offers[] | select(.id == "'"${HOURLY_ID}"'") | .fee.units) = 30' - run_lab up && fail "up a réussi malgré des frais" - grep -q "^POST" "${WORK}/calls.log" && fail "serveur créé malgré des frais" - teardown -} - -test_refuses_when_hourly_offer_missing () { - setup "refus quand seule l'offre mensuelle existe" - mutate 'del(.offers[] | select(.id == "'"${HOURLY_ID}"'"))' - run_lab up && fail "up a réussi sans offre horaire" - grep -q "^POST" "${WORK}/calls.log" && fail "serveur créé sur une offre mensuelle" - teardown -} - -test_refuses_ambiguous_os () { - setup "refus d'un OS ambigu" - mutate '.os += [{id: "os-deb12b", name: "Debian", version: "12 (Bookworm)", enabled: true, allowed: true}]' - run_lab plan && fail "plan a réussi avec deux Debian 12" - teardown -} - -test_refuses_out_of_stock () { - setup "refus d'une offre en rupture" - mutate '(.offers[] | select(.id == "'"${HOURLY_ID}"'") | .stock) = "empty"' - run_lab up && fail "up a réussi en rupture de stock" - grep -q "^POST" "${WORK}/calls.log" && fail "serveur créé en rupture de stock" - teardown -} - -test_up_creates_and_waits_for_installation () { - setup "up : création puis attente de la fin d'installation" - mutate '.progress = [["delivering","to_install"],["ready","installing"],["ready","completed"]]' - run_lab up || fail "code de sortie $?" - [[ $(jq -r '.offer_id' "${WORK}/create.json") == "${HOURLY_ID}" ]] || fail "offre créée incorrecte" - [[ $(jq -r '.tags | join(",")' "${WORK}/create.json") == "labctl" ]] || fail "tag absent" - [[ $(jq -r '.project_id' "${WORK}/create.json") == "${PROJECT}" ]] || fail "projet incorrect" - [[ $(cat "${WORK}/.cache/labctl/ip" 2>/dev/null) == "203.0.113.7" ]] || fail "IPv4 non retenue" - [[ $(cat "${WORK}/.cache/labctl/user" 2>/dev/null) == "debian" ]] || fail "utilisateur non retenu" - teardown -} - -test_up_refuses_when_lab_server_exists () { - setup "up : refus si un serveur de lab existe déjà" - mutate '.servers["srv-old"] = {id: "srv-old", name: "labctl", project_id: "'"${PROJECT}"'", tags: ["labctl"], status: "ready", install: {status: "completed"}, ips: []}' - run_lab up && fail "up a réussi" - grep -q "^POST" "${WORK}/calls.log" && fail "second serveur créé" - teardown -} - -test_secret_never_in_argv () { - setup "la clé d'API n'apparaît jamais dans les arguments de curl" - mutate '.progress = [["ready","completed"]]' - run_lab up || fail "code de sortie $?" - grep -q "${SECRET}" "${WORK}/argv.log" && fail "secret visible dans argv" - grep -q "${SECRET}" "${WORK}/out.log" && fail "secret affiché" - teardown -} - -test_down_deletes_only_lab_servers_of_project () { - setup "down : ne supprime que les serveurs de lab du projet" - mutate '.servers["srv-lab"] = {id: "srv-lab", name: "labctl", project_id: "'"${PROJECT}"'", tags: ["labctl"], status: "ready", install: {status: "completed"}, ips: []}' - run_lab down || fail "code de sortie $?" - [[ $(remaining) == "foreign-1,foreign-2" ]] || fail "restants : $(remaining)" - teardown -} - -test_down_retries_refused_deletion () { - setup "down : réessaie une suppression refusée" - mutate '.delete_refusals = 2 | .servers["srv-lab"] = {id: "srv-lab", name: "labctl", project_id: "'"${PROJECT}"'", tags: ["labctl"], status: "ready", install: {status: "installing"}, ips: []}' - run_lab down || fail "code de sortie $?" - [[ $(grep -c "^DELETE" "${WORK}/calls.log") -eq 3 ]] || fail "$(grep -c "^DELETE" "${WORK}/calls.log") DELETE au lieu de 3" - [[ $(remaining) == "foreign-1,foreign-2" ]] || fail "restants : $(remaining)" - teardown -} - -test_down_fails_loudly_when_deletion_keeps_failing () { - setup "down : échec bruyant si la suppression n'aboutit jamais" - mutate '.delete_refusals = 1000 | .servers["srv-lab"] = {id: "srv-lab", name: "labctl", project_id: "'"${PROJECT}"'", tags: ["labctl"], status: "ready", install: {status: "installing"}, ips: []}' - LAB_DELETE_TIMEOUT=1 run_lab down && fail "down a réussi" - grep -q "TOUJOURS FACTURÉ" "${WORK}/out.log" || fail "pas d'alerte de facturation" - teardown -} - -test_down_waits_until_server_is_gone () { - setup "down : attend que le serveur ait disparu" - mutate '.linger = 3 | .servers["srv-lab"] = {id: "srv-lab", name: "labctl", project_id: "'"${PROJECT}"'", tags: ["labctl"], status: "ready", install: {status: "completed"}, ips: []}' - run_lab down || fail "code de sortie $?" - [[ $(grep -c "^GET /baremetal/v1/zones/fr-par-1/servers/srv-lab$" "${WORK}/calls.log") -ge 4 ]] || fail "disparition non attendue" - [[ $(remaining) == "foreign-1,foreign-2" ]] || fail "restants : $(remaining)" - teardown -} - -test_down_fails_loudly_when_server_never_disappears () { - setup "down : échec bruyant si le serveur ne disparaît jamais" - mutate '.linger = 100000 | .servers["srv-lab"] = {id: "srv-lab", name: "labctl", project_id: "'"${PROJECT}"'", tags: ["labctl"], status: "ready", install: {status: "completed"}, ips: []}' - LAB_DELETE_TIMEOUT=1 run_lab down && fail "down a réussi" - grep -q "TOUJOURS FACTURÉ" "${WORK}/out.log" || fail "pas d'alerte de facturation" - teardown -} - -test_down_does_not_mistake_api_error_for_disappearance () { - setup "down : une erreur de l'API n'est pas prise pour une disparition" - mutate '.linger = 100000 | .get_errors = 1 | .servers["srv-lab"] = {id: "srv-lab", name: "labctl", project_id: "'"${PROJECT}"'", tags: ["labctl"], status: "ready", install: {status: "completed"}, ips: []}' - LAB_DELETE_TIMEOUT=1 run_lab down && fail "down a réussi alors que le serveur existe encore" - grep -q "TOUJOURS FACTURÉ" "${WORK}/out.log" || fail "pas d'alerte de facturation" - teardown -} - -test_session_deletes_server_after_remote_command () { - setup "session : serveur supprimé après la commande distante" - mutate '.progress = [["ready","completed"]]' - run_lab session uname -a || fail "code de sortie $?" - grep -q "uname -a" "${WORK}/ssh.log" || fail "commande distante non lancée" - [[ $(remaining) == "foreign-1,foreign-2" ]] || fail "restants : $(remaining)" - teardown -} - -test_session_deletes_server_and_propagates_failure_of_remote_command () { - setup "session : serveur supprimé et code d'échec propagé" - mutate '.progress = [["ready","completed"]]' - FAKE_SSH_RC=7 run_lab session false - [[ $? -eq 7 ]] || fail "code de sortie différent de 7" - [[ $(remaining) == "foreign-1,foreign-2" ]] || fail "restants : $(remaining)" - teardown -} - -test_session_deletes_server_when_installation_fails () { - setup "session : serveur supprimé quand l'installation échoue" - mutate '.progress = [["ready","installing"],["ready","error"]]' - run_lab session true && fail "session a réussi" - grep -q "true" "${WORK}/ssh.log" && fail "commande lancée sur un serveur en échec" - grep -q "état terminal en échec : ready/error" "${WORK}/out.log" || fail "échec d'installation non reconnu comme terminal" - [[ $(remaining) == "foreign-1,foreign-2" ]] || fail "restants : $(remaining)" - teardown -} - -test_session_deletes_server_when_installation_times_out () { - setup "session : serveur supprimé quand l'installation n'aboutit pas" - mutate '.progress = [range(0; 100000) | ["delivering","to_install"]]' - LAB_INSTALL_TIMEOUT=1 run_lab session true && fail "session a réussi" - [[ $(remaining) == "foreign-1,foreign-2" ]] || fail "restants : $(remaining)" - teardown -} - -test_session_does_not_touch_existing_lab_server () { - setup "session : ne supprime pas un serveur de lab lancé à côté" - mutate '.servers["srv-old"] = {id: "srv-old", name: "labctl", project_id: "'"${PROJECT}"'", tags: ["labctl"], status: "ready", install: {status: "completed"}, ips: []}' - run_lab session true && fail "session a réussi" - grep -q "^DELETE" "${WORK}/calls.log" && fail "suppression lancée" - [[ $(remaining) == "foreign-1,foreign-2,srv-old" ]] || fail "restants : $(remaining)" - teardown -} - -test_missing_credentials_are_refused_before_any_call () { - setup "refus sans clé d'API, avant tout appel" - env -i PATH="${WORK}/bin:${PATH}" HOME="${WORK}" FAKE_DIR="${WORK}" SCW_DEFAULT_PROJECT_ID="${PROJECT}" bash "${SCRIPT}" plan > "${WORK}/out.log" 2>&1 \ - && fail "plan a réussi sans clé" - [[ -s "${WORK}/calls.log" ]] && fail "appel réseau sans clé" - teardown -} - -LAB_SERVER='{id: "srv-lab", name: "labctl", project_id: "'"${PROJECT}"'", tags: ["labctl"], status: "ready", install: {status: "completed"}, ips: []}' -INSTALLING_LAB_SERVER='{id: "srv-lab", name: "labctl", project_id: "'"${PROJECT}"'", tags: ["labctl"], status: "ready", install: {status: "installing"}, ips: []}' - -test_down_keeps_retrying_while_server_is_installing () { - setup "down : réessaie au-delà du délai tant que le serveur s'installe" - mutate ".servers[\"srv-lab\"] = ${INSTALLING_LAB_SERVER} | .refuse_until = (now + 5)" - LAB_DELETE_TIMEOUT=2 LAB_POLL_INTERVAL=0.2 run_lab down || fail "code de sortie $?" - [[ $(remaining) == "foreign-1,foreign-2" ]] || fail "restants : $(remaining)" - grep -q "pendant la livraison ou l'installation" "${WORK}/out.log" || fail "installation non reconnue" - teardown -} - -test_down_gives_up_on_installing_server_after_hard_deadline () { - local RC - setup "down : abandonne quand même après délai d'installation + délai de suppression" - mutate ".servers[\"srv-lab\"] = ${INSTALLING_LAB_SERVER} | .refuse_until = (now + 100000)" - LAB_DELETE_TIMEOUT=2 LAB_INSTALL_TIMEOUT=2 LAB_POLL_INTERVAL=0.2 lab_env timeout 30 bash "${SCRIPT}" down > "${WORK}/out.log" 2>&1 - RC=$? - [[ "${RC}" -ne 124 ]] || fail "aucun plafond : down tourne encore après 30 s" - [[ "${RC}" -ne 0 ]] || fail "down a réussi" - grep -q "TOUJOURS FACTURÉ" "${WORK}/out.log" || fail "pas d'alerte de facturation" - teardown -} - -test_down_retries_listing_servers () { - setup "down : réessaie la liste des serveurs" - mutate ".servers[\"srv-lab\"] = ${LAB_SERVER} | .list_errors = 2" - run_lab down || fail "code de sortie $?" - [[ $(remaining) == "foreign-1,foreign-2" ]] || fail "restants : $(remaining)" - teardown -} - -test_down_fails_loudly_when_listing_never_works () { - setup "down : échec bruyant si la liste reste indisponible" - mutate ".servers[\"srv-lab\"] = ${LAB_SERVER} | .list_errors = 100000" - LAB_DELETE_TIMEOUT=1 run_lab down && fail "down a réussi" - grep -q "TOUJOURS FACTURÉ" "${WORK}/out.log" || fail "pas d'alerte de facturation" - teardown -} - -test_down_deletes_what_answering_zones_list_when_one_zone_fails () { - setup "down : une zone en erreur n'empêche pas de supprimer les serveurs des autres" - mutate ".servers[\"srv-lab\"] = ${LAB_SERVER} | .zones = {\"nl-ams-2\": {list_fail: true}}" - LAB_ZONES="fr-par-1 nl-ams-2" LAB_DELETE_TIMEOUT=1 run_lab down && fail "down a réussi malgré une zone en erreur" - [[ $(remaining) == "foreign-1,foreign-2" ]] || fail "restants : $(remaining)" - grep -q "zone nl-ams-2" "${WORK}/out.log" || fail "zone en erreur non signalée" - grep -q "TOUJOURS FACTURÉ" "${WORK}/out.log" || fail "pas d'alerte de facturation" - teardown -} - -test_status_lists_answering_zones_and_fails_when_one_zone_fails () { - setup "status : liste les zones qui répondent, échoue si une zone est en erreur" - mutate ".servers[\"srv-lab\"] = ${LAB_SERVER} | .zones = {\"nl-ams-2\": {list_fail: true}}" - LAB_ZONES="fr-par-1 nl-ams-2" run_lab status && fail "status a réussi malgré une zone en erreur" - grep -q "^fr-par-1 srv-lab " "${WORK}/out.log" || fail "srv-lab non listé" - grep -q "liste incomplète" "${WORK}/out.log" || fail "liste incomplète non signalée" - teardown -} - -test_up_refuses_when_one_zone_cannot_be_listed () { - setup "up : refus si une zone ne peut pas être listée" - mutate '.zones = {"nl-ams-2": {list_fail: true}} | .progress = [["ready","completed"]]' - LAB_ZONES="fr-par-1 nl-ams-2" run_lab up && fail "up a réussi" - grep -q "^POST" "${WORK}/calls.log" && fail "serveur créé sans connaître toutes les zones" - teardown -} - -test_session_deletes_created_server_even_if_missing_from_list () { - setup "session : supprime le serveur créé même absent de la liste" - mutate '.hide_from_list = true | .progress = [["ready","completed"]]' - run_lab session true || fail "code de sortie $?" - [[ $(remaining) == "foreign-1,foreign-2" ]] || fail "restants : $(remaining)" - teardown -} - -test_every_api_call_has_timeouts () { - setup "chaque appel à l'API a un délai de connexion et un délai total" - mutate '.progress = [["ready","completed"]]' - run_lab up || fail "code de sortie $?" - [[ -s "${WORK}/argv.log" ]] || fail "aucun appel" - [[ $(jq -s '[.[] | select((index("--max-time") | not) or (index("--connect-timeout") | not))] | length' "${WORK}/argv.log") -eq 0 ]] \ - || fail "appel sans délai" - teardown -} - -test_up_reports_uncertain_creation_when_post_fails () { - setup "up : création incertaine signalée quand le POST échoue" - mutate '.post_fail_after_create = true' - run_lab up && fail "up a réussi" - grep -q "création incertaine" "${WORK}/out.log" || fail "pas de message de création incertaine" - grep -q "un serveur de lab existe bien : srv-1" "${WORK}/out.log" || fail "serveur créé non signalé" - teardown -} - -test_session_deletes_server_when_post_fails_after_creation () { - setup "session : serveur supprimé quand le POST échoue après création" - mutate '.post_fail_after_create = true' - run_lab session true && fail "session a réussi" - [[ $(remaining) == "foreign-1,foreign-2" ]] || fail "restants : $(remaining)" - teardown -} - -test_up_refuses_response_without_id () { - setup "up : réponse de création sans identifiant refusée" - mutate '.post_no_id = true' - run_lab up && fail "up a réussi" - grep -q "création incertaine" "${WORK}/out.log" || fail "pas de message de création incertaine" - grep -q "servers/null" "${WORK}/calls.log" && fail "appel sur un identifiant null" - teardown -} - -test_up_stops_at_once_when_server_vanishes () { - setup "up : arrêt immédiat si le serveur disparaît pendant l'installation" - mutate '.vanish_after = 1 | .progress = [["delivering","to_install"]]' - LAB_INSTALL_TIMEOUT=5 run_lab up && fail "up a réussi" - grep -q "erreur définitive HTTP 404" "${WORK}/out.log" || fail "404 non traité comme définitif" - teardown -} - -test_up_stops_at_once_when_server_is_stopped_during_installation () { - setup "up : arrêt immédiat si le serveur passe à l'arrêt pendant l'installation" - mutate '.progress = [["delivering","to_install"],["stopped","installing"]]' - LAB_INSTALL_TIMEOUT=5 run_lab up && fail "up a réussi" - grep -q "état terminal en échec : stopped/installing" "${WORK}/out.log" || fail "arrêt non reconnu comme terminal" - teardown -} - -test_session_cleanup_survives_a_second_signal () { - local PID RC I - setup "session : un second signal n'interrompt pas le nettoyage" - mutate '.progress = [["ready","completed"]] | .linger = 15' - set -m - FAKE_SSH_SLEEP=5 LAB_POLL_INTERVAL=0.2 lab_env exec bash "${SCRIPT}" session sleep-long > "${WORK}/out.log" 2>&1 & - PID=$! - set +m - for I in $(seq 1 100); do - grep -q "sleep-long" "${WORK}/ssh.log" && break - sleep 0.1 - done - kill -TERM -- "-${PID}" - for I in $(seq 1 100); do - grep -q "suppression de srv-1" "${WORK}/out.log" && break - sleep 0.1 - done - grep -q "suppression de srv-1" "${WORK}/out.log" || fail "nettoyage jamais commencé" - kill -INT -- "-${PID}" 2>/dev/null - kill -TERM -- "-${PID}" 2>/dev/null - wait "${PID}" - RC=$? - [[ "${RC}" -eq 143 ]] || fail "code ${RC} au lieu de 143" - grep -q "aucun serveur de lab ne reste" "${WORK}/out.log" || fail "nettoyage interrompu" - [[ $(remaining) == "foreign-1,foreign-2" ]] || fail "restants : $(remaining)" - teardown -} - -test_ssh_never_receives_api_key () { - setup "ssh ne reçoit jamais la clé d'API dans son environnement" - mutate '.progress = [["ready","completed"]]' - run_lab session uname || fail "code de sortie $?" - [[ -s "${WORK}/ssh-env.log" ]] || fail "ssh jamais lancé" - grep -qv '^key=$' "${WORK}/ssh-env.log" && fail "clé transmise à ssh" - teardown -} - -test_session_waits_for_ssh_before_running_command () { - setup "session : attend que SSH réponde avant la commande" - mutate '.progress = [["ready","completed"]]' - echo 3 > "${WORK}/probe_fails" - run_lab session uname || fail "code de sortie $?" - [[ $(grep -c "BatchMode=yes" "${WORK}/ssh.log") -eq 4 ]] || fail "$(grep -c "BatchMode=yes" "${WORK}/ssh.log") sondes au lieu de 4" - [[ $(tail -n 1 "${WORK}/ssh.log") == *" uname" ]] || fail "commande non lancée en dernier" - teardown -} - -test_session_deletes_server_when_ssh_never_answers () { - setup "session : serveur supprimé si SSH ne répond jamais" - mutate '.progress = [["ready","completed"]]' - echo 100000 > "${WORK}/probe_fails" - LAB_SSH_TIMEOUT=1 LAB_POLL_INTERVAL=0.2 run_lab session uname && fail "session a réussi" - grep -qv "BatchMode=yes" "${WORK}/ssh.log" && fail "commande lancée sans SSH joignable" - [[ $(remaining) == "foreign-1,foreign-2" ]] || fail "restants : $(remaining)" - teardown -} - -test_ssh_uses_dedicated_lab_key_only_when_present () { - setup "ssh : clé dédiée du lab utilisée seule quand elle existe" - mutate '.progress = [["ready","completed"]]' - mkdir -p "${WORK}/.config/labctl/ssh" - : > "${WORK}/.config/labctl/ssh/lab_ed25519" - run_lab session uname || fail "code de sortie $?" - grep -q " uname" "${WORK}/ssh.log" || fail "commande non lancée" - [[ $(grep -c -- "-i ${WORK}/.config/labctl/ssh/lab_ed25519 -o IdentitiesOnly=yes -o IdentityAgent=none" "${WORK}/ssh.log") -eq $(wc -l < "${WORK}/ssh.log") ]] \ - || fail "une connexion n'a pas utilisé la clé dédiée seule" - teardown -} - -test_ssh_falls_back_to_agent_without_lab_key () { - setup "ssh : agent SSH utilisé quand la clé dédiée est absente" - mutate '.progress = [["ready","completed"]]' - run_lab session uname || fail "code de sortie $?" - grep -q -- "-i " "${WORK}/ssh.log" && fail "clé imposée alors qu'elle n'existe pas" - grep -q "IdentityAgent=none" "${WORK}/ssh.log" && fail "agent désactivé sans clé dédiée" - teardown -} - -known_server () { - mkdir -p "${WORK}/.cache/labctl" - echo 203.0.113.7 > "${WORK}/.cache/labctl/ip" - echo debian > "${WORK}/.cache/labctl/user" - : > "${WORK}/.cache/labctl/known_hosts" -} - -test_up_prepares_the_server_after_ssh () { - setup "up : prépare le serveur (qemu, genisoimage, KVM imbriqué) une fois SSH joignable" - mutate '.progress = [["ready","completed"]]' - run_lab up || fail "code de sortie $?" - [[ $(tail -n 1 "${WORK}/ssh.log") == *"debian@203.0.113.7 bash -s" ]] || fail "préparation non lancée en dernier : $(tail -n 1 "${WORK}/ssh.log")" - grep -q "apt-get install -y -qq --no-install-recommends qemu-system-x86 qemu-utils genisoimage" "${WORK}/prepare.sh" || fail "paquets absents du script" - grep -q 'usermod -aG kvm' "${WORK}/prepare.sh" || fail "groupe kvm absent du script" - grep -q -- '-c /dev/kvm' "${WORK}/prepare.sh" || fail "contrôle de /dev/kvm absent" - grep -q 'kvm_intel/parameters/nested' "${WORK}/prepare.sh" || fail "contrôle de nested absent" - teardown -} - -test_up_reports_a_billed_server_when_preparation_fails () { - setup "up : préparation échouée signalée, serveur toujours facturé" - mutate '.progress = [["ready","completed"]]' - FAKE_PREPARE_RC=1 run_lab up && fail "up a réussi" - grep -q "préparation du serveur échouée — il est toujours facturé" "${WORK}/out.log" || fail "message absent" - grep -q "prêt :" "${WORK}/out.log" && fail "serveur annoncé prêt" - teardown -} - -test_session_deletes_server_when_preparation_fails () { - setup "session : serveur supprimé si la préparation échoue, commande jamais lancée" - mutate '.progress = [["ready","completed"]]' - FAKE_PREPARE_RC=1 run_lab session uname && fail "session a réussi" - grep -q " uname" "${WORK}/ssh.log" && fail "commande lancée malgré la préparation échouée" - [[ $(remaining) == "foreign-1,foreign-2" ]] || fail "restants : $(remaining)" - teardown -} - -test_prepare_script_is_valid_shell () { - setup "prepare : le script distant est du shell valide" - known_server - run_lab prepare || fail "code de sortie $?" - bash -n "${WORK}/prepare.sh" || fail "bash -n refuse le script" - sh -n "${WORK}/prepare.sh" || fail "sh -n refuse le script" - teardown -} - -test_prepare_without_known_server_is_refused () { - setup "prepare : refusé sans serveur connu" - run_lab prepare && fail "prepare a réussi" - [[ -s "${WORK}/ssh.log" ]] && fail "ssh lancé" - teardown -} - -test_push_builds_for_linux_and_sends_binary_and_topology () { - setup "push : compile labctl pour linux/amd64, envoie le binaire et le répertoire de la topologie" - known_server - mkdir -p "${WORK}/conf/frr" - printf 'name: evpn-2hv\n' > "${WORK}/conf/evpn-2hv.yml" - printf 'hostname rr1\n' > "${WORK}/conf/frr/rr1.conf" - xattr -w com.apple.test lab "${WORK}/conf/evpn-2hv.yml" 2>/dev/null || true - run_lab push "${WORK}/conf/evpn-2hv.yml" || fail "code de sortie $?" - local REPO LISTING - REPO="$(cd "$(dirname "${SCRIPT}")/.." && pwd)" - [[ $(cat "${WORK}/go.log") == "${REPO}|build -o ${WORK}/.cache/labctl/labctl ./cmd/labctl|CGO_ENABLED=0 GOOS=linux GOARCH=amd64" ]] \ - || fail "compilation : $(cat "${WORK}/go.log")" - grep -q "debian@203.0.113.7 cat > 'labctl.part' && chmod 755 'labctl.part' && mv 'labctl.part' 'labctl'" "${WORK}/ssh.log" || fail "envoi de labctl absent" - grep -q "debian@203.0.113.7 rm -rf topology.part && mkdir topology.part && tar -C topology.part --no-same-owner -xf - && rm -rf topology && mv topology.part topology" "${WORK}/ssh.log" \ - || fail "envoi du répertoire absent" - [[ $(cat "${WORK}/pushed.1") == "binaire-lab" ]] || fail "contenu de lab : $(cat "${WORK}/pushed.1")" - LISTING=$(tar -tf "${WORK}/pushed.2" | sed 's|^\./||' | grep -v '/$' | grep -v '^$' | sort | tr '\n' ' ') - [[ "${LISTING}" == "evpn-2hv.yml frr/rr1.conf " ]] || fail "contenu de l'archive : ${LISTING}" - grep -aq 'LIBARCHIVE.xattr' "${WORK}/pushed.2" && fail "attributs étendus macOS dans l'archive" - mkdir "${WORK}/x" && tar -C "${WORK}/x" -xf "${WORK}/pushed.2" - [[ $(cat "${WORK}/x/frr/rr1.conf") == "hostname rr1" ]] || fail "frr/rr1.conf altéré" - grep -q "ssh './labctl up topology/evpn-2hv.yml'" "${WORK}/out.log" || fail "consigne finale absente" - teardown -} - -test_push_stops_when_the_build_fails () { - setup "push : rien n'est envoyé si la compilation échoue" - known_server - printf 'name: x\n' > "${WORK}/x.yml" - FAKE_GO_FAIL=1 run_lab push "${WORK}/x.yml" && fail "push a réussi" - [[ -s "${WORK}/ssh.log" ]] && fail "ssh lancé" - grep -q "compilation de labctl échouée" "${WORK}/out.log" || fail "message absent" - teardown -} - -test_push_fails_when_a_transfer_fails () { - setup "push : un envoi échoué fait échouer push" - known_server - printf 'name: x\n' > "${WORK}/x.yml" - FAKE_PUSH_RC=1 run_lab push "${WORK}/x.yml" && fail "push a réussi" - grep -q "envoi de labctl échoué" "${WORK}/out.log" || fail "message absent" - teardown -} - -test_push_refusals () { - local CASE - for CASE in absent quote nothing; do - setup "push : refus (${CASE})" - known_server - case "${CASE}" in - absent) run_lab push "${WORK}/absent.yml" && fail "push a réussi" ;; - quote) printf 'x\n' > "${WORK}/a'b.yml"; run_lab push "${WORK}/a'b.yml" && fail "push a réussi" ;; - nothing) run_lab push && fail "push a réussi" ;; - esac - [[ -s "${WORK}/go.log" ]] && fail "compilation lancée" - [[ -s "${WORK}/ssh.log" ]] && fail "ssh lancé" - teardown - done -} - -test_ssh_without_terminal_does_not_ask_for_one () { - setup "ssh : pas de -t quand l'entrée n'est pas un terminal" - known_server - run_lab ssh './labctl status' < /dev/null || fail "code de sortie $?" - [[ $(cat "${WORK}/ssh.log") == *"debian@203.0.113.7 ./labctl status" ]] || fail "commande : $(cat "${WORK}/ssh.log")" - grep -q -- " -t " "${WORK}/ssh.log" && fail "-t demandé sans terminal" - teardown -} - -run_lab_without_env_credentials () { - env -i PATH="${WORK}/bin:${PATH}" HOME="${WORK}" TMPDIR="${TMPDIR:-/tmp}" \ - FAKE_DIR="${WORK}" FAKE_SECRET="${SECRET}" SCW_API_URL="https://api.example.invalid" \ - LAB_POLL_INTERVAL=0 LAB_ZONES=fr-par-1 LAB_OFFER=EM-B212X-SSD "$@" bash "${SCRIPT}" plan > "${WORK}/out.log" 2>&1 -} - -write_credentials () { - mkdir -p "${WORK}/.config/labctl" - printf '%s\n' "$@" > "${WORK}/.config/labctl/scaleway.env" - chmod 600 "${WORK}/.config/labctl/scaleway.env" -} - -test_credentials_file_is_used_when_environment_is_empty () { - setup "identifiants : fichier lu quand l'environnement est vide" - write_credentials "SCW_SECRET_KEY=${SECRET}" "SCW_DEFAULT_PROJECT_ID=${PROJECT}" "SCW_DEFAULT_ZONE=fr-par-1" - run_lab_without_env_credentials || fail "code de sortie $?" - grep -q "\"project_id\": \"${PROJECT}\"" "${WORK}/out.log" || fail "projet du fichier non utilisé" - grep -q "${SECRET}" "${WORK}/out.log" && fail "secret affiché" - teardown -} - -test_credentials_file_without_final_newline_is_read () { - setup "identifiants : dernière ligne sans retour à la ligne lue quand même" - mkdir -p "${WORK}/.config/labctl" - printf 'SCW_DEFAULT_PROJECT_ID=%s\nSCW_SECRET_KEY=%s' "${PROJECT}" "${SECRET}" > "${WORK}/.config/labctl/scaleway.env" - chmod 600 "${WORK}/.config/labctl/scaleway.env" - run_lab_without_env_credentials || fail "code de sortie $?" - teardown -} - -test_environment_wins_over_credentials_file () { - setup "identifiants : l'environnement l'emporte sur le fichier" - write_credentials "SCW_SECRET_KEY=mauvais-secret" "SCW_DEFAULT_PROJECT_ID=${OTHER_PROJECT}" - run_lab_without_env_credentials SCW_SECRET_KEY="${SECRET}" SCW_DEFAULT_PROJECT_ID="${PROJECT}" || fail "code de sortie $?" - grep -q "\"project_id\": \"${PROJECT}\"" "${WORK}/out.log" || fail "projet de l'environnement non retenu" - teardown -} - -test_environment_value_kept_when_file_completes_the_rest () { - setup "identifiants : une valeur de l'environnement n'est pas écrasée quand le fichier complète" - write_credentials "SCW_SECRET_KEY=${SECRET}" "SCW_DEFAULT_PROJECT_ID=${OTHER_PROJECT}" - run_lab_without_env_credentials SCW_DEFAULT_PROJECT_ID="${PROJECT}" || fail "code de sortie $?" - grep -q "\"project_id\": \"${PROJECT}\"" "${WORK}/out.log" || fail "projet de l'environnement écrasé par le fichier" - teardown -} - -test_credentials_file_readable_by_others_is_refused () { - setup "identifiants : fichier lisible par d'autres refusé, sans aucun appel" - write_credentials "SCW_SECRET_KEY=${SECRET}" "SCW_DEFAULT_PROJECT_ID=${PROJECT}" - chmod 644 "${WORK}/.config/labctl/scaleway.env" - run_lab_without_env_credentials && fail "plan a réussi" - grep -q "chmod 600" "${WORK}/out.log" || fail "pas de consigne de droits" - [[ -s "${WORK}/calls.log" ]] && fail "appel réseau avec un fichier exposé" - teardown -} - -test_credentials_file_is_never_executed () { - setup "identifiants : le fichier est lu, jamais exécuté" - write_credentials "SCW_SECRET_KEY=\$(touch ${WORK}/pwned)" "touch ${WORK}/pwned2" "SCW_DEFAULT_PROJECT_ID=${PROJECT}" - run_lab_without_env_credentials && fail "plan a réussi avec un secret invalide" - [[ -e "${WORK}/pwned" || -e "${WORK}/pwned2" ]] && fail "contenu du fichier exécuté" - teardown -} - -signal_during_session () { - local SIGNAL="${1}" - local EXPECTED="${2}" - local PID RC I - setup "session : ${SIGNAL} pendant la commande distante, serveur supprimé, code ${EXPECTED}" - mutate '.progress = [["ready","completed"]]' - set -m - FAKE_SSH_SLEEP=5 lab_env exec bash "${SCRIPT}" session sleep-long > "${WORK}/out.log" 2>&1 & - PID=$! - set +m - for I in $(seq 1 100); do - grep -q "sleep-long" "${WORK}/ssh.log" && break - sleep 0.1 - done - grep -q "sleep-long" "${WORK}/ssh.log" || fail "commande distante jamais lancée" - kill "-${SIGNAL}" -- "-${PID}" - wait "${PID}" - RC=$? - [[ "${RC}" -eq "${EXPECTED}" ]] || fail "code ${RC} au lieu de ${EXPECTED}" - [[ $(remaining) == "foreign-1,foreign-2" ]] || fail "restants : $(remaining)" - teardown -} - -zone_offer () { - jq -n --arg id "${1}" --arg stock "${2}" '{id: $id, name: "EM-B420E-NVME", subscription_period: "hourly", enable: true, - stock: $stock, cpus: [{name: "AMD EPYC 7272"}], price_per_hour: {currency_code: "EUR", units: 0, nanos: 444000000}, - fee: {currency_code: "EUR", units: 0, nanos: 0}}' -} - -test_default_offer_is_the_epyc_one () { - setup "offre par défaut : EM-B420E-NVME" - LAB_OFFER=EM-B420E-NVME run_lab plan - grep -q 'aucune zone candidate' "${WORK}/out.log" || fail "l'offre EM-B420E-NVME n'a pas été cherchée" - grep -q 'name=EM-B420E-NVME' "${WORK}/calls.log" || fail "requête : $(cat "${WORK}/calls.log")" - [[ $(env -i bash -c ". '${SCRIPT}'; echo \${OFFER_NAME}") == EM-B420E-NVME ]] \ - || fail "défaut lu : $(env -i bash -c ". '${SCRIPT}'; echo \${OFFER_NAME}")" - teardown -} - -test_up_takes_the_first_zone_with_stock () { - setup "up : première zone candidate où l'offre est en stock" - mutate ".zones = {\"fr-par-2\": {offers: [$(zone_offer off-par2 empty)]}, \"nl-ams-2\": {offers: [$(zone_offer off-ams2 available)]}} - | .progress = [[\"ready\", \"completed\"]]" - LAB_ZONES="fr-par-2 nl-ams-2 pl-waw-3" LAB_OFFER=EM-B420E-NVME run_lab up - grep -q 'POST /baremetal/v1/zones/nl-ams-2/servers' "${WORK}/calls.log" || fail "pas de création en nl-ams-2 : $(grep POST "${WORK}/calls.log")" - grep -q 'zones/pl-waw-3/offers' "${WORK}/calls.log" && fail "zone suivante interrogée après avoir trouvé du stock" - [[ $(jq -r '.offer_id' "${WORK}/create.json") == off-ams2 ]] || fail "offre créée : $(jq -c . "${WORK}/create.json")" - grep -q 'fr-par-2 : offre EM-B420E-NVME en rupture de stock' "${WORK}/out.log" || fail "raison du refus de fr-par-2 absente" - teardown -} - -test_preferred_zone_goes_first () { - setup "SCW_DEFAULT_ZONE : préférence placée en tête, sans exclure les autres" - [[ $(lab_env bash -c ". '${SCRIPT}'; candidate_zones nl-ams-2 'fr-par-1 nl-ams-2 pl-waw-3'") == "nl-ams-2 fr-par-1 pl-waw-3" ]] \ - || fail "ordre : $(lab_env bash -c ". '${SCRIPT}'; candidate_zones nl-ams-2 'fr-par-1 nl-ams-2 pl-waw-3'")" - [[ $(lab_env bash -c ". '${SCRIPT}'; candidate_zones '' 'fr-par-1 nl-ams-2'") == "fr-par-1 nl-ams-2" ]] || fail "sans préférence" - teardown -} - -test_no_zone_with_stock_is_refused_without_creation () { - setup "aucune zone en stock : refus, rien n'est créé" - LAB_ZONES="fr-par-2 nl-ams-2" LAB_OFFER=EM-B420E-NVME run_lab up && fail "code de retour nul" - grep -q 'disponible dans aucune zone candidate (fr-par-2 nl-ams-2)' "${WORK}/out.log" || fail "message absent" - grep -q '^POST' "${WORK}/calls.log" && fail "serveur créé" - teardown -} - -test_down_and_status_cover_every_candidate_zone () { - setup "down et status : serveurs de lab de toutes les zones candidates" - mutate ".servers[\"lab-ams\"] = {id: \"lab-ams\", name: \"labctl\", project_id: \"${PROJECT}\", tags: [\"labctl\"], - status: \"ready\", install: {status: \"completed\"}, ips: [], zone: \"nl-ams-2\", offer_name: \"EM-B420E-NVME\", created_at: \"now\"}" - mutate ".servers[\"lab-par\"] = {id: \"lab-par\", name: \"labctl\", project_id: \"${PROJECT}\", tags: [\"labctl\"], - status: \"ready\", install: {status: \"completed\"}, ips: [], offer_name: \"EM-B212X-SSD\", created_at: \"now\"}" - LAB_ZONES="fr-par-1 nl-ams-2" run_lab status - grep -q '^nl-ams-2 lab-ams' "${WORK}/out.log" || fail "status : $(cat "${WORK}/out.log")" - LAB_ZONES="fr-par-1 nl-ams-2" run_lab down || fail "down en échec" - grep -q 'DELETE /baremetal/v1/zones/nl-ams-2/servers/lab-ams' "${WORK}/calls.log" || fail "lab-ams non supprimé dans sa zone" - [[ $(remaining) == "foreign-1,foreign-2" ]] || fail "restants : $(remaining)" - teardown -} - -test_prepare_script_requires_x86_64_v3 () { - setup "prepare : refus d'un CPU sans x86-64-v3" - local DIR="${WORK}/root" - mkdir -p "${DIR}/bin" "${DIR}/sys/module/kvm_intel/parameters" "${DIR}/dev" - lab_env bash -c ". '${SCRIPT}'; prepare_script" > "${WORK}/prepare.sh" - grep -q "x86-64-v3 (supported" "${WORK}/prepare.sh" || fail "aucune vérification x86-64-v3 dans le script de préparation" - grep -q "exit 1" <<< "$(sed -n '/x86-64-v3/,/fi/p' "${WORK}/prepare.sh")" || fail "pas d'arrêt si le niveau manque" - teardown -} - -test_session_handles_term () { signal_during_session TERM 143; } -test_session_handles_hup () { signal_during_session HUP 129; } -test_session_handles_int () { signal_during_session INT 130; } - -for T in $(declare -F | awk '{print $3}' | grep '^test_'); do - "${T}" -done -echo "${PASS} réussi(s), ${FAIL} échec(s)" -[[ "${FAIL}" -eq 0 ]] -- 2.52.0