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 86c3caaf 2018-03-09 stsp #include "got_worktree.h"
38 511a516b 2018-05-19 stsp #include "got_opentemp.h"
39 eea47b7e 2019-01-04 stsp #include "got_privsep.h"
41 718b3ab0 2018-03-17 stsp #include "got_lib_worktree.h"
42 718b3ab0 2018-03-17 stsp #include "got_lib_path.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);
87 b18d25df 2018-03-11 stsp remove_worktree(const char *worktree_path)
89 0f92850e 2018-12-25 stsp if (!remove_meta_file(worktree_path, GOT_WORKTREE_HEAD_REF))
91 0f92850e 2018-12-25 stsp if (!remove_meta_file(worktree_path, GOT_WORKTREE_BASE_COMMIT))
93 45d8e5fd 2018-03-11 stsp if (!remove_meta_file(worktree_path, GOT_WORKTREE_FILE_INDEX))
95 45d8e5fd 2018-03-11 stsp if (!remove_meta_file(worktree_path, GOT_WORKTREE_REPOSITORY))
97 45d8e5fd 2018-03-11 stsp if (!remove_meta_file(worktree_path, GOT_WORKTREE_PATH_PREFIX))
99 45d8e5fd 2018-03-11 stsp if (!remove_meta_file(worktree_path, GOT_WORKTREE_LOCK))
101 45d8e5fd 2018-03-11 stsp if (!remove_meta_file(worktree_path, GOT_WORKTREE_FORMAT))
103 ec22038e 2019-03-10 stsp if (!remove_meta_file(worktree_path, GOT_WORKTREE_UUID))
105 45d8e5fd 2018-03-11 stsp if (!remove_got_dir(worktree_path))
107 45d8e5fd 2018-03-11 stsp if (rmdir(worktree_path) == -1)
113 3962e86a 2018-03-11 stsp read_meta_file(char **content, const char *path)
116 3962e86a 2018-03-11 stsp size_t len;
117 3962e86a 2018-03-11 stsp const char delim[3] = {'\0', '\0', '\0'};
118 3962e86a 2018-03-11 stsp int ret = 0;
120 3962e86a 2018-03-11 stsp f = fopen(path, "r");
121 3962e86a 2018-03-11 stsp if (f == NULL)
122 3962e86a 2018-03-11 stsp return errno;
124 3962e86a 2018-03-11 stsp *content = fparseln(f, &len, NULL, delim, 0);
125 3962e86a 2018-03-11 stsp if (*content == NULL)
126 3962e86a 2018-03-11 stsp ret = errno;
127 fb43ecf1 2019-02-11 stsp if (fclose(f) != 0 && ret == 0)
128 fb43ecf1 2019-02-11 stsp ret = errno;
129 3962e86a 2018-03-11 stsp return ret;
133 86c3caaf 2018-03-09 stsp check_meta_file_exists(const char *worktree_path, const char *name)
135 07a7f8ad 2018-03-11 stsp struct stat sb;
136 86c3caaf 2018-03-09 stsp char *path;
137 5de261fe 2018-03-11 stsp int ret = 0;
139 86c3caaf 2018-03-09 stsp if (asprintf(&path, "%s/%s/%s", worktree_path, GOT_WORKTREE_GOT_DIR,
140 86c3caaf 2018-03-09 stsp name) == -1)
142 5de261fe 2018-03-11 stsp if (stat(path, &sb) == 0)
144 3962e86a 2018-03-11 stsp if (verbose) {
145 3962e86a 2018-03-11 stsp char *content;
146 3962e86a 2018-03-11 stsp if (read_meta_file(&content, path) == 0) {
147 3962e86a 2018-03-11 stsp test_printf("%s:\t%s\n", name, content);
148 3962e86a 2018-03-11 stsp free(content);
151 5de261fe 2018-03-11 stsp free(path);
152 5de261fe 2018-03-11 stsp return ret;
156 86c3caaf 2018-03-09 stsp worktree_init(const char *repo_path)
158 86c3caaf 2018-03-09 stsp const struct got_error *err;
159 86c3caaf 2018-03-09 stsp struct got_repository *repo = NULL;
160 86c3caaf 2018-03-09 stsp struct got_reference *head_ref = NULL;
161 86c3caaf 2018-03-09 stsp char worktree_path[PATH_MAX];
162 86c3caaf 2018-03-09 stsp int ok = 0;
164 86c3caaf 2018-03-09 stsp err = got_repo_open(&repo, repo_path);
165 86c3caaf 2018-03-09 stsp if (err != NULL || repo == NULL)
167 86c3caaf 2018-03-09 stsp err = got_ref_open(&head_ref, repo, GOT_REF_HEAD);
168 86c3caaf 2018-03-09 stsp if (err != NULL || head_ref == NULL)
171 86c3caaf 2018-03-09 stsp strlcpy(worktree_path, "worktree-XXXXXX", sizeof(worktree_path));
172 86c3caaf 2018-03-09 stsp if (mkdtemp(worktree_path) == NULL)
175 577ec78f 2018-03-11 stsp err = got_worktree_init(worktree_path, head_ref, "/", repo);
176 86c3caaf 2018-03-09 stsp if (err != NULL)
179 86c3caaf 2018-03-09 stsp /* Ensure required files were created. */
180 0f92850e 2018-12-25 stsp if (!check_meta_file_exists(worktree_path, GOT_WORKTREE_HEAD_REF))
182 0f92850e 2018-12-25 stsp if (!check_meta_file_exists(worktree_path, GOT_WORKTREE_BASE_COMMIT))
184 056e7441 2018-03-11 stsp if (!check_meta_file_exists(worktree_path, GOT_WORKTREE_LOCK))
186 86c3caaf 2018-03-09 stsp if (!check_meta_file_exists(worktree_path, GOT_WORKTREE_FILE_INDEX))
188 86c3caaf 2018-03-09 stsp if (!check_meta_file_exists(worktree_path, GOT_WORKTREE_REPOSITORY))
190 577ec78f 2018-03-11 stsp if (!check_meta_file_exists(worktree_path, GOT_WORKTREE_PATH_PREFIX))
192 1451e70d 2018-03-10 stsp if (!check_meta_file_exists(worktree_path, GOT_WORKTREE_FORMAT))
194 ec22038e 2019-03-10 stsp if (!check_meta_file_exists(worktree_path, GOT_WORKTREE_UUID))
197 45d8e5fd 2018-03-11 stsp if (!remove_worktree(worktree_path))
201 86c3caaf 2018-03-09 stsp if (head_ref)
202 86c3caaf 2018-03-09 stsp got_ref_close(head_ref);
204 86c3caaf 2018-03-09 stsp got_repo_close(repo);
209 0da17012 2018-03-09 stsp obstruct_meta_file(char **path, const char *worktree_path, const char *name)
212 0da17012 2018-03-09 stsp char *s = "This file should not be here\n";
213 6b7476e9 2018-03-11 stsp int ret = 1;
215 0da17012 2018-03-09 stsp if (asprintf(path, "%s/%s/%s", worktree_path, GOT_WORKTREE_GOT_DIR,
216 0da17012 2018-03-09 stsp name) == -1)
218 0da17012 2018-03-09 stsp f = fopen(*path, "w+");
219 0da17012 2018-03-09 stsp if (f == NULL) {
220 0da17012 2018-03-09 stsp free(*path);
223 0da17012 2018-03-09 stsp if (fwrite(s, 1, strlen(s), f) != strlen(s)) {
224 0da17012 2018-03-09 stsp free(*path);
227 fb43ecf1 2019-02-11 stsp if (fclose(f) != 0)
229 6b7476e9 2018-03-11 stsp return ret;
233 8eac252b 2018-03-11 stsp obstruct_meta_file_and_init(int *ok, struct got_repository *repo,
234 8eac252b 2018-03-11 stsp const char *worktree_path, char *name)
236 8eac252b 2018-03-11 stsp const struct got_error *err;
237 8eac252b 2018-03-11 stsp char *path;
238 8eac252b 2018-03-11 stsp int ret = 0;
239 8eac252b 2018-03-11 stsp struct got_reference *head_ref = NULL;
241 8eac252b 2018-03-11 stsp if (!obstruct_meta_file(&path, worktree_path, GOT_WORKTREE_FILE_INDEX))
244 8eac252b 2018-03-11 stsp err = got_ref_open(&head_ref, repo, GOT_REF_HEAD);
245 8eac252b 2018-03-11 stsp if (err != NULL || head_ref == NULL)
248 8eac252b 2018-03-11 stsp err = got_worktree_init(worktree_path, head_ref, "/", repo);
249 8eac252b 2018-03-11 stsp if (err != NULL && err->code == GOT_ERR_ERRNO && errno == EEXIST) {
253 8eac252b 2018-03-11 stsp unlink(path);
254 8eac252b 2018-03-11 stsp free(path);
255 8eac252b 2018-03-11 stsp got_ref_close(head_ref);
256 8eac252b 2018-03-11 stsp return ret;
260 0da17012 2018-03-09 stsp worktree_init_exists(const char *repo_path)
262 0da17012 2018-03-09 stsp const struct got_error *err;
263 0da17012 2018-03-09 stsp struct got_repository *repo = NULL;
264 0da17012 2018-03-09 stsp char worktree_path[PATH_MAX];
265 91c986ef 2018-03-09 stsp char *gotpath = NULL;
266 0da17012 2018-03-09 stsp int ok = 0;
268 0da17012 2018-03-09 stsp err = got_repo_open(&repo, repo_path);
269 0da17012 2018-03-09 stsp if (err != NULL || repo == NULL)
271 0da17012 2018-03-09 stsp strlcpy(worktree_path, "worktree-XXXXXX", sizeof(worktree_path));
272 0da17012 2018-03-09 stsp if (mkdtemp(worktree_path) == NULL)
274 91c986ef 2018-03-09 stsp if (mkdir(worktree_path, GOT_DEFAULT_DIR_MODE) == -1 && errno != EEXIST)
277 0da17012 2018-03-09 stsp if (asprintf(&gotpath, "%s/%s", worktree_path, GOT_WORKTREE_GOT_DIR)
280 0da17012 2018-03-09 stsp if (mkdir(gotpath, GOT_DEFAULT_DIR_MODE) == -1 && errno != EEXIST)
283 0da17012 2018-03-09 stsp /* Create files which got_worktree_init() will try to create as well. */
284 8eac252b 2018-03-11 stsp if (!obstruct_meta_file_and_init(&ok, repo, worktree_path,
285 0f92850e 2018-12-25 stsp GOT_WORKTREE_HEAD_REF))
287 8eac252b 2018-03-11 stsp if (!obstruct_meta_file_and_init(&ok, repo, worktree_path,
288 0f92850e 2018-12-25 stsp GOT_WORKTREE_BASE_COMMIT))
290 65596e15 2018-12-24 stsp if (!obstruct_meta_file_and_init(&ok, repo, worktree_path,
291 8eac252b 2018-03-11 stsp GOT_WORKTREE_LOCK))
293 8eac252b 2018-03-11 stsp if (!obstruct_meta_file_and_init(&ok, repo, worktree_path,
294 8eac252b 2018-03-11 stsp GOT_WORKTREE_FILE_INDEX))
296 8eac252b 2018-03-11 stsp if (!obstruct_meta_file_and_init(&ok, repo, worktree_path,
297 8eac252b 2018-03-11 stsp GOT_WORKTREE_REPOSITORY))
299 8eac252b 2018-03-11 stsp if (!obstruct_meta_file_and_init(&ok, repo, worktree_path,
300 8eac252b 2018-03-11 stsp GOT_WORKTREE_PATH_PREFIX))
302 8eac252b 2018-03-11 stsp if (!obstruct_meta_file_and_init(&ok, repo, worktree_path,
303 8eac252b 2018-03-11 stsp GOT_WORKTREE_FORMAT))
308 0da17012 2018-03-09 stsp got_repo_close(repo);
309 91c986ef 2018-03-09 stsp free(gotpath);
310 65596e15 2018-12-24 stsp if (ok == 7)
311 b18d25df 2018-03-11 stsp remove_worktree(worktree_path);
312 65596e15 2018-12-24 stsp return (ok == 7);
315 291c6f03 2018-03-12 stsp static void
316 a0eb853d 2018-12-29 stsp progress_cb(void *arg, unsigned char status, const char *path)
321 9d31a1d8 2018-03-11 stsp worktree_checkout(const char *repo_path)
323 9d31a1d8 2018-03-11 stsp const struct got_error *err;
324 9d31a1d8 2018-03-11 stsp struct got_repository *repo = NULL;
325 9d31a1d8 2018-03-11 stsp struct got_reference *head_ref = NULL;
326 9d31a1d8 2018-03-11 stsp struct got_worktree *worktree = NULL;
327 9d31a1d8 2018-03-11 stsp char *makefile_path = NULL, *cfile_path = NULL;
328 9d31a1d8 2018-03-11 stsp char worktree_path[PATH_MAX];
329 9d31a1d8 2018-03-11 stsp int ok = 0;
330 9d31a1d8 2018-03-11 stsp struct stat sb;
332 9d31a1d8 2018-03-11 stsp err = got_repo_open(&repo, repo_path);
333 9d31a1d8 2018-03-11 stsp if (err != NULL || repo == NULL)
335 9d31a1d8 2018-03-11 stsp err = got_ref_open(&head_ref, repo, GOT_REF_HEAD);
336 9d31a1d8 2018-03-11 stsp if (err != NULL || head_ref == NULL)
339 9d31a1d8 2018-03-11 stsp strlcpy(worktree_path, "worktree-XXXXXX", sizeof(worktree_path));
340 9d31a1d8 2018-03-11 stsp if (mkdtemp(worktree_path) == NULL)
343 9d31a1d8 2018-03-11 stsp err = got_worktree_init(worktree_path, head_ref, "/regress/worktree",
345 9d31a1d8 2018-03-11 stsp if (err != NULL)
348 9d31a1d8 2018-03-11 stsp err = got_worktree_open(&worktree, worktree_path);
349 9d31a1d8 2018-03-11 stsp if (err != NULL)
352 d7b62c98 2018-12-27 stsp err = got_worktree_checkout_files(worktree, repo, progress_cb, NULL,
353 93a30277 2018-12-24 stsp NULL, NULL);
354 9d31a1d8 2018-03-11 stsp if (err != NULL)
357 9d31a1d8 2018-03-11 stsp test_printf("checked out %s\n", worktree_path);
359 9d31a1d8 2018-03-11 stsp /* The work tree should contain a Makefile and worktree_test.c. */
360 9d31a1d8 2018-03-11 stsp if (asprintf(&makefile_path, "%s/Makefile", worktree_path) == -1)
362 9d31a1d8 2018-03-11 stsp if (stat(makefile_path, &sb) != 0)
365 9d31a1d8 2018-03-11 stsp unlink(makefile_path);
366 9d31a1d8 2018-03-11 stsp if (asprintf(&cfile_path, "%s/worktree_test.c", worktree_path) == -1)
368 9d31a1d8 2018-03-11 stsp if (stat(cfile_path, &sb) != 0)
371 9d31a1d8 2018-03-11 stsp unlink(cfile_path);
373 9d31a1d8 2018-03-11 stsp if (!remove_worktree(worktree_path))
378 9d31a1d8 2018-03-11 stsp if (worktree)
379 9d31a1d8 2018-03-11 stsp got_worktree_close(worktree);
380 9d31a1d8 2018-03-11 stsp if (head_ref)
381 9d31a1d8 2018-03-11 stsp got_ref_close(head_ref);
383 9d31a1d8 2018-03-11 stsp got_repo_close(repo);
384 9d31a1d8 2018-03-11 stsp free(makefile_path);
385 9d31a1d8 2018-03-11 stsp free(cfile_path);
389 86c3caaf 2018-03-09 stsp #define RUN_TEST(expr, name) \
390 86c3caaf 2018-03-09 stsp { test_ok = (expr); \
391 9465d522 2019-01-03 stsp printf("test_%s %s\n", (name), test_ok ? "ok" : "failed"); \
392 86c3caaf 2018-03-09 stsp failure = (failure || !test_ok); }
396 86c3caaf 2018-03-09 stsp usage(void)
398 86c3caaf 2018-03-09 stsp fprintf(stderr, "usage: worktree_test [-v] [REPO_PATH]\n");
402 86c3caaf 2018-03-09 stsp main(int argc, char *argv[])
404 86c3caaf 2018-03-09 stsp int test_ok = 0, failure = 0;
405 86c3caaf 2018-03-09 stsp const char *repo_path;
406 eea47b7e 2019-01-04 stsp char *cwd = NULL;
409 2ff12563 2018-09-15 stsp #ifndef PROFILE
410 68ed9ba5 2019-02-10 stsp if (pledge("stdio rpath wpath cpath fattr flock proc exec sendfd "
411 68ed9ba5 2019-02-10 stsp "unveil", NULL) == -1)
412 f8352b2a 2018-03-12 stsp err(1, "pledge");
415 86c3caaf 2018-03-09 stsp while ((ch = getopt(argc, argv, "v")) != -1) {
416 86c3caaf 2018-03-09 stsp switch (ch) {
418 86c3caaf 2018-03-09 stsp verbose = 1;
425 86c3caaf 2018-03-09 stsp argc -= optind;
426 86c3caaf 2018-03-09 stsp argv += optind;
428 86c3caaf 2018-03-09 stsp if (argc == 0)
429 86c3caaf 2018-03-09 stsp repo_path = GOT_REPO_PATH;
430 86c3caaf 2018-03-09 stsp else if (argc == 1)
431 86c3caaf 2018-03-09 stsp repo_path = argv[0];
437 eea47b7e 2019-01-04 stsp cwd = getcwd(NULL, 0);
438 eea47b7e 2019-01-04 stsp if (cwd == NULL)
439 eea47b7e 2019-01-04 stsp err(1, "getcwd");
440 eea47b7e 2019-01-04 stsp if (unveil(cwd, "rwc") != 0)
441 eea47b7e 2019-01-04 stsp err(1, "unvail");
444 eea47b7e 2019-01-04 stsp if (unveil("/tmp", "rwc") != 0)
445 eea47b7e 2019-01-04 stsp err(1, "unveil");
447 eea47b7e 2019-01-04 stsp if (unveil(repo_path, "r") != 0)
448 eea47b7e 2019-01-04 stsp err(1, "unveil");
450 eea47b7e 2019-01-04 stsp if (got_privsep_unveil_exec_helpers() != NULL)
453 eea47b7e 2019-01-04 stsp if (unveil(NULL, NULL) != 0)
454 eea47b7e 2019-01-04 stsp err(1, "unveil");
456 86c3caaf 2018-03-09 stsp RUN_TEST(worktree_init(repo_path), "init");
457 0da17012 2018-03-09 stsp RUN_TEST(worktree_init_exists(repo_path), "init exists");
458 9d31a1d8 2018-03-11 stsp RUN_TEST(worktree_checkout(repo_path), "checkout");
460 86c3caaf 2018-03-09 stsp return failure ? 1 : 0;