Merge pull request #1922 from DaveLak/fix-fuzz-submodule-expected-exc… · gitpython-developers/GitPython@8502efe · GitHub

gitpython-developers / GitPython Public

• Notifications You must be signed in to change notification settings
• Fork 989
• Star 5.2k

• Code
• Issues 8
• Pull requests 2
• Discussions
• Actions
• Security and quality 34
• Insights

Additional navigation options

Commit 8502efe

Browse filesBrowse the repository at this point in the historyBrowse files

Byron

authored

Merge pull request #1922 from DaveLak/fix-fuzz-submodule-expected-exceptions-handling

Add graceful handling of expected exceptions in fuzz_submodule.py

2 parents 2345c1a + 2b64dee commit 8502efe
Copy full SHA for 8502efe

2 files changed

+44-11Lines changed: 44 additions & 11 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• fuzzing/fuzz-targets
  • fuzz_submodule.py
  • utils.py

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎fuzzing/fuzz-targets/fuzz_submodule.py‎

Copy file name to clipboardExpand all lines: fuzzing/fuzz-targets/fuzz_submodule.py

+29-11Lines changed: 29 additions & 11 deletions

Original file line number	Diff line number	Diff line change
@@ -3,14 +3,23 @@
3	3	import os
4	4	import tempfile
5	5	from configparser import ParsingError
6		- from utils import is_expected_exception_message
	6	+ from utils import is_expected_exception_message, get_max_filename_length
	7	+ from git import Repo, GitCommandError, InvalidGitRepositoryError
7	8
8		- if getattr(sys, "frozen", False) and hasattr(sys, "_MEIPASS"):
	9	+ if getattr(sys, "frozen", False) and hasattr(sys, "_MEIPASS"): # pragma: no cover
9	10	path_to_bundled_git_binary = os.path.abspath(os.path.join(os.path.dirname(__file__), "git"))
10	11	os.environ["GIT_PYTHON_GIT_EXECUTABLE"] = path_to_bundled_git_binary
11	12
12		- with atheris.instrument_imports():
13		- from git import Repo, GitCommandError, InvalidGitRepositoryError
	13	+ if not sys.warnoptions: # pragma: no cover
	14	+ # The warnings filter below can be overridden by passing the -W option
	15	+ # to the Python interpreter command line or setting the `PYTHONWARNINGS` environment variable.
	16	+ import warnings
	17	+ import logging
	18	+
	19	+ # Fuzzing data causes some modules to generate a large number of warnings
	20	+ # which are not usually interesting and make the test output hard to read, so we ignore them.
	21	+ warnings.simplefilter("ignore")
	22	+ logging.getLogger().setLevel(logging.ERROR)
14	23
15	24
16	25	def TestOneInput(data):
@@ -42,12 +51,12 @@ def TestOneInput(data):
42	51	writer.release()
43	52
44	53	submodule.update(init=fdp.ConsumeBool(), dry_run=fdp.ConsumeBool(), force=fdp.ConsumeBool())
45		-
46	54	submodule_repo = submodule.module()
47		- new_file_path = os.path.join(
48		- submodule_repo.working_tree_dir,
49		- f"new_file_{fdp.ConsumeUnicodeNoSurrogates(fdp.ConsumeIntInRange(1, 512))}",
	55	+
	56	+ new_file_name = fdp.ConsumeUnicodeNoSurrogates(
	57	+ fdp.ConsumeIntInRange(1, max(1, get_max_filename_length(submodule_repo.working_tree_dir)))
50	58	)
	59	+ new_file_path = os.path.join(submodule_repo.working_tree_dir, new_file_name)
51	60	with open(new_file_path, "wb") as new_file:
52	61	new_file.write(fdp.ConsumeBytes(fdp.ConsumeIntInRange(1, 512)))
53	62	submodule_repo.index.add([new_file_path])
@@ -67,16 +76,24 @@ def TestOneInput(data):
67	76	)
68	77	repo.index.commit(f"Removed submodule {submodule_name}")
69	78
70		- except (ParsingError, GitCommandError, InvalidGitRepositoryError, FileNotFoundError, BrokenPipeError):
	79	+ except (
	80	+ ParsingError,
	81	+ GitCommandError,
	82	+ InvalidGitRepositoryError,
	83	+ FileNotFoundError,
	84	+ FileExistsError,
	85	+ IsADirectoryError,
	86	+ NotADirectoryError,
	87	+ BrokenPipeError,
	88	+ ):
71	89	return -1
72		- except (ValueError, OSError) as e:
	90	+ except ValueError as e:
73	91	expected_messages = [
74	92	"SHA is empty",
75	93	"Reference at",
76	94	"embedded null byte",
77	95	"This submodule instance does not exist anymore",
78	96	"cmd stdin was empty",
79		- "File name too long",
80	97	]
81	98	if is_expected_exception_message(e, expected_messages):
82	99	return -1
@@ -85,6 +102,7 @@ def TestOneInput(data):
85	102
86	103
87	104	def main():
	105	+ atheris.instrument_all()
88	106	atheris.Setup(sys.argv, TestOneInput)
89	107	atheris.Fuzz()
90	108

Collapse file

‎fuzzing/fuzz-targets/utils.py‎

Copy file name to clipboardExpand all lines: fuzzing/fuzz-targets/utils.py

+15Lines changed: 15 additions & 0 deletions

Original file line number	Diff line number	Diff line change
@@ -1,4 +1,5 @@
1	1	import atheris # pragma: no cover
	2	+ import os # pragma: no cover
2	3	from typing import List # pragma: no cover
3	4
4	5
@@ -20,3 +21,17 @@ def is_expected_exception_message(exception: Exception, error_message_list: List
20	21	if error.lower() in exception_message:
21	22	return True
22	23	return False
	24	+
	25	+
	26	+ @atheris.instrument_func
	27	+ def get_max_filename_length(path: str) -> int: # pragma: no cover
	28	+ """
	29	+ Get the maximum filename length for the filesystem containing the given path.
	30	+
	31	+ Args:
	32	+ path (str): The path to check the filesystem for.
	33	+
	34	+ Returns:
	35	+ int: The maximum filename length.
	36	+ """
	37	+ return os.pathconf(path, "PC_NAME_MAX")

0 commit comments

Comments

0 (0)