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

Repository navigation

History

459 lines (411 loc) · 19.4 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

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

# This module is part of GitPython and is released under the

# 3-Clause BSD License: https://opensource.org/license/bsd-3-clause/

import os

import os.path as osp

import pathlib

import sys

import tempfile

from unittest import skip

from unittest import mock

from git import Git, GitCommandError, Repo

from git.exc import UnsafeOptionError, UnsafeProtocolError

from test.lib import TestBase, with_rw_directory, with_rw_repo, PathLikeMock

from pathlib import Path

import re

import git

import pytest

@pytest.mark.parametrize("clone_method", ["clone", "clone_from"])

@pytest.mark.parametrize("path_type", [str, Path, PathLikeMock])

@pytest.mark.parametrize("name", ["$GITPYTHON_TEST_SECRET", "${GITPYTHON_TEST_SECRET}", "%GITPYTHON_TEST_SECRET%"])

def test_clone_preserves_literal_separate_git_dir(tmp_path, monkeypatch, caplog, clone_method, path_type, name):

monkeypatch.setenv("GITPYTHON_TEST_SECRET", "sensitive-value")

caplog.set_level("DEBUG", logger="git.cmd")

separate_git_dir = tmp_path / name

options = {"separate_git_dir": path_type(str(separate_git_dir)), "allow_unsafe_options": True}

with Repo.init(tmp_path / "source") as source:

if clone_method == "clone":

cloned = source.clone(tmp_path / "clone", **options)

else:

cloned = Repo.clone_from(source.git_dir, tmp_path / "clone", **options)

with cloned:

assert (separate_git_dir / "HEAD").is_file()

assert separate_git_dir.samefile(cloned.git_dir)

assert not (tmp_path / "sensitive-value").exists()

assert "sensitive-value" not in caplog.text

class TestClone(TestBase):

@with_rw_directory

def test_checkout_in_non_empty_dir(self, rw_dir):

non_empty_dir = Path(rw_dir)

garbage_file = non_empty_dir / "not-empty"

garbage_file.write_text("Garbage!")

# Verify that cloning into the non-empty dir fails while complaining about the

# target directory not being empty/non-existent.

try:

self.rorepo.clone(non_empty_dir)

except git.GitCommandError as exc:

self.assertTrue(exc.stderr, "GitCommandError's 'stderr' is unexpectedly empty")

expr = re.compile(r"(?is).*\bfatal:\s+destination\s+path\b.*\bexists\b.*\bnot\b.*\bempty\s+directory\b")

self.assertTrue(

expr.search(exc.stderr),

'"%s" does not match "%s"' % (expr.pattern, exc.stderr),

)

else:

self.fail("GitCommandError not raised")

@with_rw_directory

def test_clone_from_pathlib(self, rw_dir):

original_repo = Repo.init(osp.join(rw_dir, "repo"))

Repo.clone_from(pathlib.Path(original_repo.git_dir), pathlib.Path(rw_dir) / "clone_pathlib")

@with_rw_directory

def test_clone_from_pathlike(self, rw_dir):

original_repo = Repo.init(osp.join(rw_dir, "repo"))

Repo.clone_from(PathLikeMock(original_repo.git_dir), PathLikeMock(os.path.join(rw_dir, "clone_pathlike")))

@with_rw_directory

def test_clone_from_pathlib_withConfig(self, rw_dir):

original_repo = Repo.init(osp.join(rw_dir, "repo"))

cloned = Repo.clone_from(

original_repo.git_dir,

pathlib.Path(rw_dir) / "clone_pathlib_withConfig",

multi_options=[

"--recurse-submodules=repo",

"--config core.filemode=false",

"--config submodule.repo.update=checkout",

"--config filter.lfs.clean='git-lfs clean -- %f'",

allow_unsafe_options=True,

)

self.assertEqual(cloned.config_reader().get_value("submodule", "active"), "repo")

self.assertEqual(cloned.config_reader().get_value("core", "filemode"), False)

self.assertEqual(cloned.config_reader().get_value('submodule "repo"', "update"), "checkout")

self.assertEqual(

cloned.config_reader().get_value('filter "lfs"', "clean"),

"git-lfs clean -- %f",

)

def test_clone_from_with_path_contains_unicode(self):

with tempfile.TemporaryDirectory() as tmpdir:

unicode_dir_name = "\u0394"

path_with_unicode = os.path.join(tmpdir, unicode_dir_name)

os.makedirs(path_with_unicode)

try:

Repo.clone_from(

url=self._small_repo_url(),

to_path=path_with_unicode,

# Local clones hardlink the reconstructed smmap repository's

# read-only metadata, which Windows cannot remove at cleanup.

no_hardlinks=True,

)

except UnicodeEncodeError:

self.fail("Raised UnicodeEncodeError")

@with_rw_directory

@skip(

"""The referenced repository was removed, and one needs to set up a new

password controlled repo under the org's control."""

)

def test_leaking_password_in_clone_logs(self, rw_dir):

password = "fakepassword1234"

try:

Repo.clone_from(

url="https://fakeuser:{}@fakerepo.example.com/testrepo".format(password),

to_path=rw_dir,

)

except GitCommandError as err:

assert password not in str(err), "The error message '%s' should not contain the password" % err

# Working example from a blank private project.

Repo.clone_from(

url="https://gitlab+deploy-token-392045:mLWhVus7bjLsy8xj8q2V@gitlab.com/mercierm/test_git_python",

to_path=rw_dir,

)

@with_rw_repo("HEAD")

def test_clone_unsafe_options(self, rw_repo):

with tempfile.TemporaryDirectory() as tdir:

tmp_dir = pathlib.Path(tdir)

tmp_file = tmp_dir / "pwn"

unsafe_options = [

f"--upload-pack='touch {tmp_file}'",

f"--upl='touch {tmp_file}'",

f"-u 'touch {tmp_file}'",

f"-utouch {tmp_file}; false",

f"-futouch${{IFS}}{tmp_file}; false",

f"-qutouch${{IFS}}{tmp_file}; false",

"--config=protocol.ext.allow=always",

"--conf=protocol.ext.allow=always",

"-c protocol.ext.allow=always",

"-cprotocol.ext.allow=always",

"-vcprotocol.ext.allow=always",

f"--template={tmp_dir}",

f"--bundle-uri=file://{tmp_dir}",

f"--separate-git-dir={tmp_dir / 'git-dir'}",

]

for unsafe_option in unsafe_options:

with self.assertRaises(UnsafeOptionError):

rw_repo.clone(tmp_dir, multi_options=[unsafe_option])

assert not tmp_file.exists()

unsafe_options = [

{"upload-pack": f"touch {tmp_file}"},

{"upload_pack": f"touch {tmp_file}"},

{"upl": f"touch {tmp_file}"},

{"u": f"touch {tmp_file}"},

{"config": "protocol.ext.allow=always"},

{"conf": "protocol.ext.allow=always"},

{"c": "protocol.ext.allow=always"},

{"template": tmp_dir},

{"bundle_uri": f"file://{tmp_dir}"},

{"separate_git_dir": tmp_dir / "git-dir"},

]

for unsafe_option in unsafe_options:

with self.assertRaises(UnsafeOptionError):

rw_repo.clone(tmp_dir, **unsafe_option)

assert not tmp_file.exists()

@with_rw_repo("HEAD")

def test_clone_unsafe_options_abbreviated(self, rw_repo):

with tempfile.TemporaryDirectory() as tdir:

tmp_dir = pathlib.Path(tdir)

tmp_file = tmp_dir / "pwn"

unsafe_options = [

f"--upl='touch {tmp_file}'",

f"--upload-pac='touch {tmp_file}'",

"--conf=protocol.ext.allow=always",

]

for unsafe_option in unsafe_options:

with self.assertRaises(UnsafeOptionError):

rw_repo.clone(tmp_dir, multi_options=[unsafe_option])

assert not tmp_file.exists()

unsafe_kwargs = [

{"upl": f"touch {tmp_file}"},

{"upload_pac": f"touch {tmp_file}"},

{"conf": "protocol.ext.allow=always"},

]

for unsafe_option in unsafe_kwargs:

with self.assertRaises(UnsafeOptionError):

rw_repo.clone(tmp_dir, **unsafe_option)

assert not tmp_file.exists()

@with_rw_repo("HEAD")

def test_clone_unsafe_options_are_checked_after_splitting_multi_options(self, rw_repo):

with tempfile.TemporaryDirectory() as tdir:

tmp_dir = pathlib.Path(tdir)

payload = "--single-branch --config protocol.ext.allow=always"

with self.assertRaises(UnsafeOptionError):

rw_repo.clone(tmp_dir, multi_options=[payload])

@pytest.mark.xfail(

sys.platform == "win32",

reason=(

"File not created. A separate Windows command may be needed. This and the "

"currently passing test test_clone_unsafe_options must be adjusted in the "

"same way. Until then, test_clone_unsafe_options is unreliable on Windows."

raises=AssertionError,

)

@with_rw_repo("HEAD")

def test_clone_unsafe_options_allowed(self, rw_repo):

with tempfile.TemporaryDirectory() as tdir:

tmp_dir = pathlib.Path(tdir)

tmp_file = tmp_dir / "pwn"

unsafe_options = [

f"--upload-pack='touch {tmp_file}'",

f"-u 'touch {tmp_file}'",

]

for i, unsafe_option in enumerate(unsafe_options):

destination = tmp_dir / str(i)

assert not tmp_file.exists()

# The options will be allowed, but the command will fail.

with self.assertRaises(GitCommandError):

rw_repo.clone(destination, multi_options=[unsafe_option], allow_unsafe_options=True)

assert tmp_file.exists()

tmp_file.unlink()

unsafe_options = [

"--config=protocol.ext.allow=always",

"-c protocol.ext.allow=always",

]

for i, unsafe_option in enumerate(unsafe_options):

destination = tmp_dir / str(i)

assert not destination.exists()

rw_repo.clone(destination, multi_options=[unsafe_option], allow_unsafe_options=True)

assert destination.exists()

@with_rw_repo("HEAD")

def test_clone_safe_options(self, rw_repo):

with tempfile.TemporaryDirectory() as tdir:

tmp_dir = pathlib.Path(tdir)

options = [

"--depth=1",

"--single-branch",

"--origin upload",

"-q",

"-oupstream",

]

for option in options:

destination = tmp_dir / option

assert not destination.exists()

rw_repo.clone(destination, multi_options=[option])

assert destination.exists()

@with_rw_repo("HEAD")

def test_clone_from_unsafe_options(self, rw_repo):

with tempfile.TemporaryDirectory() as tdir:

tmp_dir = pathlib.Path(tdir)

tmp_file = tmp_dir / "pwn"

unsafe_options = [

f"--upload-pack='touch {tmp_file}'",

f"-u 'touch {tmp_file}'",

f"-utouch {tmp_file}; false",

f"-futouch${{IFS}}{tmp_file}; false",

f"-qutouch${{IFS}}{tmp_file}; false",

"--config=protocol.ext.allow=always",

"-c protocol.ext.allow=always",

"-cprotocol.ext.allow=always",

"-vcprotocol.ext.allow=always",

f"--separate-git-dir={tmp_dir / 'git-dir'}",

]

for unsafe_option in unsafe_options:

with self.assertRaises(UnsafeOptionError):

Repo.clone_from(rw_repo.working_dir, tmp_dir, multi_options=[unsafe_option])

assert not tmp_file.exists()

unsafe_options = [

{"upload-pack": f"touch {tmp_file}"},

{"upload_pack": f"touch {tmp_file}"},

{"u": f"touch {tmp_file}"},

{"config": "protocol.ext.allow=always"},

{"c": "protocol.ext.allow=always"},

{"separate_git_dir": tmp_dir / "git-dir"},

]

for unsafe_option in unsafe_options:

with self.assertRaises(UnsafeOptionError):

Repo.clone_from(rw_repo.working_dir, tmp_dir, **unsafe_option)

assert not tmp_file.exists()

@with_rw_repo("HEAD")

def test_clone_from_unsafe_options_are_checked_after_splitting_multi_options(self, rw_repo):

with tempfile.TemporaryDirectory() as tdir:

tmp_dir = pathlib.Path(tdir)

payload = "--single-branch --config protocol.ext.allow=always"

with self.assertRaises(UnsafeOptionError):

Repo.clone_from(rw_repo.working_dir, tmp_dir, multi_options=[payload])

@pytest.mark.xfail(

sys.platform == "win32",

reason=(

"File not created. A separate Windows command may be needed. This and the "

"currently passing test test_clone_from_unsafe_options must be adjusted in the "

"same way. Until then, test_clone_from_unsafe_options is unreliable on Windows."

raises=AssertionError,

)

@with_rw_repo("HEAD")

def test_clone_from_unsafe_options_allowed(self, rw_repo):

with tempfile.TemporaryDirectory() as tdir:

tmp_dir = pathlib.Path(tdir)

tmp_file = tmp_dir / "pwn"

unsafe_options = [

f"--upload-pack='touch {tmp_file}'",

f"-u 'touch {tmp_file}'",

]

for i, unsafe_option in enumerate(unsafe_options):

destination = tmp_dir / str(i)

assert not tmp_file.exists()

# The options will be allowed, but the command will fail.

with self.assertRaises(GitCommandError):

Repo.clone_from(

rw_repo.working_dir, destination, multi_options=[unsafe_option], allow_unsafe_options=True

)

assert tmp_file.exists()

tmp_file.unlink()

unsafe_options = [

"--config=protocol.ext.allow=always",

"-c protocol.ext.allow=always",

]

for i, unsafe_option in enumerate(unsafe_options):

destination = tmp_dir / str(i)

assert not destination.exists()

Repo.clone_from(

rw_repo.working_dir, destination, multi_options=[unsafe_option], allow_unsafe_options=True

)

assert destination.exists()

@with_rw_repo("HEAD")

def test_clone_from_safe_options(self, rw_repo):

with tempfile.TemporaryDirectory() as tdir:

tmp_dir = pathlib.Path(tdir)

options = [

"--depth=1",

"--single-branch",

"-q",

]

for option in options:

destination = tmp_dir / option

assert not destination.exists()

Repo.clone_from(rw_repo.common_dir, destination, multi_options=[option])

assert destination.exists()

def test_clone_from_unsafe_protocol(self):

with tempfile.TemporaryDirectory() as tdir:

tmp_dir = pathlib.Path(tdir)

tmp_file = tmp_dir / "pwn"

urls = [

f"ext::sh -c touch% {tmp_file}",

"fd::17/foo",

]

for url in urls:

with self.assertRaises(UnsafeProtocolError):

Repo.clone_from(url, tmp_dir / "repo")

assert not tmp_file.exists()

def test_clone_from_does_not_expand_environment_variables_in_url(self):

urls = [

"https://example.com/$GITPYTHON_TEST_SECRET/repo.git",

"https://example.com/${GITPYTHON_TEST_SECRET}/repo.git",

"https://example.com/%GITPYTHON_TEST_SECRET%/repo.git",

]

with mock.patch.dict(os.environ, {"GITPYTHON_TEST_SECRET": "sensitive-value"}):

for url in urls:

with mock.patch.object(Git, "_call_process", side_effect=RuntimeError) as call_process:

with self.assertRaises(RuntimeError):

Repo.clone_from(url, "unused")

assert call_process.call_args[0][3] == url

@with_rw_directory

def test_clone_from_does_not_expand_environment_variables_in_stored_url(self, rw_dir):

url = pathlib.Path(rw_dir) / "$GITPYTHON_TEST_SECRET" / "source"

Git().init(url)

with mock.patch.dict(os.environ, {"GITPYTHON_TEST_SECRET": "sensitive-value"}):

cloned = Repo.clone_from(url, pathlib.Path(rw_dir) / "clone")

assert cloned.remotes.origin.url == Git.polish_url(str(url), expand_vars=False)

def test_clone_from_checks_polished_url_for_unsafe_protocol(self):

with mock.patch.object(Git, "polish_url", return_value="ext::command"):

with mock.patch.object(Git, "_call_process") as call_process:

with self.assertRaises(UnsafeProtocolError):

Repo.clone_from("$GITPYTHON_TEST_URL", "unused")

call_process.assert_not_called()

def test_polish_url_does_not_expand_environment_variables_for_cygwin(self):

urls = ["$GITPYTHON_TEST_SECRET/repo", "user@example.com:$GITPYTHON_TEST_SECRET/repo"]

with mock.patch.dict(os.environ, {"GITPYTHON_TEST_SECRET": "sensitive-value"}):

for url in urls:

assert Git.polish_url(url, is_cygwin=True, expand_vars=False) == url

def test_clone_from_unsafe_protocol_allowed(self):

with tempfile.TemporaryDirectory() as tdir:

tmp_dir = pathlib.Path(tdir)

tmp_file = tmp_dir / "pwn"

urls = [

f"ext::sh -c touch% {tmp_file}",

"fd::/foo",

]

for url in urls:

# The URL will be allowed into the command, but the command will

# fail since we don't have that protocol enabled in the Git config file.

with self.assertRaises(GitCommandError):

Repo.clone_from(url, tmp_dir / "repo", allow_unsafe_protocols=True)

assert not tmp_file.exists()

def test_clone_from_unsafe_protocol_allowed_and_enabled(self):

with tempfile.TemporaryDirectory() as tdir:

tmp_dir = pathlib.Path(tdir)

tmp_file = tmp_dir / "pwn"

urls = [

f"ext::sh -c touch% {tmp_file}",

]

allow_ext = [

"--config=protocol.ext.allow=always",

]

for url in urls:

# The URL will be allowed into the command, and the protocol is enabled,

# but the command will fail since it can't read from the remote repo.

assert not tmp_file.exists()

with self.assertRaises(GitCommandError):

Repo.clone_from(

url,

tmp_dir / "repo",

multi_options=allow_ext,

allow_unsafe_protocols=True,

allow_unsafe_options=True,

)

assert tmp_file.exists()

tmp_file.unlink()

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

Repository navigation

Expand file tree

Breadcrumbs

test_clone.py

Latest commit

History

Breadcrumbs

test_clone.py

File metadata and controls