1 module unit_threaded.factory;
2 
3 import unit_threaded.testcase;
4 import unit_threaded.reflection;
5 import unit_threaded.asserts;
6 import unit_threaded.should;
7 
8 import std.stdio;
9 import std.traits;
10 import std.algorithm;
11 import std.array;
12 import std.string;
13 import core.runtime;
14 
15 
16 private CompositeTestCase[string] serialComposites;
17 
18 /**
19  * Creates tests cases from the given modules.
20  * If testsToRun is empty, it means run all tests.
21  */
22 TestCase[] createTestCases(in TestData[] testData, in string[] testsToRun = []) {
23     serialComposites = null;
24     bool[TestCase] tests;
25     foreach(const data; testData) {
26         if(!isWantedTest(data, testsToRun)) continue;
27         auto test = createTestCase(data);
28          if(test !is null) tests[test] = true; //can be null if abtract base class
29     }
30 
31     return tests.keys.sort!((a, b) => a.getPath < b.getPath).array;
32 }
33 
34 
35 package TestCase createTestCase(in TestData testData) {
36     TestCase createImpl() {
37         import unit_threaded.io: WriterThread;
38 
39         TestCase testCase;
40         if(testData.isTestClass)
41             testCase = cast(TestCase) Object.factory(testData.name);
42          else
43             testCase = testData.builtin ? new BuiltinTestCase(testData) : new FunctionTestCase(testData);
44 
45         assert(testCase !is null, "Error creating test case");
46 
47         if(testData.shouldFail) {
48             testCase = new ShouldFailTestCase(testCase, testData.exceptionTypeInfo);
49         }
50 
51         return testCase;
52     }
53 
54     auto testCase = createImpl();
55 
56     if(testData.singleThreaded) {
57         // @Serial tests in the same module run sequentially.
58         // A CompositeTestCase is created for each module with at least
59         // one @Serial test and subsequent @Serial tests
60         // appended to it
61         const moduleName = testData.name.splitter(".").
62             array[0 .. $ - 1].
63             reduce!((a, b) => a ~ "." ~ b);
64 
65         // create one if not already there
66         if(moduleName !in serialComposites) {
67             serialComposites[moduleName] = new CompositeTestCase;
68         }
69 
70         // add the current test to the composite
71         serialComposites[moduleName] ~= testCase;
72         return serialComposites[moduleName];
73     }
74 
75     assert(testCase !is null || testData.testFunction is null,
76            "Could not create TestCase object for test " ~ testData.name);
77 
78     return testCase;
79 }
80 
81 
82 
83 private bool isWantedTest(in TestData testData, in string[] testsToRun) {
84     bool isTag(in string t) { return t.startsWith("@") || t.startsWith("~@"); }
85 
86     auto normalToRun = testsToRun.filter!(a => !isTag(a)).array;
87     auto tagsToRun = testsToRun.filter!isTag;
88 
89     bool matchesTags(in string tag) { //runs all tests with the specified tags
90         assert(isTag(tag));
91         return tag[0] == '@' && testData.tags.canFind(tag[1..$]) ||
92             (!testData.hidden && tag.startsWith("~@") && !testData.tags.canFind(tag[2..$]));
93     }
94 
95     return isWantedNonTagTest(testData, normalToRun) &&
96         (tagsToRun.empty || tagsToRun.all!(t => matchesTags(t)));
97 }
98 
99 private bool isWantedNonTagTest(in TestData testData, in string[] testsToRun) {
100     if(!testsToRun.length) return !testData.hidden; //all tests except the hidden ones
101 
102     bool matchesExactly(in string t) {
103         return t == testData.name;
104     }
105 
106     bool matchesPackage(in string t) { //runs all tests in package if it matches
107         with(testData) return !hidden && name.length > t.length &&
108                            name.startsWith(t) && name[t.length .. $].canFind(".");
109     }
110 
111     return testsToRun.any!(a => matchesExactly(a) || matchesPackage(a));
112 }
113 
114 
115 unittest {
116     //existing, wanted
117     assert(isWantedTest(TestData("tests.server.testSubscribe"), ["tests"]));
118     assert(isWantedTest(TestData("tests.server.testSubscribe"), ["tests."]));
119     assert(isWantedTest(TestData("tests.server.testSubscribe"), ["tests.server.testSubscribe"]));
120     assert(!isWantedTest(TestData("tests.server.testSubscribe"), ["tests.server.testSubscribeWithMessage"]));
121     assert(!isWantedTest(TestData("tests.stream.testMqttInTwoPackets"), ["tests.server"]));
122     assert(isWantedTest(TestData("tests.server.testSubscribe"), ["tests.server"]));
123     assert(isWantedTest(TestData("pass_tests.testEqual"), ["pass_tests"]));
124     assert(isWantedTest(TestData("pass_tests.testEqual"), ["pass_tests.testEqual"]));
125     assert(isWantedTest(TestData("pass_tests.testEqual"), []));
126     assert(!isWantedTest(TestData("pass_tests.testEqual"), ["pass_tests.foo"]));
127     assert(!isWantedTest(TestData("example.tests.pass.normal.unittest"),
128                          ["example.tests.pass.io.TestFoo"]));
129     assert(isWantedTest(TestData("example.tests.pass.normal.unittest"), []));
130     assert(!isWantedTest(TestData("tests.pass.attributes.testHidden", null, true /*hidden*/), ["tests.pass"]));
131     assert(!isWantedTest(TestData("", null, false /*hidden*/, false /*shouldFail*/, false /*singleThreaded*/,
132                                   false /*builtin*/, "" /*suffix*/),
133                          ["@foo"]));
134     assert(isWantedTest(TestData("", null, false /*hidden*/, false /*shouldFail*/, false /*singleThreaded*/,
135                                  false /*builtin*/, "" /*suffix*/, ["foo"]),
136                         ["@foo"]));
137 
138     assert(!isWantedTest(TestData("", null, false /*hidden*/, false /*shouldFail*/, false /*singleThreaded*/,
139                                  false /*builtin*/, "" /*suffix*/, ["foo"]),
140                         ["~@foo"]));
141 
142     assert(isWantedTest(TestData("", null, false /*hidden*/, false /*shouldFail*/, false /*singleThreaded*/,
143                                   false /*builtin*/, "" /*suffix*/),
144                          ["~@foo"]));
145 
146     assert(isWantedTest(TestData("", null, false /*hidden*/, false /*shouldFail*/, false /*singleThreaded*/,
147                                  false /*builtin*/, "" /*suffix*/, ["bar"]),
148                          ["~@foo"]));
149 
150     // if hidden, don't run by default
151     assert(!isWantedTest(TestData("", null, true /*hidden*/, false /*shouldFail*/, false /*singleThreaded*/,
152                                   false /*builtin*/, "" /*suffix*/, ["bar"]),
153                         ["~@foo"]));
154 
155 
156 }