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
241
242
243
244
245
246
247
248
249
250
|
//
// Note: This example test is leveraging the Mocha test framework.
// Please refer to their documentation on https://mochajs.org/ for help.
//
// The module 'assert' provides assertion methods from node
import * as assert from "assert";
// You can import and use all API from the 'vscode' module
// as well as import your extension to test it
import * as moment from "moment";
import * as vscode from "vscode";
import { Config } from "../../Config";
import TestSetup from "./TestSetup";
// Defines a Mocha test suite to group tests of similar kind together
suite("C++ - Configuration Tests", () => {
const testSetup: TestSetup = new TestSetup("void foo();");
// Tests
test("Default config", () => {
testSetup.cfg = new Config();
const result = testSetup.SetLine("template<typename T> bool foo(T a);").GetResult();
assert.strictEqual("/**\n * @brief \n * \n * @tparam T \n * @param a \n * "
+ "@return true \n * @return false \n */", result);
});
test("Comment order", () => {
testSetup.cfg = new Config();
testSetup.cfg.Generic.order = ["brief", "param", "tparam", "return"];
const result = testSetup.SetLine("template<typename T> bool foo(T a);").GetResult();
assert.strictEqual("/**\n * @brief \n * @param a \n * @tparam T \n * "
+ "@return true \n * @return false \n */", result);
});
test("Non existing order param", () => {
testSetup.cfg = new Config();
testSetup.cfg.Generic.order = ["breif"];
const result = testSetup.SetLine("template<typename T> bool foo(T a);").GetResult();
assert.strictEqual("/**\n */", result);
});
test("Modified template", () => {
testSetup.cfg = new Config();
testSetup.cfg.C.firstLine = "";
testSetup.cfg.C.lastLine = "";
testSetup.cfg.C.commentPrefix = "/// ";
testSetup.cfg.Generic.briefTemplate = "\\brief ";
testSetup.cfg.Generic.paramTemplate = "\\param {param} ";
testSetup.cfg.Cpp.tparamTemplate = "\\tparam {param} ";
testSetup.cfg.Generic.returnTemplate = "\\return {type} ";
const result = testSetup.SetLine("template<typename T> bool foo(T a);").GetResult();
assert.strictEqual("/// \\brief \n/// \n/// \\tparam T \n/// \\param a \n"
+ "/// \\return true \n/// \\return false ", result);
});
test("Disable true false on bool", () => {
testSetup.cfg = new Config();
testSetup.cfg.Generic.boolReturnsTrueFalse = false;
const result = testSetup.SetLine("template<typename T> bool foo(T a);").GetResult();
assert.strictEqual("/**\n * @brief \n * \n * @tparam T \n * @param a \n"
+ " * @return bool \n */", result);
});
test("Disable including return type.", () => {
testSetup.cfg = new Config();
testSetup.cfg.Generic.includeTypeAtReturn = false;
const result = testSetup.SetLine("template<typename T> bool foo(T a);").GetResult();
assert.strictEqual("/**\n * @brief \n * \n * @tparam T \n * @param a \n"
+ " * @return \n */", result);
});
test("Newlines after params and tparams but not after brief", () => {
testSetup.cfg = new Config();
testSetup.cfg.Generic.order = ["brief", "tparam", "empty", "param", "empty", "return"];
const result = testSetup.SetLine("template<typename T> bool foo(T a);").GetResult();
testSetup.cfg.Generic.order = ["brief", "empty", "tparam", "param", "return"]; // reset to default
assert.strictEqual("/**\n * @brief \n * @tparam T \n * \n * @param a \n * \n"
+ " * @return true \n * @return false \n */", result);
});
test("Indentation test", () => {
testSetup.cfg = new Config();
let result = testSetup.SetLine("\ttemplate<typename T> bool foo(T a);").GetResult();
assert.strictEqual("/**\n\t * @brief \n\t * \n\t * @tparam T \n\t * @param a \n\t * "
+ "@return true \n\t * @return false \n\t */", result);
result = testSetup.SetLine(" template<typename T> bool foo(T a);").GetResult();
assert.strictEqual("/**\n * @brief \n * \n * @tparam T "
+ "\n * @param a \n * "
+ "@return true \n * @return false \n */", result);
});
test("Lines to get test", () => {
testSetup.cfg = new Config();
testSetup.cfg.Generic.linesToGet = 2;
const positiveResult = testSetup.SetLines(["template<typename T> bool \n", "foo(T a);"]).GetResult();
assert.strictEqual("/**\n * @brief \n * \n * @tparam T \n * @param a \n * "
+ "@return true \n * @return false \n */", positiveResult);
testSetup.cfg.Generic.linesToGet = 0;
testSetup.firstLine = 1;
const negativeResult = testSetup.SetLines(["template<typename T> bool \n", "foo(T a);"]).GetResult();
assert.strictEqual("/**\n * @brief \n * \n */", negativeResult);
});
test("File description order test", () => {
testSetup.cfg = new Config();
testSetup.firstLine = 0;
testSetup.cfg.File.fileOrder = ["brief", "author", "date", "file"];
const result = testSetup.SetLine("").GetResult();
assert.strictEqual("/**\n * @brief \n * @author your name (you@domain.com)\n" +
" * @date " + moment().format("YYYY-MM-DD") + "\n * @file MockDocument.h\n */", result);
});
test("Custom smart text Ctor", () => {
testSetup.cfg.Cpp.ctorText = "Test {name}";
const result = testSetup.SetLine("Foo();").GetResult();
assert.strictEqual("/**\n * @brief Test Foo\n * \n */", result);
});
test("Custom smart text Dtor", () => {
testSetup.cfg.Cpp.dtorText = "Test {name}";
const result = testSetup.SetLine("~Foo();").GetResult();
assert.strictEqual("/**\n * @brief Test Foo\n * \n */", result);
});
test("Custom smart text getter", () => {
testSetup.cfg.C.getterText = "Test {name}";
const result = testSetup.SetLine("int getFoo();").GetResult();
assert.strictEqual("/**\n * @brief Test Foo\n * \n * @return int \n */", result);
});
test("Custom smart text setter", () => {
testSetup.cfg.C.setterText = "Test {name}";
const result = testSetup.SetLine("void setFoo(int foo);").GetResult();
assert.strictEqual("/**\n * @brief Test Foo\n * \n * @param foo \n */", result);
});
test("Custom smart text factory method", () => {
testSetup.cfg.C.factoryMethodText = "Test {name}";
const result = testSetup.SetLine("int createFoo();").GetResult();
assert.strictEqual("/**\n * @brief Test Foo\n * \n * @return int \n */", result);
});
test("Don't split casing for smart text", () => {
testSetup.cfg.C.factoryMethodText = "Test {name}";
testSetup.cfg.Generic.splitCasingSmartText = false;
const result = testSetup.SetLine("int createFooObject();").GetResult();
assert.strictEqual("/**\n * @brief Test FooObject\n * \n * @return int \n */", result);
});
test("Remove inserted '*/' from line", () => {
const result = testSetup.SetLines(["*/", "int foo();"]).GetResult();
assert.strictEqual("/**\n * @brief \n * \n * @return int \n */", result);
});
test("Single alignment", () => {
testSetup.cfg.Generic.paramTemplate = "@param{indent:10}{param}";
testSetup.cfg.Cpp.tparamTemplate = "@tparam{indent:10}{param}";
testSetup.cfg.Generic.returnTemplate = "@return{indent:10}{type}";
testSetup.cfg.Generic.briefTemplate = "@brief{indent:10}Brief";
const result = testSetup.SetLines(["template<typename T>", "int foo(std::string bar, T foobar);"]).GetResult();
// tslint:disable-next-line:max-line-length
assert.strictEqual("/**\n * @brief Brief\n * \n * @tparam T\n * @param bar\n * @param foobar\n * @return int\n */", result);
});
test("Multi alignment", () => {
testSetup.cfg.Generic.paramTemplate = "@param{indent:10}{param}{indent:30}Parameters everywhere";
testSetup.cfg.Cpp.tparamTemplate = "@tparam{indent:10}{param}{indent:30}I'm a template";
testSetup.cfg.Generic.returnTemplate = "@return{indent:10}{type}{indent:30}Returns stuff";
testSetup.cfg.Generic.briefTemplate = "@brief{indent:30}Short desc";
const result = testSetup.SetLines(["template<typename T>", "int foo(std::string bar, T foobar);"]).GetResult();
// tslint:disable-next-line:max-line-length
assert.equal("/**\n * @brief Short desc\n * \n * @tparam T I'm a template\n * @param bar Parameters everywhere\n * @param foobar Parameters everywhere\n * @return int Returns stuff\n */", result);
});
test("Negative alignment tests", () => {
testSetup.cfg.Generic.returnTemplate = "";
const result = testSetup.SetLines(["template<typename T>", "int foo(std::string bar, T foobar);"]).GetResult();
// tslint:disable-next-line:max-line-length
assert.equal("/**\n * @brief Short desc\n * \n * @tparam T I'm a template\n * @param bar Parameters everywhere\n * @param foobar Parameters everywhere\n */", result);
});
test("Multiline template", () => {
testSetup.cfg.C.commentPrefix = "/// ";
testSetup.cfg.C.firstLine = "";
testSetup.cfg.C.lastLine = "";
testSetup.cfg.Generic.briefTemplate = "<summary>\n{text}\n</summary>";
testSetup.cfg.Generic.paramTemplate = "<param name=\"{param}\">\n</param>";
testSetup.cfg.Generic.returnTemplate = "<returns>\n</returns>";
const result = testSetup.SetLine(" int foo(bool a);").GetResult();
// tslint:disable:no-trailing-whitespace
assert.strictEqual(
result, `/// <summary>
///
/// </summary>
///
/// <param name="a">
/// </param>
/// <returns>
/// </returns>`,
);
// tslint:enable:no-trailing-whitespace
});
test("Macro define in funtion", () => {
testSetup.cfg = new Config();
testSetup.cfg.Generic.filteredKeywords = ["MOCKABLE"];
// tslint:disable-next-line:max-line-length
const result = testSetup.SetLine("MOCKABLE void processNetworkStatusReset( const common_n::NetworkCommands_s *networkstatus );").GetResult();
assert.strictEqual("/**\n * @brief \n * \n * @param networkstatus \n */", result);
});
test("Custom tag", () => {
testSetup.cfg = new Config();
testSetup.cfg.Generic.order = ["custom"];
testSetup.cfg.Generic.customTags = ["@note"];
const result = testSetup.SetLine("void foo();").GetResult();
assert.strictEqual("/**\n * @note\n */", result);
});
test("Env variable", () => {
testSetup.cfg = new Config();
testSetup.cfg.Generic.order = ["custom"];
if (process.platform === "win32") {
testSetup.cfg.Generic.customTags = ["@author ${env:USERNAME}"];
const res = testSetup.SetLine("void foo();").GetResult();
// USERNAME env var is different for everybody
assert.notStrictEqual("/**\n * @author USERNAME\n */", res);
} else {
testSetup.cfg.Generic.customTags = ["@author ${env:USER}"];
const res = testSetup.SetLine("void foo();").GetResult();
// USER env var is different for everybody
assert.notStrictEqual("/**\n * @author USER\n */", res);
}
testSetup.cfg.Generic.customTags = ["@author ${env:MY_VARIABLE}"];
const result = testSetup.SetLine("void foo();").GetResult();
assert.strictEqual("/**\n * @author MY_VARIABLE\n */", result);
});
});
|