tests/src/execute__execute_get_external_cmd_opts_from_config.c

   1 /*
   2    src - tests for execute_external_editor_or_viewer() function
   3
   4    Copyright (C) 2013
   5    The 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 #define TEST_SUITE_NAME "/src"
  27
  28 #include <config.h>
  29
  30 #include <check.h>
  31
  32 #include "lib/global.h"
  33 #include "lib/mcconfig.h"
  34 #include "lib/strutil.h"
  35 #include "lib/vfs/path.h"
  36 #include "src/vfs/local/local.c"
  37
  38 char *execute_get_external_cmd_opts_from_config (const char *command,
  39                                                  const vfs_path_t * filename_vpath, int start_line);
  40
  41 /* --------------------------------------------------------------------------------------------- */
  42
  43 /* @CapturedValue */
  44 static GPtrArray *mc_config_get_string__group__captured;
  45 /* @CapturedValue */
  46 static GPtrArray *mc_config_get_string__param__captured;
  47 /* @CapturedValue */
  48 static GPtrArray *mc_config_get_string__default_value__captured;
  49 /* @ThenReturnValue */
  50 static GPtrArray *mc_config_get_string__return_value;
  51
  52 /* @Mock */
  53 gchar *
  54 mc_config_get_string_raw (const mc_config_t * config_ignored, const gchar * group,
  55                           const gchar * param, const gchar * default_value)
  56 {
  57     char *return_value;
  58     (void) config_ignored;
  59
  60     g_ptr_array_add (mc_config_get_string__group__captured, g_strdup (group));
  61     g_ptr_array_add (mc_config_get_string__param__captured, g_strdup (param));
  62     g_ptr_array_add (mc_config_get_string__default_value__captured, g_strdup (default_value));
  63
  64     return_value = g_ptr_array_index (mc_config_get_string__return_value, 0);
  65     g_ptr_array_remove_index (mc_config_get_string__return_value, 0);
  66     return return_value;
  67 }
  68
  69 static void
  70 mc_config_get_string__init (void)
  71 {
  72     mc_config_get_string__group__captured = g_ptr_array_new ();
  73     mc_config_get_string__param__captured = g_ptr_array_new ();
  74     mc_config_get_string__default_value__captured = g_ptr_array_new ();
  75
  76     mc_config_get_string__return_value = g_ptr_array_new ();
  77 }
  78
  79 static void
  80 mc_config_get_string__deinit (void)
  81 {
  82     g_ptr_array_foreach (mc_config_get_string__group__captured, (GFunc) g_free, NULL);
  83     g_ptr_array_free (mc_config_get_string__group__captured, TRUE);
  84
  85     g_ptr_array_foreach (mc_config_get_string__param__captured, (GFunc) g_free, NULL);
  86     g_ptr_array_free (mc_config_get_string__param__captured, TRUE);
  87
  88     g_ptr_array_foreach (mc_config_get_string__default_value__captured, (GFunc) g_free, NULL);
  89     g_ptr_array_free (mc_config_get_string__default_value__captured, TRUE);
  90
  91     g_ptr_array_foreach (mc_config_get_string__return_value, (GFunc) g_free, NULL);
  92     g_ptr_array_free (mc_config_get_string__return_value, TRUE);
  93 }
  94
  95 /* --------------------------------------------------------------------------------------------- */
  96
  97 /* @Before */
  98 static void
  99 setup (void)
 100 {
 101     str_init_strings (NULL);
 102     vfs_init ();
 103     init_localfs ();
 104     vfs_setup_work_dir ();
 105
 106     mc_config_get_string__init ();
 107 }
 108
 109 /* --------------------------------------------------------------------------------------------- */
 110
 111 /* @After */
 112 static void
 113 teardown (void)
 114 {
 115     mc_config_get_string__deinit ();
 116
 117     vfs_shut ();
 118     str_uninit_strings ();
 119 }
 120
 121 /* --------------------------------------------------------------------------------------------- */
 122
 123 /* @DataSource("check_subtitute_ds") */
 124 /* *INDENT-OFF* */
 125 static const struct check_subtitute_ds
 126 {
 127     const char *config_opts_string;
 128     const char *app_name;
 129     const char *file_name;
 130     int  start_line;
 131     const char *expected_result;
 132 } check_subtitute_ds[] =
 133 {
 134     {
 135         "-a -b -c %filename \\%filename %filename:%lineno \\%lineno +%lineno",
 136         "some-editor",
 137         "/path/to/file",
 138         1234,
 139         "-a -b -c '/path/to/file' %filename '/path/to/file':1234 %lineno +1234",
 140     },
 141     {
 142         "%filename:\\\\\\\\\\\\%lineno",
 143         "some-editor",
 144         "/path/to/'f i\" l e \t\t\n",
 145         1234,
 146         "'/path/to/'\\''f i\" l e \t\t\n':\\\\\\\\\\\\1234",
 147     },
 148 };
 149 /* *INDENT-ON* */
 150
 151 /* @Test(dataSource = "check_subtitute_ds") */
 152 /* *INDENT-OFF* */
 153 START_TEST (check_if_filename_and_lineno_will_be_subtituted)
 154 /* *INDENT-ON* */
 155 {
 156     /* given */
 157     const struct check_subtitute_ds *data = &check_subtitute_ds[_i];
 158     char *actual_result;
 159     vfs_path_t *filename_vpath;
 160
 161     g_ptr_array_add (mc_config_get_string__return_value, g_strdup (data->config_opts_string));
 162     filename_vpath = vfs_path_from_str (data->file_name);
 163
 164     /* when */
 165     actual_result =
 166         execute_get_external_cmd_opts_from_config (data->app_name, filename_vpath,
 167                                                    data->start_line);
 168
 169     /* then */
 170
 171     /* check returned value */
 172     g_assert_cmpstr (actual_result, ==, data->expected_result);
 173
 174     /* check calls to mc_config_get_string() function */
 175     g_assert_cmpstr (g_ptr_array_index (mc_config_get_string__group__captured, 0), ==,
 176                      CONFIG_EXT_EDITOR_VIEWER_SECTION);
 177     g_assert_cmpstr (g_ptr_array_index (mc_config_get_string__param__captured, 0), ==,
 178                      data->app_name);
 179     g_assert_cmpstr (g_ptr_array_index (mc_config_get_string__default_value__captured, 0), ==,
 180                      NULL);
 181
 182     vfs_path_free (filename_vpath);
 183
 184 }
 185 /* *INDENT-OFF* */
 186 END_TEST
 187 /* *INDENT-ON* */
 188
 189 /* --------------------------------------------------------------------------------------------- */
 190
 191 int
 192 main (void)
 193 {
 194     int number_failed;
 195
 196     Suite *s = suite_create (TEST_SUITE_NAME);
 197     TCase *tc_core = tcase_create ("Core");
 198     SRunner *sr;
 199
 200     tcase_add_checked_fixture (tc_core, setup, teardown);
 201
 202     /* Add new tests here: *************** */
 203     tcase_add_loop_test (tc_core, check_if_filename_and_lineno_will_be_subtituted, 0,
 204                          sizeof (check_subtitute_ds) / sizeof (check_subtitute_ds[0]));
 205     /* *********************************** */
 206
 207     suite_add_tcase (s, tc_core);
 208     sr = srunner_create (s);
 209     srunner_set_log (sr, "execute__execute_get_external_cmd_opts_from_config.log");
 210     srunner_run_all (sr, CK_NORMAL);
 211     number_failed = srunner_ntests_failed (sr);
 212     srunner_free (sr);
 213     return (number_failed == 0) ? 0 : 1;
 214 }
 215
 216 /* --------------------------------------------------------------------------------------------- */