Skip to content

Fix creating references containing '@' #854

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Fix creating references containing '@' #854

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Fix creating references containing '@' 
References containing the '@' char are legal in git but fail with
[1]. This fails because as soon as '@' is encountered we stop
searching for a ref name, assume it is there and fail while retrieving
it. This can be fixed by catching this exception and continue with the
search for a valid ref.

[1] Trace:
Traceback (most recent call last):
  File "/opt/zuul/lib/python3.7/site-packages/zuul/merger/merger.py", line 108, in __init__
   self._ensure_cloned()
  File "/opt/zuul/lib/python3.7/site-packages/zuul/merger/merger.py", line 178, in _ensure_cloned
    repo.create_head(ref.remote_head, ref, force=True)
  File "/opt/zuul/lib/python3.7/site-packages/git/repo/base.py", line 373, in create_head
    return Head.create(self, path, commit, force, logmsg)
  File "/opt/zuul/lib/python3.7/site-packages/git/refs/symbolic.py", line 546, in create
    return cls._create(repo, path, cls._resolve_ref_on_create, reference, force, logmsg)
  File "/opt/zuul/lib/python3.7/site-packages/git/refs/symbolic.py", line 497, in _create
    target = repo.rev_parse(str(reference))
  File "/opt/zuul/lib/python3.7/site-packages/git/repo/fun.py", line 211, in rev_parse
    ref = name_to_object(repo, rev[:start], return_ref=True)
  File "/opt/zuul/lib/python3.7/site-packages/git/repo/fun.py", line 142, in name_to_object
    raise BadObject("Couldn't find reference named %r" % name)
gitdb.exc.BadObject: <unprintable BadObject object>
  • Loading branch information
@tobiashenkel
tobiashenkel committed Mar 15, 2019
commit c57ef1f408dd787386121a4fa569f230424c0b1e
9 changes: 8 additions & 1 deletion git/repo/fun.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,14 @@ def rev_parse(repo, rev):
ref = repo.head.ref
else:
if token == '@':
ref = name_to_object(repo, rev[:start], return_ref=True)
try:
Copy link
Member

@Byron Byron Jul 20, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A better solution might be to stop treating @ as special outside of the spots that it is allowed in.
I am a hesitant to let it make assumptions unless there absolutely is no other way. Or in other words, I believe the git or C implementation is deterministic here

Copy link
Author

@tobiashenkel tobiashenkel Aug 8, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your feedback, I'll try it when I have time in the next weeks.

ref = name_to_object(repo, rev[:start], return_ref=True)
except BadObject:
# If this doesn't result in an object we most likely
# encounter a reference containing the '@' character.
# In this case we just to continue the search.
start += 1
continue
else:
obj = name_to_object(repo, rev[:start])
# END handle token
Expand Down
4 changes: 4 additions & 0 deletions git/test/test_repo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -701,6 +701,10 @@ def test_rw_rev_parse(self, rwrepo):
ahead = rwrepo.create_head('aaaaaaaa')
assert(rwrepo.rev_parse(str(ahead)) == ahead.commit)

# verify @ in branch names are possible
bhead = rwrepo.create_head('aaa@aaa')
assert (rwrepo.rev_parse(str(bhead)) == bhead.commit)

def test_rev_parse(self):
rev_parse = self.rorepo.rev_parse

Expand Down