GitPython/git/test/objects/test_submodule.py at master · uniphil/GitPython · GitHub

Repository navigation

History

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

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

# This module is part of GitPython and is released under

# the BSD License: http://www.opensource.org/licenses/bsd-license.php

from lib import *

from git.exc import *

from git.objects.submodule.base import Submodule

from git.objects.submodule.root import RootModule, RootUpdateProgress

from git.util import to_native_path_linux, join_path_native

import shutil

import git

import sys

import os

import sys

# Change the configuration if possible to prevent the underlying memory manager

# to keep file handles open. On windows we get problems as they are not properly

# closed due to mmap bugs on windows (as it appears)

if sys.platform == 'win32':

try:

import smmap.util

smmap.util.MapRegion._test_read_into_memory = True

except ImportError:

sys.stderr.write("The submodule tests will fail as some files cannot be removed due to open file handles.\n")

sys.stderr.write("The latest version of gitdb uses a memory map manager which can be configured to work around this problem")

#END handle windows platform

class TestRootProgress(RootUpdateProgress):

"""Just prints messages, for now without checking the correctness of the states"""

def update(self, op, index, max_count, message='', input=''):

print message

prog = TestRootProgress()

class TestSubmodule(TestObjectBase):

k_subm_current = "468cad66ff1f80ddaeee4123c24e4d53a032c00d"

k_subm_changed = "394ed7006ee5dc8bddfd132b64001d5dfc0ffdd3"

k_no_subm_tag = "0.1.6"

k_github_gitdb_url = 'git://github.com/gitpython-developers/gitdb.git'

env_gitdb_local_path = "GITPYTHON_TEST_GITDB_LOCAL_PATH"

def _generate_async_local_path(self):

return to_native_path_linux(join_path_native(self.rorepo.working_tree_dir, 'git/ext/async'))

def _rewrite_gitdb_to_local_path(self, smgitdb):

"""Rewrites the given submodule to point to the local path of the gitdb repository, if possible.

Otherwise it leaves it unchanged

:return: new clone path, or None if no new path was set"""

new_smclone_path = os.environ.get(self.env_gitdb_local_path)

if new_smclone_path is not None:

writer = smgitdb.config_writer()

writer.set_value('url', new_smclone_path)

del(writer)

assert smgitdb.config_reader().get_value('url') == new_smclone_path

assert smgitdb.url == new_smclone_path

else:

sys.stderr.write("Submodule tests need the gitdb repository. You can specify a local source setting the %s environment variable. Otherwise it will be downloaded from the internet" % self.env_gitdb_local_path)

#END handle submodule path

return new_smclone_path

def _do_base_tests(self, rwrepo):

"""Perform all tests in the given repository, it may be bare or nonbare"""

# manual instantiation

smm = Submodule(rwrepo, "\0"*20)

# name needs to be set in advance

self.failUnlessRaises(AttributeError, getattr, smm, 'name')

# iterate - 1 submodule

sms = Submodule.list_items(rwrepo, self.k_subm_current)

assert len(sms) == 1

sm = sms[0]

# at a different time, there is None

assert len(Submodule.list_items(rwrepo, self.k_no_subm_tag)) == 0

assert sm.path == 'git/ext/gitdb'

assert sm.path != sm.name # in our case, we have ids there, which don't equal the path

assert sm.url == self.k_github_gitdb_url

assert sm.branch_path == 'refs/heads/master' # the default ...

assert sm.branch_name == 'master'

assert sm.parent_commit == rwrepo.head.commit

# size is always 0

assert sm.size == 0

# the module is not checked-out yet

self.failUnlessRaises(InvalidGitRepositoryError, sm.module)

# which is why we can't get the branch either - it points into the module() repository

self.failUnlessRaises(InvalidGitRepositoryError, getattr, sm, 'branch')

# branch_path works, as its just a string

assert isinstance(sm.branch_path, basestring)

# some commits earlier we still have a submodule, but its at a different commit

smold = Submodule.iter_items(rwrepo, self.k_subm_changed).next()

assert smold.binsha != sm.binsha

assert smold != sm # the name changed

# force it to reread its information

del(smold._url)

smold.url == sm.url

# test config_reader/writer methods

sm.config_reader()

new_smclone_path = None # keep custom paths for later

new_csmclone_path = None #

if rwrepo.bare:

self.failUnlessRaises(InvalidGitRepositoryError, sm.config_writer)

else:

# for faster checkout, set the url to the local path

# Note: This is nice but doesn't work anymore with the latest git-python

# version. This would also mean we need internet for this to work which

# is why we allow an override using an environment variable

new_smclone_path = self._rewrite_gitdb_to_local_path(sm)

# END handle bare repo

smold.config_reader()

# cannot get a writer on historical submodules

if not rwrepo.bare:

self.failUnlessRaises(ValueError, smold.config_writer)

# END handle bare repo

# make the old into a new - this doesn't work as the name changed

prev_parent_commit = smold.parent_commit

self.failUnlessRaises(ValueError, smold.set_parent_commit, self.k_subm_current)

# the sha is properly updated

smold.set_parent_commit(self.k_subm_changed+"~1")

assert smold.binsha != sm.binsha

# raises if the sm didn't exist in new parent - it keeps its

# parent_commit unchanged

self.failUnlessRaises(ValueError, smold.set_parent_commit, self.k_no_subm_tag)

# TEST TODO: if a path in the gitmodules file, but not in the index, it raises

# TEST UPDATE

##############

# module retrieval is not always possible

if rwrepo.bare:

self.failUnlessRaises(InvalidGitRepositoryError, sm.module)

self.failUnlessRaises(InvalidGitRepositoryError, sm.remove)

self.failUnlessRaises(InvalidGitRepositoryError, sm.add, rwrepo, 'here', 'there')

else:

# its not checked out in our case

self.failUnlessRaises(InvalidGitRepositoryError, sm.module)

assert not sm.module_exists()

# currently there is only one submodule

assert len(list(rwrepo.iter_submodules())) == 1

assert sm.binsha != "\0"*20

# TEST ADD

###########

# preliminary tests

# adding existing returns exactly the existing

sma = Submodule.add(rwrepo, sm.name, sm.path)

assert sma.path == sm.path

# no url and no module at path fails

self.failUnlessRaises(ValueError, Submodule.add, rwrepo, "newsubm", "pathtorepo", url=None)

# CONTINUE UPDATE

#################

# lets update it - its a recursive one too

newdir = os.path.join(sm.abspath, 'dir')

os.makedirs(newdir)

# update fails if the path already exists non-empty

self.failUnlessRaises(OSError, sm.update)

os.rmdir(newdir)

# dry-run does nothing

sm.update(dry_run=True, progress=prog)

assert not sm.module_exists()

assert sm.update() is sm

sm_repopath = sm.path # cache for later

assert sm.module_exists()

assert isinstance(sm.module(), git.Repo)

assert sm.module().working_tree_dir == sm.abspath

# INTERLEAVE ADD TEST

#####################

# url must match the one in the existing repository ( if submodule name suggests a new one )

# or we raise

self.failUnlessRaises(ValueError, Submodule.add, rwrepo, "newsubm", sm.path, "git://someurl/repo.git")

# CONTINUE UPDATE

#################

# we should have setup a tracking branch, which is also active

assert sm.module().head.ref.tracking_branch() is not None

# delete the whole directory and re-initialize

shutil.rmtree(sm.abspath)

assert len(sm.children()) == 0

# dry-run does nothing

sm.update(dry_run=True, recursive=False, progress=prog)

assert len(sm.children()) == 0

sm.update(recursive=False)

assert len(list(rwrepo.iter_submodules())) == 2

assert len(sm.children()) == 1 # its not checked out yet

csm = sm.children()[0]

assert not csm.module_exists()

csm_repopath = csm.path

# adjust the path of the submodules module to point to the local destination

# In the current gitpython version, async is used directly by gitpython

new_csmclone_path = self._generate_async_local_path()

csm.config_writer().set_value('url', new_csmclone_path)

assert csm.url == new_csmclone_path

# dry-run does nothing

assert not csm.module_exists()

sm.update(recursive=True, dry_run=True, progress=prog)

assert not csm.module_exists()

# update recursively again

sm.update(recursive=True)

assert csm.module_exists()

# tracking branch once again

csm.module().head.ref.tracking_branch() is not None

# this flushed in a sub-submodule

assert len(list(rwrepo.iter_submodules())) == 2

# reset both heads to the previous version, verify that to_latest_revision works

smods = (sm.module(), csm.module())

for repo in smods:

repo.head.reset('HEAD~2', working_tree=1)

# END for each repo to reset

# dry run does nothing

sm.update(recursive=True, dry_run=True, progress=prog)

for repo in smods:

assert repo.head.commit != repo.head.ref.tracking_branch().commit

# END for each repo to check

sm.update(recursive=True, to_latest_revision=True)

for repo in smods:

assert repo.head.commit == repo.head.ref.tracking_branch().commit

# END for each repo to check

del(smods)

# if the head is detached, it still works ( but warns )

smref = sm.module().head.ref

sm.module().head.ref = 'HEAD~1'

# if there is no tracking branch, we get a warning as well

csm_tracking_branch = csm.module().head.ref.tracking_branch()

csm.module().head.ref.set_tracking_branch(None)

sm.update(recursive=True, to_latest_revision=True)

# to_latest_revision changes the child submodule's commit, it needs an

# update now

csm.set_parent_commit(csm.repo.head.commit)

# undo the changes

sm.module().head.ref = smref

csm.module().head.ref.set_tracking_branch(csm_tracking_branch)

# REMOVAL OF REPOSITOTRY

########################

# must delete something

self.failUnlessRaises(ValueError, csm.remove, module=False, configuration=False)

# We have modified the configuration, hence the index is dirty, and the

# deletion will fail

# NOTE: As we did a few updates in the meanwhile, the indices were reset

# Hence we create some changes

csm.set_parent_commit(csm.repo.head.commit)

sm.config_writer().set_value("somekey", "somevalue")

csm.config_writer().set_value("okey", "ovalue")

self.failUnlessRaises(InvalidGitRepositoryError, sm.remove)

# if we remove the dirty index, it would work

sm.module().index.reset()

# still, we have the file modified

self.failUnlessRaises(InvalidGitRepositoryError, sm.remove, dry_run=True)

sm.module().index.reset(working_tree=True)

# make sure sub-submodule is not modified by forcing it to update

# to the revision it is supposed to point to.

for subitem in sm.traverse():

subitem.update()

#END checkout to right commit

# this would work

assert sm.remove(dry_run=True) is sm

assert sm.module_exists()

sm.remove(force=True, dry_run=True)

assert sm.module_exists()

# but ... we have untracked files in the child submodule

fn = join_path_native(csm.module().working_tree_dir, "newfile")

open(fn, 'w').write("hi")

self.failUnlessRaises(InvalidGitRepositoryError, sm.remove)

# forcibly delete the child repository

prev_count = len(sm.children())

assert csm.remove(force=True) is csm

assert not csm.exists()

assert not csm.module_exists()

assert len(sm.children()) == prev_count - 1

# now we have a changed index, as configuration was altered.

# fix this

sm.module().index.reset(working_tree=True)

# now delete only the module of the main submodule

assert sm.module_exists()

sm.remove(configuration=False)

assert sm.exists()

assert not sm.module_exists()

assert sm.config_reader().get_value('url')

# delete the rest

sm.remove()

assert not sm.exists()

assert not sm.module_exists()

assert len(rwrepo.submodules) == 0

# ADD NEW SUBMODULE

###################

# add a simple remote repo - trailing slashes are no problem

smid = "newsub"

osmid = "othersub"

nsm = Submodule.add(rwrepo, smid, sm_repopath, new_smclone_path+"/", None, no_checkout=True)

assert nsm.name == smid

assert nsm.module_exists()

assert nsm.exists()

# its not checked out

assert not os.path.isfile(join_path_native(nsm.module().working_tree_dir, Submodule.k_modules_file))

assert len(rwrepo.submodules) == 1

# add another submodule, but into the root, not as submodule

osm = Submodule.add(rwrepo, osmid, csm_repopath, new_csmclone_path, Submodule.k_head_default)

assert osm != nsm

assert osm.module_exists()

assert osm.exists()

assert os.path.isfile(join_path_native(osm.module().working_tree_dir, 'setup.py'))

assert len(rwrepo.submodules) == 2

# commit the changes, just to finalize the operation

rwrepo.index.commit("my submod commit")

assert len(rwrepo.submodules) == 2

# needs update as the head changed, it thinks its in the history

# of the repo otherwise

nsm.set_parent_commit(rwrepo.head.commit)

osm.set_parent_commit(rwrepo.head.commit)

# MOVE MODULE

#############

# invalid inptu

self.failUnlessRaises(ValueError, nsm.move, 'doesntmatter', module=False, configuration=False)

# renaming to the same path does nothing

assert nsm.move(sm.path) is nsm

# rename a module

nmp = join_path_native("new", "module", "dir") + "/" # new module path

pmp = nsm.path

abspmp = nsm.abspath

assert nsm.move(nmp) is nsm

nmp = nmp[:-1] # cut last /

nmpl = to_native_path_linux(nmp)

assert nsm.path == nmpl

assert rwrepo.submodules[0].path == nmpl

mpath = 'newsubmodule'

absmpath = join_path_native(rwrepo.working_tree_dir, mpath)

open(absmpath, 'w').write('')

self.failUnlessRaises(ValueError, nsm.move, mpath)

os.remove(absmpath)

# now it works, as we just move it back

nsm.move(pmp)

assert nsm.path == pmp

assert rwrepo.submodules[0].path == pmp

# TODO lowprio: test remaining exceptions ... for now its okay, the code looks right

# REMOVE 'EM ALL

################

# if a submodule's repo has no remotes, it can't be added without an explicit url

osmod = osm.module()

osm.remove(module=False)

for remote in osmod.remotes:

remote.remove(osmod, remote.name)

assert not osm.exists()

self.failUnlessRaises(ValueError, Submodule.add, rwrepo, osmid, csm_repopath, url=None)

# END handle bare mode

# Error if there is no submodule file here

self.failUnlessRaises(IOError, Submodule._config_parser, rwrepo, rwrepo.commit(self.k_no_subm_tag), True)

@with_rw_repo(k_subm_current)

def test_base_rw(self, rwrepo):

self._do_base_tests(rwrepo)

@with_rw_repo(k_subm_current, bare=True)

def test_base_bare(self, rwrepo):

self._do_base_tests(rwrepo)

@with_rw_repo(k_subm_current, bare=False)

def test_root_module(self, rwrepo):

# Can query everything without problems

rm = RootModule(rwrepo)

# test new constructor

assert rm.parent_commit == RootModule(self.rorepo, self.rorepo.commit(self.k_subm_current)).parent_commit

assert rm.module() is rwrepo

# try attributes

rm.binsha

rm.mode

rm.path

assert rm.name == rm.k_root_name

assert rm.parent_commit == self.rorepo.commit(self.k_subm_current)

rm.url

rm.branch

assert len(rm.list_items(rm.module())) == 1

rm.config_reader()

rm.config_writer()

# deep traversal git / async

rsmsp = [sm.path for sm in rm.traverse()]

assert len(rsmsp) == 1 # gitdb only - its not yet uptodate so it has no submodule

# cannot set the parent commit as root module's path didn't exist

self.failUnlessRaises(ValueError, rm.set_parent_commit, 'HEAD')

# TEST UPDATE

#############

# setup commit which remove existing, add new and modify existing submodules

rm = RootModule(rwrepo)

assert len(rm.children()) == 1

# modify path without modifying the index entry

# ( which is what the move method would do properly )

#==================================================

sm = rm.children()[0]

pp = "path/prefix"

fp = join_path_native(pp, sm.path)

prep = sm.path

assert not sm.module_exists() # was never updated after rwrepo's clone

# assure we clone from a local source

self._rewrite_gitdb_to_local_path(sm)

# dry-run does nothing

sm.update(recursive=False, dry_run=True, progress=prog)

assert not sm.module_exists()

sm.update(recursive=False)

assert sm.module_exists()

sm.config_writer().set_value('path', fp) # change path to something with prefix AFTER url change

# update fails as list_items in such a situations cannot work, as it cannot

# find the entry at the changed path

self.failUnlessRaises(InvalidGitRepositoryError, rm.update, recursive=False)

# move it properly - doesn't work as it its path currently points to an indexentry

# which doesn't exist ( move it to some path, it doesn't matter here )

self.failUnlessRaises(InvalidGitRepositoryError, sm.move, pp)

# reset the path(cache) to where it was, now it works

sm.path = prep

sm.move(fp, module=False) # leave it at the old location

assert not sm.module_exists()

cpathchange = rwrepo.index.commit("changed sm path") # finally we can commit

# update puts the module into place

rm.update(recursive=False, progress=prog)

sm.set_parent_commit(cpathchange)

assert sm.module_exists()

# add submodule

#================

nsmn = "newsubmodule"

nsmp = "submrepo"

async_url = self._generate_async_local_path()

nsm = Submodule.add(rwrepo, nsmn, nsmp, url=async_url)

csmadded = rwrepo.index.commit("Added submodule").hexsha # make sure we don't keep the repo reference

nsm.set_parent_commit(csmadded)

assert nsm.module_exists()

# in our case, the module should not exist, which happens if we update a parent

# repo and a new submodule comes into life

nsm.remove(configuration=False, module=True)

assert not nsm.module_exists() and nsm.exists()

# dry-run does nothing

rm.update(recursive=False, dry_run=True, progress=prog)

# otherwise it will work

rm.update(recursive=False, progress=prog)

assert nsm.module_exists()

# remove submodule - the previous one

#====================================

sm.set_parent_commit(csmadded)

smp = sm.abspath

assert not sm.remove(module=False).exists()

assert os.path.isdir(smp) # module still exists

csmremoved = rwrepo.index.commit("Removed submodule")

# an update will remove the module

# not in dry_run

rm.update(recursive=False, dry_run=True)

assert os.path.isdir(smp)

rm.update(recursive=False)

assert not os.path.isdir(smp)

# change url

#=============

# to the first repository, this way we have a fast checkout, and a completely different

# repository at the different url

nsm.set_parent_commit(csmremoved)

nsmurl = os.environ.get(self.env_gitdb_local_path, self.k_github_gitdb_url)

# Note: We would have liked to have a different url, but we cannot

# provoke this case

assert nsm.url != nsmurl

nsm.config_writer().set_value('url', nsmurl)

csmpathchange = rwrepo.index.commit("changed url")

nsm.set_parent_commit(csmpathchange)

prev_commit = nsm.module().head.commit

# dry-run does nothing

rm.update(recursive=False, dry_run=True, progress=prog)

assert nsm.module().remotes.origin.url != nsmurl

rm.update(recursive=False, progress=prog)

assert nsm.module().remotes.origin.url == nsmurl

# head changed, as the remote url and its commit changed

assert prev_commit != nsm.module().head.commit

# add the submodule's changed commit to the index, which is what the

# user would do

# beforehand, update our instance's binsha with the new one

nsm.binsha = nsm.module().head.commit.binsha

rwrepo.index.add([nsm])

# change branch

#=================

# we only have one branch, so we switch to a virtual one, and back

# to the current one to trigger the difference

cur_branch = nsm.branch

nsmm = nsm.module()

prev_commit = nsmm.head.commit

for branch in ("some_virtual_branch", cur_branch.name):

nsm.config_writer().set_value(Submodule.k_head_option, git.Head.to_full_path(branch))

csmbranchchange = rwrepo.index.commit("changed branch to %s" % branch)

nsm.set_parent_commit(csmbranchchange)

# END for each branch to change

# Lets remove our tracking branch to simulate some changes

nsmmh = nsmm.head

assert nsmmh.ref.tracking_branch() is None # never set it up until now

assert not nsmmh.is_detached

#dry run does nothing

rm.update(recursive=False, dry_run=True, progress=prog)

assert nsmmh.ref.tracking_branch() is None

# the real thing does

rm.update(recursive=False, progress=prog)

assert nsmmh.ref.tracking_branch() is not None

assert not nsmmh.is_detached

# recursive update

# =================

# finally we recursively update a module, just to run the code at least once

# remove the module so that it has more work

assert len(nsm.children()) >= 1 # could include smmap

assert nsm.exists() and nsm.module_exists() and len(nsm.children()) >= 1

# assure we pull locally only

nsmc = nsm.children()[0]

nsmc.config_writer().set_value('url', async_url)

rm.update(recursive=True, progress=prog, dry_run=True) # just to run the code

rm.update(recursive=True, progress=prog)

assert len(nsm.children()) >= 2 and nsmc.module_exists()

GitPython/git/test/objects/test_submodule.py at master · uniphil/GitPython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

test_submodule.py

Latest commit

History

Breadcrumbs

test_submodule.py

File metadata and controls