Snapshot location

docs/recipes/typescript.md

@@ -83,3 +83,7 @@ test('an actual test', t => {
 ```
 $ npm test
 ```
+
+## Snapshots
+
+Ava derives the base location for the snapshot fixtures relative to the typescript as if it were standard javascript tests. It determines this from the associated `*.js.map` sourcemap files. Enabling sourcemaps with the typescript compiler can be done in either the [tsconfig](http://www.typescriptlang.org/docs/handbook/tsconfig-json.html) `tsconfig.json#compilerOptions#sourceMap=true` or in the `tsc` cli option `--sourceMap`.

lib/cli.js

@@ -144,6 +144,7 @@ exports.run = () => {
 		timeout: conf.timeout,
 		concurrency: conf.concurrency ? parseInt(conf.concurrency, 10) : 0,
 		updateSnapshots: conf.updateSnapshots,
+		snapshotLocation: conf.snapshotLocation,
 		color: conf.color
 	});
 

lib/main.js

@@ -13,7 +13,8 @@ const runner = new Runner({
 	match: opts.match,
 	projectDir: opts.projectDir,
 	serial: opts.serial,
-	updateSnapshots: opts.updateSnapshots
+	updateSnapshots: opts.updateSnapshots,
+	snapshotLocation: opts.snapshotLocation
 });
 
 worker.setRunner(runner);

lib/runner.js

@@ -52,6 +52,7 @@ class Runner extends EventEmitter {
 		this.projectDir = options.projectDir;
 		this.serial = options.serial;
 		this.updateSnapshots = options.updateSnapshots;
+		this.snapshotLocation = options.snapshotLocation;
 
 		this.hasStarted = false;
 		this.results = [];
@@ -187,7 +188,8 @@ class Runner extends EventEmitter {
 				projectDir: this.projectDir,
 				relFile: path.relative(this.projectDir, this.file),
 				testDir: path.dirname(this.file),
-				updating: this.updateSnapshots
+				updating: this.updateSnapshots,
+				location: this.snapshotLocation
 			});
 			this.emit('dependency', this.snapshots.snapPath);
 		}

lib/snapshot-manager.js

@@ -81,6 +81,18 @@ function tryRead(file) {
 	}
 }
 
+function tryReadSourceMap(file) {
+	const content = tryRead(file);
+	if (content) {
+		try {
+			return JSON.parse(content.toString());
+		} catch (err) {
+			console.error('Parse error on snapshot sourcemap', file);
+			throw err;
+		}
+	}
+}
+
 function withoutLineEndings(buffer) {
 	let newLength = buffer.byteLength - 1;
 	while (buffer[newLength] === 0x0A || buffer[newLength] === 0x0D) {
@@ -355,7 +367,16 @@ class Manager {
 	}
 }
 
-function determineSnapshotDir(projectDir, testDir) {
+function determineSnapshotDir(options) {
+	const projectDir = options.projectDir;
+	const testDir = determineSourceMappedDir(options);
+	if (options.location) {
+		// "snapshotLocation" in ava package.json config, snapshots derive a location
+		// relative from the source testDir not the preset "__snapshots__" folder names
+		const resolvedLocation = path.resolve(options.projectDir, options.location);
+		const relativeTestLocation = options.testDir.replace(options.projectDir, '');
+		return path.join(resolvedLocation, relativeTestLocation);
+	}
 	const parts = new Set(path.relative(projectDir, testDir).split(path.sep));
 	if (parts.has('__tests__')) {
 		return path.join(testDir, '__snapshots__');
@@ -365,8 +386,31 @@ function determineSnapshotDir(projectDir, testDir) {
 	return testDir;
 }
 
+function determineSourceMappedDir(options) {
+	const sourceMapFilePath = path.join(options.testDir, `${options.name}.map`);
+	const sourceMapContent = tryReadSourceMap(sourceMapFilePath);
+
+	if (sourceMapContent) {
+		const targetFilename = path.basename(sourceMapContent.file, 'js');
+		const testFileSource = sourceMapContent.sources.find(file => {
+			const fileName = file.replace(path.extname(targetFilename), '');
+			return fileName.indexOf(targetFilename) > -1;
+		});
+		if (testFileSource) {
+			if (options.location) {
+				const basePath = path.join(options.projectDir, options.location);
+				const sourceTestFilePath = path.dirname(path.resolve(options.testDir, testFileSource));
+				const relativePath = sourceTestFilePath.replace(options.projectDir, '');
+				return path.join(basePath, relativePath);
+			}
+			return path.dirname(path.resolve(options.testDir, testFileSource));
+		}
+	}
+	return options.testDir;
+}
+
 function load(options) {
-	const dir = determineSnapshotDir(options.projectDir, options.testDir);
+	const dir = determineSnapshotDir(options);
 	const reportFile = `${options.name}.md`;
 	const snapFile = `${options.name}.snap`;
 	const snapPath = path.join(dir, snapFile);

readme.md

@@ -1041,6 +1041,20 @@ You can then check your code. If the change was intentional you can use the `--u
 $ ava --update-snapshots
 ```
 
+You can also set a custom location for the generated snapshot fixtures. This can be configured in the `package.json#ava` configuration for every test run.
+
+```json
+{
+  "ava": {
+    "snapshotLocation": "custom-directory"
+  }
+}
+```
+
+Snapshots fixtures will be then saved in a directory structure that reflects the test sourcecode.
+
+If you are transpiling the tests with sourcemaps, ava will derive the test location from the `*.js.map` files, see more in the [TypeScript](docs/recipes/typescript.md) recipe.
+
 ### Skipping assertions
 
 Any assertion can be skipped using the `skip` modifier. Skipped assertions are still counted, so there is no need to change your planned assertion count.

test/cli.js

@@ -680,6 +680,49 @@ test('legacy snapshot files are reported to the console', t => {
 	});
 });
 
+test('snapshots infer their location from sourcemaps', t => {
+	t.plan(8);
+	const dirname = path.join('fixture/snapshots/test-sourcemaps');
+	const testLocationTypes = [
+		'src',
+		'src/test/snapshots',
+		'src/feature/__tests__/__snapshots__'
+	];
+	const removeExists = relFilePath => {
+		const snapshotFolderPath = path.join(__dirname, dirname, relFilePath);
+		t.true(fs.existsSync(path.join(snapshotFolderPath, 'test.js.md')));
+		t.true(fs.existsSync(path.join(snapshotFolderPath, 'test.js.snap')));
+	};
+	execCli([], {dirname}, (err, stdout, stderr) => {
+		t.ifError(err);
+		testLocationTypes.forEach(removeExists);
+		t.match(stderr, /6 passed/);
+		t.end();
+	});
+});
+
+test('snapshots resolved location from "snapshotLocation" in ava config', t => {
+	t.plan(8);
+	const dirname = path.join('fixture/snapshots/test-snapshot-location');
+	const snapshotLocation = 'snapshot-fixtures';
+	const testLocationTypes = [
+		'src',
+		'src/feature',
+		'src/feature/nested-feature'
+	];
+	const removeExists = relFilePath => {
+		const snapshotFolderPath = path.join(__dirname, dirname, snapshotLocation, relFilePath);
+		t.true(fs.existsSync(path.join(snapshotFolderPath, 'test.js.md')));
+		t.true(fs.existsSync(path.join(snapshotFolderPath, 'test.js.snap')));
+	};
+	execCli([], {dirname}, (err, stdout, stderr) => {
+		t.ifError(err);
+		testLocationTypes.forEach(removeExists);
+		t.match(stderr, /6 passed/);
+		t.end();
+	});
+});
+
 test('--no-color disables formatting colors', t => {
 	execCli(['--no-color', '--verbose', 'formatting-color.js'], {dirname: 'fixture'}, (err, stdout, stderr) => {
 		t.ok(err);

test/fixture/snapshots/test-snapshot-location/package.json

@@ -0,0 +1,8 @@
+{
+  "ava": {
+	"files": [
+		"src/**/*test.js"
+	],
+	"snapshotLocation": "snapshot-fixtures"
+  }
+}

test/fixture/snapshots/test-snapshot-location/src/feature/nested-feature/test.js

@@ -0,0 +1,11 @@
+import test from '../../../../../../..';
+
+test('test nested feature title', t => {
+	t.snapshot({foo: 'bar'});
+
+	t.snapshot({answer: 42});
+});
+
+test('another nested feature test', t => {
+	t.snapshot(new Map());
+});

test/fixture/snapshots/test-snapshot-location/src/feature/test.js

@@ -0,0 +1,11 @@
+import test from '../../../../../..';
+
+test('test feature title', t => {
+	t.snapshot({foo: 'bar'});
+
+	t.snapshot({answer: 42});
+});
+
+test('another feature test', t => {
+	t.snapshot(new Map());
+});

test/fixture/snapshots/test-snapshot-location/src/test.js

@@ -0,0 +1,11 @@
+import test from '../../../../..';
+
+test('test title', t => {
+	t.snapshot({foo: 'bar'});
+
+	t.snapshot({answer: 42});
+});
+
+test('another test', t => {
+	t.snapshot(new Map());
+});

test/fixture/snapshots/test-sourcemaps/package.json

@@ -0,0 +1,10 @@
+{
+  "scripts": {
+	"build": "tsc"
+  },
+  "ava": {
+	"files": [
+		"build/**/*test.js"
+	]
+  }
+}

test/fixture/snapshots/test-sourcemaps/src/feature/__tests__/test.ts

@@ -0,0 +1,11 @@
+import test from '../../../../../../..'
+
+test('feature test title', t => {
+	t.snapshot({foo: 'bar'});
+
+	t.snapshot({answer: 40});
+});
+
+test('another feature test', t => {
+	t.snapshot(new Map());
+});

test/fixture/snapshots/test-sourcemaps/src/test.ts

@@ -0,0 +1,11 @@
+import test from '../../../../..';
+
+test('top level test title', t => {
+	t.snapshot({foo: 'bar'});
+
+	t.snapshot({answer: 42});
+});
+
+test('another top level test', t => {
+	t.snapshot(new Map());
+});

test/fixture/snapshots/test-sourcemaps/src/test/test.ts

@@ -0,0 +1,11 @@
+import test from '../../../../../..';
+
+test('test title', t => {
+	t.snapshot({foo: 'bar'});
+
+	t.snapshot({answer: 43});
+});
+
+test('another test', t => {
+	t.snapshot(new Map());
+});

test/fixture/snapshots/test-sourcemaps/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+	"target": "es6",
+	"module": "commonjs",
+	"outDir": "build",
+	"sourceMap": true
+  },
+  "include": [
+	"src/**/*test.ts"
+  ]
+}