Ability to define custom metadata + some documentation errors #19

LennDG · 2017-11-27T10:28:58Z

I added 2 .tmpl files to give the possibility to add custom metadata to features. This will override all regular metadata. The PR does not create any breaking changes to already existing code that uses the project.

One bug that I do not know how to fix is that when many variables are added, the list of Metadata variables in a Feature overview will start continuing outside of the Metadata overview box.

I added the documentation on how this feature is used and corrected some typos and errors in the already existing documentation.

…e existing interface

coveralls · 2017-11-27T10:30:20Z

Coverage decreased (-0.6%) to 97.756% when pulling b21cbdd on LennDG:master into 1be6145 on wswebcreation:master.

wswebcreation

Hi @LennDG

Tnx for this PR, this one is smaller and better to check ;-).

If I now generate the report with the old testdata I get this in the overview

And this in the scenario template

Looks like the code isn't doing what it should do. Please make your changes be backwards compatible otherwise I can't approve the PR.

Please also look at the rest of the comments

wswebcreation · 2017-12-02T07:14:28Z

lib/generate-report.js

        const featuresOverviewIndex = path.resolve(reportPath, INDEX_HTML);

+        // Assign the correct overview template
+        var featuresOverviewTemplate;


Please write this as and try to avoid the usage of var

FEATURE_METADATA_OVERVIEW_TEMPLATE = suite.customMetadata ? FEATURE_CUSTOM_METADATA_OVERVIEW_TEMPLATE : FEATURE_METADATA_OVERVIEW_TEMPLATE;

wswebcreation · 2017-12-02T07:21:30Z

lib/generate-report.js

    function _createFeatureIndexPages(suite) {
+
+        // Set custom metadata overview for the feature
+        var featuresMetadataOverview;


Please write this as below and try to avoid the usage of var

FEATURE_METADATA_OVERVIEW_TEMPLATE = suite.customMetadata ? FEATURE_CUSTOM_METADATA_OVERVIEW_TEMPLATE : FEATURE_METADATA_OVERVIEW_TEMPLATE;

wswebcreation · 2017-12-02T07:22:28Z

lib/generate-report.js

 const FEATURE_FOLDER = 'features';
 const FEATURES_OVERVIEW_INDEX_TEMPLATE = 'features-overview.index.tmpl';
 const CUSTOMDATA_TEMPLATE = 'components/custom-data.tmpl';
 const FEATURES_OVERVIEW_TEMPLATE = 'components/features-overview.tmpl';


Make a let of this

wswebcreation · 2017-12-02T07:22:42Z

lib/generate-report.js

 const FEATURES_OVERVIEW_INDEX_TEMPLATE = 'features-overview.index.tmpl';
 const CUSTOMDATA_TEMPLATE = 'components/custom-data.tmpl';
 const FEATURES_OVERVIEW_TEMPLATE = 'components/features-overview.tmpl';
+const FEATURES_OVERVIEW_CUSTOM_METADATA_TEMPLATE = 'components/features-overview-custom-metadata.tmpl'


Your missing a ; here

wswebcreation · 2017-12-02T07:22:50Z

lib/generate-report.js

 const FEATURES_OVERVIEW_CHART_TEMPLATE = 'components/features-overview.chart.tmpl';
 const SCENARIOS_OVERVIEW_CHART_TEMPLATE = 'components/scenarios-overview.chart.tmpl';
 const FEATURE_OVERVIEW_INDEX_TEMPLATE = 'feature-overview.index.tmpl';
 const FEATURE_METADATA_OVERVIEW_TEMPLATE = 'components/feature-metadata-overview.tmpl';


Make a let of this

wswebcreation · 2017-12-02T07:23:35Z

lib/generate-report.js

            _.template(_readTemplateFile(FEATURES_OVERVIEW_INDEX_TEMPLATE))({
                suite: suite,
-                featuresOverview: _.template(_readTemplateFile(FEATURES_OVERVIEW_TEMPLATE))({
+                featuresOverview: _.template(_readTemplateFile(featuresOverviewTemplate))({


Keep the old line here because we re-assigned the let

wswebcreation · 2017-12-02T07:23:52Z

lib/generate-report.js

                        _: _
                    }),
-                    featureMetadataOverview: _.template(_readTemplateFile(FEATURE_METADATA_OVERVIEW_TEMPLATE))({
+                    featureMetadataOverview: _.template(_readTemplateFile(featuresMetadataOverview))({


Keep the old line here because we re-assigned the let

wswebcreation · 2017-12-02T07:25:00Z

test/test.js

 test.generate({
    saveCollectedJSON: true,
-    jsonDir: './test/unit/data/json/',
+    jsonDir: './reports/',


Please provide a new test file with new data and and a new location so we can generate the report for your specific changes

LennDG · 2017-12-04T07:39:19Z

Alright I will incorporate your comments. Quite new to Javascript so I will take some time to figure out best practices.

…st and data for testing the custom metadata functionality

coveralls · 2017-12-11T08:48:09Z

Coverage decreased (-0.6%) to 97.742% when pulling 8cceda9 on LennDG:master into 1be6145 on wswebcreation:master.

LennDG · 2017-12-11T08:48:47Z

Sorry for the late update, I was sick last week.

The first issue is because the customMetadata flag was set to true for the old data. Since the old does not have metadata formed as [{name: "foo", value: "bar"}] it has some weird effects. In correct usage this should not happen. I added a new test and changed the variable assignments like you requested.

coveralls · 2017-12-11T08:55:06Z

Coverage decreased (-0.6%) to 97.742% when pulling 03f6376 on LennDG:master into 1be6145 on wswebcreation:master.

wswebcreation

I just got one question, if we look at the situation where you use the report (without browsers), do you also have an example of json-output you get. I prefer having the data more specific to prevent questions about the testdata in the future.

wswebcreation · 2017-12-11T19:35:17Z

test/unit/data/custom-metadata-json/ambiguous_scenarios_specified_v1.json

@@ -0,0 +1,100 @@
+[


Hi @LennDG

Tnx for the changes. I only think you missed something. If I now generate the files there is no custom-metadata in the report, there is also no custom metadata in the pushed JSON files

I overwrite the metadata of the JSON files and have not added a custom-metadata field. This is to use the existing code as much as possible without needing changes.

wswebcreation · 2017-12-11T19:36:29Z

test/custom-metadata-test.js

@@ -0,0 +1,21 @@
+'use strict';


When I now look at this I think we can do it better like this in 1 file. I've also adjusted the paths so they will not overwrite each other. Hope you don't mind it.

'use strict'; const test = require('../lib/generate-report'); /** * Generate a report for browsers */ test.generate({ saveCollectedJSON: true, jsonDir: './test/unit/data/json/', reportPath: './.tmp/browsers/', reportName: 'You can adjust this report name', customData: { title: 'Run info', data: [ {label: 'Project', value: 'Custom project'}, {label: 'Release', value: '1.2.3'}, {label: 'Cycle', value: 'B11221.34321'}, {label: 'Execution Start Time', value: 'Nov 19th 2017, 02:31 PM EST'}, {label: 'Execution End Time', value: 'Nov 19th 2017, 02:56 PM EST'} ] } }); /** * Generate a report with custom metadata */ test.generate({ saveCollectedJSON: true, jsonDir: './test/unit/data/custom-metadata-json/', reportPath: './.tmp/custom-metadata/', reportName: 'You can adjust this report name', customMetadata: true, customData: { title: 'Run info', data: [ {label: 'Project', value: 'Custom project'}, {label: 'Release', value: '1.2.3'}, {label: 'Cycle', value: 'B11221.34321'}, {label: 'Execution Start Time', value: 'Nov 19th 2017, 02:31 PM EST'}, {label: 'Execution End Time', value: 'Nov 19th 2017, 02:56 PM EST'} ] } });

It's your project, I can't tell you what to do with filepaths :)

wswebcreation · 2017-12-11T19:37:25Z

test/unit/data/custom-metadata-json/ambiguous_scenarios_specified_v1.json

+    "name": "Ambiguous scenarios specified V1",
+    "tags": [],
+    "uri": "/Users/wswebcreation/deTesters/protractor-cucumber-typescript-boilerplate/e2e-tests/features/ambiguous.feature",
+    "metadata": [


I think this can be removed

Do you mean that the file can be removed? I just overwrote the metadata field to re use it.

No this is good 👍

wswebcreation · 2017-12-11T19:37:34Z

test/unit/data/custom-metadata-json/ambiguous_scenarios_specified_v2.json

@@ -0,0 +1,72 @@
+[
+  {
+    "metadata": [


I think this can be removed

wswebcreation · 2017-12-11T19:37:57Z

test/unit/data/custom-metadata-json/happy_flow_app_android.json

@@ -0,0 +1,77 @@
+[
+  {
+    "metadata": [


I think this can be removed, I also think the App needs to be removed from the testdata so we have "clean" data

I cleaned out the App because it indeed didn't make sense and was confusing.

wswebcreation · 2017-12-11T19:38:42Z

test/unit/data/custom-metadata-json/pending_scenarios_specified_v1.json

+    "name": "Pending scenarios specified V1",
+    "tags": [],
+    "uri": "/Users/wswebcreation/deTesters/protractor-cucumber-typescript-boilerplate/e2e-tests/features/pending.feature",
+    "metadata": [


I think this can be removed

wswebcreation · 2017-12-11T19:38:48Z

test/unit/data/custom-metadata-json/skipped_scenarios.json

@@ -0,0 +1,278 @@
+[
+  {
+    "metadata": [


I think this can be removed

wswebcreation · 2017-12-11T19:39:00Z

test/unit/data/custom-metadata-json/undefined_scenarios_specified_v3.json

@@ -0,0 +1,90 @@
+[
+  {
+    "metadata": [


I think this can be removed

LennDG · 2017-12-12T09:50:21Z

I will update the test data to reflect other use cases than browser versions.

…distinct metadata from the browsers

coveralls · 2017-12-12T10:16:22Z

Coverage decreased (-0.6%) to 97.742% when pulling 8bfb31d on LennDG:master into 1be6145 on wswebcreation:master.

LennDG · 2017-12-12T10:18:17Z

The pushed JSON files have their custom metadata under the metadata field. I decided against using a custom-metadata field to prevent users being confused by trying to use both simultaneously, which does not work.

wswebcreation · 2017-12-15T04:38:11Z

Hi @LennDG

It now looks great. Thanks for this feature! I'll merge it and make a new release

ldegraef added 5 commits November 27, 2017 10:59

Added possibility to define custom metadata and provide it through th…

1738c90

…e existing interface

Changed the test to show some actual variabales

7cc98be

added a picture for documentation

4b250f3

updated the last README error I could find

1a5c8d9

changed fileformat of picture to conform to the rest

b21cbdd

LennDG mentioned this pull request Nov 29, 2017

Allowing custom metadata #18

Closed

wswebcreation self-assigned this Dec 2, 2017

wswebcreation requested changes Dec 2, 2017

View reviewed changes

Changed the way the custom metadata template is chosen and added a te…

8cceda9

…st and data for testing the custom metadata functionality

Forgot the data files for custom data test

03f6376

wswebcreation reviewed Dec 11, 2017

View reviewed changes

Merged the tests files and updated the custom metadata jsons to have …

8bfb31d

…distinct metadata from the browsers

wswebcreation merged commit b6f7a28 into WasiqB:master Dec 15, 2017

Uh oh!

Ability to define custom metadata + some documentation errors #19

Ability to define custom metadata + some documentation errors #19

Uh oh!

Conversation

LennDG commented Nov 27, 2017

Uh oh!

coveralls commented Nov 27, 2017

Uh oh!

wswebcreation left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

LennDG commented Dec 4, 2017

Uh oh!

coveralls commented Dec 11, 2017

Uh oh!

LennDG commented Dec 11, 2017

Uh oh!

coveralls commented Dec 11, 2017

Uh oh!

wswebcreation left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

LennDG commented Dec 12, 2017

Uh oh!

coveralls commented Dec 12, 2017

Uh oh!

LennDG commented Dec 12, 2017

Uh oh!

wswebcreation commented Dec 15, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!