Don't override authentication callbacks in libgit2 clone (#319)

Use the supported callbacks interface rather than trying to re-do
the low level interface. As reported in JuliaPackaging/BinaryBuilder.jl#1287,
we currently try to error when attempting to clone a repository
over ssh (either directly or via the insteadOf git setting),
because we accidentally override the base callback to provide
ssh credentials.

Fixes JuliaPackaging/BinaryBuilder.jl#1287

Author: Keno

.github/workflows/ci.yml

@@ -68,6 +68,12 @@ jobs:
         run: julia --project=. --color=yes -e "using BinaryBuilderBase; BinaryBuilderBase.versioninfo()"
       - name: Run tests
         run: |
+          eval `ssh-agent`
+          chmod 0600 test/id_ecdsa_deploy_helloworld_c_jll_read_only
+          mkdir -p ~/.ssh
+          touch ~/.ssh/known_hosts
+          ssh-keyscan github.com >> ~/.ssh/known_hosts
+          ssh-add test/id_ecdsa_deploy_helloworld_c_jll_read_only
           julia --check-bounds=yes --color=yes --depwarn=yes --inline=yes --project=@. -e 'using Pkg; Pkg.instantiate(); Pkg.test(coverage=true)'
       - uses: julia-actions/[email protected]
         continue-on-error: true

src/Sources.jl

@@ -186,7 +186,8 @@ struct GitTransferProgress
     received_bytes::Csize_t
 end
 
-function transfer_progress(progress::Ptr{GitTransferProgress}, p::Any)
+function transfer_progress(progress::Ptr{GitTransferProgress}, payloads::Dict)
+    p = payloads[:transfer_progress]
     progress = unsafe_load(progress)
     p.n = progress.total_objects
     if progress.total_deltas != 0
@@ -225,25 +226,19 @@ function cached_git_clone(url::String;
         if verbose
             @info("Cloning git repository", url, repo_path)
         end
+        callbacks = LibGit2.Callbacks()
+        p = Progress(0, dt=1, desc="Cloning: ")
         if progressbar
-            # Clone with a progress bar
-            p = Progress(0, 1, "Cloning: ")
-            GC.@preserve p begin
-                callbacks = LibGit2.RemoteCallbacks(
-                    transfer_progress=@cfunction(
+            callbacks[:transfer_progress] = (
+                @cfunction(
                         transfer_progress,
                         Cint,
                         (Ptr{GitTransferProgress}, Any)
                     ),
-                    payload = p
-                )
-                fetch_opts = LibGit2.FetchOptions(; callbacks)
-                clone_opts = LibGit2.CloneOptions(; fetch_opts, bare = Cint(true))
-                LibGit2.clone(url, repo_path, clone_opts)
-            end
-        else
-            LibGit2.clone(url, repo_path; isbare=true)
+                p
+            )
         end
+        LibGit2.clone(url, repo_path; isbare=true, callbacks)
     end
     return repo_path
 end

test/dependencies.jl

@@ -275,24 +275,31 @@ end
         end
 
         # Dependency as a local directory
-        with_temp_project() do dir
-            mktempdir() do pkgdir
-                prefix = Prefix(dir)
-                # Clone if necessary the remote repository and check out its
-                # working directory in a temporary space.
-                cache_dir = cached_git_clone("https://github.com/JuliaBinaryWrappers/HelloWorldC_jll.jl")
-                LibGit2.with(LibGit2.clone(cache_dir, pkgdir)) do repo
-                    LibGit2.checkout!(repo, "c7f2e95d9c04e218931c14954ecd31ebde72cca5")
+        for remote_url in (
+            "https://github.com/JuliaBinaryWrappers/HelloWorldC_jll.jl",
+            "ssh://[email protected]/JuliaBinaryWrappers/HelloWorldC_jll.jl"
+        )
+            for progressbar in (true, false)
+                with_temp_project() do dir
+                    mktempdir() do pkgdir
+                        prefix = Prefix(dir)
+                        # Clone if necessary the remote repository and check out its
+                        # working directory in a temporary space.
+                        cache_dir = cached_git_clone(remote_url; progressbar)
+                        LibGit2.with(LibGit2.clone(cache_dir, pkgdir)) do repo
+                            LibGit2.checkout!(repo, "c7f2e95d9c04e218931c14954ecd31ebde72cca5")
+                        end
+                        dependencies = [
+                            PackageSpec(
+                                name="HelloWorldC_jll",
+                                path=pkgdir,
+                            ),
+                        ]
+                        platform = Platform("x86_64", "linux"; libc="glibc")
+                        @test_logs setup_dependencies(prefix, dependencies, platform)
+                        @test readdir(joinpath(destdir(dir, platform), "bin")) == ["hello_world"]
+                    end
                 end
-                dependencies = [
-                    PackageSpec(
-                        name="HelloWorldC_jll",
-                        path=pkgdir,
-                    ),
-                ]
-                platform = Platform("x86_64", "linux"; libc="glibc")
-                @test_logs setup_dependencies(prefix, dependencies, platform)
-                @test readdir(joinpath(destdir(dir, platform), "bin")) == ["hello_world"]
             end
         end
 

test/id_ecdsa_deploy_helloworld_c_jll_read_only

@@ -0,0 +1,9 @@
+-----BEGIN OPENSSH PRIVATE KEY-----
+b3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAaAAAABNlY2RzYS
+1zaGEyLW5pc3RwMjU2AAAACG5pc3RwMjU2AAAAQQQg84ce7J+he7ByXanYD0nGVpw2b7h2
+1PJLi1MjyDTiT2iSZyLe9GMB1O5wx8/XS3NjAPghz5Y1vxfcGlw64DlbAAAAwIVGhjKFRo
+YyAAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBCDzhx7sn6F7sHJd
+qdgPScZWnDZvuHbU8kuLUyPINOJPaJJnIt70YwHU7nDHz9dLc2MA+CHPljW/F9waXDrgOV
+sAAAAhAJ6u+41H8CUK5xnn1NiP3KODYU8iS3o0b3/+2emYw/03AAAAImtlbm9AS2Vub3Mt
+TWFjQm9vay1Qcm8tMi5mcml0ei5ib3gBAgMEBQ==
+-----END OPENSSH PRIVATE KEY-----