Ensuring arguments are not null.

Author: AMSadek

LibGit2Sharp.Tests/PackBuilderFixture.cs

@@ -1,5 +1,5 @@
 using LibGit2Sharp.Tests.TestHelpers;
-using System.Collections.Generic;
+using System;
 using System.IO;
 using System.Linq;
 using Xunit;
@@ -9,18 +9,25 @@ namespace LibGit2Sharp.Tests
     public class PackBuilderFixture : BaseFixture
     {
         [Fact]
-        public void ObjectsWrittenSameAsOriginal()
+        public void TestDefaultBuildDelegate()
+        {
+            TestIfSameRepoAfterPacking(null);
+        }
+
+        [Fact]
+        public void TestCommitsPerBranchBuildDelegate()
+        {
+            TestIfSameRepoAfterPacking(TestBuildDelegate);
+        }
+
+        internal void TestIfSameRepoAfterPacking(Action<PackBuilder> buildingDelegate)
         {
             // read a repo
-            // pack with default action
+            // pack with the provided action
             // write the pack file in a mirror repo
             // read new repo
             // compare
 
-            //string orgRepoPath = @"D:\TestRepos\packbuilder_testrepo_wd\packbuilder_testrepo_git_org\dot_git";
-            //string mrrRepoPath = @"D:\TestRepos\packbuilder_testrepo_wd\packbuilder_testrepo_git_mrr_1\dot_git";
-            //string packFilePath = @"D:\TestRepos\packbuilder_testrepo_wd\packbuilder_testrepo_git_mrr_1\dot_git\objects\pack";
-
             string orgRepoPath = SandboxPackBuilderTestRepo();
             SelfCleaningDirectory scd = BuildSelfCleaningDirectory(orgRepoPath + "_mrr");
             string mrrRepoPath = scd.DirectoryPath;
@@ -37,7 +44,7 @@ public void ObjectsWrittenSameAsOriginal()
 
             Repository orgRepo = new Repository(orgRepoPath);
 
-            PackBuilderResults results = orgRepo.ObjectDatabase.Pack(packBuilderOptions, null);
+            PackBuilderResults results = orgRepo.ObjectDatabase.Pack(packBuilderOptions, buildingDelegate);
 
             // written objects count is the same as in objects database
             Assert.Equal(orgRepo.ObjectDatabase.Count(), results.WrittenObjectsCount);
@@ -57,53 +64,13 @@ public void ObjectsWrittenSameAsOriginal()
             mrrRepo.Dispose();
         }
 
-        [Fact]
-        public void ObjectsWrittenSameAsOriginalUsingDelegate()
-        {
-            string orgRepoPath = SandboxPackBuilderTestRepo();
-            SelfCleaningDirectory scd = BuildSelfCleaningDirectory(orgRepoPath + "_mrr");
-            string mrrRepoPath = scd.DirectoryPath;
-            string mrrRepoPathPackDirPath = mrrRepoPath + "/.git/objects";
-
-            DirectoryHelper.CopyFilesRecursively(new DirectoryInfo(orgRepoPath), new DirectoryInfo(mrrRepoPath));
-            DirectoryHelper.DeleteDirectory(mrrRepoPathPackDirPath);
-            Directory.CreateDirectory(mrrRepoPathPackDirPath);
-            Directory.CreateDirectory(mrrRepoPathPackDirPath + "/pack");
-
-            PackBuilderOptions packBuilderOptions = new PackBuilderOptions();
-            packBuilderOptions.MaximumNumberOfThreads = 0;
-            packBuilderOptions.PackFilePath = mrrRepoPathPackDirPath + "/pack";
-
-            Repository orgRepo = new Repository(orgRepoPath);
-
-            // pack using the custom build method
-            PackBuilderResults results = orgRepo.ObjectDatabase.Pack(packBuilderOptions, TestBuildDelegate);
-
-            // written objects count is the same as in objects database
-            Assert.Equal(results.WrittenObjectsCount, orgRepo.ObjectDatabase.Count());
-
-            // loading a repo from the written pack file.
-            Repository mrrRepo = new Repository(mrrRepoPath);
-
-            // make sure the objects of the original repo are the same as the ones in the mirror repo
-            // doing that by making sure the count is the same, and the set differnce is empty
-            Assert.True(mrrRepo.ObjectDatabase.Count() == orgRepo.ObjectDatabase.Count() && !mrrRepo.ObjectDatabase.Except(orgRepo.ObjectDatabase).Any());
-
-            Assert.Equal(orgRepo.Commits.Count(), mrrRepo.Commits.Count());
-            Assert.Equal(orgRepo.Branches.Count(), mrrRepo.Branches.Count());
-            Assert.Equal(orgRepo.Refs.Count(), mrrRepo.Refs.Count());
-
-            orgRepo.Dispose();
-            mrrRepo.Dispose();
-        }
-
-        internal void TestBuildDelegate (PackBuilder builder)
+        internal void TestBuildDelegate(PackBuilder builder)
         {
-            foreach(Branch branch in builder.Repository.Branches)
+            foreach (Branch branch in builder.Repository.Branches)
             {
                 foreach (Commit commit in branch.Commits)
                 {
-                    builder.AddRecursively(commit);
+                    builder.AddRecursively(commit.Id);
                 }
             }
         }

LibGit2Sharp/ObjectDatabase.cs

@@ -644,8 +644,17 @@ public virtual MergeTreeResult MergeCommits(Commit ours, Commit theirs, MergeTre
             }
         }
 
+        /// <summary>
+        /// Pack the objects in the <see cref="ObjectDatabase"/> and write a packfile and indexfile for it.
+        /// </summary>
+        /// <param name="options">Packing options</param>
+        /// <param name="buildDelegate">Packing action. If null is passed, the pack method will invoke the default action of packing
+        /// all objects in an arbitrary order.</param>
+        /// <returns>Packing results</returns>
         public virtual PackBuilderResults Pack(PackBuilderOptions options, Action<PackBuilder> buildDelegate)
         {
+            Ensure.ArgumentNotNull(options, "options");
+
             PackBuilderResults results = new PackBuilderResults();
             PackBuilder builder = new PackBuilder(repo);
 
@@ -657,8 +666,7 @@ public virtual PackBuilderResults Pack(PackBuilderOptions options, Action<PackBu
                 // if no build delegate is provided, just insert all objects one by one.
                 foreach (GitObject obj in this)
                 {
-                    Console.WriteLine();
-                    builder.Add(obj);
+                    builder.Add(obj.Id);
                 }
             }
             else

LibGit2Sharp/PackBuilder.cs

@@ -10,13 +10,15 @@ namespace LibGit2Sharp
     public sealed class PackBuilder : IDisposable
     {
         private readonly PackBuilderSafeHandle packBuilderHandle;
-        internal Repository repo;
+        private readonly Repository repo;
 
         /// <summary>
         /// Constructs a packbuilder from a repository.
         /// </summary>
         internal PackBuilder(Repository repository)
         {
+            Ensure.ArgumentNotNull(repository, "repository");
+
             repo = repository;
             packBuilderHandle = Proxy.git_packbuilder_new(repo.Handle);
         }
@@ -25,35 +27,23 @@ internal PackBuilder(Repository repository)
         /// Inserts a single object to the packbuilder.
         /// For an optimal pack it's mandatory to insert objects in recency order, commits followed by trees and blobs. (quoted from libgit2 API ref)
         /// </summary>
-        /// <param name="gitObject">The object to be inserted.</param>
-        public void Add(GitObject gitObject)
+        /// <param name="gitObjectID">The object ID to be inserted.</param>
+        public void Add(ObjectId gitObjectID)
         {
-            Proxy.git_packbuilder_insert(packBuilderHandle, gitObject.Id, null);
+            Ensure.ArgumentNotNull(gitObjectID, "gitObject");
+
+            Proxy.git_packbuilder_insert(packBuilderHandle, gitObjectID, null);
         }
 
         /// <summary>
         /// Recursively insert an object and its referenced objects. Inserts the object as well as any object it references.
         /// </summary>
-        /// <param name="gitObject">The object to be recursively inserted.</param>
-        public void AddRecursively(GitObject gitObject)
+        /// <param name="gitObjectID">The object ID to be recursively inserted.</param>
+        public void AddRecursively(ObjectId gitObjectID)
         {
-            Proxy.git_packbuilder_insert_recur(packBuilderHandle, gitObject.Id, null);
-        }
+            Ensure.ArgumentNotNull(gitObjectID, "gitObject");
 
-        public Repository Repository
-        {
-            get { return repo; }
-        }
-
-        //================
-
-        /// <summary>
-        /// Insert a <see cref="Tag"/> object to the packbuilder.
-        /// </summary>
-        /// <param name="tag">The tag object to be inserted.</param>
-        internal void InsertTag(Tag tag)
-        {
-            Proxy.git_packbuilder_insert(packBuilderHandle, tag.Target.Id, null);
+            Proxy.git_packbuilder_insert_recur(packBuilderHandle, gitObjectID, null);
         }
 
         /// <summary>
@@ -93,13 +83,22 @@ internal long ObjectsCount
         }
 
         /// <summary>
-        /// Get the number of objects the packbuilder has already written out. This is only correct after the packfile has been written.
+        /// Get the number of objects the packbuilder has already written out. 
+        /// This is only correct after the packfile has been written.
         /// </summary>
         internal long WrittenObjectsCount
         {
             get { return Proxy.git_packbuilder_written(packBuilderHandle); }
         }
 
+        /// <summary>
+        /// A refernce to the repository that the packbuilder is working on.
+        /// </summary>
+        public Repository Repository
+        {
+            get { return repo; }
+        }
+
         internal PackBuilderSafeHandle Handle
         {
             get { return packBuilderHandle; }