fix(core): removed deprecated ContextTag

use PlatformTag and BrowserTag instead Related tickets: closes #1403
serenity-js · Mar 22, 2023 · d09a688 · d09a688
1 parent 58cc29c
commit d09a688
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 47 deletions.
diff --git a/packages/core/spec/model/Tag.spec.ts b/packages/core/spec/model/Tag.spec.ts
@@ -1,7 +1,7 @@
 import { describe } from 'mocha';
 import { given } from 'mocha-testdata';
 
-import { ArbitraryTag, BrowserTag, CapabilityTag, ContextTag, FeatureTag, IssueTag, ManualTag, Tag, Tags, ThemeTag } from '../../src/model';
+import { ArbitraryTag, BrowserTag, CapabilityTag, FeatureTag, IssueTag, ManualTag, Tag, Tags, ThemeTag } from '../../src/model';
 import { expect } from '../expect';
 
 describe('Tag', () => {
@@ -29,7 +29,6 @@ describe('Tag', () => {
         new ArbitraryTag('wip'),
         new BrowserTag('chrome', '80.0.3987.87'),
         new CapabilityTag('checkout'),
-        new ContextTag('mac osx'),
         new FeatureTag('testability'),
         new IssueTag('abc-123'),
         new ManualTag(),

diff --git a/packages/core/src/model/tags/ContextTag.ts b/packages/core/src/model/tags/ContextTag.ts
diff --git a/packages/core/src/model/tags/index.ts b/packages/core/src/model/tags/index.ts
@@ -1,7 +1,6 @@
 export * from './ArbitraryTag';
 export * from './BrowserTag';
 export * from './CapabilityTag';
-export * from './ContextTag';
 export * from './ExecutionRetriedTag';
 export * from './FeatureTag';
 export * from './IssueTag';

diff --git a/...y-bdd/spec/stage/crew/serenity-bdd-reporter/SerenityBDDReporter/tagging_scenarios.spec.ts b/...y-bdd/spec/stage/crew/serenity-bdd-reporter/SerenityBDDReporter/tagging_scenarios.spec.ts
@@ -2,7 +2,7 @@
 import { EventRecorder, expect, PickEvent } from '@integration/testing-tools';
 import { Stage } from '@serenity-js/core';
 import { ArtifactGenerated, SceneFinished, SceneStarts, SceneTagged, TestRunFinishes } from '@serenity-js/core/lib/events';
-import { ArbitraryTag, BrowserTag, CapabilityTag, ContextTag, CorrelationId, ExecutionSuccessful, FeatureTag, IssueTag, ManualTag, ThemeTag } from '@serenity-js/core/lib/model';
+import { ArbitraryTag, BrowserTag, CapabilityTag, CorrelationId, ExecutionSuccessful, FeatureTag, IssueTag, ManualTag, PlatformTag, ThemeTag } from '@serenity-js/core/lib/model';
 import { beforeEach, describe, it } from 'mocha';
 
 import { defaultCardScenario } from '../../samples';
@@ -247,7 +247,7 @@ describe('SerenityBDDReporter', () => {
 
                     it('indicates the operating system where the test was executed', () => {
                         stage.announce(
-                            new SceneTagged(sceneId, new ContextTag('iphone')),
+                            new SceneTagged(sceneId, new PlatformTag('iphone')),
                             new SceneFinished(sceneId, defaultCardScenario, new ExecutionSuccessful()),
                             new TestRunFinishes(),
                         );
@@ -261,15 +261,17 @@ describe('SerenityBDDReporter', () => {
                                 expect(report.tags).to.deep.include.members([{
                                     name: 'iphone',
                                     displayName: 'iphone',
-                                    type: 'context',
+                                    platformName: 'iphone',
+                                    platformVersion: '',
+                                    type: 'platform'
                                 }]);
                             });
                     });
 
                     it('ensures that the user-specified context takes precedence over browser context', () => {
                         stage.announce(
                             new SceneTagged(sceneId, new BrowserTag('safari', '13.0.5')),
-                            new SceneTagged(sceneId, new ContextTag('iphone')),
+                            new SceneTagged(sceneId, new PlatformTag('iphone')),
                             new SceneFinished(sceneId, defaultCardScenario, new ExecutionSuccessful()),
                             new TestRunFinishes(),
                         );
@@ -278,19 +280,21 @@ describe('SerenityBDDReporter', () => {
                             .last(ArtifactGenerated, event => {
                                 const report = event.artifact.map(_ => _);
 
-                                expect(report.context).to.equal('iphone');
+                                expect(report.context).to.equal('safari,iphone');
 
-                                expect(report.tags).to.deep.include.members([{
+                                expect(report.tags).to.deep.include.members([ {
                                     name: 'safari 13.0.5',
-                                    displayName: 'safari 13.0.5',
                                     type: 'browser',
                                     browserName: 'safari',
                                     browserVersion: '13.0.5',
+                                    displayName: 'safari 13.0.5',
                                 }, {
                                     name: 'iphone',
-                                    displayName: 'iphone',
-                                    type: 'context',
-                                }]);
+                                    type: 'platform',
+                                    platformName: 'iphone',
+                                    platformVersion: '',
+                                    displayName: 'iphone'
+                                } ]);
                             });
                     });
                 });

diff --git a/...ges/serenity-bdd/src/stage/crew/serenity-bdd-reporter/processors/transformations/tagOf.ts b/...ges/serenity-bdd/src/stage/crew/serenity-bdd-reporter/processors/transformations/tagOf.ts
@@ -1,4 +1,4 @@
-import { BrowserTag, CapabilityTag, ContextTag, ExecutionRetriedTag, FeatureTag, IssueTag, ManualTag, PlatformTag, Tag, ThemeTag } from '@serenity-js/core/lib/model';
+import { BrowserTag, CapabilityTag, ExecutionRetriedTag, FeatureTag, IssueTag, ManualTag, PlatformTag, Tag, ThemeTag } from '@serenity-js/core/lib/model';
 import { match } from 'tiny-types';
 import { equal } from 'tiny-types/lib/objects';
 
@@ -89,15 +89,6 @@ export function tagOf<Context extends SerenityBDDReportContext>(tag: Tag): (cont
 
                 return context;
             })
-            .when(ContextTag, _ => {
-
-                reportIdIncluding(tag.name)(context);
-
-                context.report.context = tag.name;
-                context.report.tags = concatIfNotPresent(context.report.tags, tagReportFor(tag));
-
-                return context;
-            })
             .when(ExecutionRetriedTag, _ => {
 
                 reportIdIncluding(tag.name)(context);