Update how submodule fetch options are handled

libgit2 · Nov 26, 2023 · 4d3c56e · 4d3c56e
1 parent 49d39c9
commit 4d3c56e
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 35 deletions.
diff --git a/LibGit2Sharp.Tests/SubmoduleFixture.cs b/LibGit2Sharp.Tests/SubmoduleFixture.cs
@@ -3,7 +3,6 @@
 using System.Linq;
 using LibGit2Sharp.Tests.TestHelpers;
 using Xunit;
-using Xunit.Extensions;
 
 namespace LibGit2Sharp.Tests
 {
@@ -240,9 +239,10 @@ public void CanUpdateSubmodule()
                     OnCheckoutProgress = (x, y, z) => checkoutProgressCalled = true,
                     OnCheckoutNotify = (x, y) => { checkoutNotifyCalled = true; return true; },
                     CheckoutNotifyFlags = CheckoutNotifyFlags.Updated,
-                    OnUpdateTips = (x, y, z) => { updateTipsCalled = true; return true; },
                 };
 
+                options.FetchOptions.OnUpdateTips = (x, y, z) => { updateTipsCalled = true; return true; };
+
                 repo.Submodules.Init(submodule.Name, false);
                 repo.Submodules.Update(submodule.Name, options);
 

diff --git a/LibGit2Sharp/Core/GitSubmoduleOptions.cs b/LibGit2Sharp/Core/GitSubmoduleOptions.cs
@@ -11,8 +11,6 @@ internal struct GitSubmoduleUpdateOptions
 
         public GitFetchOptions FetchOptions;
 
-        public CheckoutStrategy CloneCheckoutStrategy;
-
         public int AllowFetch;
     }
 }
diff --git a/LibGit2Sharp/Repository.cs b/LibGit2Sharp/Repository.cs
@@ -865,14 +865,11 @@ private static void RecursivelyCloneSubmodules(CloneOptions options, string repo
 
                 using (Repository repo = new Repository(repoPath))
                 {
-                    SubmoduleUpdateOptions updateOptions = new SubmoduleUpdateOptions()
+                    var updateOptions = new SubmoduleUpdateOptions()
                     {
                         Init = true,
-                        CredentialsProvider = options.FetchOptions.CredentialsProvider,
                         OnCheckoutProgress = options.OnCheckoutProgress,
-                        OnProgress = options.FetchOptions.OnProgress,
-                        OnTransferProgress = options.FetchOptions.OnTransferProgress,
-                        OnUpdateTips = options.FetchOptions.OnUpdateTips,
+                        FetchOptions = options.FetchOptions
                     };
 
                     string parentRepoWorkDir = repo.Info.WorkingDirectory;

diff --git a/LibGit2Sharp/SubmoduleCollection.cs b/LibGit2Sharp/SubmoduleCollection.cs
@@ -74,43 +74,41 @@ public virtual void Init(string name, bool overwrite)
         /// Update specified submodule.
         /// <para>
         ///   This will:
-        ///   1) Optionally initialize the if it not already initialzed,
+        ///   1) Optionally initialize the if it not already initialized,
         ///   2) clone the sub repository if it has not already been cloned, and
         ///   3) checkout the commit ID for the submodule in the sub repository.
         /// </para>
         /// </summary>
         /// <param name="name">The name of the submodule to update.</param>
-        /// <param name="options">Options controlling submodule udpate behavior and callbacks.</param>
+        /// <param name="options">Options controlling submodule update behavior and callbacks.</param>
         public virtual void Update(string name, SubmoduleUpdateOptions options)
         {
-            options = options ?? new SubmoduleUpdateOptions();
+            options ??= new SubmoduleUpdateOptions();
 
-            using (var handle = Proxy.git_submodule_lookup(repo.Handle, name))
-            {
-                if (handle == null)
-                {
-                    throw new NotFoundException("Submodule lookup failed for '{0}'.",
-                                                              name);
-                }
+            using var handle = Proxy.git_submodule_lookup(repo.Handle, name) ?? throw new NotFoundException("Submodule lookup failed for '{0}'.", name);
+            using var checkoutOptionsWrapper = new GitCheckoutOptsWrapper(options);
+            using var fetchOptionsWrapper = new GitFetchOptionsWrapper();
 
-                using (GitCheckoutOptsWrapper checkoutOptionsWrapper = new GitCheckoutOptsWrapper(options))
-                {
-                    var gitCheckoutOptions = checkoutOptionsWrapper.Options;
+            var gitCheckoutOptions = checkoutOptionsWrapper.Options;
 
-                    var remoteCallbacks = new RemoteCallbacks(options);
-                    var gitRemoteCallbacks = remoteCallbacks.GenerateCallbacks();
+            var gitFetchOptions = fetchOptionsWrapper.Options;
+            gitFetchOptions.ProxyOptions = options.FetchOptions.ProxyOptions.CreateGitProxyOptions();
+            gitFetchOptions.RemoteCallbacks = new RemoteCallbacks(options.FetchOptions).GenerateCallbacks();
 
-                    var gitSubmoduleUpdateOpts = new GitSubmoduleUpdateOptions
-                    {
-                        Version = 1,
-                        CheckoutOptions = gitCheckoutOptions,
-                        FetchOptions = new GitFetchOptions { ProxyOptions = options.ProxyOptions.CreateGitProxyOptions(), RemoteCallbacks = gitRemoteCallbacks },
-                        CloneCheckoutStrategy = CheckoutStrategy.GIT_CHECKOUT_SAFE
-                    };
-
-                    Proxy.git_submodule_update(handle, options.Init, ref gitSubmoduleUpdateOpts);
-                }
+            if (options.FetchOptions != null && options.FetchOptions.CustomHeaders != null)
+            {
+                gitFetchOptions.CustomHeaders =
+                    GitStrArrayManaged.BuildFrom(options.FetchOptions.CustomHeaders);
             }
+
+            var gitSubmoduleUpdateOpts = new GitSubmoduleUpdateOptions
+            {
+                Version = 1,
+                CheckoutOptions = gitCheckoutOptions,
+                FetchOptions = gitFetchOptions
+            };
+
+            Proxy.git_submodule_update(handle, options.Init, ref gitSubmoduleUpdateOpts);
         }
 
         /// <summary>

diff --git a/LibGit2Sharp/SubmoduleUpdateOptions.cs b/LibGit2Sharp/SubmoduleUpdateOptions.cs
@@ -6,7 +6,7 @@ namespace LibGit2Sharp
     /// <summary>
     /// Options controlling Submodule Update behavior and callbacks.
     /// </summary>
-    public sealed class SubmoduleUpdateOptions : FetchOptionsBase, IConvertableToGitCheckoutOpts
+    public sealed class SubmoduleUpdateOptions : IConvertableToGitCheckoutOpts
     {
         /// <summary>
         /// Initialize the submodule if it is not already initialized.
@@ -30,6 +30,11 @@ public sealed class SubmoduleUpdateOptions : FetchOptionsBase, IConvertableToGit
         /// </summary>
         public CheckoutNotifyFlags CheckoutNotifyFlags { get; set; }
 
+        /// <summary>
+        /// Collection of parameters controlling Fetch behavior.
+        /// </summary>
+        public FetchOptions FetchOptions { get; internal set; } = new();
+
         CheckoutCallbacks IConvertableToGitCheckoutOpts.GenerateCallbacks()
         {
             return CheckoutCallbacks.From(OnCheckoutProgress, OnCheckoutNotify);