Merge "Revert "app_voicemail: Remove need to subscribe to stasis""
[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 #include <sys/types.h>
36 #include <dirent.h>
37 #ifndef __USE_GNU
38 #define __USE_GNU 1
39 #endif
40 #include <locale.h>
41
42 #include "asterisk/cli.h"
43 #include "asterisk/linkedlists.h"
44 #include "asterisk/localtime.h"
45 #include "asterisk/utils.h"
46 #include "asterisk/module.h"
47
48
49 static char *handle_cli_test_locales(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
50 {
51         DIR *localedir;
52         struct dirent *dent;
53         struct ast_tm atm;
54         struct timeval tv;
55         const char *orig_locale;
56         char origlocalformat[200] = "", localformat[200] = "";
57         struct test_locales {
58                 AST_LIST_ENTRY(test_locales) list;
59                 char *localformat;
60                 char name[0];
61         } *tl = NULL;
62         AST_LIST_HEAD_NOLOCK(locales, test_locales) locales;
63         int varies = 0, all_successful = 1, count = 0, count_fail = 0;
64
65         switch (cmd) {
66         case CLI_INIT:
67                 e->command = "test locale";
68                 e->usage = ""
69                         "Usage: test locale\n"
70                         "   Test thread safety of locale functions.\n";
71                 return NULL;
72         case CLI_GENERATE:
73                 return NULL;
74         }
75
76         if (a->argc != e->args) {
77                 return CLI_SHOWUSAGE;
78         }
79
80         /* First we run a set of tests with the global locale, which isn't thread-safe. */
81         if (!(localedir = opendir(
82 #if defined(__FreeBSD__) || defined(__OpenBSD__) || defined( __NetBSD__ ) || defined(__APPLE__)
83                 "/usr/share/locale"
84 #else /* Linux */
85                 "/usr/lib/locale"
86 #endif
87                 ))) {
88                 ast_cli(a->fd, "No locales seem to exist on this platform.\n");
89                 return CLI_SUCCESS;
90         }
91
92         tv = ast_tvnow();
93         ast_localtime(&tv, &atm, NULL);
94         orig_locale = setlocale(LC_ALL, NULL);
95         AST_LIST_HEAD_SET_NOLOCK(&locales, NULL);
96
97         /* Get something different, to compare against. */
98         ast_strftime(origlocalformat, sizeof(origlocalformat), "%c", &atm);
99
100         while ((dent = readdir(localedir))) {
101                 size_t namelen;
102
103                 if (dent->d_name[0] == '.') {
104                         continue;
105                 }
106
107                 setlocale(LC_ALL, dent->d_name);
108                 ast_strftime(localformat, sizeof(localformat), "%c", &atm);
109
110                 /* Store values */
111                 if (!(tl = ast_calloc(1, sizeof(*tl) + strlen(localformat) + (namelen = strlen(dent->d_name)) + 2))) {
112                         continue;
113                 }
114
115                 strcpy(tl->name, dent->d_name); /* SAFE */
116                 tl->localformat = tl->name + namelen + 1;
117                 strcpy(tl->localformat, localformat); /* SAFE */
118
119                 AST_LIST_INSERT_TAIL(&locales, tl, list);
120
121                 /* Ensure that at least two entries differ, otherwise this test doesn't mean much. */
122                 if (!varies && strcmp(AST_LIST_FIRST(&locales)->localformat, localformat)) {
123                         varies = 1;
124                 }
125         }
126
127         setlocale(LC_ALL, orig_locale);
128
129         closedir(localedir);
130
131         if (!varies) {
132                 if (!strcmp(origlocalformat, localformat)) {
133                         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");
134                 }
135         }
136
137         orig_locale = ast_setlocale(AST_LIST_FIRST(&locales)->name);
138
139         while ((tl = AST_LIST_REMOVE_HEAD(&locales, list))) {
140                 ast_setlocale(tl->name);
141                 ast_strftime(localformat, sizeof(localformat), "%c", &atm);
142                 if (strcmp(localformat, tl->localformat)) {
143                         ast_cli(a->fd, "WARNING: locale test fails for locale %s\n", tl->name);
144                         all_successful = 0;
145                         count_fail++;
146                 }
147                 ast_free(tl);
148                 count++;
149         }
150
151         ast_setlocale(orig_locale);
152
153         if (all_successful) {
154                 ast_cli(a->fd, "All %d locale tests successful\n", count);
155         } else if (count_fail == count && count > 0) {
156                 ast_cli(a->fd, "No locale tests successful out of %d tries\n", count);
157         } else if (count > 0) {
158                 ast_cli(a->fd, "Partial failure (%d/%d) for a %.0f%% failure rate\n", count_fail, count, count_fail * 100.0 / count);
159         } else {
160                 ast_cli(a->fd, "No locales tested.  Install more locales.\n");
161         }
162
163         return CLI_SUCCESS;
164 }
165
166 static struct ast_cli_entry cli_locales[] = {
167         AST_CLI_DEFINE(handle_cli_test_locales, "Test locales for thread-safety"),
168 };
169
170 static int unload_module(void)
171 {
172         ast_cli_unregister_multiple(cli_locales, ARRAY_LEN(cli_locales));
173         return 0;
174 }
175
176 static int load_module(void)
177 {
178         ast_cli_register_multiple(cli_locales, ARRAY_LEN(cli_locales));
179         return AST_MODULE_LOAD_SUCCESS;
180 }
181
182 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Locale tests");