Fix export template when using dummy links (#2483)

fix export template when using dummy links
srl-labs · Feb 21, 2025 · 1c9c561 · 1c9c561
1 parent 43367b9
commit 1c9c561
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 8 deletions.
diff --git a/clab/export.go b/clab/export.go
@@ -17,10 +17,12 @@ import (
 )
 
 // GenerateExports generates various export files and writes it to a file in the lab directory.
+// `p` is the path to the template.
+// `f` is the file to write the exported data to.
 func (c *CLab) GenerateExports(ctx context.Context, f io.Writer, p string) error {
 	err := c.exportTopologyDataWithTemplate(ctx, f, p)
 	if err != nil {
-		log.Warnf("Cannot parse export template %s: %v", p, err)
+		log.Warn("Failed to execute the export template", "template", p, "err", err)
 		// a minimal topology data file that just provides the name of a lab that failed to generate a proper export data
 		err = c.exportTopologyDataWithMinimalTemplate(f)
 		if err != nil {
@@ -47,7 +49,7 @@ var defaultExportTemplate string
 //go:embed export_templates/full.tmpl
 var fullExportTemplate string
 
-// exportTopologyDataWithTemplate generates and writes topology data file to w using a template.
+// exportTopologyDataWithTemplate generates and writes topology data file to w using a template referenced by path `p`.
 func (c *CLab) exportTopologyDataWithTemplate(_ context.Context, w io.Writer, p string) error {
 	name := "export"
 	if p != "" {

diff --git a/clab/export_templates/auto.tmpl b/clab/export_templates/auto.tmpl
@@ -45,15 +45,17 @@
         "node": "{{ $ep.GetNode.GetShortName }}",
         "interface": "{{ $ep.GetIfaceName }}",
         "mac": "{{ $ep.GetMac }}",
-        "peer": "z"
-      },
-      {{- $ep :=  index $eps 1 }}
+        "peer": "{{if eq (len $eps) 2}}z{{else}}dummy{{end}}"
+      }
+      {{- if eq (len $eps) 2 }}
+      {{- $ep :=  index $eps 1 }},
       "z": {
         "node": "{{  $ep.GetNode.GetShortName }}",
         "interface": "{{ $ep.GetIfaceName }}",
         "mac": "{{ $ep.GetMac }}",
         "peer": "a"
       }
+      {{- end }}
     }{{end}}
   ]
 }
diff --git a/clab/export_templates/full.tmpl b/clab/export_templates/full.tmpl
@@ -14,15 +14,17 @@
         "node": "{{ $ep.GetNode.GetShortName }}",
         "interface": "{{ $ep.GetIfaceName }}",
         "mac": "{{ $ep.GetMac }}",
-        "peer": "z"
-      },
-      {{- $ep :=  index $eps 1 }}
+        "peer": "{{if eq (len $eps) 2}}z{{else}}dummy{{end}}"
+      }
+      {{- if eq (len $eps) 2 }}
+      {{- $ep :=  index $eps 1 }},
       "z": {
         "node": "{{  $ep.GetNode.GetShortName }}",
         "interface": "{{ $ep.GetIfaceName }}",
         "mac": "{{ $ep.GetMac }}",
         "peer": "a"
       }
+      {{- end }}
     }{{end}}
   ]
 }
diff --git a/docs/rn/0.65.md b/docs/rn/0.65.md
@@ -32,3 +32,10 @@ The snippet above will have the `SRL_LOCATION` variable set to `default-value` i
 * json output format added to [netem](../cmd/tools/netem/show.md#format) output #2454
 * new logging library with structured logging #2449
 * updated VS Code extension documentation #2427 #2451
+
+## Patches
+
+### 0.65.1
+
+* fix template export errors when using dummy links #2483
+* update termenv dependency to enable colorized logging in ghostty #2482