Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/tools/jsdoc-toolkit/app/t/TestDoc.js
blob: c0768b71c63bc916aa528722debc15d6ad44887a (plain)
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
var TestDoc = {
	fails: 0,
	plans: 0,
	passes: 0,
	results: []
};

TestDoc.record = function(result) {
	TestDoc.results.push(result);
	if (typeof result.verdict == "boolean") {
		if (result.verdict === false) TestDoc.fails++;
		if (result.verdict === true) TestDoc.passes++;
	}
}

TestDoc.prove = function(filePath) {
	if (typeof document != "undefined" && typeof document.write != "undefined") {
		if (TestDoc.console) print = function(s) { TestDoc.console.appendChild(document.createTextNode(s+"\n")); }
		else print = function(s) { document.write(s+"<br />"); }
	}
	TestDoc.run(TestDoc.readFile(filePath));
}

TestDoc.run = function(src) {
	try { eval(src); } catch(e) { print("# ERROR! "+e); }
	
	var chunks = src.split(/\/\*t:/);
	
	var run = function(chunk) {
		// local shortcuts
		var is = TestDoc.assertEquals;
		var isnt = TestDoc.assertNotEquals;
		var plan = TestDoc.plan;
		var requires = TestDoc.requires;
		
		try { eval(chunk); } catch(e) { print("# ERROR! "+e); }
	}
	for (var start = -1, end = 0; (start = src.indexOf("/*t:", end)) > end; start = end) {
		run(
			src.substring(
				start+4,
				(end = src.indexOf("*/", start))
			)
		);
	}
}

TestDoc.Result = function(verdict, message) {
	this.verdict = verdict;
	this.message = message;
}

TestDoc.Result.prototype.toString = function() {
	if (typeof this.verdict == "boolean") {
		return (this.verdict? "ok" : "not ok") + " " + (++TestDoc.report.counter) + " - " + this.message;
	}
	
	return "# " + this.message;
}

TestDoc.requires = function(file) {
	if (!TestDoc.requires.loaded[file]) {
		load(file);
		TestDoc.requires.loaded[file] = true;
	}
}
TestDoc.requires.loaded = {};

TestDoc.report = function() {
	TestDoc.report.counter = 0;
	print("1.."+TestDoc.plans);
	for (var i = 0; i < TestDoc.results.length; i++) {
		print(TestDoc.results[i]);
	}
	print("----------------------------------------");
	if (TestDoc.fails == 0 && TestDoc.passes == TestDoc.plans) {
		print("All tests successful.");
	}
	else {
		print("Failed " + TestDoc.fails + "/" + TestDoc.plans + " tests, "+((TestDoc.plans == 0)? 0 : Math.round(TestDoc.passes/(TestDoc.passes+TestDoc.fails)*10000)/100)+"% okay. Planned to run "+TestDoc.plans+", did run "+(TestDoc.passes+TestDoc.fails)+".")
	}
}

TestDoc.plan = function(n, message) {
	TestDoc.plans += n;
	TestDoc.record(new TestDoc.Result(null, message+" ("+n+" tests)"));
}

TestDoc.assertEquals = function(a, b, message) {
	var result = (a == b);
	if (!result) message += "\n#\n# " + a + " does not equal " + b + "\n#";
	TestDoc.record(new TestDoc.Result(result, message));
}

TestDoc.assertNotEquals = function(a, b, message) {
	var result = (a != b);
	if (!result) message += "\n#\n# " + a + " equals " + b + "\n#";
	TestDoc.record(new TestDoc.Result(result, message));
}

TestDoc.readFile = (function(){
	// rhino
	if (typeof readFile == "function") {
		return function(url) {
			var text = readFile(url);
			return text || "";
		}
	}

	// a web browser
	else {
		return function(url) {
			var httpRequest;
		
			if (window.XMLHttpRequest) { // Mozilla, Safari, etc
				httpRequest = new XMLHttpRequest();
			} 
			else if (window.ActiveXObject) { // IE
				try {
					httpRequest = new ActiveXObject("Msxml2.XMLHTTP");
				} 
				catch (e) {
				   try {
						httpRequest = new ActiveXObject("Microsoft.XMLHTTP");
					} 
					catch (e) {
					}
				}
			}
		
			if (!httpRequest) { throw "Cannot create HTTP Request."; }
			
			httpRequest.open('GET', url, false);
			httpRequest.send('');
			if (httpRequest.readyState == 4) {
				if (httpRequest.status >= 400) {
					throw "The HTTP Request returned an error code: "+httpRequest.status;
				}
			}
			
			return httpRequest.responseText || "";
		}
	}
})();