destroy: fix folder as topology ref (#1747)

* destroy: fix folder as topology ref

* update

* execute runtime ps via sudo

* remove param

* added comment

---------

Co-authored-by: Roman Dodin <dodin.roman@gmail.com>

Author: steiler

clab/clab.go

@@ -128,32 +128,10 @@ func WithKeepMgmtNet() ClabOption {
 
 func WithTopoPath(path, varsFile string) ClabOption {
 	return func(c *CLab) error {
-		var file string
-		var err error
-
-		switch {
-		case path == "-" || path == "stdin":
-			file, err = c.readFromStdin()
-			if err != nil {
-				return err
-			}
-		// if the path is not a local file and a URL, download the file and store it in the tmp dir
-		case !utils.FileOrDirExists(path) && utils.IsHttpURL(path, true):
-			file, err = c.downloadTopoFile(path)
-			if err != nil {
-				return err
-			}
-
-		case path == "":
-			return fmt.Errorf("provide a path to the clab topology file")
-
-		default:
-			file, err = findTopoFileByPath(path)
-			if err != nil {
-				return err
-			}
+		file, err := c.ProcessTopoPath(path)
+		if err != nil {
+			return err
 		}
-
 		if err := c.GetTopology(file, varsFile); err != nil {
 			return fmt.Errorf("failed to read topology file: %v", err)
 		}
@@ -162,9 +140,40 @@ func WithTopoPath(path, varsFile string) ClabOption {
 	}
 }
 
+// ProcessTopoPath takes a topology path, which might be the path to a directory or a file
+// or stdin or a URL and returns the topology file name if found.
+func (c *CLab) ProcessTopoPath(path string) (string, error) {
+	var file string
+	var err error
+
+	switch {
+	case path == "-" || path == "stdin":
+		file, err = readFromStdin(c.TopoPaths.ClabTmpDir())
+		if err != nil {
+			return "", err
+		}
+	// if the path is not a local file and a URL, download the file and store it in the tmp dir
+	case !utils.FileOrDirExists(path) && utils.IsHttpURL(path, true):
+		file, err = downloadTopoFile(path, c.TopoPaths.ClabTmpDir())
+		if err != nil {
+			return "", err
+		}
+
+	case path == "":
+		return "", fmt.Errorf("provide a path to the clab topology file")
+
+	default:
+		file, err = FindTopoFileByPath(path)
+		if err != nil {
+			return "", err
+		}
+	}
+	return file, nil
+}
+
 // findTopoFileByPath takes a topology path, which might be the path to a directory
 // and returns the topology file name if found.
-func findTopoFileByPath(path string) (string, error) {
+func FindTopoFileByPath(path string) (string, error) {
 	finfo, err := os.Stat(path)
 	if err != nil {
 		return "", err
@@ -206,10 +215,8 @@ func findTopoFileByPath(path string) (string, error) {
 // readFromStdin reads the topology file from stdin
 // creates a temp file with topology contents
 // and returns a path to the temp file.
-func (c *CLab) readFromStdin() (string, error) {
-	c.TopoPaths.CreateTmpDir()
-
-	tmpFile, err := os.CreateTemp(c.TopoPaths.ClabTmpDir(), "topo-*.clab.yml")
+func readFromStdin(tempDir string) (string, error) {
+	tmpFile, err := os.CreateTemp(tempDir, "topo-*.clab.yml")
 	if err != nil {
 		return "", err
 	}
@@ -222,10 +229,8 @@ func (c *CLab) readFromStdin() (string, error) {
 	return tmpFile.Name(), nil
 }
 
-func (c *CLab) downloadTopoFile(url string) (string, error) {
-	c.TopoPaths.CreateTmpDir()
-
-	tmpFile, err := os.CreateTemp(c.TopoPaths.ClabTmpDir(), "topo-*.clab.yml")
+func downloadTopoFile(url, tempDir string) (string, error) {
+	tmpFile, err := os.CreateTemp(tempDir, "topo-*.clab.yml")
 	if err != nil {
 		return "", err
 	}

clab/config.go

@@ -267,9 +267,6 @@ func (c *CLab) processStartupConfig(nodeCfg *types.NodeConfig) error {
 	isDownloadableConfig := utils.IsHttpURL(p, false)
 
 	if isEmbeddedConfig || isDownloadableConfig {
-		// both embedded and downloadable configs are require clab tmp dir to be created
-		c.TopoPaths.CreateTmpDir()
-
 		switch {
 		case isEmbeddedConfig:
 			log.Debugf("Node %q startup-config is an embedded config: %q", nodeCfg.ShortName, p)

cmd/destroy.go

@@ -271,6 +271,11 @@ func listContainers(ctx context.Context, topo string) ([]runtime.GenericContaine
 
 	// when topo file is provided, filter containers by lab name
 	if topo != "" {
+		topo, err = c.ProcessTopoPath(topo)
+		if err != nil {
+			return nil, err
+		}
+
 		// read topo yaml file to get the lab name
 		topo, err := os.ReadFile(topo)
 		if err != nil {

tests/01-smoke/12-cloned-lab.robot

@@ -2,8 +2,7 @@
 Library             Process
 Resource            ../common.robot
 
-Suite Setup         Cleanup
-Suite Teardown      Cleanup
+Test Teardown      Cleanup
 
 
 *** Variables ***
@@ -16,6 +15,7 @@ ${lab1-gitlab-url}      https://github.com/hellt/clab-test-repo
 ${lab1-gitlab-url2}     https://github.com/hellt/clab-test-repo/blob/main/lab1.clab.yml
 ${lab2-gitlab-url}      https://github.com/hellt/clab-test-repo/tree/branch1
 ${http-lab-url}         https://gist.githubusercontent.com/hellt/66a5d8fca7bf526b46adae9008a5e04b/raw/034a542c3fbb17333afd20e6e7d21869fee6aeb5/linux.clab.yml
+${single-topo-folder}   tests/01-smoke/single-topo-folder
 ${runtime}              docker
 
 
@@ -33,7 +33,6 @@ Test lab1 with Github
     # check that node3 was filtered and not present in the lab output
     Should Contain    ${output.stdout}    clab-lab1-node1
 
-    Cleanup
 
 Test lab1 with Gitlab
     ${output} =    Process.Run Process
@@ -48,7 +47,6 @@ Test lab1 with Gitlab
     # check that node3 was filtered and not present in the lab output
     Should Contain    ${output.stdout}    clab-lab1-node1
 
-    Cleanup
 
 Test lab2 with Github
     ${output} =    Process.Run Process
@@ -63,7 +61,6 @@ Test lab2 with Github
     # check that node3 was filtered and not present in the lab output
     Should Contain    ${output.stdout}    clab-lab1-node1
 
-    Cleanup
 
 Test lab2 with Gitlab
     ${output} =    Process.Run Process
@@ -78,7 +75,6 @@ Test lab2 with Gitlab
     # check that node3 was filtered and not present in the lab output
     Should Contain    ${output.stdout}    clab-lab1-node1
 
-    Cleanup
 
 Test lab3 with Github
     ${output} =    Process.Run Process
@@ -93,7 +89,6 @@ Test lab3 with Github
     # check that node3 was filtered and not present in the lab output
     Should Contain    ${output.stdout}    clab-lab2-node1
 
-    Cleanup
 
 Test lab3 with Gitlab
     ${output} =    Process.Run Process
@@ -108,7 +103,6 @@ Test lab3 with Gitlab
     # check that node3 was filtered and not present in the lab output
     Should Contain    ${output.stdout}    clab-lab2-node1
 
-    Cleanup
 
 Test lab1 with short github url
     ${output} =    Process.Run Process
@@ -120,10 +114,8 @@ Test lab1 with short github url
 
     Should Be Equal As Integers    ${output.rc}    0
 
-    # check that node3 was filtered and not present in the lab output
     Should Contain    ${output.stdout}    clab-lab1-node1
 
-    Cleanup
 
 Test lab1 downloaded from https url
     ${output} =    Process.Run Process
@@ -135,10 +127,38 @@ Test lab1 downloaded from https url
 
     Should Be Equal As Integers    ${output.rc}    0
 
-    # check that node3 was filtered and not present in the lab output
     Should Contain    ${output.stdout}    clab-alpine-l1
 
-    Cleanup
+
+Test deploy referencing folder as topo
+    ${output_pre} =    Process.Run Process
+    ...    sudo -E ${CLAB_BIN} --runtime ${runtime} deploy -t ${single-topo-folder}
+    ...    shell=True
+
+    Log    ${output_pre.stdout}
+    Log    ${output_pre.stderr}
+
+    Should Be Equal As Integers    ${output_pre.rc}    0
+
+    ## double check deletion via runtime ps 
+    ${output_post2} =    Process.Run Process
+    ...    sudo -E ${runtime} ps
+    ...    shell=True
+
+    Should Contain    ${output_post2.stdout}    clab-lab1-node1
+
+
+    ## destroy with just a reference to a folder
+    ${output_post1} =    Process.Run Process
+    ...    sudo -E ${CLAB_BIN} --runtime ${runtime} destroy -t ${single-topo-folder}
+    ...    shell=True
+
+    ## double check deletion via runtime ps 
+    ${output_post2} =    Process.Run Process
+    ...    sudo -E ${runtime} ps
+    ...    shell=True
+
+    Should Not Contain    ${output_post2.stdout}    clab-lab1-node1
 
 
 *** Keywords ***

tests/01-smoke/single-topo-folder/lab1.clab.yml

@@ -0,0 +1,7 @@
+name: lab1
+
+topology:
+  nodes:
+    node1:
+      kind: linux
+      image: alpine:3

types/topo_paths.go

@@ -175,15 +175,14 @@ func (t *TopoPaths) TopologyFilenameAbsPath() string {
 }
 
 // ClabTmpDir returns the path to the temporary directory where clab stores temporary and/or downloaded files.
+// Creates the directory if it does not exist.
 func (*TopoPaths) ClabTmpDir() string {
+	if !utils.DirExists(clabTmpDir) {
+		utils.CreateDirectory(clabTmpDir, 0755)
+	}
 	return clabTmpDir
 }
 
-// CreateTmpDir creates a clab temp directory.
-func (t *TopoPaths) CreateTmpDir() {
-	utils.CreateDirectory(t.ClabTmpDir(), 0755)
-}
-
 // StartupConfigDownloadFileAbsPath returns the absolute path to the startup-config file
 // when it is downloaded from a remote location to the clab temp directory.
 func (t *TopoPaths) StartupConfigDownloadFileAbsPath(node, postfix string) string {