Skip to content
This repository was archived by the owner on Jul 29, 2024. It is now read-only.

Commit 2572feb

Browse files
sjelinsjelin
committed
feat(plugin): ngHint plugin
1 parent cbe9b65 commit 2572feb

11 files changed

+2539
-1
lines changed

‎plugins/ngHintPlugin.js

+228
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,228 @@
1+
var q = require('q'),
2+
fs = require('fs'),
3+
_ = require('lodash'),
4+
ngHintNames = {
5+
ngHintControllers: 'Controllers',
6+
ngHintDirectives: 'Directives',
7+
ngHintDom: 'DOM',
8+
ngHintEvents: 'Events',
9+
ngHintInterpolation: 'Interpolation',
10+
ngHintModules: 'Modules',
11+
ngHintScopes: 'Scopes',
12+
ngHintGeneral: 'General'
13+
};
14+
15+
/**
16+
* You enable this plugin in your config file:
17+
*
18+
* exports.config = {
19+
* ...
20+
* plugins: {
21+
* ...
22+
* ngHint: {
23+
* asTests: {Boolean},
24+
* excludeURLs: {(String|RegExp)[]}
25+
* }
26+
* }
27+
* }
28+
*
29+
* asTests specifies if the plugin should generate passed/failed test results
30+
* based on the ngHint output or instead log the results to the console.
31+
* Defaults to true.
32+
*
33+
* excludeURLs specifies a list of URLs for which ngHint results should be
34+
* ignored. Defaults to []
35+
*/
36+
37+
/*
38+
* The stratagy for this plugin is as follows:
39+
*
40+
* During setup, install the ngHint code and listeners to capture its output.
41+
* Store the output in the following format:
42+
* {page URL} -> {module} -> {message} -> {message type}
43+
*
44+
* So, for instance, you might have:
45+
* {
46+
* 'google.com': {
47+
* 'Controllers': {
48+
* {'It is against Angular best practices to...': warning}
49+
* },
50+
* 'Modules: {
51+
* {'Module "Search" was loaded but does not exist': error}
52+
* }
53+
* }
54+
* }
55+
*
56+
* We store the messages as keys in objects in order to avoid duplicates.
57+
*/
58+
59+
/**
60+
* Configures the plugin to grab the output of ngHint
61+
*
62+
* @param {Object} config The configuration file for the ngHint plugin
63+
* @public
64+
*/
65+
function setup(config) {
66+
// Intercept ngHint output
67+
browser.addMockModule('protractorNgHintCaptureModule_', function() {
68+
angular.module('protractorNgHintCaptureModule_', []);
69+
var hintInstalled = true;
70+
if (!angular.hint) {
71+
hintInstalled = false;
72+
angular.hint = {};
73+
}
74+
/** override */
75+
angular.hint.onMessage = function(module, message, type) {
76+
var ngHintLog = JSON.parse(localStorage.getItem(
77+
'ngHintLog_protractor') || '{}');
78+
var pageLog = ngHintLog[location] || {};
79+
var moduleLog = pageLog[module] || {};
80+
moduleLog[message] = type;
81+
pageLog[module] = moduleLog;
82+
ngHintLog[location] = pageLog;
83+
localStorage.setItem('ngHintLog_protractor',
84+
JSON.stringify(ngHintLog));
85+
};
86+
if (!hintInstalled) {
87+
angular.hint.onMessage('General', 'ngHint plugin cannot be run as ' +
88+
'ngHint code was never included into the page', 'warning');
89+
}
90+
});
91+
};
92+
93+
/**
94+
* Checks if a URL should not be examined by the ngHint plugin
95+
*
96+
* @param {String} url The URL to check for exclusion
97+
* @param {Object} config The configuration file for the ngHint plugin
98+
* @return {Boolean} true if the URL should not be examined by the ngHint plugin
99+
* @private
100+
*/
101+
function isExcluded(url, config) {
102+
var excludeURLs = config.excludeURLs || [];
103+
for (var i = 0; i < excludeURLs.length; i++) {
104+
if (typeof excludeURLs[i] == typeof "") {
105+
if (url == excludeURLs[i]) {
106+
return true;
107+
}
108+
} else {
109+
if (excludeURLs[i].test(url)) {
110+
return true;
111+
}
112+
}
113+
}
114+
return false;
115+
}
116+
117+
/**
118+
* Checks if a warning message should be ignored by the ngHint plugin
119+
*
120+
* @param {String} message The message to check
121+
* @return {Boolean} true if the message should be ignored
122+
* @private
123+
*/
124+
function isMessageToIgnore(message) {
125+
if (message == 'It is against Angular best practices to instantiate a ' +
126+
'controller on the window. This behavior is deprecated in Angular ' +
127+
'1.3.0') {
128+
return true; // An ngHint bug, see http://git.io/S3yySQ
129+
}
130+
131+
var module = /^Module "(\w*)" was created but never loaded\.$/.exec(
132+
message);
133+
if (module != null) {
134+
module = module[1];
135+
if (ngHintNames[module] != null) {
136+
return true; // An ngHint module
137+
}
138+
if ((module == 'protractorBaseModule_') || (module ==
139+
'protractorNgHintCaptureModule_')) {
140+
return true; // A protractor module
141+
}
142+
}
143+
144+
return false;
145+
}
146+
147+
/**
148+
* Checks the information which has been stored by the ngHint plugin and
149+
* generates passed/failed tests and/or console output
150+
*
151+
* @param {Object} config The configuration file for the ngHint plugin
152+
* @return {q.Promise} A promise which resolves to the results of any passed or
153+
* failed tests
154+
* @public
155+
*/
156+
function teardown(config) {
157+
// Get logged data
158+
return browser.executeScript_(function() {
159+
return localStorage.getItem('ngHintLog_protractor') || '{}';
160+
}, 'get ngHintLog').then(function(ngHintLog) {
161+
ngHintLog = JSON.parse(ngHintLog);
162+
163+
// Get a list of all the modules we tested against
164+
var modulesUsed = _.union.apply(_, [_.values(ngHintNames)].concat(
165+
_.values(ngHintLog).map(Object.keys)));
166+
167+
// Check log
168+
var testOut = {failedCount: 0, specResults: []};
169+
for (url in ngHintLog) {
170+
if (!isExcluded(url, config)) {
171+
for (var i = 0; i < modulesUsed.length; i++) {
172+
// Add new test to output
173+
var assertions = [];
174+
testOut.specResults.push({
175+
description: 'Angular Hint Test: ' + modulesUsed[i] + ' (' + url +
176+
')',
177+
assertions: assertions,
178+
duration: 1
179+
});
180+
181+
// Fill in the test details
182+
var messages = ngHintLog[url][modulesUsed[i]];
183+
if (messages) {
184+
for (var message in messages) {
185+
if (!isMessageToIgnore(message)) {
186+
assertions.push({
187+
passed: false,
188+
errorMsg: messages[message] + " -- " + message,
189+
stackTrace: ''
190+
});
191+
}
192+
}
193+
}
194+
195+
if (assertions.length == 0) {
196+
// Pass
197+
assertions.push({
198+
passed: true,
199+
errorMsg: '',
200+
stackTrace: ''
201+
});
202+
} else {
203+
// Fail
204+
testOut.failedCount++;
205+
}
206+
}
207+
}
208+
}
209+
210+
// Return
211+
if (config.asTests == false) {
212+
for (var i = 0; i < testOut.specResults.length; i++) {
213+
for (var j = 0; j < testOut.specResults[i].assertions.length; j++) {
214+
var assertion = testOut.specResults[i].assertions[j];
215+
if (!assertion.passed) {
216+
console.log(assertion.errorMsg);
217+
}
218+
}
219+
}
220+
} else if ((testOut.failedCount > 0) || (testOut.specResults.length > 0)) {
221+
return testOut;
222+
}
223+
});
224+
}
225+
226+
// Export
227+
exports.setup = setup;
228+
exports.teardown = teardown;

‎scripts/test.js

+16-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ var passingTests = [
2121
'node lib/cli.js spec/suitesConf.js --suite okspec',
2222
'node lib/cli.js spec/suitesConf.js --suite okmany,okspec',
2323
'node lib/cli.js spec/pluginsBasicConf.js',
24-
'node lib/cli.js spec/pluginsFullConf.js'
24+
'node lib/cli.js spec/pluginsFullConf.js',
25+
'node lib/cli.js spec/ngHintSuccessConfig.js'
2526
];
2627

2728
passingTests.push(
@@ -88,4 +89,18 @@ executor.addCommandlineTest('node lib/cli.js spec/errorTest/mochaFailureConf.js'
8889
stacktrace: 'mocha_failure_spec.js:11:20'
8990
}]);
9091

92+
// Check ngHint plugin
93+
94+
executor.addCommandlineTest('node lib/cli.js spec/ngHintFailConfig.js')
95+
.expectExitCode(1)
96+
.expectErrors([{
97+
message: 'warning -- ngHint plugin cannot be run as ngHint code was ' +
98+
'never included into the page'
99+
}, {
100+
message: 'warning -- ngHint is included on the page, but is not active ' +
101+
'because there is no `ng-hint` attribute present'
102+
}, {
103+
message: 'warning -- Module "xApp" was created but never loaded.'
104+
}]);
105+
91106
executor.execute();

‎spec/ngHint/fail_spec.js

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
describe('check if ngHint plugin works on bad apps', function() {
2+
it('should have ngHint problems on bad apps', function() {
3+
browser.get("ngHint/noNgHint.html");
4+
browser.get("ngHint/noTag.html");
5+
browser.get("ngHint/unused.html");
6+
});
7+
});

‎spec/ngHint/success_spec.js

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
describe('check if ngHint plugin works on good apps', function() {
2+
it('should not have ngHint problems on a good app', function() {
3+
browser.get("ngHint/index.html");
4+
});
5+
});

‎spec/ngHintFailConfig.js

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
var env = require('./environment.js');
2+
3+
exports.config = {
4+
seleniumAddress: env.seleniumAddress,
5+
specs: ['ngHint/fail_spec.js'],
6+
baseUrl: env.baseUrl,
7+
plugins: [{
8+
path: "../plugins/ngHintPlugin.js"
9+
}]
10+
};

‎spec/ngHintSuccessConfig.js

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
var env = require('./environment.js');
2+
3+
exports.config = {
4+
seleniumAddress: env.seleniumAddress,
5+
specs: ['ngHint/success_spec.js'],
6+
baseUrl: env.baseUrl,
7+
plugins: [{
8+
path: "../plugins/ngHintPlugin.js"
9+
}]
10+
};

‎testapp/ngHint/index.html

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<!DOCTYPE html>
2+
3+
<html ng-app="xApp" ng-hint>
4+
<head>
5+
<meta charset="utf-8">
6+
<title>Angular.js Example</title>
7+
<!-- Use version Angular 1.2.x since ngHint doesn't work with 1.3.x -->
8+
<script src="../lib/angular_v1.2.9/angular.min.js"></script>
9+
<script src="ngHint.js"></script>
10+
<script>
11+
angular.module('xApp', []);
12+
</script>
13+
</head>
14+
<body>
15+
First name:<input ng-model="firstName" type="text"/>
16+
<br>
17+
Last name:<input ng-model="lastName" type="text"/>
18+
<br>
19+
Hello {{firstName}} {{lastName}}
20+
</body>
21+
</html>

0 commit comments

Comments
 (0)