feat: Add test filename to html report's metaInfo section

up73k · up73k · commit 0311f6d91402 · 2016-12-29T12:48:48.000+03:00
diff --git a/lib/reporters/html/view-model.js b/lib/reporters/html/view-model.js
@@ -123,6 +123,7 @@ module.exports = class ViewModel {
         const suite = result.suite;
         const metaInfo = suite ? suite.metaInfo : {};
         metaInfo.sessionId = result.sessionId || 'unknown session id';
+        metaInfo.file = suite.file;
 
         const testResult = _.assign({
             suiteUrl: rootUrl + suite.url,
diff --git a/lib/suite.js b/lib/suite.js
@@ -24,6 +24,7 @@ module.exports = class Suite {
         this.afterActions = [];
         this.browsers = [];
         this.context = {};
+        this.file = null;
         definePrivate(this);
     }
 
diff --git a/lib/test-reader.js b/lib/test-reader.js
@@ -1,6 +1,7 @@
 'use strict';
 
 const _ = require('lodash');
+const path = require('path');
 const SetsBuilder = require('gemini-core').SetsBuilder;
 const Suite = require('./suite');
 const Events = require('./constants/events');
@@ -9,15 +10,17 @@ const utils = require('./utils');
 
 const DEFAULT_DIR = require('../package').name;
 
-const loadSuites = (sets, emitter) => {
+const loadSuites = (sets, emitter, projectRoot) => {
     const rootSuite = Suite.create('');
 
-    _.forEach(sets.groupByFile(), (browsers, path) => {
-        global.gemini = testsApi(rootSuite, browsers);
+    _.forEach(sets.groupByFile(), (browsers, filePath) => {
+        const relativeFilePath = path.relative(projectRoot, filePath);
 
-        emitter.emit(Events.BEFORE_FILE_READ, path);
-        utils.requireWithNoCache(path);
-        emitter.emit(Events.AFTER_FILE_READ, path);
+        global.gemini = testsApi(rootSuite, browsers, relativeFilePath);
+
+        emitter.emit(Events.BEFORE_FILE_READ, filePath);
+        utils.requireWithNoCache(filePath);
+        emitter.emit(Events.AFTER_FILE_READ, filePath);
 
         delete global.gemini;
     });
@@ -32,5 +35,5 @@ module.exports = (emitter, config, opts) => {
         .useFiles(opts.paths)
         .useBrowsers(opts.browsers)
         .build(config.system.projectRoot, {ignore: config.system.exclude})
-        .then((setCollection) => loadSuites(setCollection, emitter));
+        .then((setCollection) => loadSuites(setCollection, emitter, config.system.projectRoot));
 };
diff --git a/lib/tests-api/index.js b/lib/tests-api/index.js
@@ -4,7 +4,7 @@ const Suite = require('../suite');
 const SuiteBuilder = require('./suite-builder');
 const keysCodes = require('./keys-codes');
 
-module.exports = (suite, browsers) => {
+module.exports = (suite, browsers, file) => {
     let suiteId = 1;
     const testsAPI = keysCodes;
 
@@ -25,9 +25,17 @@ module.exports = (suite, browsers) => {
         suite = Suite.create(name, parent);
         parent.addChild(suite);
         suite.id = suiteId++;
-        if (browsers && suite.parent.isRoot) {
-            suite.browsers = browsers;
+
+        if (suite.parent.isRoot) {
+            if (browsers) {
+                suite.browsers = browsers;
+            }
+
+            if (file) {
+                suite.file = file;
+            }
         }
+
         callback(new SuiteBuilder(suite));
         if (suite.hasStates) {
             if (!suite.url) {
diff --git a/test/unit/reporters/html/view-model.js b/test/unit/reporters/html/view-model.js
@@ -0,0 +1,38 @@
+'use strict';
+
+const _ = require('lodash');
+
+const ViewModel = require('lib/reporters/html/view-model');
+
+describe('ViewModel', () => {
+    const sandbox = sinon.sandbox.create();
+    const stubTest_ = (opts) => {
+        opts = opts || {};
+
+        return _.defaultsDeep(opts, {
+            state: {name: 'name-default'},
+            suite: {
+                path: ['suite'],
+                metaInfo: {sessionId: 'sessionId-default'},
+                file: 'default/path/file.js'
+            }
+        });
+    };
+    const getResult_ = (model) => model.getResult().suites[0].children[0].browsers[0].result;
+    const createViewModel_ = () =>{
+        const config = {forBrowser: sandbox.stub().returns({})};
+        return new ViewModel(config);
+    };
+
+    it('should contain "file" in "metaInfo"', () => {
+        const model = createViewModel_();
+
+        model.addSuccess(stubTest_({
+            suite: {file: '/path/file.js'}
+        }));
+
+        const metaInfo = JSON.parse(getResult_(model).metaInfo);
+
+        assert.equal(metaInfo.file, '/path/file.js');
+    });
+});
diff --git a/test/unit/test-reader.js b/test/unit/test-reader.js
@@ -135,6 +135,19 @@ describe('test-reader', () => {
                     );
                 });
         });
+
+        it('should call "testsApi" with relative file path', () => {
+            const groupByFile = () => ({'/project/root/path/file1.js': []});
+
+            const config = mkConfigStub({
+                system: {projectRoot: '/project/root'}
+            });
+
+            SetsBuilder.prototype.build.returns(Promise.resolve({groupByFile}));
+
+            return readTests_({config})
+                .then(() => assert.calledWith(testsApi, sinon.match.any, sinon.match.any, 'path/file1.js'));
+        });
     });
 
     describe('global "gemini" variable', () => {
diff --git a/test/unit/tests-api/index.js b/test/unit/tests-api/index.js

Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,7 @@ module.exports = class Suite {`
`24`	`24`	`this.afterActions = [];`
`25`	`25`	`this.browsers = [];`
`26`	`26`	`this.context = {};`
	`27`	`+ this.file = null;`
`27`	`28`	`definePrivate(this);`
`28`	`29`	`}`
`29`	`30`