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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
// -----------------------------------------------------------------------------------------------------
// 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 <string>
#include <vector>
#include <gtest/gtest.h>
#include <seqan3/argument_parser/argument_parser.hpp>
#include <seqan3/argument_parser/detail/format_man.hpp>
// Reused global variables
struct format_man_test : public ::testing::Test
{
int option_value{5};
bool flag_value{};
int8_t non_list_pos_opt_value{1};
std::vector<std::string> list_pos_opt_value{};
std::string my_stdout{};
const char * argv[4] = {"./format_man_test --version-check 0", "--export-help", "man"};
std::string expected =
R"(.TH DEFAULT 1 "December 01, 1994" "default 01.01.01" "default_man_page_title")" "\n"
R"(.SH NAME)" "\n"
R"(default \- A short description here.)" "\n"
R"(.SH SYNOPSIS)" "\n"
R"(\fB./format_man_test\fP synopsis)" "\n"
R"(.br)" "\n"
R"(\fB./format_man_test\fP synopsis2)" "\n"
R"(.SH DESCRIPTION)" "\n"
R"(description)" "\n"
R"(.sp)" "\n"
R"(description2)" "\n"
R"(.SH POSITIONAL ARGUMENTS)" "\n"
R"(.TP)" "\n"
R"(\fBARGUMENT-1\fP (\fIsigned 8 bit integer\fP))" "\n"
R"(this is a positional option. )" "\n"
R"(.TP)" "\n"
R"(\fBARGUMENT-2\fP (\fIList\fP of \fIstd::string\fP's))" "\n"
R"(this is a positional option. Default: []. )" "\n"
R"(.SH OPTIONS)" "\n"
R"(.SS Basic options:)" "\n"
R"(.TP)" "\n"
R"(\fB-h\fP, \fB--help\fP)" "\n"
R"(Prints the help page.)" "\n"
R"(.TP)" "\n"
R"(\fB-hh\fP, \fB--advanced-help\fP)" "\n"
R"(Prints the help page including advanced options.)" "\n"
R"(.TP)" "\n"
R"(\fB--version\fP)" "\n"
R"(Prints the version information.)" "\n"
R"(.TP)" "\n"
R"(\fB--copyright\fP)" "\n"
R"(Prints the copyright/license information.)" "\n"
R"(.TP)" "\n"
R"(\fB--export-help\fP (std::string))" "\n"
R"(Export the help page information. Value must be one of [html, man].)" "\n"
R"(.TP)" "\n"
R"(\fB--version-check\fP (bool))" "\n"
R"(Whether to to check for the newest app version. Default: 1.)" "\n"
R"(.SS )" "\n"
R"(.TP)" "\n"
R"(\fB-i\fP, \fB--int\fP (\fIsigned 32 bit integer\fP))" "\n"
R"(this is a int option. Default: 5. )" "\n"
R"(.TP)" "\n"
R"(\fB-j\fP, \fB--jint\fP (\fIsigned 32 bit integer\fP))" "\n"
R"(this is a required int option. )" "\n"
R"(.SH FLAGS)" "\n"
R"(.SS SubFlags)" "\n"
R"(here come all the flags)" "\n"
R"(.TP)" "\n"
R"(\fB-f\fP, \fB--flag\fP)" "\n"
R"(this is a flag.)" "\n"
R"(.TP)" "\n"
R"(\fB-k\fP, \fB--kflag\fP)" "\n"
R"(this is a flag.)" "\n"
R"(.SH EXAMPLES)" "\n"
R"(example)" "\n"
R"(.sp)" "\n"
R"(example2)" "\n";
// Full info parser initialisation
void dummy_init(seqan3::argument_parser & parser)
{
parser.info.date = "December 01, 1994";
parser.info.version = "01.01.01";
parser.info.man_page_title = "default_man_page_title";
parser.info.short_description = "A short description here.";
parser.info.synopsis.push_back("./format_man_test synopsis");
parser.info.synopsis.push_back("./format_man_test synopsis2");
parser.info.description.push_back("description");
parser.info.description.push_back("description2");
parser.add_option(option_value, 'i', "int", "this is a int option.");
parser.add_option(option_value, 'j', "jint", "this is a required int option.", seqan3::option_spec::REQUIRED);
parser.add_section("Flags");
parser.add_subsection("SubFlags");
parser.add_line("here come all the flags");
parser.add_flag(flag_value, 'f', "flag", "this is a flag.");
parser.add_flag(flag_value, 'k', "kflag", "this is a flag.");
parser.add_positional_option(non_list_pos_opt_value, "this is a positional option.");
parser.add_positional_option(list_pos_opt_value, "this is a positional option.");
parser.info.examples.push_back("example");
parser.info.examples.push_back("example2");
}
};
TEST_F(format_man_test, empty_information)
{
// Create the dummy parser.
seqan3::argument_parser parser{"default", 3, argv};
parser.info.date = "December 01, 1994";
parser.info.version = "01.01.01";
parser.info.man_page_title = "default_man_page_title";
parser.info.short_description = "A short description here.";
std::string expected_short =
R"(.TH DEFAULT 1 "December 01, 1994" "default 01.01.01" "default_man_page_title")" "\n"
R"(.SH NAME)" "\n"
R"(default \- A short description here.)" "\n"
R"(.SH OPTIONS)" "\n"
R"(.SS Basic options:)" "\n"
R"(.TP)" "\n"
R"(\fB-h\fP, \fB--help\fP)" "\n"
R"(Prints the help page.)" "\n"
R"(.TP)" "\n"
R"(\fB-hh\fP, \fB--advanced-help\fP)" "\n"
R"(Prints the help page including advanced options.)" "\n"
R"(.TP)" "\n"
R"(\fB--version\fP)" "\n"
R"(Prints the version information.)" "\n"
R"(.TP)" "\n"
R"(\fB--copyright\fP)" "\n"
R"(Prints the copyright/license information.)" "\n"
R"(.TP)" "\n"
R"(\fB--export-help\fP (std::string))" "\n"
R"(Export the help page information. Value must be one of [html, man].)" "\n"
R"(.TP)" "\n"
R"(\fB--version-check\fP (bool))" "\n"
R"(Whether to to check for the newest app version. Default: 1.)" "\n"
R"(.SS )" "\n";
// Test the dummy parser with minimal information.
testing::internal::CaptureStdout();
EXPECT_EXIT(parser.parse(), ::testing::ExitedWithCode(EXIT_SUCCESS), "");
my_stdout = testing::internal::GetCapturedStdout();
EXPECT_EQ(my_stdout, expected_short);
}
TEST_F(format_man_test, full_information)
{
// Create the dummy parser.
seqan3::argument_parser parser{"default", 3, argv};
// Fill out the dummy parser with options and flags and sections and subsections.
dummy_init(parser);
// Test the dummy parser without any copyright or citations.
testing::internal::CaptureStdout();
EXPECT_EXIT(parser.parse(), ::testing::ExitedWithCode(EXIT_SUCCESS), "");
my_stdout = testing::internal::GetCapturedStdout();
EXPECT_EQ(my_stdout, expected);
}
TEST_F(format_man_test, full_info_short_copyright)
{
// Create the dummy parser.
seqan3::argument_parser parser{"default", 3, argv};
// Fill out the dummy parser with options and flags and sections and subsections.
dummy_init(parser);
// Add a short copyright and test the dummy parser.
parser.info.short_copyright = "short copyright";
expected += R"(.SH LEGAL
\fBdefault Copyright:\fR short copyright
.br
\fBSeqAn Copyright:\fR 2006-2015 Knut Reinert, FU-Berlin; released under the 3-clause BSDL.
.br
)";
testing::internal::CaptureStdout();
EXPECT_EXIT(parser.parse(), ::testing::ExitedWithCode(EXIT_SUCCESS), "");
my_stdout = testing::internal::GetCapturedStdout();
EXPECT_EQ(my_stdout, expected);
}
TEST_F(format_man_test, full_info_short_and_citation)
{
// Create the dummy parser.
seqan3::argument_parser parser{"default", 3, argv};
// Fill out the dummy parser with options and flags and sections and subsections.
dummy_init(parser);
// Add a short copyright & citation and test the dummy parser.
parser.info.short_copyright = "short copyright";
parser.info.citation = "citation";
expected += R"(.SH LEGAL
\fBdefault Copyright:\fR short copyright
.br
\fBSeqAn Copyright:\fR 2006-2015 Knut Reinert, FU-Berlin; released under the 3-clause BSDL.
.br
\fBIn your academic works please cite:\fR citation
.br
)";
testing::internal::CaptureStdout();
EXPECT_EXIT(parser.parse(), ::testing::ExitedWithCode(EXIT_SUCCESS), "");
my_stdout = testing::internal::GetCapturedStdout();
EXPECT_EQ(my_stdout, expected);
}
TEST_F(format_man_test, full_info_short_long_and_citation)
{
// Create the dummy parser.
seqan3::argument_parser parser{"default", 3, argv};
// Fill out the dummy parser with options and flags and sections and subsections.
dummy_init(parser);
// Add a short copyright & citation & long copyright and test the dummy parser.
parser.info.short_copyright = "short copyright";
parser.info.citation = "citation";
parser.info.long_copyright = "looong copyright";
expected += R"(.SH LEGAL
\fBdefault Copyright:\fR short copyright
.br
\fBSeqAn Copyright:\fR 2006-2015 Knut Reinert, FU-Berlin; released under the 3-clause BSDL.
.br
\fBIn your academic works please cite:\fR citation
.br
For full copyright and/or warranty information see \fB--copyright\fR.
)";
testing::internal::CaptureStdout();
EXPECT_EXIT(parser.parse(), ::testing::ExitedWithCode(EXIT_SUCCESS), "");
my_stdout = testing::internal::GetCapturedStdout();
EXPECT_EQ(my_stdout, expected);
}
|
