GitPython/test/test_command_guards.py at main · gitpython-developers/GitPython · GitHub

Repository navigation

History

257 lines (225 loc) · 10.8 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

"""Command wrappers apply safety checks before starting Git."""

from pathlib import Path

from unittest import mock

import pytest

from git import Actor, Git, GitCommandError, Remote, Repo

from git.exc import UnsafeOptionError, UnsafeProtocolError

@pytest.mark.parametrize("allow_unsafe_options", [False, True])

@pytest.mark.parametrize(

"args, kwargs",

[

(("ext::helper",), {}),

(("ext::",), {}),

(("custom::address",), {}),

(("1custom+v2.test-name::address",), {}),

(("::address",), {}),

(("custom::\naddress",), {}),

((["--refs", ("ext::helper",)],), {}),

((None, "--", "ext::helper", "HEAD"), {}),

((Path("ext::helper"),), {}),

((), {"q": "ext::helper"}),

((), {"h": ["ext::helper"]}),

((), {"-": "ext::helper"}),

((), {"o": [True, "ext::helper"]}),

(("--server-option",), {"o": "ext::helper", "insert_kwargs_after": "--server-option"}),

)

def test_ls_remote_rejects_unsafe_protocols(args, kwargs, allow_unsafe_options):

with mock.patch.object(Git, "execute", side_effect=AssertionError("Git must not run")) as run:

with pytest.raises(UnsafeProtocolError):

Git().ls_remote(*args, allow_unsafe_options=allow_unsafe_options, **kwargs)

run.assert_not_called()

@pytest.mark.parametrize("through_repo", (False, True))

@pytest.mark.parametrize("remote", ("ext::helper", "ext://helper"))

def test_ls_remote_protocol_guard_at_both_entry_points(tmp_path, through_repo, remote):

with Repo.init(tmp_path) as repo:

command = repo.git if through_repo else Git()

with mock.patch.object(Git, "execute", return_value="refs") as execute:

for allow_unsafe_options in (False, True):

with pytest.raises(UnsafeProtocolError):

command.ls_remote(remote, allow_unsafe_options=allow_unsafe_options)

execute.assert_not_called()

url = "ssh://git@[2001:db8::1]/repo.git"

assert command.ls_remote(url) == "refs"

execute.assert_called_once_with([Git.GIT_PYTHON_GIT_EXECUTABLE, "ls-remote", url])

execute.reset_mock()

with pytest.raises(UnsafeOptionError):

command.ls_remote(remote, upload_pack="helper", allow_unsafe_protocols=True)

execute.assert_not_called()

assert command.ls_remote(remote, allow_unsafe_protocols=True) == "refs"

execute.assert_called_once_with([Git.GIT_PYTHON_GIT_EXECUTABLE, "ls-remote", remote])

@pytest.mark.parametrize(

"args, kwargs",

[

((), {}),

((None,), {}),

(("origin", "HEAD"), {"h": True}),

(("https://example.com/repo.git",), {}),

(("git@example.com:repo.git",), {}),

(("origin",), {"o": "key=value"}),

(("origin",), {"server_option": "key::value"}),

)

def test_ls_remote_preserves_safe_arguments(args, kwargs):

with mock.patch.object(Git, "execute", return_value="refs") as run:

assert Git().ls_remote(*args, **kwargs) == "refs"

run.assert_called_once()

@pytest.mark.parametrize(

"url",

[

"https://[::1]/repo.git",

"ssh://git@[2001:db8::1]/repo.git",

"https://example.com/repo::name",

"git@example.com:repo::name",

"./repo::name",

)

def test_ls_remote_preserves_double_colons_outside_helper_selector(url):

assert Git().ls_remote(url, get_url=True) == url

def test_ls_remote_unsafe_opt_ins_are_independent():

with mock.patch.object(Git, "execute", return_value="refs") as run:

with pytest.raises(UnsafeOptionError):

Git().ls_remote("origin", upload_pack="helper", allow_unsafe_protocols=True)

run.assert_not_called()

assert (

Git().ls_remote("ext::helper", upload_pack="helper", allow_unsafe_protocols=True, allow_unsafe_options=True)

== "refs"

)

run.assert_called_once_with([Git.GIT_PYTHON_GIT_EXECUTABLE, "ls-remote", "--upload-pack=helper", "ext::helper"])

@pytest.mark.parametrize("method", ["fetch", "pull", "push"])

@pytest.mark.parametrize("allow_unsafe_options", [False, True])

@pytest.mark.parametrize(

"name, kwargs",

[

("origin", {"q": "ext::helper"}),

("origin", {"q": "ext://helper"}),

("origin", {"q": [True, "ext::helper"]}),

("origin", {"q": (None, False, True, "custom::address")}),

("origin", {"-": "ext::helper"}),

("ext::helper", {}),

("ext://helper", {}),

)

def test_remote_protocol_guards_check_rendered_operands(tmp_path, method, allow_unsafe_options, name, kwargs):

with Repo.init(tmp_path) as repo:

remote = Remote(repo, name)

with mock.patch.object(Git, "execute", side_effect=AssertionError("Git must not run")) as run:

with pytest.raises(UnsafeProtocolError):

getattr(remote, method)("HEAD", allow_unsafe_options=allow_unsafe_options, **kwargs)

run.assert_not_called()

@pytest.mark.parametrize("method", ["fetch", "pull", "push"])

@pytest.mark.parametrize(

"kwargs, token",

[

({"q": True}, "-q"),

({"q": [None, False, True]}, "-q"),

({"q": "https://[::1]/repo.git"}, "https://[::1]/repo.git"),

({"o": "ext::literal", "split_single_char_options": False}, "-oext::literal"),

({"server_option": "ext::literal"}, "--server-option=ext::literal"),

)

def test_remote_protocol_guards_preserve_safe_rendered_arguments(tmp_path, method, kwargs, token):

with Repo.init(tmp_path) as repo:

remote = Remote(repo, "origin")

error = GitCommandError("captured command", 128)

with mock.patch.object(Git, "execute", side_effect=error) as run:

with pytest.raises(GitCommandError) as raised:

getattr(remote, method)("HEAD", **kwargs)

assert raised.value is error

run.assert_called_once()

argv = run.call_args[0][0]

assert token in argv

assert argv[-3:] == ["--", "origin", "HEAD"]

@pytest.mark.parametrize("method", ["fetch", "pull", "push"])

def test_remote_protocol_and_option_opt_ins_are_independent(tmp_path, method):

with Repo.init(tmp_path) as repo:

remote = Remote(repo, "origin")

kwargs = {"q": "ext::helper"}

option = "receive_pack" if method == "push" else "upload_pack"

error = GitCommandError("captured command", 128)

with mock.patch.object(Git, "execute", side_effect=error) as run:

with pytest.raises(UnsafeOptionError):

getattr(remote, method)("HEAD", allow_unsafe_protocols=True, **kwargs, **{option: "helper"})

run.assert_not_called()

with pytest.raises(GitCommandError) as raised:

getattr(remote, method)("HEAD", allow_unsafe_protocols=True, **kwargs)

assert raised.value is error

run.assert_called_once()

argv = run.call_args[0][0]

assert argv[argv.index("-q") + 1] == "ext::helper"

assert argv[-3:] == ["--", "origin", "HEAD"]

assert not any(arg.startswith("--allow-unsafe") for arg in argv)

@pytest.mark.parametrize("verbose", ["ext::helper", "--upload-pack=helper"])

def test_fetch_verbose_cannot_introduce_operands_or_options(tmp_path, verbose):

with Repo.init(tmp_path) as repo:

remote = Remote(repo, "origin")

error = GitCommandError("captured command", 128)

with mock.patch.object(Git, "execute", side_effect=error) as run:

with pytest.raises(GitCommandError) as raised:

remote.fetch("HEAD", verbose=verbose)

assert raised.value is error

run.assert_called_once()

assert run.call_args[0][0] == [Git.GIT_PYTHON_GIT_EXECUTABLE, "fetch", "-v", "--", "origin", "HEAD"]

@pytest.mark.parametrize("allow_unsafe_options", [False, True])

@pytest.mark.parametrize(

"revs, kwargs",

[

(("HEAD", "--output=unused"), {}),

(("HEAD", ["--out=unused"]), {}),

(("HEAD", "-ounused"), {}),

(("HEAD", "HEAD"), {"output": "unused"}),

(("HEAD", "HEAD"), {"out": "unused"}),

(("HEAD", "HEAD"), {"o": "unused"}),

)

def test_merge_base_checks_unsafe_options(tmp_path, revs, kwargs, allow_unsafe_options):

repo = Repo.init(tmp_path)

with mock.patch.object(Git, "execute", return_value="") as run:

if allow_unsafe_options:

assert repo.merge_base(*revs, allow_unsafe_options=True, **kwargs) == []

run.assert_called_once()

assert "--allow-unsafe-options" not in run.call_args[0][0]

else:

with pytest.raises(UnsafeOptionError):

repo.merge_base(*revs, **kwargs)

run.assert_not_called()

@pytest.mark.parametrize("status", [-9, 2, 128, 129])

def test_merge_base_propagates_errors(tmp_path, status):

repo = Repo.init(tmp_path)

error = GitCommandError("git merge-base", status)

with mock.patch.object(Git, "execute", side_effect=error):

with pytest.raises(GitCommandError) as raised:

repo.merge_base("HEAD", "HEAD")

assert raised.value is error

def test_merge_base_distinguishes_unrelated_history_from_invalid_options(tmp_path):

repo = Repo.init(tmp_path)

actor = Actor("Test", "test@example.com")

first = repo.index.commit("first", author=actor, committer=actor)

second = repo.index.commit("second", parent_commits=[], head=False, author=actor, committer=actor)

assert repo.merge_base(first, first) == [first]

assert repo.merge_base(first, second) == []

with pytest.raises(GitCommandError) as raised:

repo.merge_base(first, second, invalid_option=True)

assert raised.value.status == 129

@pytest.mark.parametrize("allow_unsafe_options", [False, True])

@pytest.mark.parametrize("option", ["pathspec_from_file", "pathspec-from-file", "pathspec_from"])

@pytest.mark.parametrize("dry_run", [False, True])

def test_move_checks_unsafe_options(tmp_path, option, dry_run, allow_unsafe_options):

repo = Repo.init(tmp_path)

with mock.patch.object(Git, "execute", return_value="Renaming source to destination\n") as run:

kwargs = {option: "unused", "dry_run": dry_run}

if allow_unsafe_options:

assert repo.index.move(["source", "destination"], True, allow_unsafe_options=True, **kwargs) == [

("source", "destination")

]

assert run.call_count == (1 if dry_run else 2)

for call in run.call_args_list:

argv = call[0][0]

assert "-k" in argv

assert f"--{option.replace('_', '-')}=unused" in argv

assert "--allow-unsafe-options" not in argv

assert argv[-3:] == ["--", "source", "destination"]

else:

with pytest.raises(UnsafeOptionError):

repo.index.move(["source", "destination"], **kwargs)

run.assert_not_called()

GitPython/test/test_command_guards.py at main · gitpython-developers/GitPython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

test_command_guards.py

Latest commit

History

Breadcrumbs

test_command_guards.py

File metadata and controls