Adds optional configuration snapshotTag

TestUtils.js

@@ -94,6 +94,7 @@ const DEFAULT_PROJECT_CONFIG: ProjectConfig = {
   setupTestFrameworkScriptFile: null,
   skipNodeResolution: false,
   snapshotSerializers: [],
+  snapshotTag: '',
   testEnvironment: 'node',
   testEnvironmentOptions: {},
   testLocationInResults: false,

packages/jest-circus/src/legacy_code_todo_rewrite/jest_adapter_init.js

@@ -51,7 +51,12 @@ export const initialize = ({
     });
 
   const {expand, updateSnapshot} = globalConfig;
-  const snapshotState = new SnapshotState(testPath, {expand, updateSnapshot});
+  const snapshotTag = config.snapshotTag || globalConfig.snapshotTag || '';
+  const snapshotState = new SnapshotState(testPath, {
+    expand,
+    snapshotTag,
+    updateSnapshot,
+  });
   setState({snapshotState, testPath});
 
   // Return it back to the outer scope (test runner outside the VM).

packages/jest-cli/src/cli/args.js

@@ -497,6 +497,10 @@ export const options = {
       'use for snapshot testing.',
     type: 'array',
   },
+  snapshotTag: {
+    description: "A tag to be appended to Jest's snapshots file name.",
+    type: 'string',
+  },
   testEnvironment: {
     description: 'Alias for --env',
     type: 'string',

packages/jest-cli/src/test_scheduler.js

@@ -151,6 +151,7 @@ export default class TestScheduler {
         const status = snapshot.cleanup(
           context.hasteFS,
           this._globalConfig.updateSnapshot,
+          context.config.snapshotTag,
         );
 
         aggregatedResults.snapshot.filesRemoved += status.filesRemoved;

packages/jest-config/src/defaults.js

@@ -60,6 +60,7 @@ export default ({
   runTestsByPath: false,
   runner: 'jest-runner',
   snapshotSerializers: [],
+  snapshotTag: '',
   testEnvironment: 'jest-environment-jsdom',
   testEnvironmentOptions: {},
   testFailureExitCode: 1,

packages/jest-config/src/index.js

@@ -79,8 +79,8 @@ export function readConfig(
     configPath = resolveConfigPath(packageRootOrConfig, process.cwd());
     rawOptions = readConfigFileAndSetRootDir(configPath);
   }
-
   const {options, hasDeprecationWarnings} = normalize(rawOptions, argv);
+
   const {globalConfig, projectConfig} = getConfigs(options);
   return {
     configPath,
@@ -131,6 +131,7 @@ const getConfigs = (
       rootDir: options.rootDir,
       runTestsByPath: options.runTestsByPath,
       silent: options.silent,
+      snapshotTag: options.snapshotTag,
       testFailureExitCode: options.testFailureExitCode,
       testNamePattern: options.testNamePattern,
       testPathPattern: options.testPathPattern,
@@ -174,6 +175,7 @@ const getConfigs = (
       setupTestFrameworkScriptFile: options.setupTestFrameworkScriptFile,
       skipNodeResolution: options.skipNodeResolution,
       snapshotSerializers: options.snapshotSerializers,
+      snapshotTag: options.snapshotTag,
       testEnvironment: options.testEnvironment,
       testEnvironmentOptions: options.testEnvironmentOptions,
       testLocationInResults: options.testLocationInResults,

packages/jest-config/src/normalize.js

@@ -527,6 +527,7 @@ export default function normalize(options: InitialOptions, argv: Argv) {
       case 'runTestsByPath':
       case 'silent':
       case 'skipNodeResolution':
+      case 'snapshotTag':
       case 'testEnvironment':
       case 'testEnvironmentOptions':
       case 'testFailureExitCode':

packages/jest-config/src/valid_config.js

@@ -82,6 +82,7 @@ export default ({
   silent: true,
   skipNodeResolution: false,
   snapshotSerializers: ['my-serializer-module'],
+  snapshotTag: '',
   testEnvironment: 'jest-environment-jsdom',
   testEnvironmentOptions: {},
   testFailureExitCode: 1,

packages/jest-jasmine2/src/setup_jest_globals.js

@@ -100,7 +100,13 @@ export default ({
     });
   patchJasmine();
   const {expand, updateSnapshot} = globalConfig;
-  const snapshotState = new SnapshotState(testPath, {expand, updateSnapshot});
+  const snapshotTag = config.snapshotTag || globalConfig.snapshotTag || '';
+
+  const snapshotState = new SnapshotState(testPath, {
+    expand,
+    snapshotTag,
+    updateSnapshot,
+  });
   setState({snapshotState, testPath});
   // Return it back to the outer scope (test runner outside the VM).
   return snapshotState;

packages/jest-snapshot/src/State.js

@@ -21,9 +21,9 @@ import {
 } from './utils';
 
 export type SnapshotStateOptions = {|
-  updateSnapshot: SnapshotUpdateState,
-  snapshotPath?: string,
   expand?: boolean,
+  snapshotTag?: string,
+  updateSnapshot: SnapshotUpdateState,
 |};
 
 export default class SnapshotState {
@@ -41,7 +41,7 @@ export default class SnapshotState {
   updated: number;
 
   constructor(testPath: Path, options: SnapshotStateOptions) {
-    this._snapshotPath = options.snapshotPath || getSnapshotPath(testPath);
+    this._snapshotPath = getSnapshotPath(testPath, options.snapshotTag || '');
     const {data, dirty} = getSnapshotData(
       this._snapshotPath,
       options.updateSnapshot,

packages/jest-snapshot/src/__tests__/utils.test.js

@@ -13,11 +13,14 @@ const chalk = require('chalk');
 
 const {
   getSnapshotData,
+  getSnapshotExtension,
   getSnapshotPath,
   keyToTestName,
   saveSnapshotFile,
   serialize,
   testNameToKey,
+  SNAPSHOT_FOLDER,
+  SNAPSHOT_EXTENSION,
   SNAPSHOT_GUIDE_LINK,
   SNAPSHOT_VERSION,
   SNAPSHOT_VERSION_WARNING,
@@ -54,6 +57,18 @@ test('getSnapshotPath()', () => {
   expect(getSnapshotPath('/abc/cde/a.test.js')).toBe(
     path.join('/abc', 'cde', '__snapshots__', 'a.test.js.snap'),
   );
+  expect(getSnapshotPath('/abc/cde/a.test.js')).toBe(
+    path.join('/abc', 'cde', SNAPSHOT_FOLDER, 'a.test.js.snap'),
+  );
+  expect(getSnapshotPath('/abc/cde/a.test.js', 'someSnapshotTag')).toBe(
+    path.join('/abc', 'cde', '__snapshots__', 'a.test.js.someSnapshotTag.snap'),
+  );
+});
+
+test('getSnapshotExtension()', () => {
+  expect(getSnapshotExtension('')).toBe('.snap');
+  expect(getSnapshotExtension('')).toBe(SNAPSHOT_EXTENSION);
+  expect(getSnapshotExtension('someSnapshotTag')).toBe('.someSnapshotTag.snap');
 });
 
 test('saveSnapshotFile() works with \r\n', () => {

packages/jest-snapshot/src/index.js

@@ -22,26 +22,37 @@ import * as utils from './utils';
 const fileExists = (filePath: Path, hasteFS: HasteFS): boolean =>
   hasteFS.exists(filePath) || fs.existsSync(filePath);
 
-const cleanup = (hasteFS: HasteFS, update: SnapshotUpdateState) => {
+const cleanup = (
+  hasteFS: HasteFS,
+  update: SnapshotUpdateState,
+  snapshotTag: string,
+) => {
   const pattern = '\\.' + utils.SNAPSHOT_EXTENSION + '$';
-  const files = hasteFS.matchFiles(pattern);
-  const filesRemoved = files
-    .filter(
-      snapshotFile =>
-        !fileExists(
-          path.resolve(
-            path.dirname(snapshotFile),
-            '..',
-            path.basename(snapshotFile, '.' + utils.SNAPSHOT_EXTENSION),
-          ),
-          hasteFS,
-        ),
-    )
-    .map(snapshotFile => {
-      if (update === 'all') {
-        fs.unlinkSync(snapshotFile);
-      }
-    }).length;
+  const filesToRemove = hasteFS.matchFiles(pattern).filter(snapshotFile => {
+    if (snapshotTag) {
+      const baseNameParts = path.basename(snapshotFile).split('.');
+      baseNameParts.splice(snapshotTag.split().length * -1 - 1);
+      const doesFileExists = path.resolve(
+        path.dirname(snapshotFile),
+        '..',
+        path.basename(baseNameParts.join('.')),
+      );
+      if (doesFileExists) return false;
+    }
+    return !fileExists(
+      path.resolve(
+        path.dirname(snapshotFile),
+        '..',
+        path.basename(snapshotFile, utils.SNAPSHOT_EXTENSION),
+      ),
+      hasteFS,
+    );
+  });
+  const filesRemoved = filesToRemove.map(snapshotFile => {
+    if (update === 'all') {
+      fs.unlinkSync(snapshotFile);
+    }
+  }).length;
 
   return {
     filesRemoved,

packages/jest-snapshot/src/utils.js

@@ -17,6 +17,7 @@ import naturalCompare from 'natural-compare';
 import path from 'path';
 import prettyFormat from 'pretty-format';
 
+export const SNAPSHOT_FOLDER = '__snapshots__';
 export const SNAPSHOT_EXTENSION = 'snap';
 export const SNAPSHOT_VERSION = '1';
 const SNAPSHOT_VERSION_REGEXP = /^\/\/ Jest Snapshot v(.+),/;
@@ -88,10 +89,15 @@ export const keyToTestName = (key: string) => {
   return key.replace(/ \d+$/, '');
 };
 
-export const getSnapshotPath = (testPath: Path) =>
+export const getSnapshotExtension = (snapshotTag: string) =>
+  (snapshotTag ? `.${snapshotTag.toLowerCase()}` : '') +
+  '.' +
+  SNAPSHOT_EXTENSION;
+
+export const getSnapshotPath = (testPath: Path, snapshotTag: string) =>
   path.join(
-    path.join(path.dirname(testPath), '__snapshots__'),
-    path.basename(testPath) + '.' + SNAPSHOT_EXTENSION,
+    path.join(path.dirname(testPath), SNAPSHOT_FOLDER),
+    path.basename(testPath) + getSnapshotExtension(snapshotTag),
   );
 
 export const getSnapshotData = (

packages/jest-validate/src/__tests__/fixtures/jest_config.js

@@ -46,6 +46,7 @@ const defaultConfig = {
   restoreMocks: false,
   roots: ['<rootDir>'],
   snapshotSerializers: [],
+  snapshotTag: '',
   testEnvironment: 'jest-environment-jsdom',
   testPathIgnorePatterns: [NODE_MODULES_REGEXP],
   testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.jsx?$',
@@ -108,6 +109,7 @@ const validConfig = {
   setupTestFrameworkScriptFile: '<rootDir>/testSetupFile.js',
   silent: true,
   snapshotSerializers: ['my-serializer-module'],
+  snapshotTag: 'valid',
   testEnvironment: 'jest-environment-jsdom',
   testNamePattern: 'test signature',
   testPathIgnorePatterns: [NODE_MODULES_REGEXP],

types/Argv.js

@@ -74,6 +74,7 @@ export type Argv = {|
   showConfig: boolean,
   silent: boolean,
   snapshotSerializers: Array<string>,
+  snapshotTag: ?string,
   testEnvironment: string,
   testFailureExitCode: ?string,
   testMatch: Array<string>,

types/Config.js

@@ -52,6 +52,7 @@ export type DefaultOptions = {|
   runner: string,
   runTestsByPath: boolean,
   snapshotSerializers: Array<Path>,
+  snapshotTag: ?string,
   testEnvironment: string,
   testEnvironmentOptions: Object,
   testFailureExitCode: string | number,
@@ -133,6 +134,7 @@ export type InitialOptions = {
   silent?: boolean,
   skipNodeResolution?: boolean,
   snapshotSerializers?: Array<Path>,
+  snapshotTag: ?string,
   testEnvironment?: string,
   testEnvironmentOptions?: Object,
   testFailureExitCode?: string | number,
@@ -198,6 +200,7 @@ export type GlobalConfig = {|
   runTestsByPath: boolean,
   rootDir: Path,
   silent: boolean,
+  snapshotTag: string,
   testFailureExitCode: number,
   testNamePattern: string,
   testPathPattern: string,
@@ -242,6 +245,7 @@ export type ProjectConfig = {|
   setupTestFrameworkScriptFile: ?Path,
   skipNodeResolution: boolean,
   snapshotSerializers: Array<Path>,
+  snapshotTag: string,
   testEnvironment: string,
   testEnvironmentOptions: Object,
   testMatch: Array<Glob>,