Utils: Add unit-test and documentation for type_traits.hh
[senf.git] / Console / ParsedCommand.test.cc
1 // $Id$
2 //
3 // Copyright (C) 2008 
4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 //     Stefan Bund <g0dil@berlios.de>
7 //
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2 of the License, or
11 // (at your option) any later version.
12 //
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 // GNU General Public License for more details.
17 //
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22
23 /** \file
24     \brief ParsedCommand.test unit tests */
25
26 //#include "ParsedCommand.test.hh"
27 //#include "ParsedCommand.test.ih"
28
29 // Custom includes
30 #include <iostream>
31 #include <sstream>
32 #include "ParsedCommand.hh"
33 #include "Executor.hh"
34 #include "Parse.hh"
35 #include "ScopedDirectory.hh"
36
37 #include "../Utils/auto_unit_test.hh"
38 #include <boost/test/test_tools.hpp>
39
40 #define prefix_
41 ///////////////////////////////cc.p////////////////////////////////////////
42
43 namespace {
44
45     int cb1(int a, double b) { return int(a+b); }
46     double cb2(){ return 1.2; }
47     void cb3(int i) { }
48     std::string cb4(std::ostream & os) { os << "text\n"; return "value"; }
49     void cb5(std::ostream & os, std::string v) { os << "Value: " << v << "\n"; }
50 }
51
52 BOOST_AUTO_UNIT_TEST(parsedCommand)
53 {
54     senf::console::Executor executor;
55     senf::console::CommandParser parser;
56     senf::console::ScopedDirectory<> dir;
57     senf::console::root().add("test", dir);
58
59     {
60         std::stringstream ss;
61         dir.add("cb1", &cb1);
62         parser.parse("test/cb1 2 3.2", 
63                      boost::bind<void>( boost::ref(executor), boost::ref(ss), _1 ));
64         BOOST_CHECK_EQUAL( ss.str(), "5\n" );
65     }
66
67     {
68         std::stringstream ss;
69         dir.add("cb2", &cb2);
70         parser.parse("test/cb2",
71                      boost::bind<void>( boost::ref(executor), boost::ref(ss), _1 ));
72         BOOST_CHECK_EQUAL( ss.str(), "1.2\n" );
73     }
74
75     {
76         std::stringstream ss;
77         dir.add("cb3", &cb3);
78         parser.parse("test/cb3 234",
79                      boost::bind<void>( boost::ref(executor), boost::ref(ss), _1 ));
80         BOOST_CHECK_EQUAL( ss.str(), "" );
81     }
82
83     {
84         std::stringstream ss;
85         dir.add("cb4", &cb4);
86         parser.parse("test/cb4",
87                      boost::bind<void>( boost::ref(executor), boost::ref(ss), _1 ));
88         BOOST_CHECK_EQUAL( ss.str(), "text\n" "value\n" );
89     }
90
91     {
92         std::stringstream ss;
93         dir.add("cb5", &cb5);
94         parser.parse("test/cb5 1234",
95                      boost::bind<void>( boost::ref(executor), boost::ref(ss), _1 ));
96         BOOST_CHECK_EQUAL( ss.str(), "Value: 1234\n" );
97     }
98
99     {
100         std::stringstream ss;
101
102         BOOST_CHECK_THROW( 
103             parser.parse("test/cb1 2 3.2 foo", 
104                          boost::bind<void>( boost::ref(executor), boost::ref(ss), _1 )),
105             senf::console::SyntaxErrorException );
106
107         BOOST_CHECK_THROW(
108             parser.parse("test/cb1 2", 
109                          boost::bind<void>( boost::ref(executor), boost::ref(ss), _1 )),
110             senf::console::SyntaxErrorException );
111
112         BOOST_CHECK_THROW(
113             parser.parse("test/cb1 2 foo", 
114                          boost::bind<void>( boost::ref(executor), boost::ref(ss), _1 )),
115             senf::console::SyntaxErrorException );
116     }
117
118     {
119         std::stringstream ss;
120
121         senf::console::OverloadedCommandNode & cbNode ( dir.add("cb", &cb1)
122             .doc(
123                 "Ops fortunate, ops me ut orgia vociferatio contumax per, rudo re loco emitto\n"
124                 "intolerabiliter ita iugo. Subcribo gravo. Devenio luna fonticulus Castanea\n"
125                 "horum fascino Os interpretor non ipse conjuratio hora, qui filius denuntio ait\n"
126                 "sono te odium Anhelo. Dum Cedo audax celox alius una Agnosco hic, ibi retineo\n"
127                 "lux sto ioco. Per Re dono. Copiose reus scitus jus diligens sis scapulare\n"
128                 "Servitium transi.")
129             .overloadDoc(
130                 "Lo nam balnearius Opprimo Pennatus, no decentia sui, dicto esse se pulchritudo,\n"
131                 "pupa Sive res indifferenter. Captivo pa.")
132             .arg("", "Bar didelfrump di desgorb. Nu widsoflar brimeldrgf.")
133             .arg("checkup", "Florgel, dargel and durgel", 2.1) );
134
135         dir.add("cb", &cb5)
136             .overloadDoc(
137                 "Uus Primordia fundo falsidicus corium, diurnitas humo pro leto. Sui Ueraciter\n"
138                 "hio eruca lenis qua Agalmate ut fors penitentia. Iugum obdormio anxio nuncupo\n"
139                 "iam, in vos nam Custodi.");
140
141         (void) cbNode;
142
143         dir.add("cb", &cb2);
144
145         parser.parse("test/cb 111 222.4; test/cb 222; test/cb foo; test/cb",
146                      boost::bind<void>( boost::ref(executor), boost::ref(ss), _1 ));
147         BOOST_CHECK_EQUAL( ss.str(), "333\n" "224\n" "Value: foo\n" "1.2\n" );
148     }
149
150     {
151         std::stringstream ss;
152         senf::console::root()["test"]("cb").help(ss);
153         BOOST_CHECK_EQUAL( 
154             ss.str(), 
155             "Usage:\n"
156             "    1- cb arg11:int [checkup:double]\n"
157             "    2- cb arg21:string\n"
158             "    3- cb\n"
159             "\n"
160             "With:\n"
161             "    arg11     Bar didelfrump di desgorb. Nu widsoflar brimeldrgf.\n"
162             "    checkup   Florgel, dargel and durgel\n"
163             "        default: 2.1\n"
164             "\n"
165             "Ops fortunate, ops me ut orgia vociferatio contumax per, rudo re loco emitto\n"
166             "intolerabiliter ita iugo. Subcribo gravo. Devenio luna fonticulus Castanea\n"
167             "horum fascino Os interpretor non ipse conjuratio hora, qui filius denuntio ait\n"
168             "sono te odium Anhelo. Dum Cedo audax celox alius una Agnosco hic, ibi retineo\n"
169             "lux sto ioco. Per Re dono. Copiose reus scitus jus diligens sis scapulare\n"
170             "Servitium transi.\n"
171             "\n"
172             "Variant 1:\n"
173             "Lo nam balnearius Opprimo Pennatus, no decentia sui, dicto esse se pulchritudo,\n"
174             "pupa Sive res indifferenter. Captivo pa.\n"
175             "\n"
176             "Variant 2:\n"
177             "Uus Primordia fundo falsidicus corium, diurnitas humo pro leto. Sui Ueraciter\n"
178             "hio eruca lenis qua Agalmate ut fors penitentia. Iugum obdormio anxio nuncupo\n"
179             "iam, in vos nam Custodi.\n" );
180     }
181 }
182
183 namespace {
184
185     struct Test 
186     {
187         senf::console::ScopedDirectory<Test> dir;
188         std::string name_;
189
190         Test(std::string const & name) : dir(this), name_ (name) {
191             dir.add("name", &Test::name);
192         }
193
194         std::string name(std::string const & suffix) {
195             return name_ + suffix;
196         }
197     };
198
199 }
200
201 BOOST_AUTO_UNIT_TEST(memberParsedCommand)
202 {
203     senf::console::Executor executor;
204     senf::console::CommandParser parser;
205     senf::console::ScopedDirectory<> dir;
206     senf::console::root().add("test", dir);
207     
208     {
209         Test obj ("bar");
210         dir.add("obj", obj.dir);
211         
212         std::stringstream ss;
213         parser.parse("test/obj/name \": foo\"",
214                      boost::bind<void>( boost::ref(executor), boost::ref(ss), _1 ));
215         BOOST_CHECK_EQUAL( ss.str(), "bar: foo\n" );
216     }
217 }
218     
219 ///////////////////////////////cc.e////////////////////////////////////////
220 #undef prefix_
221
222 \f
223 // Local Variables:
224 // mode: c++
225 // fill-column: 100
226 // comment-column: 40
227 // c-file-style: "senf"
228 // indent-tabs-mode: nil
229 // ispell-local-dictionary: "american"
230 // compile-command: "scons -u test"
231 // End: