Adds optional configuration snapshotTag

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

@@ -513,6 +513,11 @@ export const options = {
       'use for snapshot testing.',
     type: 'array',
   },
+  snapshotTag: {
+    description:
+      "A tag to be appended to Jest's snapshots file name. It may not contain '.' in it.",
+    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/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,
@@ -133,6 +133,7 @@ const getConfigs = (
       runTestsByPath: options.runTestsByPath,
       silent: options.silent,
       skipFilter: options.skipFilter,
+      snapshotTag: options.snapshotTag,
       testFailureExitCode: options.testFailureExitCode,
       testNamePattern: options.testNamePattern,
       testPathPattern: options.testPathPattern,
@@ -178,6 +179,7 @@ const getConfigs = (
       skipFilter: options.skipFilter,
       skipNodeResolution: options.skipNodeResolution,
       snapshotSerializers: options.snapshotSerializers,
+      snapshotTag: options.snapshotTag,
       testEnvironment: options.testEnvironment,
       testEnvironmentOptions: options.testEnvironmentOptions,
       testLocationInResults: options.testLocationInResults,

packages/jest-config/src/normalize.js

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

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,21 +22,34 @@ 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,
-        ),
-    )
+    .filter(snapshotFile => {
+      const snapshotFilename = path.basename(
+        snapshotFile,
+        '.' + utils.SNAPSHOT_EXTENSION,
+      );
+      if (snapshotTag) {
+        const doesFileExists = path.resolve(
+          path.dirname(snapshotFile),
+          '..',
+          snapshotFilename
+            .split('.', snapshotFilename.split('.').length - 1)
+            .join('.'),
+        );
+        if (doesFileExists) return false;
+      }
+      return !fileExists(
+        path.resolve(path.dirname(snapshotFile), '..', snapshotFilename),
+        hasteFS,
+      );
+    })
     .map(snapshotFile => {
       if (update === 'all') {
         fs.unlinkSync(snapshotFile);

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,13 @@ export const keyToTestName = (key: string) => {
   return key.replace(/ \d+$/, '');
 };
 
-export const getSnapshotPath = (testPath: Path) =>
+export const getSnapshotExtension = (snapshotTag?: ?string) =>
+  (snapshotTag ? `.${snapshotTag}` : '') + '.' + 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

@@ -108,6 +108,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

@@ -54,6 +54,7 @@ export type DefaultOptions = {|
   runTestsByPath: boolean,
   skipFilter: boolean,
   snapshotSerializers: Array<Path>,
+  snapshotTag?: ?string,
   testEnvironment: string,
   testEnvironmentOptions: Object,
   testFailureExitCode: string | number,
@@ -137,6 +138,7 @@ export type InitialOptions = {
   skipFilter?: boolean,
   skipNodeResolution?: boolean,
   snapshotSerializers?: Array<Path>,
+  snapshotTag?: ?string,
   testEnvironment?: string,
   testEnvironmentOptions?: Object,
   testFailureExitCode?: string | number,
@@ -204,6 +206,7 @@ export type GlobalConfig = {|
   rootDir: Path,
   silent: boolean,
   skipFilter: boolean,
+  snapshotTag?: ?string,
   testFailureExitCode: number,
   testNamePattern: string,
   testPathPattern: string,
@@ -250,6 +253,7 @@ export type ProjectConfig = {|
   skipFilter: boolean,
   skipNodeResolution: boolean,
   snapshotSerializers: Array<Path>,
+  snapshotTag?: ?string,
   testEnvironment: string,
   testEnvironmentOptions: Object,
   testMatch: Array<Glob>,