trial.coverage 5/136(3%) line coverage

      
10
20
30
40
50
60
70
80
90
100
110
120
130
140
150
160
170
180
190
200
210
220
230
240
250
261
270
280
290
300
311
321
330
341
350
361
370
380
390
400
410
420
430
440
450
460
470
480
490
500
510
520
530
540
550
560
570
580
590
600
610
620
630
640
650
660
670
680
690
700
710
720
730
740
750
760
770
780
790
800
810
820
830
840
850
860
870
880
890
900
910
920
930
940
950
960
970
980
990
1000
1010
1020
1030
1040
1050
1060
1070
1080
1090
1100
1110
1120
1130
1140
1150
1160
1170
1180
1190
1200
1210
1220
1230
1240
1250
1260
1270
1280
1290
1300
1310
1320
1330
1340
1350
1360
1370
1380
1390
1400
1410
1420
1430
1440
1450
1460
1470
1480
1490
1500
1510
1520
1530
1540
1550
1560
1570
1580
1590
1600
1610
1620
1630
1640
1650
1660
1670
1680
1690
1700
1710
1720
1730
1740
1750
1760
1770
1780
1790
1800
1810
1820
1830
1840
1850
1860
1870
1880
1890
1900
1910
1920
1930
1940
1950
1960
1970
1980
1990
2000
2010
2020
2030
2040
2050
2060
2070
2080
2090
2100
2110
2120
2130
2140
2150
2160
2170
2180
2190
2200
2210
2220
2230
2240
2250
2260
2270
2280
2290
2300
2310
2320
2330
2340
2350
2360
2370
2380
2390
2400
2410
2420
2430
2440
2450
2460
2470
2480
2490
2500
2510
2520
2530
2540
2550
2560
2570
2580
2590
2600
2610
2620
2630
2640
2650
2660
2670
2680
2690
2700
2710
2720
2730
2740
2750
2760
2770
2780
2790
2800
2810
2820
2830
2840
2850
2860
2870
2880
2890
2900
2910
2920
2930
2940
2950
2960
2970
2980
2990
3000
3010
3020
3030
3040
3050
3060
3070
3080
3090
3100
3110
3120
3130
3140
3150
3160
3170
3180
3190
3200
3210
3220
3230
3240
3250
3260
3270
3280
3290
3300
3310
3320
3330
3340
3350
3360
3370
3380
3390
3400
3410
3420
3430
3440
3450
3460
3470
3480
3490
3500
3510
3520
3530
3540
3550
3560
3570
3580
3590
3600
3610
3620
3630
3640
3650
3660
3670
3680
3690
3700
3710
3720
3730
3740
3750
3760
3770
3780
3790
3800
3810
3820
3830
3840
3850
3860
3870
3880
3890
3900
3910
3920
3930
3940
3950
3960
3970
3980
3990
4000
4010
4020
4030
4040
4050
4060
4070
4080
4090
4100
4110
4120
4130
4140
4150
4160
4170
4180
4190
4200
4210
4220
4230
4240
4250
4260
4270
4280
4290
4300
4310
4320
4330
4340
4350
4360
4370
4380
4390
4400
4410
4420
4430
4440
4450
4460
4470
4480
4490
4500
4510
4520
4530
4540
4550
4560
4570
4580
4590
4600
4610
4620
4630
4640
4650
4660
4670
4680
4690
4700
4710
4720
4730
4740
4750
4760
4770
4780
4790
4800
4810
4820
4830
4840
4850
4860
4870
4880
4890
4900
4910
4920
4930
4940
4950
4960
4970
4980
4990
5000
5010
5020
5030
5040
5050
5060
5070
5080
5090
5100
5110
5120
5130
5140
5150
5160
5170
5180
5190
5200
5210
5220
5230
5240
5250
5260
5270
5280
5290
5300
5310
5320
5330
5340
5350
5360
5370
5380
5390
5400
5410
5420
5430
5440
5450
5460
5470
5480
5490
5500
5510
5520
5530
5540
5550
5560
5570
5580
5590
5600
5610
5620
5630
5640
5650
5660
5670
5680
5690
5700
5710
5720
5730
5740
5750
5760
5770
5780
5790
5800
5810
5820
5830
5840
5850
5860
5870
5880
5890
5900
5910
5920
5930
5940
5950
5960
5970
5980
5990
6000
6010
6020
6030
6040
6050
6060
6070
6080
6090
6100
6110
6120
6130
6140
6150
6160
6170
6180
6190
6200
6210
6220
6230
6240
6250
6260
6270
6280
6290
6300
6310
6320
6330
6340
6350
6360
6370
6380
6390
6400
6410
6420
6430
6440
6450
6460
6470
6480
6490
6500
6510
6520
6530
6540
6550
6560
6570
6580
6590
6600
6610
6620
6630
6640
6650
6660
6670
6680
6690
6700
6710
6720
6730
6740
6750
6760
6770
6780
6790
6800
6810
6820
6830
6840
6850
6860
6870
6880
6890
6900
6910
6920
6930
6940
/++ A module containing the logic for parsing and analysing the code coverage Copyright: © 2017 Szabo Bogdan License: Subject to the terms of the MIT license, as written in the included LICENSE.txt file. Authors: Szabo Bogdan +/ module trial.coverage; import std.algorithm; import std.range; import std.string; import std.stdio; import std.conv; import std.exception; import std.file; import std.path; import std.math; import trial.discovery.code; version(D_Coverage) { shared static this() { import core.runtime; if(exists("coverage")) { writeln("Creating coverage folder..."); rmdirRecurse("coverage"); } auto destination = buildPath("coverage", "raw").asAbsolutePath.array.idup.to!string; mkdirRecurse(destination); dmd_coverSetMerge(false); //dmd_coverSourcePath(thisExePath); dmd_coverDestPath(destination); } } /// Converts coverage lst files to html double convertLstFiles(string packagePath, string packageName) { if(!exists(buildPath("coverage", "raw"))) { return 0; } if(!exists(buildPath("coverage", "html"))) { mkdirRecurse(buildPath("coverage", "html")); } std.file.write(buildPath("coverage", "html", "coverage.css"), import("templates/coverage.css")); auto coverageData = dirEntries(buildPath("coverage", "raw"), SpanMode.shallow) .filter!(f => f.name.endsWith(".lst")) .filter!(f => f.isFile) .map!(a => readText(a.name)) .map!(a => a.toCoverageFile(packagePath)).array; std.file.write(buildPath("coverage", "html", "coverage-shield.svg"), coverageShield(coverageData.filter!"a.isInCurrentProject".array.coveragePercent.to!int.to!string)); std.file.write(buildPath("coverage", "html", "index.html"), coverageData.toHtmlIndex(packageName)); foreach (data; coverageData) { auto htmlFile = data.path.toCoverageHtmlFileName; std.file.write(buildPath("coverage", "html", htmlFile), data.toHtml); } return coverageData.coveragePercent; } string toCoverageHtmlFileName(string fileName) { return fileName.replace("/", "-").replace("\\", "-") ~ ".html"; } /// Get the line that contains the coverage summary auto getCoverageSummary(string fileContent) { auto lines = fileContent.splitLines.array; std.algorithm.reverse(lines); return lines .filter!(a => a.indexOf('|') == -1 || a.indexOf('|') > 9) .map!(a => a.strip) .filter!(a => a != ""); } /// It should get the coverage summary from the .lst file with no coverage unittest { " | double threadUsage(uint index); |} core/cloud/source/cloud/system.d has no code ".getCoverageSummary.front.should.equal("core/cloud/source/cloud/system.d has no code"); } /// It should get the coverage summary from the .lst file with missing data unittest { " ".getCoverageSummary.empty.should.equal(true); } /// It should get the coverage summary from the .lst file with percentage unittest { " 2| statusList[0].properties[\"thread1\"].value.should.startWith(\"1;\"); |} core/cloud/source/cloud/system.d is 88% covered ".getCoverageSummary.front.should.equal("core/cloud/source/cloud/system.d is 88% covered"); } /// Get the filename from the coverage summary string getFileName(string fileContent) { auto r = fileContent.getCoverageSummary; if(r.empty) { return ""; } auto pos = r.front.lastIndexOf(".d"); return r.front[0..pos + 2]; } version(unittest) { import fluent.asserts; } /// It should get the filename from the .lst file with no coverage unittest { " | double threadUsage(uint index); |} core/cloud/source/cloud/system.d has no code ".getFileName.should.equal("core/cloud/source/cloud/system.d"); } /// It should get the filename from the .lst file with no code unittest { " ".getFileName.should.equal(""); } /// It should get the filename from the .lst file with percentage unittest { " 2| statusList[0].properties[\"thread1\"].value.should.startWith(\"1;\"); |} core/cloud/source/cloud/system.d is 88% covered ".getFileName.should.equal("core/cloud/source/cloud/system.d"); } /// Get the percentage from the covered summary double getCoveragePercent(string fileContent) { auto r = fileContent.getCoverageSummary; if(r.empty) { return 100; } auto pos = r.front.lastIndexOf('%'); if(pos == -1) { return 100; } auto pos2 = r.front[0..pos].lastIndexOf(' ') + 1; return r.front[pos2..pos].to!double; } /// It should get the filename from the .lst file with no coverage unittest { " | double threadUsage(uint index); |} core/cloud/source/cloud/system.d has no code ".getCoveragePercent.should.equal(100); } /// It should get the filename from the .lst file with no code unittest { " ".getCoveragePercent.should.equal(100); } /// It should get the filename from the .lst file with percentage unittest { " 2| statusList[0].properties[\"thread1\"].value.should.startWith(\"1;\"); |} core/cloud/source/cloud/system.d is 88% covered ".getCoveragePercent.should.equal(88); } /// The representation of a line from the .lst file struct LineCoverage { /// string code; /// size_t hits; /// bool hasCode; @disable this(); /// this(string line) { enforce(line.indexOf("\n") == -1, "You should provide a line"); line = line.strip; auto column = line.indexOf("|"); if(column == -1) { code = line; } else if(column == 0) { code = line[1..$]; } else { hits = line[0..column].strip.to!size_t; hasCode = true; code = line[column + 1..$]; } } } /// It should parse an empty line unittest { auto lineCoverage = LineCoverage(` |`); lineCoverage.code.should.equal(""); lineCoverage.hits.should.equal(0); lineCoverage.hasCode.should.equal(false); } /// Parse the file lines auto toCoverageLines(string fileContent) { return fileContent .splitLines .filter!(a => a.indexOf('|') != -1 && a.indexOf('|') < 10) .map!(a => a.strip) .map!(a => LineCoverage(a)); } /// It should convert a .lst file to covered line structs unittest { auto lines = " | |import std.stdio; 75| this(File f) { | } core/cloud/source/cloud/system.d is 88% covered ".toCoverageLines.array; lines.length.should.equal(4); lines[0].code.should.equal(""); lines[0].hits.should.equal(0); lines[0].hasCode.should.equal(false); lines[1].code.should.equal("import std.stdio;"); lines[1].hits.should.equal(0); lines[1].hasCode.should.equal(false); lines[2].code.should.equal(" this(File f) {"); lines[2].hits.should.equal(75); lines[2].hasCode.should.equal(true); lines[3].code.should.equal(" }"); lines[3].hits.should.equal(0); lines[3].hasCode.should.equal(false); } /// Structure that represents one .lst file struct CoveredFile { /// The covered file path string path; /// Is true if the file is from the tested library and /// false if is an external file bool isInCurrentProject; /// Is true if the file is set to be ignored /// from the final report bool isIgnored; /// The module name string moduleName; /// The covered percent double coveragePercent; /// The file lines with coverage data LineCoverage[] lines; } /// Check if a file should be ignored from the report bool isIgnored(const string content) { auto firstLine = content.splitter('\n'); if(firstLine.empty) { return false; } auto smallCase = firstLine.front.strip.toLower; auto pieces = smallCase.replace("\t", " ").splitter(' ').filter!(a => a != "").array; if(pieces[0].indexOf("//") == -1 && pieces[0].indexOf("/*") == -1 && pieces[0].indexOf("/+") == -1) { return false; } if(pieces.length == 2) { return pieces[0].indexOf("ignore") != -1 && pieces[1] == "coverage"; } if(pieces.length < 3) { return false; } return pieces[1] == "ignore" && pieces[2] == "coverage"; } /// It should return true for ignored coverage files unittest { "// IGNORE COVERAGE".isIgnored.should.equal(true); "// \t IGNORE \t COVERAGE".isIgnored.should.equal(true); "// ignore coverage".isIgnored.should.equal(true); "//IGNORE COVERAGE".isIgnored.should.equal(true); "/////IGNORE COVERAGE".isIgnored.should.equal(true); "// IGNORE COVERAGE ".isIgnored.should.equal(true); "/* IGNORE COVERAGE */".isIgnored.should.equal(true); "/***** IGNORE COVERAGE ".isIgnored.should.equal(true); "/***** IGNORE COVERAGE ****/".isIgnored.should.equal(true); "/+ IGNORE COVERAGE +/".isIgnored.should.equal(true); "/+++++ IGNORE COVERAGE ".isIgnored.should.equal(true); "/+++++ IGNORE COVERAGE +++++/".isIgnored.should.equal(true); } /// It should return false for when the ignore coverage file is missing unittest { "".isIgnored.should.equal(false); "//\nIGNORE COVERAGE".isIgnored.should.equal(false); "//\nIGNORE COVERAGE".isIgnored.should.equal(false); "/////\nIGNORE COVERAGE".isIgnored.should.equal(false); "//\n IGNORE COVERAGE ".isIgnored.should.equal(false); "/*\n IGNORE COVERAGE */".isIgnored.should.equal(false); "/***** \n IGNORE COVERAGE ".isIgnored.should.equal(false); "/***** \n IGNORE COVERAGE ****/".isIgnored.should.equal(false); "/+ \n IGNORE COVERAGE +/".isIgnored.should.equal(false); "/+++++ \n IGNORE COVERAGE ".isIgnored.should.equal(false); "/+++++ \n IGNORE COVERAGE +++++/".isIgnored.should.equal(false); "// IGNORE\nCOVERAGE".isIgnored.should.equal(false); "//IGNORE\nCOVERAGE".isIgnored.should.equal(false); } /// Check if a file is in the current path bool isPackagePath(string fullPath, string packagePath) { if(fullPath.indexOf("trial_") != -1) { return false; } if(fullPath.indexOf(packagePath) == 0) { return true; } if(fullPath.replace("\\", "/").indexOf(packagePath) == 0) { return true; } return false; } /// Check project paths unittest { "../../something.d".isPackagePath("/Users/trial/").should.equal(false); "/Users/trial/trial_.d".isPackagePath("/Users/trial/").should.equal(false); "/Users/trial/runner.d".isPackagePath("/Users/trial/").should.equal(true); "C:\\Users\\trial\\runner.d".isPackagePath("C:/Users/trial/").should.equal(true); } /// Converts a .lst file content to a CoveredFile structure CoveredFile toCoverageFile(string content, string packagePath) { auto fileName = content.getFileName; auto fullPath = buildNormalizedPath(getcwd, fileName); return CoveredFile( fileName, fullPath.isPackagePath(packagePath), content.isIgnored(), getModuleName(fullPath), getCoveragePercent(content), content.toCoverageLines.array); } /// should convert a .lst file to CoveredFile structure unittest { auto result = ` |/++ | The main runner logic. You can find here some LifeCycle logic and test runner | initalization |+/ |module trial.runner; | | /// Send the begin run event to all listeners | void begin(ulong testCount) { 23| lifecycleListeners.each!(a => a.begin(testCount)); | } lifecycle/trial/runner.d is 74% covered `.toCoverageFile(buildPath(getcwd, "lifecycle/trial")); result.path.should.equal("lifecycle/trial/runner.d"); result.isInCurrentProject.should.equal(true); result.moduleName.should.equal("trial.runner"); result.coveragePercent.should.equal(74); result.lines.length.should.equal(10); result.lines[0].code.should.equal("/++"); result.lines[9].code.should.equal(" }"); } /// should mark the `trial_.d` file as external file unittest { auto result = `trial_package.d is 74% covered `.toCoverageFile(buildPath(getcwd, "lifecycle/trial")); result.isInCurrentProject.should.equal(false); } /// Generate the html for a line coverage string toLineCoverage(T)(LineCoverage line, T index) { return import("templates/coverageColumn.html") .replaceVariable("hasCode", line.hasCode ? "has-code" : "") .replaceVariable("hit", line.hits > 0 ? "hit" : "") .replaceVariable("line", index.to!string) .replaceVariable("hitCount", line.hits.to!string); } /// Render line coverage column unittest { LineCoverage(" |").toLineCoverage(1).should.contain([`<span class="line-number">1</span>`, `<span class="hit-count">0</span>`]); LineCoverage(" |").toLineCoverage(1).should.not.contain(["has-code", `hit"`]); LineCoverage(" 1|code").toLineCoverage(2).should.contain([ `<span class="line-number">2</span>`, `<span class="hit-count">1</span>`, "has-code", `hit"` ]); } /// Get the line coverage column for the html report string toHtmlCoverage(LineCoverage[] lines) { return lines.enumerate(1).map!(a => a[1].toLineCoverage(a[0])).array.join("").replace("\n", ""); } /// Cont how many lines were hit auto hitLines(LineCoverage[] lines) { return lines.filter!(a => a.hits > 0).array.length; } /// Cont how many lines were hit auto codeLines(LineCoverage[] lines) { return lines.filter!(a => a.hasCode).array.length; } /// Replace an `{variable}` inside a string string replaceVariable(const string page, const string key, const string value) pure { return page.replace("{"~key~"}", value); } /// It should replace a variable inside a page unittest { `-{key}-`.replaceVariable("key", "value").should.equal("-value-"); } /// wraps some string in a html page string wrapToHtml(string content, string title) { return import("templates/page.html").replaceVariable("content", content).replaceVariable("title", title); } ///should replace the variables inside the page.html unittest { auto page = wrapToHtml("some content", "some title"); page.should.contain(`<title>some title</title>`); page.should.contain("<body>\n some content\n</body>"); } /// Create an html progress bar string htmlProgress(string percent) { return import("templates/progress.html").replaceVariable("percent", percent); } ///should replace the variables inside the page.html unittest { htmlProgress("33").should.contain(`33%`); htmlProgress("33").should.contain(`33% Covered`); } /// Generate the coverage page header string coverageHeader(CoveredFile coveredFile) { return import("templates/coverageHeader.html") .replaceVariable("title", coveredFile.moduleName) .replaceVariable("hitLines", coveredFile.lines.hitLines.to!string) .replaceVariable("totalLines", coveredFile.lines.codeLines.to!string) .replaceVariable("coveragePercent", coveredFile.coveragePercent.to!string) .replaceVariable("pathPieces", pathSplitter(coveredFile.path).array.join(`</li><li>`)); } /// Check variables for the coverage header unittest { CoveredFile coveredFile; coveredFile.moduleName = "module.name"; coveredFile.coveragePercent = 30; coveredFile.path = "a/b"; coveredFile.lines = [ LineCoverage(" 0| not code"), LineCoverage(" 1| some code") ]; auto header = coverageHeader(coveredFile); header.should.contain(`<h1>module.name`); header.should.contain(`1/2`); header.should.contain(`30%`); header.should.contain(`<li>a</li><li>b</li>`); } /// Convert a `CoveredFile` struct to html string toHtml(CoveredFile coveredFile) { return wrapToHtml( coverageHeader(coveredFile) ~ import("templates/coverageBody.html") .replaceVariable("lines", coveredFile.lines.toHtmlCoverage) .replaceVariable("code", coveredFile.lines.map!(a => a.code.replace("<", "<").replace(">", ">")).array.join("\n")), coveredFile.moduleName ~ " coverage" ); } /// Check variables for the coverage html unittest { CoveredFile coveredFile; coveredFile.moduleName = "module.name"; coveredFile.coveragePercent = 30; coveredFile.path = "a/b"; coveredFile.lines = [ LineCoverage(" 0| <not code>"), LineCoverage(" 1| some code") ]; auto html = toHtml(coveredFile); html.should.contain(`<h1>module.name`); html.should.contain(`<not code>`); html.should.contain(`<title>module.name coverage</title>`); html.should.contain(`hit"`); } string indexTable(string content) { return import("templates/indexTable.html").replaceVariable("content", content); } string ignoredTable(string content) { return import("templates/ignoredTable.html").replaceVariable("content", content); } /// Check if the table body is inserted unittest { indexTable("some content").should.contain(`<tbody>some content</tbody>`); } /// Calculate the coverage percent from the current project double coveragePercent(CoveredFile[] coveredFiles) { if(coveredFiles.length == 0) { return 100; } double total = 0; double covered = 0; foreach(file; coveredFiles.filter!"a.isInCurrentProject".filter!"!a.isIgnored") { total += file.lines.map!(a => a.hasCode ? 1 : 0).sum; covered += file.lines.filter!(a => a.hasCode).map!(a => a.hits > 0 ? 1 : 0).sum; } if(total == 0) { return 100; } return round((covered / total) * 10000) / 100; } /// No files are always 100% covered unittest { [].coveragePercent.should.equal(100); } /// check a 50% covered file unittest { auto coveredFile = CoveredFile("", true, false, "", 50, [ LineCoverage(" 75| this(File f)"), LineCoverage(" 0| this(File f)") ]); [coveredFile].coveragePercent.should.equal(50); } /// check a 50% external covered file unittest { auto coveredFile = CoveredFile("", false, false, "", 0, [ LineCoverage(" 0| this(File f)"), LineCoverage(" 0| this(File f)") ]); [coveredFile].coveragePercent.should.equal(100); } string toHtmlIndex(CoveredFile[] coveredFiles, string name) { sort!("toUpper(a.path) < toUpper(b.path)", SwapStrategy.stable)(coveredFiles); string content; string table; size_t totalHitLines; size_t totalLines; size_t ignoredLines; int count; foreach(file; coveredFiles.filter!"a.isInCurrentProject".filter!"!a.isIgnored") { auto currentHitLines = file.lines.hitLines; auto currentTotalLines = file.lines.codeLines; table ~= `<tr> <td><a href="` ~ file.path.toCoverageHtmlFileName ~ `">` ~ file.path ~ `</a></td> <td>` ~ file.moduleName ~ `</td> <td>` ~ file.lines.hitLines.to!string ~ `/` ~ currentTotalLines.to!string ~ `</td> <td>` ~ file.coveragePercent.to!string.htmlProgress ~ `</td> </tr>`; totalHitLines += currentHitLines; totalLines += currentTotalLines; count++; } table ~= `<tr> <th colspan="2">Total</td> <th>` ~ totalHitLines.to!string ~ `/` ~ totalLines.to!string ~ `</td> <th>` ~ coveredFiles.coveragePercent.to!string.htmlProgress ~ `</td> </tr>`; content ~= indexHeader(name) ~ table.indexTable; /// Ignored files table = ""; foreach(file; coveredFiles.filter!"a.isInCurrentProject".filter!"a.isIgnored") { auto currentTotalLines = file.lines.codeLines; table ~= `<tr> <td><a href="` ~ file.path.toCoverageHtmlFileName ~ `">` ~ file.path ~ `</a></td> <td>` ~ file.moduleName ~ `</td> <td>` ~ currentTotalLines.to!string ~ `/` ~ totalLines.to!string ~ `</td> </tr>`; ignoredLines += currentTotalLines; count++; } table ~= `<tr> <th colspan="2">Total</td> <th>` ~ ignoredLines.to!string ~ `/` ~ totalLines.to!string ~ `</td> </tr>`; content ~= `<h1>Ignored</h1>` ~ table.ignoredTable; /// external files table = ""; foreach(file; coveredFiles.filter!"!a.isInCurrentProject") { table ~= `<tr> <td><a href="` ~ file.path.toCoverageHtmlFileName ~ `">` ~ file.path ~ `</a></td> <td>` ~ file.moduleName ~ `</td> <td>` ~ file.lines.hitLines.to!string ~ `/` ~ file.lines.codeLines.to!string ~ `</td> <td>` ~ file.coveragePercent.to!string.htmlProgress ~ `</td> </tr>`; } content ~= `<h1>Dependencies</h1>` ~ table.indexTable; content = `<div class="container">` ~ content ~ `</div>`; return wrapToHtml(content, "Code Coverage report"); } string indexHeader(string name) { return `<h1>` ~ name ~ ` <img src="coverage-shield.svg"></h1>`; } /// Create line coverage shield as svg string coverageShield(string percent) { return import("templates/coverage.svg").replace("?%", percent ~ "%"); } /// The line coverage shield should contain the percent unittest { coverageShield("30").should.contain("30%"); }