Merge pull request #13 from giordano/mg/directory-nofollow

Do not follow symlinks by default for `DirectorySource`

Author: giordano

Project.toml

@@ -1,7 +1,7 @@
 name = "BinaryBuilderBase"
 uuid = "7f725544-6523-48cd-82d1-3fa08ff4056e"
 authors = ["Elliot Saba <[email protected]>"]
-version = "0.3.0"
+version = "0.3.1"
 
 [deps]
 CodecZlib = "944b1d66-785c-5afd-91f1-9de20f533193"

src/Prefix.jl

@@ -302,9 +302,9 @@ function setup(source::SetupSource{DirectorySource}, targetdir, verbose)
         @info "Copying content of $(basename(srcpath)) in $(basename(targetdir))..."
     end
     for file_dir in readdir(srcpath)
-        # Copy the content of the source directory to the destination. Note that we DO follow symlinks here!
-        # This is to support symlink patchsets across multiple versions of GCC, etc...
-        cp(joinpath(srcpath, file_dir), joinpath(targetdir, basename(file_dir)); follow_symlinks=true)
+        # Copy the content of the source directory to the destination
+        cp(joinpath(srcpath, file_dir), joinpath(targetdir, basename(file_dir));
+           follow_symlinks=source.follow_symlinks)
     end
 end
 

src/Sources.jl

@@ -76,27 +76,37 @@ GitSource(url::String, hash::String; unpack_target::String = "") =
     GitSource(url, hash, unpack_target)
 
 """
-    DirectorySource(path::String; target::String = basename(path))
+    DirectorySource(path::String; target::String = basename(path), follow_symlinks=false)
 
 Specify a local directory to mount from `path`.
 
-The content of the directory will be mounted in `\${WORKSPACE}/srcdir`, or in its
-subdirectory pointed to by the optional keyword `target`, if provided.
+The content of the directory will be mounted in `\${WORKSPACE}/srcdir`, or in
+its subdirectory pointed to by the optional keyword `target`, if provided.
+Symbolic links are replaced by a copy of the target when `follow_symlinks` is
+`true`.
 """
 struct DirectorySource <: AbstractSource
     path::String
     target::String
+    follow_symlinks::Bool
 end
-DirectorySource(path::String; target::String = "") =
-    DirectorySource(path, target)
+# When setting up the source, by default we won't follow symlinks.  However,
+# there are cases where this is necessary, for example when we have symlink
+# patchsets across multiple versions of GCC, etc...
+DirectorySource(path::String; target::String = "", follow_symlinks::Bool=false) =
+    DirectorySource(path, target, follow_symlinks)
 
 # This is not meant to be used as source in the `build_tarballs.jl` scripts but
 # only to set up the source in the workspace.
 struct SetupSource{T<:AbstractSource}
     path::String
     hash::String
     target::String
+    follow_symlinks::Bool
 end
+# `follow_symlinks` is used only for DirectorySource, let's have a method without it.
+SetupSource{T}(path::String, hash::String, target::String) where {T} =
+    SetupSource{T}(path, hash, target, false)
 # This is used in wizard/obtain_source.jl to automatically guess the parameter
 # of SetupSource from the URL
 function SetupSource(url::String, path::String, hash::String, target::String)
@@ -167,7 +177,7 @@ function download_source(source::DirectorySource; verbose::Bool = false)
         error("Could not find directory \"$(source.path)\".")
     end
     @info "Directory \"$(source.path)\" found"
-    return SetupSource{DirectorySource}(abspath(source.path), "", source.target)
+    return SetupSource{DirectorySource}(abspath(source.path), "", source.target, source.follow_symlinks)
 end
 
 """

test/sources.jl

@@ -37,15 +37,27 @@ using JSON
                 # Fetch again the repo to make sure cache works
                 @test @test_logs (:info, r"^Cached repository found in") download_source(gs; verbose = true, downloads_dir = dir) == sgs
                 # Fetch the temp directory as a `DirectorySource`
-                ds = DirectorySource("./bundled")
-                patchdir = abspath(joinpath(dir, ds.path, "patches"))
+                ds_follow = DirectorySource("./bundled_follow"; follow_symlinks=true)
+                patchdir = abspath(joinpath(dir, ds_follow.path, "patches_follow"))
                 mkpath(patchdir)
                 write(abspath(joinpath(patchdir, "fix-windows-headers.patch")), "This is a patch file")
                 # Create a symlink.  We'll want to check that `setup` follows symlinks
                 link = joinpath(patchdir, "link.patch")
                 symlink("fix-windows-headers.patch", link)
                 @test islink(link)
-                sds = @test_logs (:info, r"^Directory .* found") download_source(ds; verbose = true)
+                sds_follow = @test_logs (:info, r"^Directory .* found") download_source(ds_follow; verbose = true)
+                # Try to fetch a non-existing directory
+                @test_throws ErrorException download_source(DirectorySource(joinpath(dir, "does_not_exist")); verbose = true)
+                # Another directory source, which doesn't follow symlinks
+                ds_nofollow = DirectorySource("./bundled_nofollow")
+                patchdir = abspath(joinpath(dir, ds_nofollow.path, "patches_nofollow"))
+                mkpath(patchdir)
+                write(abspath(joinpath(patchdir, "fix-windows-headers.patch")), "This is a patch file")
+                # Create a symlink.  We'll want to check that `setup` follows symlinks
+                link = joinpath(patchdir, "link.patch")
+                symlink("fix-windows-headers.patch", link)
+                @test islink(link)
+                sds_nofollow = @test_logs (:info, r"^Directory .* found") download_source(ds_nofollow; verbose = true)
                 # Try to fetch a non-existing directory
                 @test_throws ErrorException download_source(DirectorySource(joinpath(dir, "does_not_exist")); verbose = true)
 
@@ -60,21 +72,29 @@ using JSON
                 target = joinpath(srcdir, gs.unpack_target)
                 @test_logs (:info, "Cloning ARCHDefs.git to ARCHDefs...") setup(sgs, target, true)
                 @test isdir(target)
-                target = abspath(joinpath(srcdir, "patches"))
-                @test_logs (:info, "Copying content of bundled in srcdir...") setup(sds, srcdir, true)
+                # Setup directory source with links to follow
+                target = abspath(joinpath(srcdir, "patches_follow"))
+                @test_logs (:info, "Copying content of bundled_follow in srcdir...") setup(sds_follow, srcdir, true)
                 @test isdir(target)
                 # Make sure that the symlinks are followed
                 @test isfile(joinpath(target, "link.patch"))
                 @test !islink(joinpath(target, "link.patch"))
+                # Setup directory source with links to not follow
+                target = abspath(joinpath(srcdir, "patches_nofollow"))
+                @test_logs (:info, "Copying content of bundled_nofollow in srcdir...") setup(sds_nofollow, srcdir, true)
+                @test isdir(target)
+                # Make sure that the symlinks are not followed
+                @test isfile(joinpath(target, "link.patch"))
+                @test islink(joinpath(target, "link.patch"))
 
                 # Make sure in srcdir there are all files and directories we expect
-                @test Set(readdir(srcdir)) == Set(["ARCHDefs", "ARCHDefs-2.0.3x", fs.filename, "patches"])
+                @test Set(readdir(srcdir)) == Set(["ARCHDefs", "ARCHDefs-2.0.3x", fs.filename, "patches_follow", "patches_nofollow"])
 
                 # Setup the sources with `setup_workspace`
                 workspace = joinpath(dir, "workspace")
                 mkpath(workspace)
-                prefix = @test_logs (:info, r"^Copying") (:info, r"^Copying") (:info, r"^Cloning") setup_workspace(workspace, [sfs, sds, sgs]; verbose=true)
-                @test Set(readdir(joinpath(prefix.path, "srcdir"))) == Set(["ARCHDefs", "file-source.tar.gz", "patches"])
+                prefix = @test_logs (:info, r"^Copying") (:info, r"^Copying") (:info, r"^Copying") (:info, r"^Cloning") setup_workspace(workspace, [sfs, sds_follow, sds_nofollow, sgs]; verbose=true)
+                @test Set(readdir(joinpath(prefix.path, "srcdir"))) == Set(["ARCHDefs", "file-source.tar.gz", "patches_follow", "patches_nofollow"])
             end
         end
     end
@@ -95,7 +115,7 @@ using JSON
         @test jgs == Dict("type" => "git", "url" => gs.url, "hash" => gs.hash, "unpack_target" => gs.unpack_target)
         @test sourcify(jgs) == gs
         jds = JSON.lower(ds)
-        @test jds == Dict("type" => "directory", "path" => ds.path, "target" => "")
+        @test jds == Dict("type" => "directory", "path" => ds.path, "target" => "", "follow_symlinks" => false)
         @test sourcify(jds) == ds
 
         @test_throws ErrorException sourcify(Dict("type" => "error"))