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
|
//
// 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 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.equal("/**\n * @brief \n * \n * @tparam T \n * @param a \n * "
+ "@return true \n * @return false \n */", result);
});
test("Modified template", () => {
testSetup.cfg = new Config();
testSetup.cfg.firstLine = "";
testSetup.cfg.lastLine = "";
testSetup.cfg.commentPrefix = "/// ";
testSetup.cfg.briefTemplate = "\\brief ";
testSetup.cfg.paramTemplate = "\\param {param} ";
testSetup.cfg.tparamTemplate = "\\tparam {param} ";
testSetup.cfg.returnTemplate = "\\return {type} ";
const result = testSetup.SetLine("template<typename T> bool foo(T a);").GetResult();
assert.equal("/// \\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.boolReturnsTrueFalse = false;
const result = testSetup.SetLine("template<typename T> bool foo(T a);").GetResult();
assert.equal("/**\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.includeTypeAtReturn = false;
const result = testSetup.SetLine("template<typename T> bool foo(T a);").GetResult();
assert.equal("/**\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.newLineAfterBrief = false;
testSetup.cfg.newLineAfterParams = true;
testSetup.cfg.newLineAfterTParams = true;
const result = testSetup.SetLine("template<typename T> bool foo(T a);").GetResult();
assert.equal("/**\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.equal("/**\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.equal("/**\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.linesToGet = 1;
const negativeResult = testSetup.SetLines(["template<typename T> bool \n", "foo(T a);"]).GetResult();
assert.equal("/**\n * @brief \n * \n */", negativeResult);
testSetup.cfg.linesToGet = 2;
const positiveResult = testSetup.SetLines(["template<typename T> bool \n", "foo(T a);"]).GetResult();
assert.equal("/**\n * @brief \n * \n * @tparam T \n * @param a \n * "
+ "@return true \n * @return false \n */", positiveResult);
});
});
|