This is an archive of the discontinued Mercurial Phabricator instance.

Differential D9719

shelve: don't include invalid shelves in `hg shelve --list`
ClosedPublic

Authored by martinvonz on Jan 11 2021, 1:04 PM.

Download Raw Diff

Details

Reviewers

pulkit

Group Reviewers

hg-reviewers

Commits

rHG61f8fc12e167: shelve: don't include invalid shelves in `hg shelve --list`
rHG63c3ec06ff70: shelve: don't include invalid shelves in `hg shelve --list`
rHG680cc423a23e: shelve: don't include invalid shelves in `hg shelve --list`

Summary

Before this patch, if a shelved change is missing its .hg file, we
still list it in hg shelve --list, but then hg unshelve
crashes. This patch makes it so we only list valid shelved changes.

This patch means that users who do touch .hg/shelve/buy-milk.patch
as a form of TODO list will no longer see their TODO items in `hg
shelve --list`.

Diff Detail

Repository

rHG Mercurial

Branch

default

Lint

No Linters Available

Unit

No Unit Test Coverage

Event Timeline

martinvonz created this revision.Jan 11 2021, 1:04 PM

Herald added a reviewer: hg-reviewers. · View Herald TranscriptJan 11 2021, 1:04 PM

Herald added a subscriber: mercurial-patches. · View Herald Transcript

martinvonz added a child revision: D9720: shelve: don't crash on file with unexpected extension in .hg/shelved/.Jan 11 2021, 1:04 PM

martinvonz edited the summary of this revision. (Show Details)Jan 11 2021, 1:32 PM

martinvonz updated this revision to Diff 24738.Jan 12 2021, 5:48 PM

pulkit accepted this revision.Jan 16 2021, 4:36 AM

This revision is now accepted and ready to land.Jan 16 2021, 4:36 AM

martinvonz added a commit: rHG680cc423a23e: shelve: don't include invalid shelves in `hg shelve --list`.Jan 16 2021, 5:57 AM

Closed by commit rHG680cc423a23e: shelve: don't include invalid shelves in `hg shelve --list` (authored by martinvonz). · Explain Why

This revision was automatically updated to reflect the committed changes.

martinvonz added a commit: rHG63c3ec06ff70: shelve: don't include invalid shelves in `hg shelve --list`.Jan 16 2021, 1:31 PM

martinvonz added a commit: rHG61f8fc12e167: shelve: don't include invalid shelves in `hg shelve --list`.Jan 17 2021, 2:21 AM

Revision Contents
Changeset List

			Path	Packages
M			mercurial/shelve.py (19 lines)
M			tests/test-shelve2.t (17 lines)

Diff	ID	Description	Created	Lint	Unit
Base		Base
Diff 1	24707		Jan 11 2021, 1:04 PM	★	★
Diff 2	24738		Jan 12 2021, 5:48 PM	★	★
Diff 3	24950	rHG680cc423a23e8af9e1274ef5a1a37d229632074b	Jan 11 2021, 12:26 PM	★	★

Commit	Parents	Author	Summary	Date
99c0e3bf56a9	68e5be25969a	Martin von Zweigbergk		Jan 11 2021, 12:26 PM

Status	Author	Revision
Closed	martinvonz	D9744 shelve: move listshelves() to new ShelfDir class, so caller need not pass vfs
Closed	martinvonz	D9743 shelve: also create class representing whole directory of shelves
Closed	martinvonz	D9742 shelve: add a method for deleting shelf to new shelf class
Closed	martinvonz	D9741 shelve: inline ".patch" constant now that it's only used in the Shelf class
Closed	martinvonz	D9740 shelve: use listshelves() in cleanupoldbackups()
Closed	martinvonz	D9739 shelve: make listshelves() list shelves in a given vfs
Closed	martinvonz	D9738 shelve: replace repo instance in Shelf class by vfs instance
Closed	martinvonz	D9737 shelve: use listdir() instead of readdir() when we don't need stat information
Closed	martinvonz	D9720 shelve: don't crash on file with unexpected extension in .hg/shelved/
Closed	martinvonz	D9719 shelve: don't include invalid shelves in `hg shelve --list`
Closed	martinvonz	D9714 shelve: extract some repeated creation of shelf instances to variables
Closed	martinvonz	D9713 shelve: teach new shelf class to check if .shelve file exists
Closed	martinvonz	D9712 shelve: move method for creating backup to new shelf class
Closed	martinvonz	D9711 shelve: make gennames() helper generate relative backup paths
Closed	martinvonz	D9710 shelve: use listshelves() in cleanup function
Closed	martinvonz	D9709 shelve: inline shelvedfile.filename() since there are no callers outside class
Closed	martinvonz	D9708 shelve: make listshelves() return shelf names instead of filenames
Closed	martinvonz	D9707 shelve: move method for getting stat (mtime) to new shelf class
Closed	martinvonz	D9706 shelve: open patch using new shelf class instead of open()
Closed	martinvonz	D9705 shelve: move function for opening .patch file to new shelf class
Closed	martinvonz	D9704 shelve: move method for reading .hg to new shelf class
Closed	martinvonz	D9703 shelve: move method for writing bundle to new shelf class
Closed	martinvonz	D9702 shelve: move method for reading .shelve file to new shelf class
Closed	martinvonz	D9701 shelve: move method for writing .shelve to new shelf class
Closed	martinvonz	D9700 shelve: introduce class representing a shelf
Closed	martinvonz	D9699 shelve: raise more specific errors
Closed	martinvonz	D9698 shelve: trust caller of shelvedfile.opener() to check that the file exists
Closed	martinvonz	D9697 shelve: rewrite check for unknown shelf to delete
Closed	martinvonz	D9696 shelve: remove a bundlerepo method
Closed	martinvonz	D9718 tests: add tests for corrupt .hg/shelved/ directory

Diff 24707

mercurial/shelve.py


	def __init__(self, repo, name):			def __init__(self, repo, name):
	self.repo = repo			self.repo = repo
	self.name = name			self.name = name
	self.vfs = vfsmod.vfs(repo.vfs.join(shelvedir))			self.vfs = vfsmod.vfs(repo.vfs.join(shelvedir))
	self.backupvfs = vfsmod.vfs(repo.vfs.join(backupdir))			self.backupvfs = vfsmod.vfs(repo.vfs.join(backupdir))

	def exists(self):			def exists(self):
	return self.vfs.exists(self.name + b'.' + patchextension)			return self.vfs.exists(
				self.name + b'.' + patchextension
				) and self.vfs.exists(self.name + b'.hg')

	def mtime(self):			def mtime(self):
	return self.vfs.stat(self.name + b'.' + patchextension)[stat.ST_MTIME]			return self.vfs.stat(self.name + b'.' + patchextension)[stat.ST_MTIME]

	def writeinfo(self, info):			def writeinfo(self, info):
	scmutil.simplekeyvaluefile(self.vfs, self.name + b'.shelve').write(info)			scmutil.simplekeyvaluefile(self.vfs, self.name + b'.shelve').write(info)

	def hasinfo(self):			def hasinfo(self):
	"""return all shelves in repo as list of (time, filename)"""			"""return all shelves in repo as list of (time, filename)"""
	try:			try:
	names = repo.vfs.readdir(shelvedir)			names = repo.vfs.readdir(shelvedir)
	except OSError as err:			except OSError as err:
	if err.errno != errno.ENOENT:			if err.errno != errno.ENOENT:
	raise			raise
	return []			return []
	info = []			info = []
	for (name, _type) in names:			seen = set()
	pfx, sfx = name.rsplit(b'.', 1)			for (filename, _type) in names:
	if not pfx or sfx != patchextension:			name, ext = filename.rsplit(b'.', 1)
				if name in seen:
	continue			continue
	mtime = Shelf(repo, pfx).mtime()			seen.add(name)
	info.append((mtime, pfx))			shelve = Shelf(repo, name)
				if not shelve.exists():
				continue
				mtime = shelve.mtime()
				info.append((mtime, name))
	return sorted(info, reverse=True)			return sorted(info, reverse=True)


	def listcmd(ui, repo, pats, opts):			def listcmd(ui, repo, pats, opts):
	"""subcommand that displays the list of shelves"""			"""subcommand that displays the list of shelves"""
	pats = set(pats)			pats = set(pats)
	width = 80			width = 80
	if not ui.plain():			if not ui.plain():

tests/test-shelve2.t

	Test corrupt shelves (in .hg/shelved/, not .hg/shelvestate)			Test corrupt shelves (in .hg/shelved/, not .hg/shelvestate)
	$ hg init corrupt-shelves			$ hg init corrupt-shelves
	$ cd corrupt-shelves			$ cd corrupt-shelves
	$ mkdir .hg/shelved			$ mkdir .hg/shelved

	# A (corrupt) .patch file without a .hg file			# A (corrupt) .patch file without a .hg file
	$ touch .hg/shelved/junk1.patch			$ touch .hg/shelved/junk1.patch
	$ hg shelve -l			$ hg shelve -l
	junk1 (* ago) (glob)
	$ hg unshelve			$ hg unshelve
	unshelving change 'junk1'			abort: no shelved changes to apply!
	abort: $ENOENT$: '$TESTTMP/corrupt-shelves/.hg/shelved/junk1.hg'			[20]
	[255]
	$ hg shelve -d junk1			$ hg shelve -d junk1
				abort: shelved change 'junk1' not found
				[10]
	$ find .hg/shelve*			$ find .hg/shelve*
	.hg/shelve-backup
	.hg/shelve-backup/junk1.patch
	.hg/shelved			.hg/shelved
				.hg/shelved/junk1.patch

	# A .hg file without a .patch file			# A .hg file without a .patch file
	$ touch .hg/shelved/junk2.hg			$ touch .hg/shelved/junk2.hg
	$ hg shelve -l			$ hg shelve -l
	$ hg unshelve			$ hg unshelve
	abort: no shelved changes to apply!			abort: no shelved changes to apply!
	[20]			[20]
	$ hg shelve -d junk2			$ hg shelve -d junk2
	abort: shelved change 'junk2' not found			abort: shelved change 'junk2' not found
	[10]			[10]
	$ find .hg/shelve*			$ find .hg/shelve*
	.hg/shelve-backup
	.hg/shelve-backup/junk1.patch
	.hg/shelved			.hg/shelved
				.hg/shelved/junk1.patch
	.hg/shelved/junk2.hg			.hg/shelved/junk2.hg

	# A file with an unexpected extension			# A file with an unexpected extension
	$ touch .hg/shelved/junk3			$ touch .hg/shelved/junk3
	$ hg shelve -l 2>&1 \| grep ValueError			$ hg shelve -l 2>&1 \| grep ValueError
	ValueError: not enough values to unpack (expected 2, got 1)			ValueError: not enough values to unpack (expected 2, got 1)
	$ hg unshelve 2>&1 \| grep ValueError			$ hg unshelve 2>&1 \| grep ValueError
	ValueError: not enough values to unpack (expected 2, got 1)			ValueError: not enough values to unpack (expected 2, got 1)
	$ hg shelve -d junk3			$ hg shelve -d junk3
	abort: shelved change 'junk3' not found			abort: shelved change 'junk3' not found
	[10]			[10]
	$ find .hg/shelve*			$ find .hg/shelve*
	.hg/shelve-backup
	.hg/shelve-backup/junk1.patch
	.hg/shelved			.hg/shelved
				.hg/shelved/junk1.patch
	.hg/shelved/junk3			.hg/shelved/junk3
	.hg/shelved/junk2.hg			.hg/shelved/junk2.hg

	$ cd ..			$ cd ..

	Unshelve respects --keep even if user intervention is needed			Unshelve respects --keep even if user intervention is needed
	$ hg init unshelvekeep && cd unshelvekeep			$ hg init unshelvekeep && cd unshelvekeep
	$ echo 1 > file && hg ci -Am 1			$ echo 1 > file && hg ci -Am 1