Test behavior with existing unsorted snapshots

Author: ninevra

test/snapshot-order/fixtures/backwards-compatibility/append-only/package.json

@@ -0,0 +1 @@
+{}

test/snapshot-order/fixtures/backwards-compatibility/append-only/test.js

@@ -0,0 +1,26 @@
+const test = require('ava');
+
+const id = index => `index: ${index}`;
+
+let resolveDelay;
+const delay = new Promise(resolve => {
+	resolveDelay = resolve;
+});
+
+test('B - declared first, resolves second', async t => {
+	await delay;
+	t.snapshot(id(1));
+});
+
+test('A - declared second, resolves first', t => {
+	t.snapshot(id(2));
+	resolveDelay();
+});
+
+test('D - a new test, declared third', t => {
+	t.snapshot(id(3));
+});
+
+test('C - another new test, declared fourth', t => {
+	t.snapshot(id(4));
+});

test/snapshot-order/fixtures/backwards-compatibility/check-only/package.json

@@ -0,0 +1 @@
+{}

test/snapshot-order/fixtures/backwards-compatibility/check-only/test.js

@@ -0,0 +1,18 @@
+const test = require('ava');
+
+const id = index => `index: ${index}`;
+
+let resolveDelay;
+const delay = new Promise(resolve => {
+	resolveDelay = resolve;
+});
+
+test('B - declared first, resolves second', async t => {
+	await delay;
+	t.snapshot(id(1));
+});
+
+test('A - declared second, resolves first', t => {
+	t.snapshot(id(2));
+	resolveDelay();
+});

test/snapshot-order/fixtures/backwards-compatibility/unsorted/test.js.md

@@ -0,0 +1,17 @@
+# Snapshot report for `test.js`
+
+The actual snapshot is saved in `test.js.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## A - declared second, resolves first
+
+> Snapshot 1
+
+    'index: 2'
+
+## B - declared first, resolves second
+
+> Snapshot 1
+
+    'index: 1'

test/snapshot-order/fixtures/backwards-compatibility/unsorted/test.js.snap

@@ -0,0 +1 @@
+{}

test/snapshot-order/fixtures/backwards-compatibility/updating/package.json

@@ -0,0 +1,18 @@
+const test = require('ava');
+
+const id = index => `index: ${index}`;
+
+let resolveDelay;
+const delay = new Promise(resolve => {
+	resolveDelay = resolve;
+});
+
+test('B - declared first, resolves second', async t => {
+	await delay;
+	t.snapshot(id(1));
+});
+
+test('A - declared second, resolves first', t => {
+	t.snapshot(id(2));
+	resolveDelay();
+});

test/snapshot-order/fixtures/backwards-compatibility/updating/test.js

@@ -33,6 +33,19 @@ test('snapshot files are independent of test resolution order', async t => {
 	t.deepEqual(snapshot, snapshotReversed);
 });
 
+function getSnapshotIds(report) {
+	function * matchAll(string, regexp) {
+		let match;
+		while ((match = regexp.exec(string)) !== null) {
+			yield match;
+		}
+	}
+
+	const ids = [...matchAll(report, /'index: ([-.\d]+)'/g)].map(match => Number(match[1]));
+
+	return ids;
+}
+
 test('snapshot reports are sorted in declaration order', async t => {
 	const options = {
 		cwd: exec.cwd('report-declaration-order'),
@@ -44,16 +57,115 @@ test('snapshot reports are sorted in declaration order', async t => {
 	await exec.fixture(['--update-snapshots'], options);
 
 	const report = fs.readFileSync(path.join(options.cwd, 'test.js.md'), {encoding: 'utf8'});
+	const ids = getSnapshotIds(report);
 
-	function * matchAll(string, regexp) {
-		let match;
-		while ((match = regexp.exec(string)) !== null) {
-			yield match;
+	t.deepEqual(ids, [...ids].sort((a, b) => a - b));
+});
+
+const unsortedSnapshotPath = path.join(__dirname, 'fixtures', 'backwards-compatibility', 'unsorted', 'test.js.snap');
+const unsortedReportPath = path.join(__dirname, 'fixtures', 'backwards-compatibility', 'unsorted', 'test.js.md');
+
+const unsortedSnapshot = fs.readFileSync(unsortedSnapshotPath);
+const unsortedReport = fs.readFileSync(unsortedReportPath);
+
+test('unsorted snapshots are unchanged when checking', async t => {
+	const options = {
+		cwd: exec.cwd('backwards-compatibility', 'check-only'),
+		env: {
+			AVA_FORCE_CI: 'not-ci'
 		}
-	}
+	};
 
-	const ids = [...matchAll(report, /'index: ([-.\d]+)'/g)].map(match => Number(match[1]));
-	const sortedIds = [...ids].sort((a, b) => a - b);
+	const snapshotPath = path.join(options.cwd, 'test.js.snap');
+	const reportPath = path.join(options.cwd, 'test.js.md');
+
+	// Install a known-unsorted snapshot, report
+	fs.copyFileSync(unsortedSnapshotPath, snapshotPath);
+	fs.copyFileSync(unsortedReportPath, reportPath);
+
+	// Run test
+	await exec.fixture([], options);
+
+	// Assert snapshot, report are unchanged
+	const snapshot = fs.readFileSync(snapshotPath);
+	const report = fs.readFileSync(reportPath);
+
+	t.deepEqual(snapshot, unsortedSnapshot);
+	t.deepEqual(report, unsortedReport);
+
+	// Clean up the snapshot, report
+	fs.unlinkSync(snapshotPath);
+	fs.unlinkSync(reportPath);
+});
+
+test('unsorted snapshots are changed when appending', async t => {
+	const options = {
+		cwd: exec.cwd('backwards-compatibility', 'append-only'),
+		env: {
+			AVA_FORCE_CI: 'not-ci'
+		}
+	};
+
+	const snapshotPath = path.join(options.cwd, 'test.js.snap');
+	const reportPath = path.join(options.cwd, 'test.js.md');
+
+	// Install a known-unsorted snapshot, report
+	fs.copyFileSync(unsortedSnapshotPath, snapshotPath);
+	fs.copyFileSync(unsortedReportPath, reportPath);
+
+	// Run test
+	await exec.fixture([], options);
+
+	// Assert snapshot, report are changed
+	const snapshot = fs.readFileSync(snapshotPath);
+	const report = fs.readFileSync(reportPath);
+
+	t.notDeepEqual(snapshot, unsortedSnapshot);
+	t.notDeepEqual(report, unsortedReport);
+
+	// Assert entries appended to report are sorted
+	const textReport = report.toString();
+	const ids = getSnapshotIds(textReport);
+
+	t.deepEqual(ids, [2, 1, 3, 4]);
+
+	// Clean up the snapshot, report
+	fs.unlinkSync(snapshotPath);
+	fs.unlinkSync(reportPath);
+});
+
+test('unsorted snapshots are changed when updating', async t => {
+	const options = {
+		cwd: exec.cwd('backwards-compatibility', 'updating'),
+		env: {
+			AVA_FORCE_CI: 'not-ci'
+		}
+	};
+
+	const snapshotPath = path.join(options.cwd, 'test.js.snap');
+	const reportPath = path.join(options.cwd, 'test.js.md');
+
+	// Install a known-unsorted snapshot, report
+	fs.copyFileSync(unsortedSnapshotPath, snapshotPath);
+	fs.copyFileSync(unsortedReportPath, reportPath);
+
+	// Run test
+	await exec.fixture(['--update-snapshots'], options);
+
+	// Assert snapshot, report are changed
+	const snapshot = fs.readFileSync(snapshotPath);
+	const report = fs.readFileSync(reportPath);
+
+	t.notDeepEqual(snapshot, unsortedSnapshot);
+	t.notDeepEqual(report, unsortedReport);
+
+	// Assert report is sorted
+	const textReport = report.toString();
+	const ids = getSnapshotIds(textReport);
+
+	t.deepEqual(ids, [1, 2]);
 
-	t.deepEqual(ids, sortedIds);
+	// Clean up the snapshot, report
+	fs.unlinkSync(snapshotPath);
+	fs.unlinkSync(reportPath);
 });