tests.c 5.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/* GIMP - The GNU Image Manipulation Program
 * Copyright (C) 2009 Martin Nordholts
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
15
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
16 17 18 19
 */

#include "config.h"

20 21
#include <stdlib.h>

22
#include <gegl.h>
23
#include <gtk/gtk.h>
24

25 26 27 28 29 30 31
#include "gui/gui-types.h"

#include "gui/gui.h"

#include "actions/actions.h"

#include "menus/menus.h"
32

33 34
#include "widgets/gimpsessioninfo.h"

35
#include "config/gimpgeglconfig.h"
36

37
#include "core/gimp.h"
38
#include "core/gimp-contexts.h"
39

40 41
#include "gegl/gimp-gegl.h"

42
#include "gimp-log.h"
43 44 45
#include "tests.h"


46 47 48 49 50 51 52
static void
gimp_status_func_dummy (const gchar *text1,
                        const gchar *text2,
                        gdouble      percentage)
{
}

53 54 55 56
/**
 * gimp_init_for_testing:
 *
 * Initialize the GIMP object system for unit testing. This is a
57
 * selected subset of the initialization happening in app_run().
58 59
 **/
Gimp *
60
gimp_init_for_testing (void)
61
{
62
  Gimp *gimp;
63

64
  gimp_log_init ();
65
  gegl_init (NULL, NULL);
66

67
  gimp = gimp_new ("Unit Tested GIMP", NULL, NULL, FALSE, TRUE, TRUE, TRUE,
68
                   FALSE, FALSE, TRUE, FALSE, FALSE,
69
                   GIMP_STACK_TRACE_QUERY, GIMP_PDB_COMPAT_OFF);
70 71 72

  gimp_load_config (gimp, NULL, NULL);

73
  gimp_gegl_init (gimp);
74
  gimp_initialize (gimp, gimp_status_func_dummy);
75
  gimp_restore (gimp, gimp_status_func_dummy, NULL);
76

77 78
  return gimp;
}
79 80 81 82


#ifndef GIMP_CONSOLE_COMPILATION

83 84 85 86 87
static void
gimp_init_icon_theme_for_testing (void)
{
  gchar       *icon_root;

88
  icon_root = g_test_build_filename (G_TEST_BUILT, "gimp-test-icon-theme", NULL);
89 90 91
  gtk_icon_theme_prepend_search_path (gtk_icon_theme_get_default (),
                                      icon_root);
  g_free (icon_root);
92
  return;
93 94
}

95
static Gimp *
96 97
gimp_init_for_gui_testing_internal (gboolean  show_gui,
                                    GFile    *gimprc)
98
{
99
  Gimp *gimp;
100

101 102 103 104 105 106 107 108 109 110 111 112
#if defined (G_OS_WIN32)
  /* g_test_init() sets warnings always fatal, which is a usually a good
     testing default. Nevertheless the Windows platform may have a few
     quirks generating warnings, yet we want to finish tests. So we
     allow some relaxed rules on this platform. */

  GLogLevelFlags fatal_mask;

  fatal_mask = (GLogLevelFlags) (G_LOG_FATAL_MASK | G_LOG_LEVEL_CRITICAL);
  g_log_set_always_fatal (fatal_mask);
#endif

113
  /* from main() */
114
  gimp_log_init ();
115
  gegl_init (NULL, NULL);
116

117
  /* Introduce an error margin for positions written to sessionrc */
118
  gimp_session_info_set_position_accuracy (5);
119

120
  /* from app_run() */
121
  gimp = gimp_new ("Unit Tested GIMP", NULL, NULL, FALSE, TRUE, TRUE, !show_gui,
122
                   FALSE, FALSE, TRUE, FALSE, FALSE,
123
                   GIMP_STACK_TRACE_QUERY, GIMP_PDB_COMPAT_OFF);
124

125
  gimp_set_show_gui (gimp, show_gui);
126
  gimp_load_config (gimp, gimprc, NULL);
127
  gimp_gegl_init (gimp);
128
  gui_init (gimp, TRUE);
129
  gimp_init_icon_theme_for_testing ();
130
  gimp_initialize (gimp, gimp_status_func_dummy);
131
  gimp_restore (gimp, gimp_status_func_dummy, NULL);
132 133 134 135

  return gimp;
}

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
/**
 * gimp_init_for_gui_testing:
 * @show_gui:
 *
 * Initializes a #Gimp instance for use in test cases that rely on GUI
 * code to be initialized.
 *
 * Returns: The #Gimp instance.
 **/
Gimp *
gimp_init_for_gui_testing (gboolean show_gui)
{
  return gimp_init_for_gui_testing_internal (show_gui, NULL);
}

/**
 * gimp_init_for_gui_testing:
 * @show_gui:
 * @gimprc:
 *
 * Like gimp_init_for_gui_testing(), but also allows a custom gimprc
 * filename to be specified.
 *
 * Returns: The #Gimp instance.
 **/
Gimp *
162 163
gimp_init_for_gui_testing_with_rc (gboolean  show_gui,
                                   GFile    *gimprc)
164 165 166 167
{
  return gimp_init_for_gui_testing_internal (show_gui, gimprc);
}

168
#endif /* GIMP_CONSOLE_COMPILATION */
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

static gboolean
gimp_tests_quit_mainloop (GMainLoop *loop)
{
  g_main_loop_quit (loop);

  return FALSE;
}

/**
 * gimp_test_run_temp_mainloop:
 * @running_time: The time to run the main loop.
 *
 * Helper function for tests that wants to run a main loop for a
 * while. Useful when you want GIMP's state to settle before doing
 * tests.
 **/
void
gimp_test_run_temp_mainloop (guint32 running_time)
{
  GMainLoop *loop;
  loop = g_main_loop_new (NULL, FALSE);

  g_timeout_add (running_time,
                 (GSourceFunc) gimp_tests_quit_mainloop,
                 loop);

  g_main_loop_run (loop);

  g_main_loop_unref (loop);
}

201 202 203 204 205 206 207 208 209 210
/**
 * gimp_test_run_mainloop_until_idle:
 *
 * Creates and runs a main loop until it is idle, i.e. has no more
 * work to do.
 **/
void
gimp_test_run_mainloop_until_idle (void)
{
  GMainLoop *loop = g_main_loop_new (NULL, FALSE);
211

212 213 214 215 216 217
  g_idle_add ((GSourceFunc) gimp_tests_quit_mainloop, loop);

  g_main_loop_run (loop);

  g_main_loop_unref (loop);
}
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234

/**
 * gimp_test_bail_if_no_display:
 * @void:
 *
 * If no DISPLAY is set, call exit(EXIT_SUCCESS). There is no use in
 * having UI tests failing in DISPLAY-less environments.
 **/
void
gimp_test_bail_if_no_display (void)
{
  if (! g_getenv ("DISPLAY"))
    {
      g_message ("No DISPLAY set, not running UI tests\n");
      exit (EXIT_SUCCESS);
    }
}