t/helper/test-ref-store.c

   1 #include "test-tool.h"
   2 #include "hex.h"
   3 #include "refs.h"
   4 #include "setup.h"
   5 #include "worktree.h"
   6 #include "object-store-ll.h"
   7 #include "path.h"
   8 #include "repository.h"
   9 #include "strbuf.h"
  10 #include "revision.h"
  11
  12 struct flag_definition {
  13         const char *name;
  14         uint64_t mask;
  15 };
  16
  17 #define FLAG_DEF(x)     \
  18         {               \
  19 #x, (x) \
  20         }
  21
  22 static unsigned int parse_flags(const char *str, struct flag_definition *defs)
  23 {
  24         struct string_list masks = STRING_LIST_INIT_DUP;
  25         int i = 0;
  26         unsigned int result = 0;
  27
  28         if (!strcmp(str, "0"))
  29                 return 0;
  30
  31         string_list_split(&masks, str, ',', 64);
  32         for (; i < masks.nr; i++) {
  33                 const char *name = masks.items[i].string;
  34                 struct flag_definition *def = defs;
  35                 int found = 0;
  36                 while (def->name) {
  37                         if (!strcmp(def->name, name)) {
  38                                 result |= def->mask;
  39                                 found = 1;
  40                                 break;
  41                         }
  42                         def++;
  43                 }
  44                 if (!found)
  45                         die("unknown flag \"%s\"", name);
  46         }
  47
  48         string_list_clear(&masks, 0);
  49         return result;
  50 }
  51
  52 static struct flag_definition empty_flags[] = { { NULL, 0 } };
  53
  54 static const char *notnull(const char *arg, const char *name)
  55 {
  56         if (!arg)
  57                 die("%s required", name);
  58         return arg;
  59 }
  60
  61 static unsigned int arg_flags(const char *arg, const char *name,
  62                               struct flag_definition *defs)
  63 {
  64         return parse_flags(notnull(arg, name), defs);
  65 }
  66
  67 static const char **get_store(const char **argv, struct ref_store **refs)
  68 {
  69         const char *gitdir;
  70
  71         if (!argv[0]) {
  72                 die("ref store required");
  73         } else if (!strcmp(argv[0], "main")) {
  74                 *refs = get_main_ref_store(the_repository);
  75         } else if (skip_prefix(argv[0], "submodule:", &gitdir)) {
  76                 struct strbuf sb = STRBUF_INIT;
  77                 int ret;
  78
  79                 ret = strbuf_git_path_submodule(&sb, gitdir, "objects/");
  80                 if (ret)
  81                         die("strbuf_git_path_submodule failed: %d", ret);
  82                 add_to_alternates_memory(sb.buf);
  83                 strbuf_release(&sb);
  84
  85                 *refs = get_submodule_ref_store(gitdir);
  86         } else if (skip_prefix(argv[0], "worktree:", &gitdir)) {
  87                 struct worktree **p, **worktrees = get_worktrees();
  88
  89                 for (p = worktrees; *p; p++) {
  90                         struct worktree *wt = *p;
  91
  92                         if (!wt->id) {
  93                                 /* special case for main worktree */
  94                                 if (!strcmp(gitdir, "main"))
  95                                         break;
  96                         } else if (!strcmp(gitdir, wt->id))
  97                                 break;
  98                 }
  99                 if (!*p)
 100                         die("no such worktree: %s", gitdir);
 101
 102                 *refs = get_worktree_ref_store(*p);
 103                 free_worktrees(worktrees);
 104         } else
 105                 die("unknown backend %s", argv[0]);
 106
 107         if (!*refs)
 108                 die("no ref store");
 109
 110         /* consume store-specific optional arguments if needed */
 111
 112         return argv + 1;
 113 }
 114
 115 static struct flag_definition pack_flags[] = { FLAG_DEF(PACK_REFS_PRUNE),
 116                                                FLAG_DEF(PACK_REFS_ALL),
 117                                                { NULL, 0 } };
 118
 119 static int cmd_pack_refs(struct ref_store *refs, const char **argv)
 120 {
 121         unsigned int flags = arg_flags(*argv++, "flags", pack_flags);
 122         static struct ref_exclusions exclusions = REF_EXCLUSIONS_INIT;
 123         static struct string_list included_refs = STRING_LIST_INIT_NODUP;
 124         struct pack_refs_opts pack_opts = { .flags = flags,
 125                                             .exclusions = &exclusions,
 126                                             .includes = &included_refs };
 127
 128         if (pack_opts.flags & PACK_REFS_ALL)
 129                 string_list_append(pack_opts.includes, "*");
 130
 131         return refs_pack_refs(refs, &pack_opts);
 132 }
 133
 134 static int cmd_create_symref(struct ref_store *refs, const char **argv)
 135 {
 136         const char *refname = notnull(*argv++, "refname");
 137         const char *target = notnull(*argv++, "target");
 138         const char *logmsg = *argv++;
 139
 140         return refs_create_symref(refs, refname, target, logmsg);
 141 }
 142
 143 static struct flag_definition transaction_flags[] = {
 144         FLAG_DEF(REF_NO_DEREF),
 145         FLAG_DEF(REF_FORCE_CREATE_REFLOG),
 146         FLAG_DEF(REF_SKIP_OID_VERIFICATION),
 147         FLAG_DEF(REF_SKIP_REFNAME_VERIFICATION),
 148         { NULL, 0 }
 149 };
 150
 151 static int cmd_delete_refs(struct ref_store *refs, const char **argv)
 152 {
 153         unsigned int flags = arg_flags(*argv++, "flags", transaction_flags);
 154         const char *msg = *argv++;
 155         struct string_list refnames = STRING_LIST_INIT_NODUP;
 156         int result;
 157
 158         while (*argv)
 159                 string_list_append(&refnames, *argv++);
 160
 161         result = refs_delete_refs(refs, msg, &refnames, flags);
 162         string_list_clear(&refnames, 0);
 163         return result;
 164 }
 165
 166 static int cmd_rename_ref(struct ref_store *refs, const char **argv)
 167 {
 168         const char *oldref = notnull(*argv++, "oldref");
 169         const char *newref = notnull(*argv++, "newref");
 170         const char *logmsg = *argv++;
 171
 172         return refs_rename_ref(refs, oldref, newref, logmsg);
 173 }
 174
 175 static int each_ref(const char *refname, const struct object_id *oid,
 176                     int flags, void *cb_data UNUSED)
 177 {
 178         printf("%s %s 0x%x\n", oid_to_hex(oid), refname, flags);
 179         return 0;
 180 }
 181
 182 static int cmd_for_each_ref(struct ref_store *refs, const char **argv)
 183 {
 184         const char *prefix = notnull(*argv++, "prefix");
 185
 186         return refs_for_each_ref_in(refs, prefix, each_ref, NULL);
 187 }
 188
 189 static int cmd_for_each_ref__exclude(struct ref_store *refs, const char **argv)
 190 {
 191         const char *prefix = notnull(*argv++, "prefix");
 192         const char **exclude_patterns = argv;
 193
 194         return refs_for_each_fullref_in(refs, prefix, exclude_patterns, each_ref,
 195                                         NULL);
 196 }
 197
 198 static int cmd_resolve_ref(struct ref_store *refs, const char **argv)
 199 {
 200         struct object_id oid = *null_oid();
 201         const char *refname = notnull(*argv++, "refname");
 202         int resolve_flags = arg_flags(*argv++, "resolve-flags", empty_flags);
 203         int flags;
 204         const char *ref;
 205
 206         ref = refs_resolve_ref_unsafe(refs, refname, resolve_flags,
 207                                       &oid, &flags);
 208         printf("%s %s 0x%x\n", oid_to_hex(&oid), ref ? ref : "(null)", flags);
 209         return ref ? 0 : 1;
 210 }
 211
 212 static int cmd_verify_ref(struct ref_store *refs, const char **argv)
 213 {
 214         const char *refname = notnull(*argv++, "refname");
 215         struct strbuf err = STRBUF_INIT;
 216         int ret;
 217
 218         ret = refs_verify_refname_available(refs, refname, NULL, NULL, &err);
 219         if (err.len)
 220                 puts(err.buf);
 221         return ret;
 222 }
 223
 224 static int each_reflog(const char *refname, void *cb_data UNUSED)
 225 {
 226         printf("%s\n", refname);
 227         return 0;
 228 }
 229
 230 static int cmd_for_each_reflog(struct ref_store *refs,
 231                                const char **argv UNUSED)
 232 {
 233         return refs_for_each_reflog(refs, each_reflog, NULL);
 234 }
 235
 236 static int each_reflog_ent(struct object_id *old_oid, struct object_id *new_oid,
 237                            const char *committer, timestamp_t timestamp,
 238                            int tz, const char *msg, void *cb_data UNUSED)
 239 {
 240         printf("%s %s %s %" PRItime " %+05d%s%s", oid_to_hex(old_oid),
 241                oid_to_hex(new_oid), committer, timestamp, tz,
 242                *msg == '\n' ? "" : "\t", msg);
 243         return 0;
 244 }
 245
 246 static int cmd_for_each_reflog_ent(struct ref_store *refs, const char **argv)
 247 {
 248         const char *refname = notnull(*argv++, "refname");
 249
 250         return refs_for_each_reflog_ent(refs, refname, each_reflog_ent, refs);
 251 }
 252
 253 static int cmd_for_each_reflog_ent_reverse(struct ref_store *refs, const char **argv)
 254 {
 255         const char *refname = notnull(*argv++, "refname");
 256
 257         return refs_for_each_reflog_ent_reverse(refs, refname, each_reflog_ent, refs);
 258 }
 259
 260 static int cmd_reflog_exists(struct ref_store *refs, const char **argv)
 261 {
 262         const char *refname = notnull(*argv++, "refname");
 263
 264         return !refs_reflog_exists(refs, refname);
 265 }
 266
 267 static int cmd_create_reflog(struct ref_store *refs, const char **argv)
 268 {
 269         const char *refname = notnull(*argv++, "refname");
 270         struct strbuf err = STRBUF_INIT;
 271         int ret;
 272
 273         ret = refs_create_reflog(refs, refname, &err);
 274         if (err.len)
 275                 puts(err.buf);
 276         return ret;
 277 }
 278
 279 static int cmd_delete_reflog(struct ref_store *refs, const char **argv)
 280 {
 281         const char *refname = notnull(*argv++, "refname");
 282
 283         return refs_delete_reflog(refs, refname);
 284 }
 285
 286 static int cmd_delete_ref(struct ref_store *refs, const char **argv)
 287 {
 288         const char *msg = notnull(*argv++, "msg");
 289         const char *refname = notnull(*argv++, "refname");
 290         const char *sha1_buf = notnull(*argv++, "old-sha1");
 291         unsigned int flags = arg_flags(*argv++, "flags", transaction_flags);
 292         struct object_id old_oid;
 293
 294         if (get_oid_hex(sha1_buf, &old_oid))
 295                 die("cannot parse %s as %s", sha1_buf, the_hash_algo->name);
 296
 297         return refs_delete_ref(refs, msg, refname, &old_oid, flags);
 298 }
 299
 300 static int cmd_update_ref(struct ref_store *refs, const char **argv)
 301 {
 302         const char *msg = notnull(*argv++, "msg");
 303         const char *refname = notnull(*argv++, "refname");
 304         const char *new_sha1_buf = notnull(*argv++, "new-sha1");
 305         const char *old_sha1_buf = notnull(*argv++, "old-sha1");
 306         unsigned int flags = arg_flags(*argv++, "flags", transaction_flags);
 307         struct object_id old_oid, *old_oid_ptr = NULL;
 308         struct object_id new_oid;
 309
 310         if (*old_sha1_buf) {
 311                 if (get_oid_hex(old_sha1_buf, &old_oid))
 312                         die("cannot parse %s as %s", old_sha1_buf, the_hash_algo->name);
 313                 old_oid_ptr = &old_oid;
 314         }
 315         if (get_oid_hex(new_sha1_buf, &new_oid))
 316                 die("cannot parse %s as %s", new_sha1_buf, the_hash_algo->name);
 317
 318         return refs_update_ref(refs, msg, refname,
 319                                &new_oid, old_oid_ptr,
 320                                flags, UPDATE_REFS_DIE_ON_ERR);
 321 }
 322
 323 struct command {
 324         const char *name;
 325         int (*func)(struct ref_store *refs, const char **argv);
 326 };
 327
 328 static struct command commands[] = {
 329         { "pack-refs", cmd_pack_refs },
 330         { "create-symref", cmd_create_symref },
 331         { "delete-refs", cmd_delete_refs },
 332         { "rename-ref", cmd_rename_ref },
 333         { "for-each-ref", cmd_for_each_ref },
 334         { "for-each-ref--exclude", cmd_for_each_ref__exclude },
 335         { "resolve-ref", cmd_resolve_ref },
 336         { "verify-ref", cmd_verify_ref },
 337         { "for-each-reflog", cmd_for_each_reflog },
 338         { "for-each-reflog-ent", cmd_for_each_reflog_ent },
 339         { "for-each-reflog-ent-reverse", cmd_for_each_reflog_ent_reverse },
 340         { "reflog-exists", cmd_reflog_exists },
 341         { "create-reflog", cmd_create_reflog },
 342         { "delete-reflog", cmd_delete_reflog },
 343         /*
 344          * backend transaction functions can't be tested separately
 345          */
 346         { "delete-ref", cmd_delete_ref },
 347         { "update-ref", cmd_update_ref },
 348         { NULL, NULL }
 349 };
 350
 351 int cmd__ref_store(int argc UNUSED, const char **argv)
 352 {
 353         struct ref_store *refs;
 354         const char *func;
 355         struct command *cmd;
 356
 357         setup_git_directory();
 358
 359         argv = get_store(argv + 1, &refs);
 360
 361         func = *argv++;
 362         if (!func)
 363                 die("ref function required");
 364         for (cmd = commands; cmd->name; cmd++) {
 365                 if (!strcmp(func, cmd->name))
 366                         return cmd->func(refs, argv);
 367         }
 368         die("unknown function %s", func);
 369         return 0;
 370 }