2 5d56da81 2019-01-13 stsp * Copyright (c) 2018, 2019 Stefan Sperling <stsp@openbsd.org>
4 86c3caaf 2018-03-09 stsp * Permission to use, copy, modify, and distribute this software for any
5 86c3caaf 2018-03-09 stsp * purpose with or without fee is hereby granted, provided that the above
6 86c3caaf 2018-03-09 stsp * copyright notice and this permission notice appear in all copies.
8 86c3caaf 2018-03-09 stsp * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 86c3caaf 2018-03-09 stsp * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 86c3caaf 2018-03-09 stsp * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11 86c3caaf 2018-03-09 stsp * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 86c3caaf 2018-03-09 stsp * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13 86c3caaf 2018-03-09 stsp * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14 86c3caaf 2018-03-09 stsp * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 86c3caaf 2018-03-09 stsp #include <sys/param.h>
18 86c3caaf 2018-03-09 stsp #include <sys/queue.h>
19 86c3caaf 2018-03-09 stsp #include <sys/limits.h>
20 0da17012 2018-03-09 stsp #include <sys/stat.h>
22 86c3caaf 2018-03-09 stsp #include <stdarg.h>
23 86c3caaf 2018-03-09 stsp #include <stdio.h>
24 86c3caaf 2018-03-09 stsp #include <stdlib.h>
25 86c3caaf 2018-03-09 stsp #include <string.h>
26 86c3caaf 2018-03-09 stsp #include <unistd.h>
27 0da17012 2018-03-09 stsp #include <errno.h>
28 3962e86a 2018-03-11 stsp #include <util.h>
29 f8352b2a 2018-03-12 stsp #include <err.h>
30 f8352b2a 2018-03-12 stsp #include <unistd.h>
31 c442a90d 2019-03-10 stsp #include <uuid.h>
33 86c3caaf 2018-03-09 stsp #include "got_error.h"
34 86c3caaf 2018-03-09 stsp #include "got_object.h"
35 5261c201 2018-04-01 stsp #include "got_reference.h"
36 86c3caaf 2018-03-09 stsp #include "got_repository.h"
37 1dd54920 2019-05-11 stsp #include "got_path.h"
38 86c3caaf 2018-03-09 stsp #include "got_worktree.h"
39 511a516b 2018-05-19 stsp #include "got_opentemp.h"
40 eea47b7e 2019-01-04 stsp #include "got_privsep.h"
42 718b3ab0 2018-03-17 stsp #include "got_lib_worktree.h"
44 86c3caaf 2018-03-09 stsp #define GOT_REPO_PATH "../../../"
46 86c3caaf 2018-03-09 stsp static int verbose;
49 86c3caaf 2018-03-09 stsp test_printf(char *fmt, ...)
53 86c3caaf 2018-03-09 stsp if (!verbose)
56 86c3caaf 2018-03-09 stsp va_start(ap, fmt);
57 86c3caaf 2018-03-09 stsp vprintf(fmt, ap);
62 91c986ef 2018-03-09 stsp remove_got_dir(const char *worktree_path)
66 91c986ef 2018-03-09 stsp if (asprintf(&path, "%s/%s", worktree_path, GOT_WORKTREE_GOT_DIR) == -1)
68 91c986ef 2018-03-09 stsp rmdir(path);
74 91c986ef 2018-03-09 stsp remove_meta_file(const char *worktree_path, const char *name)
78 91c986ef 2018-03-09 stsp if (asprintf(&path, "%s/%s/%s", worktree_path, GOT_WORKTREE_GOT_DIR,
79 91c986ef 2018-03-09 stsp name) == -1)
81 91c986ef 2018-03-09 stsp unlink(path);
86 0cd1c46a 2019-03-11 stsp static const struct got_error *
87 0cd1c46a 2019-03-11 stsp remove_worktree_base_ref(struct got_worktree *worktree,
88 0cd1c46a 2019-03-11 stsp struct got_repository *repo)
90 0cd1c46a 2019-03-11 stsp const struct got_error *err = NULL;
91 517bab73 2019-03-11 stsp struct got_reference *base_ref = NULL;
92 1ab61ced 2019-07-10 stsp char *refname = NULL;
94 517bab73 2019-03-11 stsp err = got_worktree_get_base_ref_name(&refname, worktree);
98 1ab61ced 2019-07-10 stsp err = got_ref_open(&base_ref, repo, refname, 0);
102 0cd1c46a 2019-03-11 stsp err = got_ref_delete(base_ref, repo);
104 0cd1c46a 2019-03-11 stsp if (base_ref)
105 0cd1c46a 2019-03-11 stsp got_ref_close(base_ref);
106 0cd1c46a 2019-03-11 stsp free(refname);
107 0cd1c46a 2019-03-11 stsp return err;
112 b18d25df 2018-03-11 stsp remove_worktree(const char *worktree_path)
114 0f92850e 2018-12-25 stsp if (!remove_meta_file(worktree_path, GOT_WORKTREE_HEAD_REF))
116 0f92850e 2018-12-25 stsp if (!remove_meta_file(worktree_path, GOT_WORKTREE_BASE_COMMIT))
118 45d8e5fd 2018-03-11 stsp if (!remove_meta_file(worktree_path, GOT_WORKTREE_FILE_INDEX))
120 45d8e5fd 2018-03-11 stsp if (!remove_meta_file(worktree_path, GOT_WORKTREE_REPOSITORY))
122 45d8e5fd 2018-03-11 stsp if (!remove_meta_file(worktree_path, GOT_WORKTREE_PATH_PREFIX))
124 45d8e5fd 2018-03-11 stsp if (!remove_meta_file(worktree_path, GOT_WORKTREE_LOCK))
126 45d8e5fd 2018-03-11 stsp if (!remove_meta_file(worktree_path, GOT_WORKTREE_FORMAT))
128 ec22038e 2019-03-10 stsp if (!remove_meta_file(worktree_path, GOT_WORKTREE_UUID))
130 45d8e5fd 2018-03-11 stsp if (!remove_got_dir(worktree_path))
132 45d8e5fd 2018-03-11 stsp if (rmdir(worktree_path) == -1)
138 3962e86a 2018-03-11 stsp read_meta_file(char **content, const char *path)
141 3962e86a 2018-03-11 stsp size_t len;
142 3962e86a 2018-03-11 stsp const char delim[3] = {'\0', '\0', '\0'};
143 3962e86a 2018-03-11 stsp int ret = 0;
145 3962e86a 2018-03-11 stsp f = fopen(path, "r");
146 3962e86a 2018-03-11 stsp if (f == NULL)
147 3962e86a 2018-03-11 stsp return errno;
149 3962e86a 2018-03-11 stsp *content = fparseln(f, &len, NULL, delim, 0);
150 3962e86a 2018-03-11 stsp if (*content == NULL)
151 3962e86a 2018-03-11 stsp ret = errno;
152 fb43ecf1 2019-02-11 stsp if (fclose(f) != 0 && ret == 0)
153 fb43ecf1 2019-02-11 stsp ret = errno;
154 3962e86a 2018-03-11 stsp return ret;
158 86c3caaf 2018-03-09 stsp check_meta_file_exists(const char *worktree_path, const char *name)
160 07a7f8ad 2018-03-11 stsp struct stat sb;
161 86c3caaf 2018-03-09 stsp char *path;
162 5de261fe 2018-03-11 stsp int ret = 0;
164 86c3caaf 2018-03-09 stsp if (asprintf(&path, "%s/%s/%s", worktree_path, GOT_WORKTREE_GOT_DIR,
165 86c3caaf 2018-03-09 stsp name) == -1)
167 5de261fe 2018-03-11 stsp if (stat(path, &sb) == 0)
169 3962e86a 2018-03-11 stsp if (verbose) {
170 3962e86a 2018-03-11 stsp char *content;
171 3962e86a 2018-03-11 stsp if (read_meta_file(&content, path) == 0) {
172 3962e86a 2018-03-11 stsp test_printf("%s:\t%s\n", name, content);
173 3962e86a 2018-03-11 stsp free(content);
176 5de261fe 2018-03-11 stsp free(path);
177 5de261fe 2018-03-11 stsp return ret;
181 86c3caaf 2018-03-09 stsp worktree_init(const char *repo_path)
183 86c3caaf 2018-03-09 stsp const struct got_error *err;
184 86c3caaf 2018-03-09 stsp struct got_repository *repo = NULL;
185 86c3caaf 2018-03-09 stsp struct got_reference *head_ref = NULL;
186 86c3caaf 2018-03-09 stsp char worktree_path[PATH_MAX];
187 86c3caaf 2018-03-09 stsp int ok = 0;
189 86c3caaf 2018-03-09 stsp err = got_repo_open(&repo, repo_path);
190 86c3caaf 2018-03-09 stsp if (err != NULL || repo == NULL)
192 2f17228e 2019-05-12 stsp err = got_ref_open(&head_ref, repo, GOT_REF_HEAD, 0);
193 86c3caaf 2018-03-09 stsp if (err != NULL || head_ref == NULL)
196 86c3caaf 2018-03-09 stsp strlcpy(worktree_path, "worktree-XXXXXX", sizeof(worktree_path));
197 86c3caaf 2018-03-09 stsp if (mkdtemp(worktree_path) == NULL)
200 577ec78f 2018-03-11 stsp err = got_worktree_init(worktree_path, head_ref, "/", repo);
201 86c3caaf 2018-03-09 stsp if (err != NULL)
204 86c3caaf 2018-03-09 stsp /* Ensure required files were created. */
205 0f92850e 2018-12-25 stsp if (!check_meta_file_exists(worktree_path, GOT_WORKTREE_HEAD_REF))
207 0f92850e 2018-12-25 stsp if (!check_meta_file_exists(worktree_path, GOT_WORKTREE_BASE_COMMIT))
209 056e7441 2018-03-11 stsp if (!check_meta_file_exists(worktree_path, GOT_WORKTREE_LOCK))
211 86c3caaf 2018-03-09 stsp if (!check_meta_file_exists(worktree_path, GOT_WORKTREE_FILE_INDEX))
213 86c3caaf 2018-03-09 stsp if (!check_meta_file_exists(worktree_path, GOT_WORKTREE_REPOSITORY))
215 577ec78f 2018-03-11 stsp if (!check_meta_file_exists(worktree_path, GOT_WORKTREE_PATH_PREFIX))
217 1451e70d 2018-03-10 stsp if (!check_meta_file_exists(worktree_path, GOT_WORKTREE_FORMAT))
219 ec22038e 2019-03-10 stsp if (!check_meta_file_exists(worktree_path, GOT_WORKTREE_UUID))
222 45d8e5fd 2018-03-11 stsp if (!remove_worktree(worktree_path))
226 86c3caaf 2018-03-09 stsp if (head_ref)
227 86c3caaf 2018-03-09 stsp got_ref_close(head_ref);
229 86c3caaf 2018-03-09 stsp got_repo_close(repo);
234 0da17012 2018-03-09 stsp obstruct_meta_file(char **path, const char *worktree_path, const char *name)
237 0da17012 2018-03-09 stsp char *s = "This file should not be here\n";
238 6b7476e9 2018-03-11 stsp int ret = 1;
240 0da17012 2018-03-09 stsp if (asprintf(path, "%s/%s/%s", worktree_path, GOT_WORKTREE_GOT_DIR,
241 0da17012 2018-03-09 stsp name) == -1)
243 0da17012 2018-03-09 stsp f = fopen(*path, "w+");
244 0da17012 2018-03-09 stsp if (f == NULL) {
245 0da17012 2018-03-09 stsp free(*path);
248 0da17012 2018-03-09 stsp if (fwrite(s, 1, strlen(s), f) != strlen(s)) {
249 0da17012 2018-03-09 stsp free(*path);
252 fb43ecf1 2019-02-11 stsp if (fclose(f) != 0)
254 6b7476e9 2018-03-11 stsp return ret;
258 8eac252b 2018-03-11 stsp obstruct_meta_file_and_init(int *ok, struct got_repository *repo,
259 8eac252b 2018-03-11 stsp const char *worktree_path, char *name)
261 8eac252b 2018-03-11 stsp const struct got_error *err;
262 8eac252b 2018-03-11 stsp char *path;
263 8eac252b 2018-03-11 stsp int ret = 0;
264 8eac252b 2018-03-11 stsp struct got_reference *head_ref = NULL;
266 8eac252b 2018-03-11 stsp if (!obstruct_meta_file(&path, worktree_path, GOT_WORKTREE_FILE_INDEX))
269 2f17228e 2019-05-12 stsp err = got_ref_open(&head_ref, repo, GOT_REF_HEAD, 0);
270 8eac252b 2018-03-11 stsp if (err != NULL || head_ref == NULL)
273 8eac252b 2018-03-11 stsp err = got_worktree_init(worktree_path, head_ref, "/", repo);
274 8eac252b 2018-03-11 stsp if (err != NULL && err->code == GOT_ERR_ERRNO && errno == EEXIST) {
278 8eac252b 2018-03-11 stsp unlink(path);
279 8eac252b 2018-03-11 stsp free(path);
280 8eac252b 2018-03-11 stsp got_ref_close(head_ref);
281 8eac252b 2018-03-11 stsp return ret;
285 0da17012 2018-03-09 stsp worktree_init_exists(const char *repo_path)
287 0da17012 2018-03-09 stsp const struct got_error *err;
288 0da17012 2018-03-09 stsp struct got_repository *repo = NULL;
289 0da17012 2018-03-09 stsp char worktree_path[PATH_MAX];
290 91c986ef 2018-03-09 stsp char *gotpath = NULL;
291 0da17012 2018-03-09 stsp int ok = 0;
293 0da17012 2018-03-09 stsp err = got_repo_open(&repo, repo_path);
294 0da17012 2018-03-09 stsp if (err != NULL || repo == NULL)
296 0da17012 2018-03-09 stsp strlcpy(worktree_path, "worktree-XXXXXX", sizeof(worktree_path));
297 0da17012 2018-03-09 stsp if (mkdtemp(worktree_path) == NULL)
299 91c986ef 2018-03-09 stsp if (mkdir(worktree_path, GOT_DEFAULT_DIR_MODE) == -1 && errno != EEXIST)
302 0da17012 2018-03-09 stsp if (asprintf(&gotpath, "%s/%s", worktree_path, GOT_WORKTREE_GOT_DIR)
305 0da17012 2018-03-09 stsp if (mkdir(gotpath, GOT_DEFAULT_DIR_MODE) == -1 && errno != EEXIST)
308 0da17012 2018-03-09 stsp /* Create files which got_worktree_init() will try to create as well. */
309 8eac252b 2018-03-11 stsp if (!obstruct_meta_file_and_init(&ok, repo, worktree_path,
310 0f92850e 2018-12-25 stsp GOT_WORKTREE_HEAD_REF))
312 8eac252b 2018-03-11 stsp if (!obstruct_meta_file_and_init(&ok, repo, worktree_path,
313 0f92850e 2018-12-25 stsp GOT_WORKTREE_BASE_COMMIT))
315 65596e15 2018-12-24 stsp if (!obstruct_meta_file_and_init(&ok, repo, worktree_path,
316 8eac252b 2018-03-11 stsp GOT_WORKTREE_LOCK))
318 8eac252b 2018-03-11 stsp if (!obstruct_meta_file_and_init(&ok, repo, worktree_path,
319 8eac252b 2018-03-11 stsp GOT_WORKTREE_FILE_INDEX))
321 8eac252b 2018-03-11 stsp if (!obstruct_meta_file_and_init(&ok, repo, worktree_path,
322 8eac252b 2018-03-11 stsp GOT_WORKTREE_REPOSITORY))
324 8eac252b 2018-03-11 stsp if (!obstruct_meta_file_and_init(&ok, repo, worktree_path,
325 8eac252b 2018-03-11 stsp GOT_WORKTREE_PATH_PREFIX))
327 8eac252b 2018-03-11 stsp if (!obstruct_meta_file_and_init(&ok, repo, worktree_path,
328 8eac252b 2018-03-11 stsp GOT_WORKTREE_FORMAT))
333 0da17012 2018-03-09 stsp got_repo_close(repo);
334 91c986ef 2018-03-09 stsp free(gotpath);
335 65596e15 2018-12-24 stsp if (ok == 7)
336 b18d25df 2018-03-11 stsp remove_worktree(worktree_path);
337 65596e15 2018-12-24 stsp return (ok == 7);
340 1ee397ad 2019-07-12 stsp static const struct got_error *
341 a0eb853d 2018-12-29 stsp progress_cb(void *arg, unsigned char status, const char *path)
343 1ee397ad 2019-07-12 stsp return NULL;
347 9d31a1d8 2018-03-11 stsp worktree_checkout(const char *repo_path)
349 9d31a1d8 2018-03-11 stsp const struct got_error *err;
350 9d31a1d8 2018-03-11 stsp struct got_repository *repo = NULL;
351 9d31a1d8 2018-03-11 stsp struct got_reference *head_ref = NULL;
352 9d31a1d8 2018-03-11 stsp struct got_worktree *worktree = NULL;
353 9d31a1d8 2018-03-11 stsp char *makefile_path = NULL, *cfile_path = NULL;
354 9d31a1d8 2018-03-11 stsp char worktree_path[PATH_MAX];
355 9d31a1d8 2018-03-11 stsp int ok = 0;
356 9d31a1d8 2018-03-11 stsp struct stat sb;
358 9d31a1d8 2018-03-11 stsp err = got_repo_open(&repo, repo_path);
359 9d31a1d8 2018-03-11 stsp if (err != NULL || repo == NULL)
361 2f17228e 2019-05-12 stsp err = got_ref_open(&head_ref, repo, GOT_REF_HEAD, 0);
362 9d31a1d8 2018-03-11 stsp if (err != NULL || head_ref == NULL)
365 9d31a1d8 2018-03-11 stsp strlcpy(worktree_path, "worktree-XXXXXX", sizeof(worktree_path));
366 9d31a1d8 2018-03-11 stsp if (mkdtemp(worktree_path) == NULL)
369 9d31a1d8 2018-03-11 stsp err = got_worktree_init(worktree_path, head_ref, "/regress/worktree",
371 9d31a1d8 2018-03-11 stsp if (err != NULL)
374 9d31a1d8 2018-03-11 stsp err = got_worktree_open(&worktree, worktree_path);
375 9d31a1d8 2018-03-11 stsp if (err != NULL)
378 c4cdcb68 2019-04-03 stsp err = got_worktree_checkout_files(worktree, "", repo, progress_cb, NULL,
379 93a30277 2018-12-24 stsp NULL, NULL);
380 9d31a1d8 2018-03-11 stsp if (err != NULL)
383 9d31a1d8 2018-03-11 stsp test_printf("checked out %s\n", worktree_path);
385 9d31a1d8 2018-03-11 stsp /* The work tree should contain a Makefile and worktree_test.c. */
386 9d31a1d8 2018-03-11 stsp if (asprintf(&makefile_path, "%s/Makefile", worktree_path) == -1)
388 9d31a1d8 2018-03-11 stsp if (stat(makefile_path, &sb) != 0)
391 9d31a1d8 2018-03-11 stsp unlink(makefile_path);
392 9d31a1d8 2018-03-11 stsp if (asprintf(&cfile_path, "%s/worktree_test.c", worktree_path) == -1)
394 9d31a1d8 2018-03-11 stsp if (stat(cfile_path, &sb) != 0)
397 9d31a1d8 2018-03-11 stsp unlink(cfile_path);
399 0cd1c46a 2019-03-11 stsp err = remove_worktree_base_ref(worktree, repo);
402 9d31a1d8 2018-03-11 stsp if (!remove_worktree(worktree_path))
407 9d31a1d8 2018-03-11 stsp if (worktree)
408 9d31a1d8 2018-03-11 stsp got_worktree_close(worktree);
409 9d31a1d8 2018-03-11 stsp if (head_ref)
410 9d31a1d8 2018-03-11 stsp got_ref_close(head_ref);
412 9d31a1d8 2018-03-11 stsp got_repo_close(repo);
413 9d31a1d8 2018-03-11 stsp free(makefile_path);
414 9d31a1d8 2018-03-11 stsp free(cfile_path);
418 86c3caaf 2018-03-09 stsp #define RUN_TEST(expr, name) \
419 86c3caaf 2018-03-09 stsp { test_ok = (expr); \
420 9465d522 2019-01-03 stsp printf("test_%s %s\n", (name), test_ok ? "ok" : "failed"); \
421 86c3caaf 2018-03-09 stsp failure = (failure || !test_ok); }
425 86c3caaf 2018-03-09 stsp usage(void)
427 86c3caaf 2018-03-09 stsp fprintf(stderr, "usage: worktree_test [-v] [REPO_PATH]\n");
431 86c3caaf 2018-03-09 stsp main(int argc, char *argv[])
433 86c3caaf 2018-03-09 stsp int test_ok = 0, failure = 0;
434 86c3caaf 2018-03-09 stsp const char *repo_path;
435 eea47b7e 2019-01-04 stsp char *cwd = NULL;
438 2ff12563 2018-09-15 stsp #ifndef PROFILE
439 68ed9ba5 2019-02-10 stsp if (pledge("stdio rpath wpath cpath fattr flock proc exec sendfd "
440 68ed9ba5 2019-02-10 stsp "unveil", NULL) == -1)
441 f8352b2a 2018-03-12 stsp err(1, "pledge");
444 86c3caaf 2018-03-09 stsp while ((ch = getopt(argc, argv, "v")) != -1) {
445 86c3caaf 2018-03-09 stsp switch (ch) {
447 86c3caaf 2018-03-09 stsp verbose = 1;
454 86c3caaf 2018-03-09 stsp argc -= optind;
455 86c3caaf 2018-03-09 stsp argv += optind;
457 86c3caaf 2018-03-09 stsp if (argc == 0)
458 86c3caaf 2018-03-09 stsp repo_path = GOT_REPO_PATH;
459 86c3caaf 2018-03-09 stsp else if (argc == 1)
460 86c3caaf 2018-03-09 stsp repo_path = argv[0];
466 eea47b7e 2019-01-04 stsp cwd = getcwd(NULL, 0);
467 eea47b7e 2019-01-04 stsp if (cwd == NULL)
468 eea47b7e 2019-01-04 stsp err(1, "getcwd");
469 eea47b7e 2019-01-04 stsp if (unveil(cwd, "rwc") != 0)
470 eea47b7e 2019-01-04 stsp err(1, "unvail");
473 eea47b7e 2019-01-04 stsp if (unveil("/tmp", "rwc") != 0)
474 eea47b7e 2019-01-04 stsp err(1, "unveil");
476 0cd1c46a 2019-03-11 stsp if (unveil(repo_path, "rwc") != 0)
477 eea47b7e 2019-01-04 stsp err(1, "unveil");
479 eea47b7e 2019-01-04 stsp if (got_privsep_unveil_exec_helpers() != NULL)
482 eea47b7e 2019-01-04 stsp if (unveil(NULL, NULL) != 0)
483 eea47b7e 2019-01-04 stsp err(1, "unveil");
485 86c3caaf 2018-03-09 stsp RUN_TEST(worktree_init(repo_path), "init");
486 0da17012 2018-03-09 stsp RUN_TEST(worktree_init_exists(repo_path), "init exists");
487 9d31a1d8 2018-03-11 stsp RUN_TEST(worktree_checkout(repo_path), "checkout");
489 86c3caaf 2018-03-09 stsp return failure ? 1 : 0;