git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 03/11] git p4: work around p4 bug that causes empty symlinks

From
PWPete Wyckoff <pw@padd.com>
Date
Jan 21, 2014, 23:16 UTC
Message-ID
<1390346208-9207-4-git-send-email-pw@padd.com>
In-Reply-To
<1390346208-9207-1-git-send-email-pw@padd.com>

Damien Gérard highlights an interesting problem. Some p4 repositories end up with symlinks that have an empty target. It is not possible to create this with current p4, but they do indeed exist.

The effect in git p4 is that "p4 print" on the symlink returns an empty string, confusing the curret symlink-handling code.

Such broken repositories cause problems in p4 as well, even with no git involved. In p4, syncing to a change that includes a bogus symlink causes errors:

    //depot/empty-symlink - updating /home/me/p4/empty-symlink
    rename: /home/me/p4/empty-symlink: No such file or directory
and leaves no symlink.

In git, replicate the p4 behavior by ignoring these bad symlinks. If, in a later p4 revision, the symlink happens to point to something non-null, the symlink will be replaced properly.

Add a big test for all this too.

This happens to be a regression introduced by 1292df1 (git-p4: Fix occasional truncation of symlink contents., 2013-08-08) and appeared first in 1.8.5. But it only shows up only in p4 repositories of dubious character, so can wait for a proper release.

Tested-by: Damien Gérard <damien@iwi.me>
Signed-off-by: Pete Wyckoff <pw@padd.com>
---
 git-p4.py                  |  9 ++++++-
 t/t9802-git-p4-filetype.sh | 66 ++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 74 insertions(+), 1 deletion(-)
diff --git a/git-p4.py b/git-p4.py
index 5ea8bb8..e798ecf 100755
--- a/git-p4.py
+++ b/git-p4.py
@@ -2075,7 +2075,14 @@ class P4Sync(Command, P4UserMap):
             # p4 print on a symlink sometimes contains "target\n";
             # if it does, remove the newline
             data = ''.join(contents)
-            if data[-1] == '\n':
+            if not data:
+                # Some version of p4 allowed creating a symlink that pointed
+                # to nothing.  This causes p4 errors when checking out such
+                # a change, and errors here too.  Work around it by ignoring
+                # the bad symlink; hopefully a future change fixes it.
+                print "\nIgnoring empty symlink in %s" % file['depotFile']
+                return
+            elif data[-1] == '\n':
                 contents = [data[:-1]]
             else:
                 contents = [data]
diff --git a/t/t9802-git-p4-filetype.sh b/t/t9802-git-p4-filetype.sh
index 94d7be9..66d3fc9 100755
--- a/t/t9802-git-p4-filetype.sh
+++ b/t/t9802-git-p4-filetype.sh
@@ -267,6 +267,72 @@ test_expect_success SYMLINKS 'ensure p4 symlink parsed correctly' '
 	)
 '
 
+test_expect_success SYMLINKS 'empty symlink target' '
+	(
+		# first create the file as a file
+		cd "$cli" &&
+		>empty-symlink &&
+		p4 add empty-symlink &&
+		p4 submit -d "add empty-symlink as a file"
+	) &&
+	(
+		# now change it to be a symlink to "target1"
+		cd "$cli" &&
+		p4 edit empty-symlink &&
+		p4 reopen -t symlink empty-symlink &&
+		rm empty-symlink &&
+		ln -s target1 empty-symlink &&
+		p4 add empty-symlink &&
+		p4 submit -d "make empty-symlink point to target1"
+	) &&
+	(
+		# Hack the p4 depot to make the symlink point to nothing;
+		# this should not happen in reality, but shows up
+		# in p4 repos in the wild.
+		#
+		# The sed expression changes this:
+		#     @@
+		#     text
+		#     @target1
+		#     @
+		# to this:
+		#     @@
+		#     text
+		#     @@
+		#
+		cd "$db/depot" &&
+		sed "/@target1/{; s/target1/@/; n; d; }" \
+		    empty-symlink,v >empty-symlink,v.tmp &&
+		mv empty-symlink,v.tmp empty-symlink,v
+	) &&
+	(
+		# Make sure symlink really is empty.  Asking
+		# p4 to sync here will make it generate errors.
+		cd "$cli" &&
+		p4 print -q //depot/empty-symlink#2 >out &&
+		test ! -s out
+	) &&
+	test_when_finished cleanup_git &&
+
+	# make sure git p4 handles it without error
+	git p4 clone --dest="$git" //depot@all &&
+
+	# fix the symlink, make it point to "target2"
+	(
+		cd "$cli" &&
+		p4 open empty-symlink &&
+		rm empty-symlink &&
+		ln -s target2 empty-symlink &&
+		p4 submit -d "make empty-symlink point to target2"
+	) &&
+	cleanup_git &&
+	git p4 clone --dest="$git" //depot@all &&
+	(
+		cd "$git" &&
+		test $(readlink empty-symlink) = target2
+	)
+'
+
 test_expect_success 'kill p4d' '
 	kill_p4d
 '
-- 
1.8.5.2.320.g99957e5
Previous: Pete WyckoffNext: Eric Sunshine
Message 4 of 27 in “git p4 tests and a few bug fixes”
  1. 00/11 git p4 tests and a few bug fixesPete Wyckoff, Jan 21, 2014
  2. 01/11 git p4 test: wildcards are supportedPete Wyckoff, Jan 21, 2014
  3. 02/11 git p4 test: ensure p4 symlink parsing worksPete Wyckoff, Jan 21, 2014
  4. 03/11 git p4: work around p4 bug that causes empty symlinksPete Wyckoff, Jan 21, 2014
  5. Eric SunshineJan 22, 2014
  6. 04/11 git p4 test: explicitly check p4 wildcard deletePete Wyckoff, Jan 21, 2014
  7. 05/11 git p4 test: is_cli_file_writeable succeedsPete Wyckoff, Jan 21, 2014
  8. 06/11 git p4 test: run as user "author"Pete Wyckoff, Jan 21, 2014
  9. Eric SunshineJan 22, 2014
  10. 07/11 git p4 test: do not pollute /tmpPete Wyckoff, Jan 21, 2014
  11. 08/11 git p4: handle files with wildcards when doing RCS scrubbingPete Wyckoff, Jan 21, 2014
  12. 09/11 git p4: fix an error message when "p4 where" failsPete Wyckoff, Jan 21, 2014
  13. 10/11 git p4 test: examine behavior with locked (+l) filesPete Wyckoff, Jan 21, 2014
  14. 11/11 git p4 doc: use two-line style for options with multiple spellingsPete Wyckoff, Jan 21, 2014
  15. Junio C HamanoJan 22, 2014
  16. Pete WyckoffJan 22, 2014
  17. 01/11 git p4 test: wildcards are supportedPete Wyckoff, Jan 22, 2014
  18. 02/11 git p4 test: ensure p4 symlink parsing worksPete Wyckoff, Jan 22, 2014
  19. 03/11 git p4: work around p4 bug that causes empty symlinksPete Wyckoff, Jan 22, 2014
  20. 04/11 git p4 test: explicitly check p4 wildcard deletePete Wyckoff, Jan 22, 2014
  21. 05/11 git p4 test: is_cli_file_writeable succeedsPete Wyckoff, Jan 22, 2014
  22. 06/11 git p4 test: run as user "author"Pete Wyckoff, Jan 22, 2014
  23. 07/11 git p4 test: do not pollute /tmpPete Wyckoff, Jan 22, 2014
  24. 08/11 git p4: handle files with wildcards when doing RCS scrubbingPete Wyckoff, Jan 22, 2014
  25. 09/11 git p4: fix an error message when "p4 where" failsPete Wyckoff, Jan 22, 2014
  26. 10/11 git p4 test: examine behavior with locked (+l) filesPete Wyckoff, Jan 22, 2014
  27. 11/11 git p4 doc: use two-line style for options with multiple spellingsPete Wyckoff, Jan 22, 2014

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.