69 lines
2.8 KiB
TypeScript
69 lines
2.8 KiB
TypeScript
/**
|
|
* Copyright Microsoft Corporation. All rights reserved.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
import type { Expect } from '../types';
|
|
import { currentTestInfo } from '../globals';
|
|
import { compare } from './golden';
|
|
import { addSuffixToFilePath } from '../util';
|
|
|
|
// from expect/build/types
|
|
type SyncExpectationResult = {
|
|
pass: boolean;
|
|
message: () => string;
|
|
};
|
|
|
|
type NameOrSegments = string | string[];
|
|
export function toMatchSnapshot(this: ReturnType<Expect['getState']>, received: Buffer | string, nameOrOptions: NameOrSegments | { name: NameOrSegments, threshold?: number }, optOptions: { threshold?: number } = {}): SyncExpectationResult {
|
|
let options: { name: NameOrSegments, threshold?: number };
|
|
const testInfo = currentTestInfo();
|
|
if (!testInfo)
|
|
throw new Error(`toMatchSnapshot() must be called during the test`);
|
|
if (Array.isArray(nameOrOptions) || typeof nameOrOptions === 'string')
|
|
options = { name: nameOrOptions, ...optOptions };
|
|
else
|
|
options = { ...nameOrOptions };
|
|
if (!options.name)
|
|
throw new Error(`toMatchSnapshot() requires a "name" parameter`);
|
|
|
|
const projectThreshold = testInfo.project.expect?.toMatchSnapshot?.threshold;
|
|
if (options.threshold === undefined && projectThreshold !== undefined)
|
|
options.threshold = projectThreshold;
|
|
|
|
// sanitizes path if string
|
|
const pathSegments = Array.isArray(options.name) ? options.name : [addSuffixToFilePath(options.name, '', undefined, true)];
|
|
const withNegateComparison = this.isNot;
|
|
let updateSnapshots = testInfo.config.updateSnapshots;
|
|
if (updateSnapshots === 'missing' && testInfo.retry < testInfo.project.retries)
|
|
updateSnapshots = 'none';
|
|
const { pass, message, expectedPath, actualPath, diffPath, mimeType } = compare(
|
|
received,
|
|
pathSegments,
|
|
testInfo.snapshotPath,
|
|
testInfo.outputPath,
|
|
updateSnapshots,
|
|
withNegateComparison,
|
|
options
|
|
);
|
|
const contentType = mimeType || 'application/octet-stream';
|
|
if (expectedPath)
|
|
testInfo.attachments.push({ name: 'expected', contentType, path: expectedPath });
|
|
if (actualPath)
|
|
testInfo.attachments.push({ name: 'actual', contentType, path: actualPath });
|
|
if (diffPath)
|
|
testInfo.attachments.push({ name: 'diff', contentType, path: diffPath });
|
|
return { pass, message: () => message || '' };
|
|
}
|