Merge branch 'jc/branch-name-sanity'

"git branch" and "git checkout -b" are now forbidden from creating
a branch whose name is "HEAD".

* jc/branch-name-sanity:
  builtin/branch: remove redundant check for HEAD
  branch: correctly reject refs/heads/{-dash,HEAD}
  branch: split validate_new_branchname() into two
  branch: streamline "attr_only" handling in validate_new_branchname()
This commit is contained in:
Junio C Hamano 2017-11-28 13:41:49 +09:00
commit 16169285f1
6 changed files with 106 additions and 43 deletions

View File

@ -178,24 +178,40 @@ int read_branch_desc(struct strbuf *buf, const char *branch_name)
return 0; return 0;
} }
int validate_new_branchname(const char *name, struct strbuf *ref, /*
int force, int attr_only) * Check if 'name' can be a valid name for a branch; die otherwise.
* Return 1 if the named branch already exists; return 0 otherwise.
* Fill ref with the full refname for the branch.
*/
int validate_branchname(const char *name, struct strbuf *ref)
{ {
if (strbuf_check_branch_ref(ref, name)) if (strbuf_check_branch_ref(ref, name))
die(_("'%s' is not a valid branch name."), name); die(_("'%s' is not a valid branch name."), name);
if (!ref_exists(ref->buf)) return ref_exists(ref->buf);
}
/*
* Check if a branch 'name' can be created as a new branch; die otherwise.
* 'force' can be used when it is OK for the named branch already exists.
* Return 1 if the named branch already exists; return 0 otherwise.
* Fill ref with the full refname for the branch.
*/
int validate_new_branchname(const char *name, struct strbuf *ref, int force)
{
const char *head;
if (!validate_branchname(name, ref))
return 0; return 0;
else if (!force && !attr_only)
die(_("A branch named '%s' already exists."), ref->buf + strlen("refs/heads/"));
if (!attr_only) { if (!force)
const char *head; die(_("A branch named '%s' already exists."),
ref->buf + strlen("refs/heads/"));
head = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
if (!is_bare_repository() && head && !strcmp(head, ref->buf))
die(_("Cannot force update the current branch."));
head = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
if (!is_bare_repository() && head && !strcmp(head, ref->buf))
die(_("Cannot force update the current branch."));
}
return 1; return 1;
} }
@ -242,9 +258,9 @@ void create_branch(const char *name, const char *start_name,
if (track == BRANCH_TRACK_EXPLICIT || track == BRANCH_TRACK_OVERRIDE) if (track == BRANCH_TRACK_EXPLICIT || track == BRANCH_TRACK_OVERRIDE)
explicit_tracking = 1; explicit_tracking = 1;
if (validate_new_branchname(name, &ref, force, if ((track == BRANCH_TRACK_OVERRIDE || clobber_head)
track == BRANCH_TRACK_OVERRIDE || ? validate_branchname(name, &ref)
clobber_head)) { : validate_new_branchname(name, &ref, force)) {
if (!force) if (!force)
dont_change_ref = 1; dont_change_ref = 1;
else else

View File

@ -23,22 +23,19 @@ void create_branch(const char *name, const char *start_name,
int clobber_head, int quiet, enum branch_track track); int clobber_head, int quiet, enum branch_track track);
/* /*
* Validates that the requested branch may be created, returning the * Check if 'name' can be a valid name for a branch; die otherwise.
* interpreted ref in ref, force indicates whether (non-head) branches * Return 1 if the named branch already exists; return 0 otherwise.
* may be overwritten. A non-zero return value indicates that the force * Fill ref with the full refname for the branch.
* parameter was non-zero and the branch already exists.
*
* Contrary to all of the above, when attr_only is 1, the caller is
* not interested in verifying if it is Ok to update the named
* branch to point at a potentially different commit. It is merely
* asking if it is OK to change some attribute for the named branch
* (e.g. tracking upstream).
*
* NEEDSWORK: This needs to be split into two separate functions in the
* longer run for sanity.
*
*/ */
int validate_new_branchname(const char *name, struct strbuf *ref, int force, int attr_only); extern int validate_branchname(const char *name, struct strbuf *ref);
/*
* Check if a branch 'name' can be created as a new branch; die otherwise.
* 'force' can be used when it is OK for the named branch already exists.
* Return 1 if the named branch already exists; return 0 otherwise.
* Fill ref with the full refname for the branch.
*/
extern int validate_new_branchname(const char *name, struct strbuf *ref, int force);
/* /*
* Remove information about the state of working on the current * Remove information about the state of working on the current

View File

@ -463,7 +463,6 @@ static void copy_or_rename_branch(const char *oldname, const char *newname, int
struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT; struct strbuf oldref = STRBUF_INIT, newref = STRBUF_INIT, logmsg = STRBUF_INIT;
struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT; struct strbuf oldsection = STRBUF_INIT, newsection = STRBUF_INIT;
int recovery = 0; int recovery = 0;
int clobber_head_ok;
if (!oldname) { if (!oldname) {
if (copy) if (copy)
@ -487,9 +486,10 @@ static void copy_or_rename_branch(const char *oldname, const char *newname, int
* A command like "git branch -M currentbranch currentbranch" cannot * A command like "git branch -M currentbranch currentbranch" cannot
* cause the worktree to become inconsistent with HEAD, so allow it. * cause the worktree to become inconsistent with HEAD, so allow it.
*/ */
clobber_head_ok = !strcmp(oldname, newname); if (!strcmp(oldname, newname))
validate_branchname(newname, &newref);
validate_new_branchname(newname, &newref, force, clobber_head_ok); else
validate_new_branchname(newname, &newref, force);
reject_rebase_or_bisect_branch(oldref.buf); reject_rebase_or_bisect_branch(oldref.buf);
@ -793,9 +793,6 @@ int cmd_branch(int argc, const char **argv, const char *prefix)
} else if (argc > 0 && argc <= 2) { } else if (argc > 0 && argc <= 2) {
struct branch *branch = branch_get(argv[0]); struct branch *branch = branch_get(argv[0]);
if (!strcmp(argv[0], "HEAD"))
die(_("it does not make sense to create 'HEAD' manually"));
if (!branch) if (!branch)
die(_("no such branch '%s'"), argv[0]); die(_("no such branch '%s'"), argv[0]);

View File

@ -1287,11 +1287,11 @@ int cmd_checkout(int argc, const char **argv, const char *prefix)
if (opts.new_branch) { if (opts.new_branch) {
struct strbuf buf = STRBUF_INIT; struct strbuf buf = STRBUF_INIT;
opts.branch_exists = if (opts.new_branch_force)
validate_new_branchname(opts.new_branch, &buf, opts.branch_exists = validate_branchname(opts.new_branch, &buf);
!!opts.new_branch_force, else
!!opts.new_branch_force); opts.branch_exists =
validate_new_branchname(opts.new_branch, &buf, 0);
strbuf_release(&buf); strbuf_release(&buf);
} }

View File

@ -1438,9 +1438,19 @@ int strbuf_check_branch_ref(struct strbuf *sb, const char *name)
strbuf_branchname(sb, name, INTERPRET_BRANCH_LOCAL); strbuf_branchname(sb, name, INTERPRET_BRANCH_LOCAL);
else else
strbuf_addstr(sb, name); strbuf_addstr(sb, name);
if (name[0] == '-')
return -1; /*
* This splice must be done even if we end up rejecting the
* name; builtin/branch.c::copy_or_rename_branch() still wants
* to see what the name expanded to so that "branch -m" can be
* used as a tool to correct earlier mistakes.
*/
strbuf_splice(sb, 0, 0, "refs/heads/", 11); strbuf_splice(sb, 0, 0, "refs/heads/", 11);
if (*name == '-' ||
!strcmp(sb->buf, "refs/heads/HEAD"))
return -1;
return check_refname_format(sb->buf, 0); return check_refname_format(sb->buf, 0);
} }

View File

@ -331,4 +331,47 @@ test_expect_success 'update-ref --stdin -z fails delete with bad ref name' '
grep "fatal: invalid ref format: ~a" err grep "fatal: invalid ref format: ~a" err
' '
test_expect_success 'branch rejects HEAD as a branch name' '
test_must_fail git branch HEAD HEAD^ &&
test_must_fail git show-ref refs/heads/HEAD
'
test_expect_success 'checkout -b rejects HEAD as a branch name' '
test_must_fail git checkout -B HEAD HEAD^ &&
test_must_fail git show-ref refs/heads/HEAD
'
test_expect_success 'update-ref can operate on refs/heads/HEAD' '
git update-ref refs/heads/HEAD HEAD^ &&
git show-ref refs/heads/HEAD &&
git update-ref -d refs/heads/HEAD &&
test_must_fail git show-ref refs/heads/HEAD
'
test_expect_success 'branch -d can remove refs/heads/HEAD' '
git update-ref refs/heads/HEAD HEAD^ &&
git branch -d HEAD &&
test_must_fail git show-ref refs/heads/HEAD
'
test_expect_success 'branch -m can rename refs/heads/HEAD' '
git update-ref refs/heads/HEAD HEAD^ &&
git branch -m HEAD tail &&
test_must_fail git show-ref refs/heads/HEAD &&
git show-ref refs/heads/tail
'
test_expect_success 'branch -d can remove refs/heads/-dash' '
git update-ref refs/heads/-dash HEAD^ &&
git branch -d -- -dash &&
test_must_fail git show-ref refs/heads/-dash
'
test_expect_success 'branch -m can rename refs/heads/-dash' '
git update-ref refs/heads/-dash HEAD^ &&
git branch -m -- -dash dash &&
test_must_fail git show-ref refs/heads/-dash &&
git show-ref refs/heads/dash
'
test_done test_done