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