Shuffle RESTful URL's around.
[asterisk/asterisk.git] / tests / test_locale.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2009, Digium, Inc.
5  *
6  * Tilghman Lesher <tlesher AT digium DOT com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Locale Test
22  *
23  * \author\verbatim Tilghman Lesher <tlesher AT digium DOT com> \endverbatim
24  * 
25  * \ingroup tests
26  */
27
28 /*** MODULEINFO
29         <depend>TEST_FRAMEWORK</depend>
30         <support_level>core</support_level>
31  ***/
32
33 #include "asterisk.h"
34
35 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
36
37 #include <sys/types.h>
38 #include <dirent.h>
39 #ifndef __USE_GNU
40 #define __USE_GNU 1
41 #endif
42 #include <locale.h>
43
44 #include "asterisk/cli.h"
45 #include "asterisk/linkedlists.h"
46 #include "asterisk/localtime.h"
47 #include "asterisk/utils.h"
48 #include "asterisk/module.h"
49
50
51 static char *handle_cli_test_locales(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
52 {
53         DIR *localedir;
54         struct dirent *dent;
55         struct ast_tm atm;
56         struct timeval tv;
57         const char *orig_locale;
58         char origlocalformat[200] = "", localformat[200] = "";
59         struct test_locales {
60                 AST_LIST_ENTRY(test_locales) list;
61                 char *localformat;
62                 char name[0];
63         } *tl = NULL;
64         AST_LIST_HEAD_NOLOCK(locales, test_locales) locales;
65         int varies = 0, all_successful = 1, count = 0, count_fail = 0;
66
67         switch (cmd) {
68         case CLI_INIT:
69                 e->command = "test locale";
70                 e->usage = ""
71                         "Usage: test locale\n"
72                         "   Test thread safety of locale functions.\n";
73                 return NULL;
74         case CLI_GENERATE:
75                 return NULL;
76         }
77
78         if (a->argc != e->args) {
79                 return CLI_SHOWUSAGE;
80         }
81
82         /* First we run a set of tests with the global locale, which isn't thread-safe. */
83         if (!(localedir = opendir(
84 #if defined(__FreeBSD__) || defined(__OpenBSD__) || defined( __NetBSD__ ) || defined(__APPLE__)
85                 "/usr/share/locale"
86 #else /* Linux */
87                 "/usr/lib/locale"
88 #endif
89                 ))) {
90                 ast_cli(a->fd, "No locales seem to exist on this platform.\n");
91                 return CLI_SUCCESS;
92         }
93
94         tv = ast_tvnow();
95         ast_localtime(&tv, &atm, NULL);
96         orig_locale = setlocale(LC_ALL, NULL);
97         AST_LIST_HEAD_SET_NOLOCK(&locales, NULL);
98
99         /* Get something different, to compare against. */
100         ast_strftime(origlocalformat, sizeof(origlocalformat), "%c", &atm);
101
102         while ((dent = readdir(localedir))) {
103                 size_t namelen;
104
105                 if (dent->d_name[0] == '.') {
106                         continue;
107                 }
108
109                 setlocale(LC_ALL, dent->d_name);
110                 ast_strftime(localformat, sizeof(localformat), "%c", &atm);
111
112                 /* Store values */
113                 if (!(tl = ast_calloc(1, sizeof(*tl) + strlen(localformat) + (namelen = strlen(dent->d_name)) + 2))) {
114                         continue;
115                 }
116
117                 strcpy(tl->name, dent->d_name); /* SAFE */
118                 tl->localformat = tl->name + namelen + 1;
119                 strcpy(tl->localformat, localformat); /* SAFE */
120
121                 AST_LIST_INSERT_TAIL(&locales, tl, list);
122
123                 /* Ensure that at least two entries differ, otherwise this test doesn't mean much. */
124                 if (!varies && strcmp(AST_LIST_FIRST(&locales)->localformat, localformat)) {
125                         varies = 1;
126                 }
127         }
128
129         setlocale(LC_ALL, orig_locale);
130
131         closedir(localedir);
132
133         if (!varies) {
134                 if (!strcmp(origlocalformat, localformat)) {
135                         ast_cli(a->fd, "WARNING: the locales on your system don't differ.  Install more locales if you want this test to mean something.\n");
136                 }
137         }
138
139         orig_locale = ast_setlocale(AST_LIST_FIRST(&locales)->name);
140
141         while ((tl = AST_LIST_REMOVE_HEAD(&locales, list))) {
142                 ast_setlocale(tl->name);
143                 ast_strftime(localformat, sizeof(localformat), "%c", &atm);
144                 if (strcmp(localformat, tl->localformat)) {
145                         ast_cli(a->fd, "WARNING: locale test fails for locale %s\n", tl->name);
146                         all_successful = 0;
147                         count_fail++;
148                 }
149                 ast_free(tl);
150                 count++;
151         }
152
153         ast_setlocale(orig_locale);
154
155         if (all_successful) {
156                 ast_cli(a->fd, "All %d locale tests successful\n", count);
157         } else if (count_fail == count && count > 0) {
158                 ast_cli(a->fd, "No locale tests successful out of %d tries\n", count);
159         } else if (count > 0) {
160                 ast_cli(a->fd, "Partial failure (%d/%d) for a %.0f%% failure rate\n", count_fail, count, count_fail * 100.0 / count);
161         } else {
162                 ast_cli(a->fd, "No locales tested.  Install more locales.\n");
163         }
164
165         return CLI_SUCCESS;
166 }
167
168 static struct ast_cli_entry cli_locales[] = {
169         AST_CLI_DEFINE(handle_cli_test_locales, "Test locales for thread-safety"),
170 };
171
172 static int unload_module(void)
173 {
174         ast_cli_unregister_multiple(cli_locales, ARRAY_LEN(cli_locales));
175         return 0;
176 }
177
178 static int load_module(void)
179 {
180         ast_cli_register_multiple(cli_locales, ARRAY_LEN(cli_locales));
181         return AST_MODULE_LOAD_SUCCESS;
182 }
183
184 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Locale tests");