about summary refs log tree commit diff
path: root/io/tst-file_change_detection.c
blob: 6e00e787b1b8e7245714d638497c9b20d0e4bce1 (plain) (blame)
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
/* Test for <file_change_detection.c>.
   Copyright (C) 2020 Free Software Foundation, Inc.
   This file is part of the GNU C Library.

   The GNU C Library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.

   The GNU C Library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with the GNU C Library; if not, see
   <https://www.gnu.org/licenses/>.  */

#include <file_change_detection.h>

#include <array_length.h>
#include <stdlib.h>
#include <support/check.h>
#include <support/support.h>
#include <support/temp_file.h>
#include <support/test-driver.h>
#include <support/xstdio.h>
#include <support/xunistd.h>
#include <unistd.h>

static void
all_same (struct file_change_detection *array, size_t length)
{
  for (size_t i = 0; i < length; ++i)
    for (size_t j = 0; j < length; ++j)
      {
        if (test_verbose > 0)
          printf ("info: comparing %zu and %zu\n", i, j);
        TEST_VERIFY (__file_is_unchanged (array + i, array + j));
      }
}

static void
all_different (struct file_change_detection *array, size_t length)
{
  for (size_t i = 0; i < length; ++i)
    for (size_t j = 0; j < length; ++j)
      {
        if (i == j)
          continue;
        if (test_verbose > 0)
          printf ("info: comparing %zu and %zu\n", i, j);
        TEST_VERIFY (!__file_is_unchanged (array + i, array + j));
      }
}

static int
do_test (void)
{
  /* Use a temporary directory with various paths.  */
  char *tempdir = support_create_temp_directory ("tst-file_change_detection-");

  char *path_dangling = xasprintf ("%s/dangling", tempdir);
  char *path_does_not_exist = xasprintf ("%s/does-not-exist", tempdir);
  char *path_empty1 = xasprintf ("%s/empty1", tempdir);
  char *path_empty2 = xasprintf ("%s/empty2", tempdir);
  char *path_fifo = xasprintf ("%s/fifo", tempdir);
  char *path_file1 = xasprintf ("%s/file1", tempdir);
  char *path_file2 = xasprintf ("%s/file2", tempdir);
  char *path_loop = xasprintf ("%s/loop", tempdir);
  char *path_to_empty1 = xasprintf ("%s/to-empty1", tempdir);
  char *path_to_file1 = xasprintf ("%s/to-file1", tempdir);

  add_temp_file (path_dangling);
  add_temp_file (path_empty1);
  add_temp_file (path_empty2);
  add_temp_file (path_fifo);
  add_temp_file (path_file1);
  add_temp_file (path_file2);
  add_temp_file (path_loop);
  add_temp_file (path_to_empty1);
  add_temp_file (path_to_file1);

  xsymlink ("target-does-not-exist", path_dangling);
  support_write_file_string (path_empty1, "");
  support_write_file_string (path_empty2, "");
  TEST_COMPARE (mknod (path_fifo, 0777 | S_IFIFO, 0), 0);
  support_write_file_string (path_file1, "line\n");
  support_write_file_string (path_file2, "line\n");
  xsymlink ("loop", path_loop);
  xsymlink ("empty1", path_to_empty1);
  xsymlink ("file1", path_to_file1);

  FILE *fp_file1 = xfopen (path_file1, "r");
  FILE *fp_file2 = xfopen (path_file2, "r");
  FILE *fp_empty1 = xfopen (path_empty1, "r");
  FILE *fp_empty2 = xfopen (path_empty2, "r");

  /* Test for the same (empty) files.  */
  {
    struct file_change_detection fcd[10];
    int i = 0;
    /* Two empty files always have the same contents.  */
    TEST_VERIFY (__file_change_detection_for_path (&fcd[i++], path_empty1));
    TEST_VERIFY (__file_change_detection_for_path (&fcd[i++], path_empty2));
    /* So does a missing file (which is treated as empty).  */
    TEST_VERIFY (__file_change_detection_for_path (&fcd[i++],
                                                   path_does_not_exist));
    /* And a symbolic link loop.  */
    TEST_VERIFY (__file_change_detection_for_path (&fcd[i++], path_loop));
    /* And a dangling symbolic link.  */
    TEST_VERIFY (__file_change_detection_for_path (&fcd[i++], path_dangling));
    /* And a directory.  */
    TEST_VERIFY (__file_change_detection_for_path (&fcd[i++], tempdir));
    /* And a symbolic link to an empty file.  */
    TEST_VERIFY (__file_change_detection_for_path (&fcd[i++], path_to_empty1));
    /* Likewise for access the file via a FILE *.  */
    TEST_VERIFY (__file_change_detection_for_fp (&fcd[i++], fp_empty1));
    TEST_VERIFY (__file_change_detection_for_fp (&fcd[i++], fp_empty2));
    /* And a NULL FILE * (missing file).  */
    TEST_VERIFY (__file_change_detection_for_fp (&fcd[i++], NULL));
    TEST_COMPARE (i, array_length (fcd));

    all_same (fcd, array_length (fcd));
  }

  /* Symbolic links are resolved.  */
  {
    struct file_change_detection fcd[3];
    int i = 0;
    TEST_VERIFY (__file_change_detection_for_path (&fcd[i++], path_file1));
    TEST_VERIFY (__file_change_detection_for_path (&fcd[i++], path_to_file1));
    TEST_VERIFY (__file_change_detection_for_fp (&fcd[i++], fp_file1));
    TEST_COMPARE (i, array_length (fcd));
    all_same (fcd, array_length (fcd));
  }

  /* Test for different files.  */
  {
    struct file_change_detection fcd[5];
    int i = 0;
    /* The other files are not empty.  */
    TEST_VERIFY (__file_change_detection_for_path (&fcd[i++], path_empty1));
    /* These two files have the same contents, but have different file
       identity.  */
    TEST_VERIFY (__file_change_detection_for_path (&fcd[i++], path_file1));
    TEST_VERIFY (__file_change_detection_for_path (&fcd[i++], path_file2));
    /* FIFOs are always different, even with themselves.  */
    TEST_VERIFY (__file_change_detection_for_path (&fcd[i++], path_fifo));
    TEST_VERIFY (__file_change_detection_for_path (&fcd[i++], path_fifo));
    TEST_COMPARE (i, array_length (fcd));
    all_different (fcd, array_length (fcd));

    /* Replacing the file with its symbolic link does not make a
       difference.  */
    TEST_VERIFY (__file_change_detection_for_path (&fcd[1], path_to_file1));
    all_different (fcd, array_length (fcd));
  }

  /* Wait for a file change.  Depending on file system time stamp
     resolution, this subtest blocks for a while.  */
  for (int use_stdio = 0; use_stdio < 2; ++use_stdio)
    {
      struct file_change_detection initial;
      TEST_VERIFY (__file_change_detection_for_path (&initial, path_file1));
      while (true)
        {
          support_write_file_string (path_file1, "line\n");
          struct file_change_detection current;
          if (use_stdio)
            TEST_VERIFY (__file_change_detection_for_fp (&current, fp_file1));
          else
            TEST_VERIFY (__file_change_detection_for_path
                         (&current, path_file1));
          if (!__file_is_unchanged (&initial, &current))
            break;
          /* Wait for a bit to reduce system load.  */
          usleep (100 * 1000);
        }
    }

  fclose (fp_empty1);
  fclose (fp_empty2);
  fclose (fp_file1);
  fclose (fp_file2);

  free (path_dangling);
  free (path_does_not_exist);
  free (path_empty1);
  free (path_empty2);
  free (path_fifo);
  free (path_file1);
  free (path_file2);
  free (path_loop);
  free (path_to_empty1);
  free (path_to_file1);

  free (tempdir);

  return 0;
}

#include <support/test-driver.c>