spec/stage/crew/serenity-bdd-reporter/SerenityBDDReporter/describing_scene.spec.ts

/* eslint-disable unicorn/filename-case, @typescript-eslint/indent */
import 'mocha';

import { expect } from '@integration/testing-tools';
import { StageManager } from '@serenity-js/core';
import { FeatureNarrativeDetected, SceneBackgroundDetected, SceneDescriptionDetected, SceneFinished, SceneStarts, TestRunFinishes } from '@serenity-js/core/lib/events';
import { CorrelationId, Description, ExecutionSuccessful, Name } from '@serenity-js/core/lib/model';
import * as sinon from 'sinon';

import { SerenityBDDReporter } from '../../../../../src';
import { SerenityBDDReport } from '../../../../../src/stage/crew/serenity-bdd-reporter/SerenityBDDJsonSchema';
import { given } from '../../given';
import { defaultCardScenario } from '../../samples';
import { create } from '../create';

describe('SerenityBDDReporter', () => {

    let stageManager: sinon.SinonStubbedInstance<StageManager>,
        reporter: SerenityBDDReporter;

    const sceneId = new CorrelationId('a-scene-id');

    beforeEach(() => {
        const env = create();

        stageManager    = env.stageManager;
        reporter        = env.reporter;
    });

    /**
     * @test {SerenityBDDReporter}
     * @test {SceneStarts}
     * @test {SceneBackgroundDetected}
     * @test {SceneFinished}
     * @test {ExecutionSuccessful}
     * @test {TestRunFinishes}
     */
    it('captures information about scenario background', () => {
        given(reporter).isNotifiedOfFollowingEvents(
            new SceneStarts(sceneId, defaultCardScenario),
                new SceneBackgroundDetected(sceneId, new Name('Background title'), new Description('Background description')),
            new SceneFinished(sceneId, defaultCardScenario, new ExecutionSuccessful()),
            new TestRunFinishes(),
        );

        const report: SerenityBDDReport = stageManager.notifyOf.firstCall.lastArg.artifact.map(_ => _);

        expect(report.backgroundTitle).to.equal('Background title');
        expect(report.backgroundDescription).to.equal('Background description');
    });

    /**
     * @test {SerenityBDDReporter}
     * @test {SceneStarts}
     * @test {SceneDescriptionDetected}
     * @test {SceneFinished}
     * @test {ExecutionSuccessful}
     * @test {TestRunFinishes}
     */
    it('captures the description of the scenario', () => {
        given(reporter).isNotifiedOfFollowingEvents(
            new SceneStarts(sceneId, defaultCardScenario),
            new SceneDescriptionDetected(sceneId, new Description('Scenario description')),
            new SceneFinished(sceneId, defaultCardScenario, new ExecutionSuccessful()),
            new TestRunFinishes(),
        );

        const report: SerenityBDDReport = stageManager.notifyOf.firstCall.lastArg.artifact.map(_ => _);

        expect(report.description).to.equal('Scenario description');
    });

    /**
     * @test {SerenityBDDReporter}
     * @test {SceneStarts}
     * @test {FeatureNarrativeDetected}
     * @test {SceneFinished}
     * @test {ExecutionSuccessful}
     * @test {TestRunFinishes}
     */
    it('captures the narrative behind the scenario', () => {
        given(reporter).isNotifiedOfFollowingEvents(
            new SceneStarts(sceneId, defaultCardScenario),
            new FeatureNarrativeDetected(sceneId, new Description('Feature narrative')),
            new SceneFinished(sceneId, defaultCardScenario, new ExecutionSuccessful()),
            new TestRunFinishes(),
        );

        const report: SerenityBDDReport = stageManager.notifyOf.firstCall.lastArg.artifact.map(_ => _);

        expect(report.userStory.narrative).to.equal('Feature narrative');
    });
});