1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
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
162
163
164
165
166
167
168
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
|
// -----------------------------------------------------------------------------------------------------
// Copyright (c) 2006-2020, Knut Reinert & Freie Universität Berlin
// Copyright (c) 2016-2020, Knut Reinert & MPI für molekulare Genetik
// This file may be used, modified and/or redistributed under the terms of the 3-clause BSD-License
// shipped with this file and also available at: https://github.com/seqan/seqan3/blob/master/LICENSE.md
// -----------------------------------------------------------------------------------------------------
#include <gtest/gtest.h>
#include <seqan3/argument_parser/argument_parser.hpp>
#include <seqan3/argument_parser/detail/format_html.hpp>
#include <seqan3/core/char_operations/predicate.hpp>
TEST(html_format, empty_information)
{
std::string my_stdout;
std::string expected;
// Empty html help page.
const char * argv0[] = {"./help_add_test --version-check 0", "--export-help", "html"};
seqan3::argument_parser parser0{"empty_options", 3, argv0};
testing::internal::CaptureStdout();
EXPECT_EXIT(parser0.parse(), ::testing::ExitedWithCode(EXIT_SUCCESS), "");
my_stdout = testing::internal::GetCapturedStdout();
expected = std::string("<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\" http://www.w3.org/TR/html4/strict.dtd\">\n"
"<html lang=\"en\">\n"
"<head>\n"
"<meta http-equiv=\"content-type\" content=\"text/html; charset=utf-8\">\n"
"<title>empty_options — </title>\n"
"</head>\n"
"<body>\n"
"<h1>empty_options</h1>\n"
"<div></div>\n"
"<h2>Options</h2>\n"
"<h3>Basic options:</h3>\n"
"<dl>\n"
"<dt><strong>-h</strong>, <strong>--help</strong></dt>\n"
"<dd>Prints the help page.</dd>\n"
"<dt><strong>-hh</strong>, <strong>--advanced-help</strong></dt>\n"
"<dd>Prints the help page including advanced options.</dd>\n"
"<dt><strong>--version</strong></dt>\n"
"<dd>Prints the version information.</dd>\n"
"<dt><strong>--copyright</strong></dt>\n"
"<dd>Prints the copyright/license information.</dd>\n"
"<dt><strong>--export-help</strong> (std::string)</dt>\n"
"<dd>Export the help page information. Value must be one of [html, man].</dd>\n"
"<dt><strong>--version-check</strong> (bool)</dt>\n"
"<dd>Whether to to check for the newest app version. Default: 1.</dd>\n"
"</dl>\n"
"<h3></h3>\n"
"<h2>Version</h2>\n"
"<strong>Last update:</strong> <br>\n"
"<strong>empty_options version:</strong> <br>\n"
"<strong>SeqAn version:</strong> " + seqan3::seqan3_version + "<br>\n"
"<br>\n"
"</body></html>");
EXPECT_EQ(my_stdout, expected);
const char * argv1[] = {"./help_add_test --version-check 0", "--export-help=html"};
seqan3::argument_parser parser1{"empty_options", 2, argv1};
testing::internal::CaptureStdout();
EXPECT_EXIT(parser1.parse(), ::testing::ExitedWithCode(EXIT_SUCCESS), "");
my_stdout = testing::internal::GetCapturedStdout();
EXPECT_EQ(my_stdout, expected);
}
TEST(html_format, full_information_information)
{
std::string my_stdout;
std::string expected;
int option_value{5};
bool flag_value;
int8_t non_list_pos_opt_value{1};
std::vector<std::string> list_pos_opt_value{};
// Full html help page.
const char * argv0[] = {"./help_add_test --version-check 0", "--export-help", "html"};
seqan3::argument_parser parser1{"program_full_options", 3, argv0};
parser1.info.synopsis.push_back("./some_binary_name synopsis");
parser1.info.synopsis.push_back("./some_binary_name synopsis2");
parser1.info.description.push_back("description");
parser1.info.description.push_back("description2");
parser1.info.short_description = "short description";
parser1.info.url = "www.seqan.de";
parser1.info.short_copyright = "short copyright";
parser1.info.long_copyright = "long_copyright";
parser1.info.citation = "citation";
parser1.add_option(option_value, 'i', "int", "this is a int option.");
parser1.add_option(option_value, 'j', "jint", "this is a required int option.", seqan3::option_spec::REQUIRED);
parser1.add_flag(flag_value, 'f', "flag", "this is a flag.");
parser1.add_flag(flag_value, 'k', "kflag", "this is a flag.");
parser1.add_positional_option(non_list_pos_opt_value, "this is a positional option.");
parser1.add_positional_option(list_pos_opt_value, "this is a positional option.");
parser1.info.examples.push_back("example");
parser1.info.examples.push_back("example2");
testing::internal::CaptureStdout();
EXPECT_EXIT(parser1.parse(), ::testing::ExitedWithCode(EXIT_SUCCESS), "");
my_stdout = testing::internal::GetCapturedStdout();
expected = std::string("<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\" http://www.w3.org/TR/html4/strict.dtd\">\n"
"<html lang=\"en\">\n"
"<head>\n"
"<meta http-equiv=\"content-type\" content=\"text/html; charset=utf-8\">\n"
"<title>program_full_options — short description</title>\n"
"</head>\n"
"<body>\n"
"<h1>program_full_options</h1>\n"
"<div>short description</div>\n"
"<h2>Synopsis</h2>\n"
"<p>\n"
"<strong>./some_binary_name</strong> synopsis\n"
"<br />\n"
"<strong>./some_binary_name</strong> synopsis2\n"
"<br />\n"
"</p>\n"
"<h2>Description</h2>\n"
"<p>\n"
"description\n"
"</p>\n"
"<p>\n"
"description2\n"
"</p>\n"
"<h2>Positional Arguments</h2>\n"
"<dl>\n"
"<dt><strong>ARGUMENT-1</strong> (<em>signed 8 bit integer</em>)</dt>\n"
"<dd>this is a positional option. </dd>\n"
"<dt><strong>ARGUMENT-2</strong> (<em>List</em> of <em>std::string</em>'s)</dt>\n"
"<dd>this is a positional option. Default: []. </dd>\n"
"</dl>\n"
"<h2>Options</h2>\n"
"<h3>Basic options:</h3>\n"
"<dl>\n"
"<dt><strong>-h</strong>, <strong>--help</strong></dt>\n"
"<dd>Prints the help page.</dd>\n"
"<dt><strong>-hh</strong>, <strong>--advanced-help</strong></dt>\n"
"<dd>Prints the help page including advanced options.</dd>\n"
"<dt><strong>--version</strong></dt>\n"
"<dd>Prints the version information.</dd>\n"
"<dt><strong>--copyright</strong></dt>\n"
"<dd>Prints the copyright/license information.</dd>\n"
"<dt><strong>--export-help</strong> (std::string)</dt>\n"
"<dd>Export the help page information. Value must be one of [html, man].</dd>\n"
"<dt><strong>--version-check</strong> (bool)</dt>\n"
"<dd>Whether to to check for the newest app version. Default: 1.</dd>\n"
"</dl>\n"
"<h3></h3>\n"
"<dl>\n"
"<dt><strong>-i</strong>, <strong>--int</strong> (<em>signed 32 bit integer</em>)</dt>\n"
"<dd>this is a int option. Default: 5. </dd>\n"
"<dt><strong>-j</strong>, <strong>--jint</strong> (<em>signed 32 bit integer</em>)</dt>\n"
"<dd>this is a required int option. </dd>\n"
"<dt><strong>-f</strong>, <strong>--flag</strong></dt>\n"
"<dd>this is a flag.</dd>\n"
"<dt><strong>-k</strong>, <strong>--kflag</strong></dt>\n"
"<dd>this is a flag.</dd>\n"
"</dl>\n"
"<h2>Examples</h2>\n"
"<p>\n"
"example\n"
"</p>\n"
"<p>\n"
"example2\n"
"</p>\n"
"<h2>Version</h2>\n"
"<strong>Last update:</strong> <br>\n"
"<strong>program_full_options version:</strong> <br>\n"
"<strong>SeqAn version:</strong> " + seqan3::seqan3_version + "<br>\n"
"<h2>Url</h2>\n"
"www.seqan.de<br>\n"
"<br>\n"
"<h2>Legal</h2>\n"
"<strong>program_full_options Copyright: </strong>short copyright<br>\n"
"<strong>SeqAn Copyright:</strong> 2006-2019 Knut Reinert, FU-Berlin; released under the 3-clause BSDL.<br>\n"
"<strong>In your academic works please cite:</strong> citation<br>\n"
"For full copyright and/or warranty information see <tt>--copyright</tt>.\n"
"</body></html>");
EXPECT_EQ(my_stdout, expected);
}
TEST(export_help, parse_error)
{
const char * argv[] = {"./help_add_test --version-check 0", "--export-help"};
const char * argv2[] = {"./help_add_test --version-check 0", "--export-help=atml"};
const char * argv3[] = {"./help_add_test --version-check 0", "--export-help", "atml"};
// no value after --export-help
EXPECT_THROW((seqan3::argument_parser{"test_parser", 2, argv}), seqan3::argument_parser_error);
// wrong value after --export-help
EXPECT_THROW((seqan3::argument_parser{"test_parser", 2, argv2}), seqan3::validation_error);
// wrong value after --export-help
EXPECT_THROW((seqan3::argument_parser{"test_parser", 3, argv3}), seqan3::validation_error);
}
|
