Fix removing symlink to a directory when processing data-dirs option (#575)

Author: anti-social

src/builder/guard.rs

@@ -1,5 +1,5 @@
 use std::path::Path;
-use std::fs::{remove_dir_all, remove_file};
+use std::fs::{remove_dir_all, remove_file, symlink_metadata};
 use std::collections::HashMap;
 
 use crate::build_step::BuildStep;
@@ -198,7 +198,11 @@ fn remove_all_except(root: &Path, keep_rel_paths: &HashMap<&Path, bool>)
                 remove_all_except(path, keep_rel_paths)?;
             },
             None => {
-                if path.is_dir() {
+                let file_type = try_msg!(
+                    symlink_metadata(path),
+                    "Error querying file metadata: {path:?}: {err}", path=path
+                ).file_type();
+                if file_type.is_dir() {
                     try_msg!(clean_dir(path, true),
                         "Error cleaning dir {path:?}: {err}",
                         path=path);

tests/generic.bats

@@ -81,21 +81,40 @@ setup() {
     assert_equal "$(ls -1 .vagga/remove/opt/ | wc -l)" "0"
 }
 
-@test "generic: The data-dirs option works" {
-    run vagga _build data-container
-    link=$(readlink .vagga/data-container)
-    assert_equal "$link" ".roots/data-container.e6da9e30/root"
-    assert [ -d ".vagga/data-container/etc" ]
-    assert [ -f ".vagga/data-container/etc/passwd" ]
-    assert [ -d ".vagga/data-container/var" ]
-    assert [ -d ".vagga/data-container/var/lib" ]
-    assert [ -d ".vagga/data-container/var/local" ]
-    assert [ -f ".vagga/data-container/var/local/hello.txt" ]
-    assert [ ! -f ".vagga/data-container/var/local/bye.txt" ]
-    assert_equal "$(ls -1 ".vagga/data-container/" | wc -l)" "2"
-    assert_equal "$(ls -1 ".vagga/data-container/var" | wc -l)" "2"
-    assert_equal "$(ls -1 ".vagga/data-container/var/lib" | wc -l)" "3"
-    assert_equal "$(ls -1 ".vagga/data-container/var/local" | wc -l)" "1"
+@test "generic: data-dirs alpine" {
+    run vagga _build data-container-alpine
+    container_path=.vagga/data-container-alpine
+    link=$(readlink $container_path)
+    assert_equal "$link" ".roots/data-container-alpine.e6da9e30/root"
+    assert [ -d "$container_path/etc" ]
+    assert [ -f "$container_path/etc/passwd" ]
+    assert [ -d "$container_path/var" ]
+    assert [ -d "$container_path/var/lib" ]
+    assert [ -d "$container_path/var/local" ]
+    assert [ -f "$container_path/var/local/hello.txt" ]
+    assert [ ! -f "$container_path/var/local/bye.txt" ]
+    assert_equal "$(ls -1 "$container_path/" | wc -l)" "2"
+    assert_equal "$(ls -1 "$container_path/var" | wc -l)" "2"
+    assert_equal "$(ls -1 "$container_path/var/lib" | wc -l)" "3"
+    assert_equal "$(ls -1 "$container_path/var/local" | wc -l)" "1"
+}
+
+@test "generic: data-dirs ubuntu" {
+    run vagga _build data-container-ubuntu
+    container_path=.vagga/data-container-ubuntu
+    link=$(readlink $container_path)
+    assert_equal "$link" ".roots/data-container-ubuntu.ee7a0504/root"
+    assert [ -d "$container_path/etc" ]
+    assert [ -f "$container_path/etc/passwd" ]
+    assert [ -d "$container_path/var" ]
+    assert [ -d "$container_path/var/lib" ]
+    assert [ -d "$container_path/var/local" ]
+    assert [ -f "$container_path/var/local/hello.txt" ]
+    assert [ ! -f "$container_path/var/local/bye.txt" ]
+    assert_equal "$(ls -1 "$container_path/" | wc -l)" "2"
+    assert_equal "$(ls -1 "$container_path/var" | wc -l)" "2"
+    assert_equal "$(ls -1 "$container_path/var/lib" | wc -l)" "5"
+    assert_equal "$(ls -1 "$container_path/var/local" | wc -l)" "1"
 }
 
 @test "generic: The supervise command works" {

tests/generic/vagga.yaml

@@ -78,14 +78,22 @@ containers:
     - !Remove /opt/test_dir
     - !Remove /opt/test_symlink
 
-  data-container:
+  data-container-alpine:
     setup:
     - !Alpine v3.4
     - !Text
       /var/local/hello.txt: Hello world!
     - !Sh ln -s /var/local/hello.txt /var/local/bye.txt
     data-dirs: [/etc, /var/lib, /var/lib/apk, /var/local/hello.txt]
 
+  data-container-ubuntu:
+    setup:
+    - !Ubuntu focal
+    - !Text
+      /var/local/hello.txt: Hello world!
+    - !Sh ln -s /var/local/hello.txt /var/local/bye.txt
+    data-dirs: [/etc, /var/lib, /var/lib/apt, /var/local/hello.txt]
+
   busybox:
     setup:
     - !Alpine v3.4