Unit test for non unicode branch name

Author: wschuell

pygit2/utils.py

@@ -34,16 +34,14 @@ def maybe_string(ptr):
     if not ptr:
         return None
 
-    try:
-        return ffi.string(ptr).decode('utf8')
-    except UnicodeDecodeError:
-        return ffi.string(ptr)
+    return ffi.string(ptr).decode("utf8", errors="surrogateescape")
+
 
-def to_bytes(s, encoding='utf-8', errors='strict'):
+def to_bytes(s, encoding="utf-8", errors="strict"):
     if s == ffi.NULL or s is None:
         return ffi.NULL
 
-    if hasattr(s, '__fspath__'):
+    if hasattr(s, "__fspath__"):
         s = os.fspath(s)
 
     if isinstance(s, bytes):
@@ -53,7 +51,7 @@ def to_bytes(s, encoding='utf-8', errors='strict'):
 
 
 def to_str(s):
-    if hasattr(s, '__fspath__'):
+    if hasattr(s, "__fspath__"):
         s = os.fspath(s)
 
     if type(s) is str:
@@ -71,13 +69,13 @@ def ptr_to_bytes(ptr_cdata):
     to a byte buffer containing the address that the pointer refers to.
     """
 
-    pp = ffi.new('void **', ptr_cdata)
+    pp = ffi.new("void **", ptr_cdata)
     return bytes(ffi.buffer(pp)[:])
 
 
 @contextlib.contextmanager
 def new_git_strarray():
-    strarray = ffi.new('git_strarray *')
+    strarray = ffi.new("git_strarray *")
     yield strarray
     C.git_strarray_dispose(strarray)
 
@@ -90,7 +88,7 @@ def strarray_to_strings(arr):
     calling this function.
     """
     try:
-        return [ffi.string(arr.strings[i]).decode('utf-8') for i in range(arr.count)]
+        return [ffi.string(arr.strings[i]).decode("utf-8") for i in range(arr.count)]
     finally:
         C.git_strarray_dispose(arr)
 
@@ -122,19 +120,19 @@ def __init__(self, l):
             return
 
         if not isinstance(l, (list, tuple)):
-            raise TypeError('Value must be a list')
+            raise TypeError("Value must be a list")
 
         strings = [None] * len(l)
         for i in range(len(l)):
             li = l[i]
-            if not isinstance(li, str) and not hasattr(li, '__fspath__'):
-                raise TypeError('Value must be a string or PathLike object')
+            if not isinstance(li, str) and not hasattr(li, "__fspath__"):
+                raise TypeError("Value must be a string or PathLike object")
 
-            strings[i] = ffi.new('char []', to_bytes(li))
+            strings[i] = ffi.new("char []", to_bytes(li))
 
-        self.__arr = ffi.new('char *[]', strings)
+        self.__arr = ffi.new("char *[]", strings)
         self.__strings = strings
-        self.__array = ffi.new('git_strarray *', [self.__arr, len(strings)])
+        self.__array = ffi.new("git_strarray *", [self.__arr, len(strings)])
 
     def __enter__(self):
         return self

test/test_nonunicode.py

@@ -0,0 +1,53 @@
+# Copyright 2010-2024 The pygit2 contributors
+#
+# This file is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License, version 2,
+# as published by the Free Software Foundation.
+#
+# In addition to the permissions in the GNU General Public License,
+# the authors give you unlimited permission to link the compiled
+# version of this file into combinations with other programs,
+# and to distribute those combinations without any restriction
+# coming from the use of this file.  (The General Public License
+# restrictions do apply in other respects; for example, they cover
+# modification of the file, and distribution when not linked into
+# a combined executable.)
+#
+# This file is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; see the file COPYING.  If not, write to
+# the Free Software Foundation, 51 Franklin Street, Fifth Floor,
+# Boston, MA 02110-1301, USA.
+
+"""Tests for reference objects."""
+
+from pathlib import Path
+
+import pygit2
+import pytest
+import subprocess
+import os
+
+bstring_list = [b"\xc3master"]
+
+
+@pytest.fixture(params=bstring_list)
+def bstring(request):
+    return request.param
+
+
+def test_nonunicode_branchname(testrepo, bstring):
+    cmd = b"git checkout -b " + bstring
+    subprocess.check_output(cmd.split(b" "), cwd=testrepo.workdir)
+    newrepo = pygit2.clone_repository(
+        testrepo.workdir,
+        os.path.join(os.path.dirname(testrepo.workdir), "test_nonunicode_repo"),
+    )
+    assert bstring in [
+        branch.encode("utf8", "surrogateescape")
+        for branch in newrepo.listall_branches()
+    ]