Default signature always returns valid signature

John Haley · John Haley · commit bd9e893a8fa0 · 2015-03-02T09:19:35.000-07:00
If the user name or email wasn't set then `repo.defaultSignature` would return an invalid signature that couldn't be used in other operations. Now the method will return a signature of an "unknown" user that can be used anywhere. This fixes #431
diff --git a/lib/repository.js b/lib/repository.js
@@ -539,7 +539,13 @@ Repository.prototype.treeBuilder = function() {
  * @return {Signature}
  */
 Repository.prototype.defaultSignature = function() {
-  return NodeGit.Signature.default(this);
+  var result = NodeGit.Signature.default(this);
+
+  if (!result.name()) {
+    result = NodeGit.Signature.now("unknown", "unknown@unknown.com");
+  }
+
+  return result;
 };
 
 /**
@@ -589,10 +595,12 @@ Repository.prototype.getRemote = function(remote, callback) {
  * Fetches from a remote
  *
  * @param {String|Remote} remote
+ * @param {Object|RemoteCallback} remoteCallbacks Any custom callbacks needed
  */
 Repository.prototype.fetch = function(
   remote,
   remoteCallbacks,
+
   callback)
 {
   var repo = this;
@@ -613,6 +621,7 @@ Repository.prototype.fetch = function(
 
 /**
  * Fetches from all remotes
+ * @param {Object|RemoteCallback} remoteCallbacks Any custom callbacks needed
  */
 Repository.prototype.fetchAll = function(
   remoteCallbacks,
diff --git a/test/tests/signature.js b/test/tests/signature.js
@@ -1,9 +1,19 @@
 var assert = require("assert");
 var path = require("path");
 var local = path.join.bind(path, __dirname);
+var promisify = require("promisify-node");
+var Promise = require("nodegit-promise");
+
+// Have to wrap exec, since it has a weird callback signature.
+var exec = promisify(function(command, opts, callback) {
+  return require("child_process").exec(command, opts, callback);
+});
 
 describe("Signature", function() {
   var Signature = require(local("../../lib/signature"));
+  var Repository = require(local("../../lib/repository"));
+
+  var reposPath = local("../repos/workdir/.git");
 
   var name = "Bob Gnarley";
   var email = "gnarlee@bob.net";
@@ -33,4 +43,53 @@ describe("Signature", function() {
     // libgit2 does its timezone offsets backwards from javascript
     assert.equal(when.offset(), -now.getTimezoneOffset());
   });
+
+  it("can get a default signature when no user name is set", function() {
+    var savedUserName;
+    var savedUserEmail;
+
+    var cleanUp = function() {
+      return exec("git config --global user.name \"" + savedUserName + "\"")
+      .then(function() {
+        return exec(
+          "git config --global user.email \"" +
+          savedUserEmail +
+          "\"");
+      });
+    };
+
+    return exec("git config --global user.name")
+    .then(function(userName) {
+      savedUserName = userName.trim();
+
+      return exec("git config --global user.email");
+    })
+    .then(function(userEmail) {
+      savedUserEmail = userEmail.trim();
+
+      return exec("git config --global --unset user.name");
+    })
+    .then(function() {
+      return exec("git config --global --unset user.email");
+    })
+    .then(function() {
+      return Repository.open(reposPath);
+    })
+    .then(function(repo) {
+      var sig = repo.defaultSignature();
+
+      assert.equal(sig.name(), "unknown");
+      assert.equal(sig.email(), "unknown@unknown.com");
+
+    })
+    .then(function() {
+      cleanUp();
+    })
+    .catch(function(e) {
+      cleanUp()
+      .then(function() {
+        return Promise.reject(e);
+      });
+    });
+  });
 });
