introduce 'got ref -s' and add two tests for 'got ref'
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 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
diff --git a/TODO b/TODO
index a7c6931..0a9ce6f 100644
--- a/TODO
+++ b/TODO
@@ -15,7 +15,6 @@ got:
- 'histedit -c' prompts for log message even if there are no changes to commit
- recursive addition: got add -R
- recursive removal: got rm -R
-- allow for creating symbolic references with 'got ref -s'
tog:
- cosmetic display issues involving \n and TABs should be fixed
diff --git a/got/got.1 b/got/got.1
index 00c7548..a826de9 100644
--- a/got/got.1
+++ b/got/got.1
@@ -459,6 +459,12 @@ work tree, use the repository path associated with this work tree.
List all existing references in the repository.
.It Fl d Ar name
Delete the reference with the specified name from the repository.
+.It Fl s
+Create a symbolic reference pointing at the specified
+.Ar target ,
+which must be an existing reference.
+Care should be taken not to create loops between references when
+this option is used.
.El
.It Cm branch Oo Fl r Ar repository-path Oc Oo Fl l Oc Oo Fl d Ar name Oc Op Ar name Op Ar base-branch
Manage branches in a repository.
diff --git a/got/got.c b/got/got.c
index 9a69229..a322f32 100644
--- a/got/got.c
+++ b/got/got.c
@@ -2561,7 +2561,7 @@ __dead static void
usage_ref(void)
{
fprintf(stderr,
- "usage: %s ref [-r repository] -l | -d name | name target\n",
+ "usage: %s ref [-r repository] -l | -d name | [-s] name target\n",
getprogname());
exit(1);
}
@@ -2650,17 +2650,49 @@ done:
}
static const struct got_error *
+add_symref(struct got_repository *repo, const char *refname, const char *target)
+{
+ const struct got_error *err = NULL;
+ struct got_reference *ref = NULL;
+ struct got_reference *target_ref = NULL;
+
+ /*
+ * Don't let the user create a reference named '-'.
+ * While technically a valid reference name, this case is usually
+ * an unintended typo.
+ */
+ if (refname[0] == '-' && refname[1] == '\0')
+ return got_error(GOT_ERR_BAD_REF_NAME);
+
+ err = got_ref_open(&target_ref, repo, target, 0);
+ if (err)
+ return err;
+
+ err = got_ref_alloc_symref(&ref, refname, target_ref);
+ if (err)
+ goto done;
+
+ err = got_ref_write(ref, repo);
+done:
+ if (target_ref)
+ got_ref_close(target_ref);
+ if (ref)
+ got_ref_close(ref);
+ return err;
+}
+
+static const struct got_error *
cmd_ref(int argc, char *argv[])
{
const struct got_error *error = NULL;
struct got_repository *repo = NULL;
struct got_worktree *worktree = NULL;
char *cwd = NULL, *repo_path = NULL;
- int ch, do_list = 0;
+ int ch, do_list = 0, create_symref = 0;
const char *delref = NULL;
/* TODO: Add -s option for adding symbolic references. */
- while ((ch = getopt(argc, argv, "d:r:l")) != -1) {
+ while ((ch = getopt(argc, argv, "d:r:ls")) != -1) {
switch (ch) {
case 'd':
delref = optarg;
@@ -2674,6 +2706,9 @@ cmd_ref(int argc, char *argv[])
case 'l':
do_list = 1;
break;
+ case 's':
+ create_symref = 1;
+ break;
default:
usage_ref();
/* NOTREACHED */
@@ -2687,6 +2722,9 @@ cmd_ref(int argc, char *argv[])
argv += optind;
if (do_list || delref) {
+ if (create_symref)
+ errx(1, "-s option cannot be used together with the "
+ "-l or -d options");
if (argc > 0)
usage_ref();
} else if (argc != 2)
@@ -2744,6 +2782,8 @@ cmd_ref(int argc, char *argv[])
error = list_refs(repo);
else if (delref)
error = delete_ref(repo, delref);
+ else if (create_symref)
+ error = add_symref(repo, argv[0], argv[1]);
else
error = add_ref(repo, argv[0], argv[1]);
done:
diff --git a/regress/cmdline/Makefile b/regress/cmdline/Makefile
index e86ea7f..c7f5765 100644
--- a/regress/cmdline/Makefile
+++ b/regress/cmdline/Makefile
@@ -1,4 +1,4 @@
-REGRESS_TARGETS=checkout update status log add rm diff blame branch commit \
+REGRESS_TARGETS=checkout update status log add rm diff blame branch ref commit \
revert cherrypick backout rebase import histedit stage unstage
NOOBJ=Yes
@@ -29,6 +29,9 @@ blame:
branch:
./branch.sh
+ref:
+ ./ref.sh
+
commit:
./commit.sh
diff --git a/regress/cmdline/ref.sh b/regress/cmdline/ref.sh
new file mode 100755
index 0000000..3774051
--- /dev/null
+++ b/regress/cmdline/ref.sh
@@ -0,0 +1,153 @@
+#!/bin/sh
+#
+# Copyright (c) 2019 Stefan Sperling <stsp@openbsd.org>
+#
+# Permission to use, copy, modify, and distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+. ./common.sh
+
+function test_ref_create {
+ local testroot=`test_init ref_create`
+ local commit_id=`git_show_head $testroot/repo`
+
+ # Create a head ref based on repository's HEAD reference
+ got ref -r $testroot/repo refs/heads/newref HEAD
+ ret="$?"
+ if [ "$ret" != "0" ]; then
+ echo "got ref command failed unexpectedly"
+ test_done "$testroot" "$ret"
+ return 1
+ fi
+
+ # Ensure that Git recognizes the ref Got has created
+ (cd $testroot/repo && git checkout -q newref)
+ ret="$?"
+ if [ "$ret" != "0" ]; then
+ echo "git checkout command failed unexpectedly"
+ test_done "$testroot" "$ret"
+ return 1
+ fi
+
+ # Ensure Git recognizes the new ref
+ got checkout -b newref $testroot/repo $testroot/wt >/dev/null
+ ret="$?"
+ if [ "$ret" != "0" ]; then
+ echo "got checkout command failed unexpectedly"
+ test_done "$testroot" "$ret"
+ return 1
+ fi
+
+ # Create a head ref based on another specific ref
+ (cd $testroot/wt && got ref refs/heads/anotherref refs/heads/master)
+ ret="$?"
+ if [ "$ret" != "0" ]; then
+ test_done "$testroot" "$ret"
+ return 1
+ fi
+
+ (cd $testroot/repo && git checkout -q anotherref)
+ ret="$?"
+ if [ "$ret" != "0" ]; then
+ echo "git checkout command failed unexpectedly"
+ test_done "$testroot" "$ret"
+ fi
+
+ # Create a symbolic ref
+ (cd $testroot/wt && got ref -s refs/heads/symbolicref refs/heads/master)
+ ret="$?"
+ if [ "$ret" != "0" ]; then
+ test_done "$testroot" "$ret"
+ return 1
+ fi
+
+ (cd $testroot/repo && git checkout -q symbolicref)
+ ret="$?"
+ if [ "$ret" != "0" ]; then
+ echo "git checkout command failed unexpectedly"
+ test_done "$testroot" "$ret"
+ fi
+
+ got ref -r $testroot/repo -l > $testroot/stdout
+ echo "HEAD: refs/heads/symbolicref" > $testroot/stdout.expected
+ echo -n "refs/got/worktree/base-" >> $testroot/stdout.expected
+ cat $testroot/wt/.got/uuid | tr -d '\n' >> $testroot/stdout.expected
+ echo ": $commit_id" >> $testroot/stdout.expected
+ echo "refs/heads/anotherref: $commit_id" >> $testroot/stdout.expected
+ echo "refs/heads/master: $commit_id" >> $testroot/stdout.expected
+ echo "refs/heads/newref: $commit_id" >> $testroot/stdout.expected
+ echo "refs/heads/symbolicref: refs/heads/master" \
+ >> $testroot/stdout.expected
+ cmp -s $testroot/stdout $testroot/stdout.expected
+ ret="$?"
+ if [ "$ret" != "0" ]; then
+ diff -u $testroot/stdout.expected $testroot/stdout
+ fi
+ test_done "$testroot" "$ret"
+}
+
+function test_ref_delete {
+ local testroot=`test_init ref_delete`
+ local commit_id=`git_show_head $testroot/repo`
+
+ for b in ref1 ref2 ref3; do
+ got ref -r $testroot/repo refs/heads/$b refs/heads/master
+ ret="$?"
+ if [ "$ret" != "0" ]; then
+ echo "got ref command failed unexpectedly"
+ test_done "$testroot" "$ret"
+ return 1
+ fi
+ done
+
+ got ref -d refs/heads/ref2 -r $testroot/repo > $testroot/stdout
+ ret="$?"
+ if [ "$ret" != "0" ]; then
+ echo "got ref command failed unexpectedly"
+ test_done "$testroot" "$ret"
+ return 1
+ fi
+
+ got ref -l -r $testroot/repo > $testroot/stdout
+ echo "HEAD: refs/heads/master" > $testroot/stdout.expected
+ echo "refs/heads/master: $commit_id" >> $testroot/stdout.expected
+ echo "refs/heads/ref1: $commit_id" >> $testroot/stdout.expected
+ echo "refs/heads/ref3: $commit_id" >> $testroot/stdout.expected
+ cmp -s $testroot/stdout $testroot/stdout.expected
+ ret="$?"
+ if [ "$ret" != "0" ]; then
+ diff -u $testroot/stdout.expected $testroot/stdout
+ test_done "$testroot" "$ret"
+ return 1
+ fi
+
+ got ref -d refs/heads/bogus_ref_name -r $testroot/repo \
+ > $testroot/stdout 2> $testroot/stderr
+ ret="$?"
+ if [ "$ret" == "0" ]; then
+ echo "got ref succeeded unexpectedly"
+ test_done "$testroot" "$ret"
+ return 1
+ fi
+
+ echo "got: reference refs/heads/bogus_ref_name not found" \
+ > $testroot/stderr.expected
+ cmp -s $testroot/stderr $testroot/stderr.expected
+ ret="$?"
+ if [ "$ret" != "0" ]; then
+ diff -u $testroot/stderr.expected $testroot/stderr
+ fi
+ test_done "$testroot" "$ret"
+}
+
+run_test test_ref_create
+run_test test_ref_delete