src/test/test-copy.c

   1 /***
   2   This file is part of systemd
   3
   4   Copyright 2014 Ronny Chevalier
   5
   6   systemd is free software; you can redistribute it and/or modify it
   7   under the terms of the GNU Lesser General Public License as published by
   8   the Free Software Foundation; either version 2.1 of the License, or
   9   (at your option) any later version.
  10
  11   systemd is distributed in the hope that it will be useful, but
  12   WITHOUT ANY WARRANTY; without even the implied warranty of
  13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14   Lesser General Public License for more details.
  15
  16   You should have received a copy of the GNU Lesser General Public License
  17   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  18 ***/
  19
  20 #include <unistd.h>
  21
  22 #include "alloc-util.h"
  23 #include "copy.h"
  24 #include "fd-util.h"
  25 #include "fileio.h"
  26 #include "fs-util.h"
  27 #include "log.h"
  28 #include "macro.h"
  29 #include "mkdir.h"
  30 #include "path-util.h"
  31 #include "rm-rf.h"
  32 #include "string-util.h"
  33 #include "strv.h"
  34 #include "util.h"
  35
  36 static void test_copy_file(void) {
  37         _cleanup_free_ char *buf = NULL;
  38         char fn[] = "/tmp/test-copy_file.XXXXXX";
  39         char fn_copy[] = "/tmp/test-copy_file.XXXXXX";
  40         size_t sz = 0;
  41         int fd;
  42
  43         log_info("%s", __func__);
  44
  45         fd = mkostemp_safe(fn);
  46         assert_se(fd >= 0);
  47         close(fd);
  48
  49         fd = mkostemp_safe(fn_copy);
  50         assert_se(fd >= 0);
  51         close(fd);
  52
  53         assert_se(write_string_file(fn, "foo bar bar bar foo", WRITE_STRING_FILE_CREATE) == 0);
  54
  55         assert_se(copy_file(fn, fn_copy, 0, 0644, 0) == 0);
  56
  57         assert_se(read_full_file(fn_copy, &buf, &sz) == 0);
  58         assert_se(streq(buf, "foo bar bar bar foo\n"));
  59         assert_se(sz == 20);
  60
  61         unlink(fn);
  62         unlink(fn_copy);
  63 }
  64
  65 static void test_copy_file_fd(void) {
  66         char in_fn[] = "/tmp/test-copy-file-fd-XXXXXX";
  67         char out_fn[] = "/tmp/test-copy-file-fd-XXXXXX";
  68         _cleanup_close_ int in_fd = -1, out_fd = -1;
  69         char text[] = "boohoo\nfoo\n\tbar\n";
  70         char buf[64] = {0};
  71
  72         log_info("%s", __func__);
  73
  74         in_fd = mkostemp_safe(in_fn);
  75         assert_se(in_fd >= 0);
  76         out_fd = mkostemp_safe(out_fn);
  77         assert_se(out_fd >= 0);
  78
  79         assert_se(write_string_file(in_fn, text, WRITE_STRING_FILE_CREATE) == 0);
  80         assert_se(copy_file_fd("/a/file/which/does/not/exist/i/guess", out_fd, true) < 0);
  81         assert_se(copy_file_fd(in_fn, out_fd, true) >= 0);
  82         assert_se(lseek(out_fd, SEEK_SET, 0) == 0);
  83
  84         assert_se(read(out_fd, buf, sizeof(buf)) == sizeof(text) - 1);
  85         assert_se(streq(buf, text));
  86
  87         unlink(in_fn);
  88         unlink(out_fn);
  89 }
  90
  91 static void test_copy_tree(void) {
  92         char original_dir[] = "/tmp/test-copy_tree/";
  93         char copy_dir[] = "/tmp/test-copy_tree-copy/";
  94         char **files = STRV_MAKE("file", "dir1/file", "dir1/dir2/file", "dir1/dir2/dir3/dir4/dir5/file");
  95         char **links = STRV_MAKE("link", "file",
  96                                  "link2", "dir1/file");
  97         char **p, **link;
  98         const char *unixsockp;
  99         struct stat st;
 100
 101         log_info("%s", __func__);
 102
 103         (void) rm_rf(copy_dir, REMOVE_ROOT|REMOVE_PHYSICAL);
 104         (void) rm_rf(original_dir, REMOVE_ROOT|REMOVE_PHYSICAL);
 105
 106         STRV_FOREACH(p, files) {
 107                 _cleanup_free_ char *f;
 108
 109                 assert_se(f = strappend(original_dir, *p));
 110
 111                 assert_se(mkdir_parents(f, 0755) >= 0);
 112                 assert_se(write_string_file(f, "file", WRITE_STRING_FILE_CREATE) == 0);
 113         }
 114
 115         STRV_FOREACH_PAIR(link, p, links) {
 116                 _cleanup_free_ char *f, *l;
 117
 118                 assert_se(f = strappend(original_dir, *p));
 119                 assert_se(l = strappend(original_dir, *link));
 120
 121                 assert_se(mkdir_parents(l, 0755) >= 0);
 122                 assert_se(symlink(f, l) == 0);
 123         }
 124
 125         unixsockp = strjoina(original_dir, "unixsock");
 126         assert_se(mknod(unixsockp, S_IFSOCK|0644, 0) >= 0);
 127
 128         assert_se(copy_tree(original_dir, copy_dir, true) == 0);
 129
 130         STRV_FOREACH(p, files) {
 131                 _cleanup_free_ char *buf = NULL, *f;
 132                 size_t sz = 0;
 133
 134                 assert_se(f = strappend(copy_dir, *p));
 135
 136                 assert_se(access(f, F_OK) == 0);
 137                 assert_se(read_full_file(f, &buf, &sz) == 0);
 138                 assert_se(streq(buf, "file\n"));
 139         }
 140
 141         STRV_FOREACH_PAIR(link, p, links) {
 142                 _cleanup_free_ char *target = NULL, *f, *l;
 143
 144                 assert_se(f = strjoin(original_dir, *p, NULL));
 145                 assert_se(l = strjoin(copy_dir, *link, NULL));
 146
 147                 assert_se(readlink_and_canonicalize(l, &target) == 0);
 148                 assert_se(path_equal(f, target));
 149         }
 150
 151         unixsockp = strjoina(copy_dir, "unixsock");
 152         assert_se(stat(unixsockp, &st) >= 0);
 153         assert_se(S_ISSOCK(st.st_mode));
 154
 155         assert_se(copy_tree(original_dir, copy_dir, false) < 0);
 156         assert_se(copy_tree("/tmp/inexistent/foo/bar/fsdoi", copy_dir, false) < 0);
 157
 158         (void) rm_rf(copy_dir, REMOVE_ROOT|REMOVE_PHYSICAL);
 159         (void) rm_rf(original_dir, REMOVE_ROOT|REMOVE_PHYSICAL);
 160 }
 161
 162 static void test_copy_bytes(void) {
 163         _cleanup_close_pair_ int pipefd[2] = {-1, -1};
 164         _cleanup_close_ int infd = -1;
 165         int r, r2;
 166         char buf[1024], buf2[1024];
 167
 168         infd = open("/usr/lib/os-release", O_RDONLY|O_CLOEXEC);
 169         if (infd < 0)
 170                 infd = open("/etc/os-release", O_RDONLY|O_CLOEXEC);
 171         assert_se(infd >= 0);
 172
 173         assert_se(pipe2(pipefd, O_CLOEXEC) == 0);
 174
 175         r = copy_bytes(infd, pipefd[1], (uint64_t) -1, false);
 176         assert_se(r == 0);
 177
 178         r = read(pipefd[0], buf, sizeof(buf));
 179         assert_se(r >= 0);
 180
 181         assert_se(lseek(infd, 0, SEEK_SET) == 0);
 182         r2 = read(infd, buf2, sizeof(buf2));
 183         assert_se(r == r2);
 184
 185         assert_se(strneq(buf, buf2, r));
 186
 187         /* test copy_bytes with invalid descriptors */
 188         r = copy_bytes(pipefd[0], pipefd[0], 1, false);
 189         assert_se(r == -EBADF);
 190
 191         r = copy_bytes(pipefd[1], pipefd[1], 1, false);
 192         assert_se(r == -EBADF);
 193
 194         r = copy_bytes(pipefd[1], infd, 1, false);
 195         assert_se(r == -EBADF);
 196 }
 197
 198 static void test_copy_bytes_regular_file(const char *src, bool try_reflink, uint64_t max_bytes) {
 199         char fn2[] = "/tmp/test-copy-file-XXXXXX";
 200         char fn3[] = "/tmp/test-copy-file-XXXXXX";
 201         _cleanup_close_ int fd = -1, fd2 = -1, fd3 = -1;
 202         int r;
 203         struct stat buf, buf2, buf3;
 204
 205         log_info("%s try_reflink=%s max_bytes=%" PRIu64, __func__, yes_no(try_reflink), max_bytes);
 206
 207         fd = open(src, O_RDONLY | O_CLOEXEC | O_NOCTTY);
 208         assert_se(fd >= 0);
 209
 210         fd2 = mkostemp_safe(fn2);
 211         assert_se(fd2 >= 0);
 212
 213         fd3 = mkostemp_safe(fn3);
 214         assert_se(fd3 >= 0);
 215
 216         r = copy_bytes(fd, fd2, max_bytes, try_reflink);
 217         if (max_bytes == (uint64_t) -1)
 218                 assert_se(r == 0);
 219         else
 220                 assert_se(IN_SET(r, 0, 1));
 221
 222         assert_se(lseek(fd2, 0, SEEK_SET) == 0);
 223
 224         r = copy_bytes(fd2, fd3, max_bytes, try_reflink);
 225         if (max_bytes == (uint64_t) -1)
 226                 assert_se(r == 0);
 227         else
 228                 /* We cannot distinguish between the input being exactly max_bytes
 229                  * or longer than max_bytes (without trying to read one more byte,
 230                  * or calling stat, or FION_READ, etc, and we don't want to do any
 231                  * of that). So we expect "truncation" since we know that file we
 232                  * are copying is exactly max_bytes bytes. */
 233                 assert_se(r == 1);
 234
 235         assert_se(fstat(fd, &buf) == 0);
 236         assert_se(fstat(fd2, &buf2) == 0);
 237         assert_se(fstat(fd3, &buf3) == 0);
 238
 239         assert_se((uint64_t) buf2.st_size == MIN((uint64_t) buf.st_size, max_bytes));
 240         assert_se(buf3.st_size == buf2.st_size);
 241
 242         unlink(fn2);
 243         unlink(fn3);
 244 }
 245
 246 int main(int argc, char *argv[]) {
 247         test_copy_file();
 248         test_copy_file_fd();
 249         test_copy_tree();
 250         test_copy_bytes();
 251         test_copy_bytes_regular_file(argv[0], false, (uint64_t) -1);
 252         test_copy_bytes_regular_file(argv[0], true, (uint64_t) -1);
 253         test_copy_bytes_regular_file(argv[0], false, 1000); /* smaller than copy buffer size */
 254         test_copy_bytes_regular_file(argv[0], true, 1000);
 255         test_copy_bytes_regular_file(argv[0], false, 32000); /* larger than copy buffer size */
 256         test_copy_bytes_regular_file(argv[0], true, 32000);
 257
 258         return 0;
 259 }