Add support for push options

Add a new keyword argument to Remote.push() that is a counterpart of
`git push --push-option=<string>`.

Fixes #1126

Author: kempniu

pygit2/remotes.py

@@ -236,7 +236,7 @@ def push_refspecs(self):
         check_error(err)
         return strarray_to_strings(specs)
 
-    def push(self, specs, callbacks=None, proxy=None):
+    def push(self, specs, callbacks=None, proxy=None, push_options=None):
         """
         Push the given refspec to the remote. Raises ``GitError`` on protocol
         error or unpack failure.
@@ -258,11 +258,16 @@ def push(self, specs, callbacks=None, proxy=None):
             * `None` (the default) to disable proxy usage
             * `True` to enable automatic proxy detection
             * an url to a proxy (`http://proxy.example.org:3128/`)
+
+        push_options : [str]
+            Push options to send to the server, which passes them to the
+            pre-receive as well as the post-receive hook.
         """
         with git_push_options(callbacks) as payload:
             opts = payload.push_options
             self.__set_proxy(opts.proxy_opts, proxy)
-            with StrArray(specs) as refspecs:
+            with StrArray(specs) as refspecs, StrArray(push_options) as pushopts:
+                pushopts.assign_to(opts.remote_push_options)
                 err = C.git_remote_push(self._remote, refspecs.ptr, opts)
                 payload.check_error(err)
 

test/test_remote.py

@@ -25,12 +25,14 @@
 
 """Tests for Remote objects."""
 
+from unittest.mock import patch
 import sys
 
 import pytest
 
 import pygit2
 from pygit2 import Oid
+from pygit2.ffi import ffi
 from . import utils
 
 
@@ -356,3 +358,25 @@ def test_push_non_fast_forward_commits_to_remote_fails(origin, clone, remote):
 
     with pytest.raises(pygit2.GitError):
         remote.push(['refs/heads/master'])
+
+
+@patch.object(pygit2.callbacks, 'RemoteCallbacks')
+def test_push_options(mock_callbacks, origin, clone, remote):
+    remote.push(['refs/heads/master'])
+    remote_push_options = mock_callbacks.return_value.push_options.remote_push_options
+    assert remote_push_options.count == 0
+
+    remote.push(['refs/heads/master'], push_options=[])
+    remote_push_options = mock_callbacks.return_value.push_options.remote_push_options
+    assert remote_push_options.count == 0
+
+    remote.push(['refs/heads/master'], push_options=['foo'])
+    remote_push_options = mock_callbacks.return_value.push_options.remote_push_options
+    assert remote_push_options.count == 1
+    assert ffi.string(remote_push_options.strings[0]) == b'foo'
+
+    remote.push(['refs/heads/master'], push_options=['Option A', 'Option B'])
+    remote_push_options = mock_callbacks.return_value.push_options.remote_push_options
+    assert remote_push_options.count == 2
+    assert ffi.string(remote_push_options.strings[0]) == b'Option A'
+    assert ffi.string(remote_push_options.strings[1]) == b'Option B'