tests/lib/utilunix__my_system-common.c

   1 /*
   2    lib - common code for testing lib/utilinux:my_system() function
   3
   4    Copyright (C) 2013-2017
   5    Free Software Foundation, Inc.
   6
   7    Written by:
   8    Slava Zanko <slavazanko@gmail.com>, 2013
   9
  10    This file is part of the Midnight Commander.
  11
  12    The Midnight Commander is free software: you can redistribute it
  13    and/or modify it under the terms of the GNU General Public License as
  14    published by the Free Software Foundation, either version 3 of the License,
  15    or (at your option) any later version.
  16
  17    The Midnight Commander is distributed in the hope that it will be useful,
  18    but WITHOUT ANY WARRANTY; without even the implied warranty of
  19    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20    GNU General Public License for more details.
  21
  22    You should have received a copy of the GNU General Public License
  23    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  24  */
  25
  26 #include <signal.h>
  27 #include <unistd.h>
  28
  29 #include "lib/vfs/vfs.h"
  30
  31 /* --------------------------------------------------------------------------------------------- */
  32
  33 /* @CapturedValue */
  34 static sigset_t *sigemptyset_set__captured;
  35 /* @ThenReturnValue */
  36 static int sigemptyset__return_value = 0;
  37
  38 /* @Mock */
  39 int
  40 sigemptyset (sigset_t * set)
  41 {
  42     sigemptyset_set__captured = set;
  43     return sigemptyset__return_value;
  44 }
  45
  46 /* --------------------------------------------------------------------------------------------- */
  47
  48 /* @CapturedValue */
  49 static GPtrArray *sigaction_signum__captured = NULL;
  50 /* @CapturedValue */
  51 static GPtrArray *sigaction_act__captured = NULL;
  52 /* @CapturedValue */
  53 static GPtrArray *sigaction_oldact__captured = NULL;
  54 /* @ThenReturnValue */
  55 static int sigaction__return_value = 0;
  56
  57 /* @Mock */
  58 int
  59 sigaction (int signum, const struct sigaction *act, struct sigaction *oldact)
  60 {
  61     int *tmp_signum;
  62     struct sigaction *tmp_act;
  63
  64     /* store signum */
  65     tmp_signum = g_new (int, 1);
  66     memcpy (tmp_signum, &signum, sizeof (*tmp_signum));
  67     if (sigaction_signum__captured != NULL)
  68         g_ptr_array_add (sigaction_signum__captured, tmp_signum);
  69
  70     /* store act */
  71     if (act != NULL)
  72     {
  73         tmp_act = g_new (struct sigaction, 1);
  74         memcpy (tmp_act, act, sizeof (*tmp_act));
  75     }
  76     else
  77         tmp_act = NULL;
  78     if (sigaction_act__captured != NULL)
  79         g_ptr_array_add (sigaction_act__captured, tmp_act);
  80
  81     /* store oldact */
  82     if (oldact != NULL)
  83     {
  84         tmp_act = g_new (struct sigaction, 1);
  85         memcpy (tmp_act, oldact, sizeof (*tmp_act));
  86     }
  87     else
  88         tmp_act = NULL;
  89     if (sigaction_oldact__captured != NULL)
  90         g_ptr_array_add (sigaction_oldact__captured, tmp_act);
  91
  92     return sigaction__return_value;
  93 }
  94
  95 static void
  96 sigaction__init (void)
  97 {
  98     sigaction_signum__captured = g_ptr_array_new ();
  99     sigaction_act__captured = g_ptr_array_new ();
 100     sigaction_oldact__captured = g_ptr_array_new ();
 101 }
 102
 103 static void
 104 sigaction__deinit (void)
 105 {
 106     g_ptr_array_foreach (sigaction_signum__captured, (GFunc) g_free, NULL);
 107     g_ptr_array_free (sigaction_signum__captured, TRUE);
 108     sigaction_signum__captured = NULL;
 109
 110     g_ptr_array_foreach (sigaction_act__captured, (GFunc) g_free, NULL);
 111     g_ptr_array_free (sigaction_act__captured, TRUE);
 112     sigaction_act__captured = NULL;
 113
 114     g_ptr_array_foreach (sigaction_oldact__captured, (GFunc) g_free, NULL);
 115     g_ptr_array_free (sigaction_oldact__captured, TRUE);
 116     sigaction_oldact__captured = NULL;
 117 }
 118
 119 /* --------------------------------------------------------------------------------------------- */
 120
 121 /* @CapturedValue */
 122 static GPtrArray *signal_signum__captured;
 123 /* @CapturedValue */
 124 static GPtrArray *signal_handler__captured;
 125 /* @ThenReturnValue */
 126 static sighandler_t signal__return_value = NULL;
 127
 128 /* @Mock */
 129 sighandler_t
 130 signal (int signum, sighandler_t handler)
 131 {
 132     int *tmp_signum;
 133     sighandler_t *tmp_handler;
 134
 135     /* store signum */
 136     tmp_signum = g_new (int, 1);
 137     memcpy (tmp_signum, &signum, sizeof (*tmp_signum));
 138     g_ptr_array_add (signal_signum__captured, tmp_signum);
 139
 140     /* store handler */
 141     if (handler != SIG_DFL)
 142     {
 143         tmp_handler = g_new (sighandler_t, 1);
 144         memcpy (tmp_handler, handler, sizeof (*tmp_handler));
 145     }
 146     else
 147         tmp_handler = (void *) SIG_DFL;
 148     g_ptr_array_add (signal_handler__captured, tmp_handler);
 149
 150     return signal__return_value;
 151 }
 152
 153 static void
 154 signal__init (void)
 155 {
 156     signal_signum__captured = g_ptr_array_new ();
 157     signal_handler__captured = g_ptr_array_new ();
 158 }
 159
 160 static void
 161 signal__deinit (void)
 162 {
 163     g_ptr_array_foreach (signal_signum__captured, (GFunc) g_free, NULL);
 164     g_ptr_array_free (signal_signum__captured, TRUE);
 165     signal_signum__captured = NULL;
 166
 167     g_ptr_array_foreach (signal_handler__captured, (GFunc) g_free, NULL);
 168     g_ptr_array_free (signal_handler__captured, TRUE);
 169     signal_handler__captured = NULL;
 170 }
 171
 172 /* --------------------------------------------------------------------------------------------- */
 173
 174 /* @ThenReturnValue */
 175 static pid_t fork__return_value;
 176
 177 /* @Mock */
 178 pid_t
 179 fork (void)
 180 {
 181     return fork__return_value;
 182 }
 183
 184 /* --------------------------------------------------------------------------------------------- */
 185 /* @CapturedValue */
 186 static int my_exit__status__captured;
 187
 188 /* @Mock */
 189 void
 190 my_exit (int status)
 191 {
 192     my_exit__status__captured = status;
 193 }
 194
 195 /* --------------------------------------------------------------------------------------------- */
 196
 197 /* @CapturedValue */
 198 static char *execvp__file__captured = NULL;
 199 /* @CapturedValue */
 200 static GPtrArray *execvp__args__captured;
 201 /* @ThenReturnValue */
 202 static int execvp__return_value = 0;
 203
 204 /* @Mock */
 205 int
 206 execvp (const char *file, char *const argv[])
 207 {
 208     char **one_arg;
 209     execvp__file__captured = g_strdup (file);
 210
 211     for (one_arg = (char **) argv; *one_arg != NULL; one_arg++)
 212         g_ptr_array_add (execvp__args__captured, g_strdup (*one_arg));
 213
 214     return execvp__return_value;
 215 }
 216
 217 static void
 218 execvp__init (void)
 219 {
 220     execvp__args__captured = g_ptr_array_new ();
 221 }
 222
 223 static void
 224 execvp__deinit (void)
 225 {
 226     g_ptr_array_foreach (execvp__args__captured, (GFunc) g_free, NULL);
 227     g_ptr_array_free (execvp__args__captured, TRUE);
 228     execvp__args__captured = NULL;
 229     MC_PTR_FREE (execvp__file__captured);
 230 }
 231
 232 /* --------------------------------------------------------------------------------------------- */
 233
 234 #define VERIFY_SIGACTION__ACT_IGNORED(_pntr) { \
 235     struct sigaction *_act = (struct sigaction *) _pntr; \
 236     mctest_assert_ptr_eq (_act->sa_handler, SIG_IGN); \
 237     mctest_assert_int_eq (_act->sa_flags, 0); \
 238 }
 239
 240 #define VERIFY_SIGACTION__IS_RESTORED(oldact_idx, act_idx) { \
 241     struct sigaction *_oldact = (struct sigaction *) g_ptr_array_index(sigaction_oldact__captured, oldact_idx); \
 242     struct sigaction *_act = (struct sigaction *) g_ptr_array_index(sigaction_act__captured, act_idx); \
 243     fail_unless (memcmp(_oldact, _act, sizeof(struct sigaction)) == 0, \
 244         "sigaction(): oldact[%d] should be equals to act[%d]", oldact_idx, act_idx); \
 245 }
 246
 247 /* @Verify */
 248 #define VERIFY_SIGACTION_CALLS() { \
 249     mctest_assert_int_eq (sigaction_signum__captured->len, 6); \
 250 \
 251     mctest_assert_int_eq (*((int *) g_ptr_array_index(sigaction_signum__captured, 0)), SIGINT); \
 252     mctest_assert_int_eq (*((int *) g_ptr_array_index(sigaction_signum__captured, 1)), SIGQUIT); \
 253     mctest_assert_int_eq (*((int *) g_ptr_array_index(sigaction_signum__captured, 2)), SIGTSTP); \
 254     mctest_assert_int_eq (*((int *) g_ptr_array_index(sigaction_signum__captured, 3)), SIGINT); \
 255     mctest_assert_int_eq (*((int *) g_ptr_array_index(sigaction_signum__captured, 4)), SIGQUIT); \
 256     mctest_assert_int_eq (*((int *) g_ptr_array_index(sigaction_signum__captured, 5)), SIGTSTP); \
 257 \
 258     VERIFY_SIGACTION__ACT_IGNORED(g_ptr_array_index(sigaction_act__captured, 0)); \
 259     VERIFY_SIGACTION__ACT_IGNORED(g_ptr_array_index(sigaction_act__captured, 1)); \
 260     { \
 261         struct sigaction *_act  = g_ptr_array_index(sigaction_act__captured, 2); \
 262         fail_unless (memcmp (_act, &startup_handler, sizeof(struct sigaction)) == 0, \
 263             "The 'act' in third call to sigaction() should be equals to startup_handler"); \
 264     } \
 265 \
 266     VERIFY_SIGACTION__IS_RESTORED (0, 3); \
 267     VERIFY_SIGACTION__IS_RESTORED (1, 4); \
 268     VERIFY_SIGACTION__IS_RESTORED (2, 5); \
 269 \
 270     fail_unless (g_ptr_array_index(sigaction_oldact__captured, 3) == NULL, \
 271         "oldact in fourth call to sigaction() should be NULL"); \
 272     fail_unless (g_ptr_array_index(sigaction_oldact__captured, 4) == NULL, \
 273         "oldact in fifth call to sigaction() should be NULL"); \
 274     fail_unless (g_ptr_array_index(sigaction_oldact__captured, 5) == NULL, \
 275         "oldact in sixth call to sigaction() should be NULL"); \
 276 }
 277
 278 /* --------------------------------------------------------------------------------------------- */
 279
 280 #define VERIFY_SIGNAL_HANDLER_IS_SIG_DFL(_idx) { \
 281     sighandler_t *tmp_handler = (sighandler_t *) g_ptr_array_index(signal_handler__captured, _idx);\
 282     mctest_assert_ptr_eq (tmp_handler, (sighandler_t *) SIG_DFL); \
 283 }
 284
 285 /* @Verify */
 286 #define VERIFY_SIGNAL_CALLS() { \
 287     mctest_assert_int_eq (signal_signum__captured->len, 4); \
 288     mctest_assert_int_eq (*((int *) g_ptr_array_index(signal_signum__captured, 0)), SIGINT); \
 289     mctest_assert_int_eq (*((int *) g_ptr_array_index(signal_signum__captured, 1)), SIGQUIT); \
 290     mctest_assert_int_eq (*((int *) g_ptr_array_index(signal_signum__captured, 2)), SIGTSTP); \
 291     mctest_assert_int_eq (*((int *) g_ptr_array_index(signal_signum__captured, 3)), SIGCHLD); \
 292     \
 293     VERIFY_SIGNAL_HANDLER_IS_SIG_DFL (0); \
 294     VERIFY_SIGNAL_HANDLER_IS_SIG_DFL (1); \
 295     VERIFY_SIGNAL_HANDLER_IS_SIG_DFL (2); \
 296     VERIFY_SIGNAL_HANDLER_IS_SIG_DFL (3); \
 297 }
 298
 299 /* --------------------------------------------------------------------------------------------- */
 300
 301 /* @Before */
 302 static void
 303 setup (void)
 304 {
 305     signal__return_value = NULL;
 306
 307     sigaction__init ();
 308     signal__init ();
 309     execvp__init ();
 310 }
 311
 312 /* --------------------------------------------------------------------------------------------- */
 313
 314 /* @After */
 315 static void
 316 teardown (void)
 317 {
 318     execvp__deinit ();
 319     signal__deinit ();
 320     sigaction__deinit ();
 321 }
 322
 323 /* --------------------------------------------------------------------------------------------- */