forked from microsoft/accessibility-insights-action
/
workflow-enforcer.spec.ts
132 lines (99 loc) · 4.68 KB
/
workflow-enforcer.spec.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
import 'reflect-metadata';
import { Mock, Times, IMock, MockBehavior } from 'typemoq';
import { ADOTaskConfig } from '../../task-config/ado-task-config';
import { CombinedReportParameters } from 'accessibility-insights-report';
import { BaselineEvaluation, BaselineFileContent } from 'accessibility-insights-scan';
import { WorkflowEnforcer } from './workflow-enforcer';
import { Logger } from '@accessibility-insights-action/shared';
describe(WorkflowEnforcer, () => {
let adoTaskConfigMock: IMock<ADOTaskConfig>;
let loggerMock: IMock<Logger>;
let workflowEnforcer: WorkflowEnforcer;
beforeEach(() => {
adoTaskConfigMock = Mock.ofType<ADOTaskConfig>(undefined, MockBehavior.Strict);
loggerMock = Mock.ofType<Logger>(undefined, MockBehavior.Strict);
});
describe('constructor', () => {
it('initializes', () => {
workflowEnforcer = buildWorkflowEnforcerWithMocks();
verifyAllMocks();
});
});
describe('completeRun', () => {
it('logs correct error if accessibility error occurred', async () => {
const reportStub = {
results: {
urlResults: {
failedUrls: 1,
},
},
} as unknown as CombinedReportParameters;
const baselineEvaluationStub = {} as BaselineEvaluation;
setupFailOnAccessibilityError(true);
setupLoggerWithErrorMessage('An accessibility error was found and you specified the "failOnAccessibilityError" flag.');
const workflowEnforcer = buildWorkflowEnforcerWithMocks();
await workflowEnforcer.completeRun(reportStub, baselineEvaluationStub);
verifyAllMocks();
});
it('logs correct error if baseline needs to be updated', async () => {
const reportStub = {} as CombinedReportParameters;
const baselineEvaluationStub = {
suggestedBaselineUpdate: {} as BaselineFileContent,
} as BaselineEvaluation;
setupFailOnAccessibilityError(false);
setupBaselineFileParameterExists();
setupLoggerWithErrorMessage('The baseline file does not match scan results.');
const workflowEnforcer = buildWorkflowEnforcerWithMocks();
await workflowEnforcer.completeRun(reportStub, baselineEvaluationStub);
verifyAllMocks();
});
it('succeeds in happy path (baseline enabled)', async () => {
const reportStub = {} as CombinedReportParameters;
const baselineEvaluationStub = {} as BaselineEvaluation;
setupFailOnAccessibilityError(false);
setupBaselineFileParameterExists();
const workflowEnforcer = buildWorkflowEnforcerWithMocks();
await workflowEnforcer.completeRun(reportStub, baselineEvaluationStub);
verifyAllMocks();
});
it('succeeds in happy path (baselineEvaluation not provided)', async () => {
const reportStub = {} as CombinedReportParameters;
setupFailOnAccessibilityError(false);
workflowEnforcer = buildWorkflowEnforcerWithMocks();
await workflowEnforcer.completeRun(reportStub);
verifyAllMocks();
});
});
describe('didScanSucceed', () => {
it('returns true by default', async () => {
const workflowEnforcer = buildWorkflowEnforcerWithMocks();
await expect(workflowEnforcer.didScanSucceed()).resolves.toBe(true);
});
it('returns false after failRun() is called', async () => {
const workflowEnforcer = buildWorkflowEnforcerWithMocks();
await workflowEnforcer.failRun();
await expect(workflowEnforcer.didScanSucceed()).resolves.toBe(false);
});
});
const buildWorkflowEnforcerWithMocks = () => new WorkflowEnforcer(adoTaskConfigMock.object, loggerMock.object);
const verifyAllMocks = () => {
adoTaskConfigMock.verifyAll();
};
const setupFailOnAccessibilityError = (fail: boolean) => {
adoTaskConfigMock
.setup((o) => o.getFailOnAccessibilityError())
.returns(() => fail)
.verifiable(Times.atLeastOnce());
};
const setupBaselineFileParameterExists = () => {
adoTaskConfigMock
.setup((o) => o.getBaselineFile())
.returns(() => 'baseline-file')
.verifiable(Times.atLeastOnce());
};
const setupLoggerWithErrorMessage = (message: string) => {
loggerMock.setup((o) => o.logError(message)).verifiable(Times.once());
};
});