Adding automatic clean up of bitmaps_test directory option

core/command/approve.js

@@ -1,6 +1,7 @@
 var fs = require('../util/fs');
 var path = require('path');
 var map = require('p-map');
+const cleanupBitmapsTestDir = require('../util/cleanupBitmapsTestDir');
 
 var FAILED_DIFF_RE = /^failed_diff_/;
 var FILTER_DEFAULT = /\w+/;
@@ -38,7 +39,10 @@ module.exports = {
               }
             }
             return true;
-          }).then(resolve).catch(reject);
+          }).then(() => {
+            cleanupBitmapsTestDir(config)
+              .finally(resolve);
+          }).catch(reject);
         });
       });
     });

core/command/reference.js

@@ -2,27 +2,31 @@ const createBitmaps = require('../util/createBitmaps');
 const fs = require('../util/fs');
 const logger = require('../util/logger')('clean');
 const { shouldRunDocker, runDocker } = require('../util/runDocker');
+const cleanupBitmapsTestDir = require('../util/cleanupBitmapsTestDir');
 
 module.exports = {
   execute: function (config) {
-    if (shouldRunDocker(config)) {
-      return runDocker(config, 'reference');
-    } else {
-      var firstStep;
-      // do not remove reference directory if we are in incremental mode
-      if (config.args.filter || config.args.i) {
-        firstStep = Promise.resolve();
-      } else {
-        firstStep = fs.remove(config.bitmaps_reference).then(function () {
-          logger.success(config.bitmaps_reference + ' was cleaned.');
-        });
-      }
+    return cleanupBitmapsTestDir(config)
+      .finally(() => {
+        if (shouldRunDocker(config)) {
+          return runDocker(config, 'reference');
+        } else {
+          var firstStep;
+          // do not remove reference directory if we are in incremental mode
+          if (config.args.filter || config.args.i) {
+            firstStep = Promise.resolve();
+          } else {
+            firstStep = fs.remove(config.bitmaps_reference).then(function () {
+              logger.success(config.bitmaps_reference + ' was cleaned.');
+            });
+          }
 
-      return firstStep.then(function () {
-        return createBitmaps(config, true);
-      }).then(function () {
-        console.log('\nRun `$ backstop test` to generate diff report.\n');
+          return firstStep.then(function () {
+            return createBitmaps(config, true);
+          }).then(function () {
+            console.log('\nRun `$ backstop test` to generate diff report.\n');
+          });
+        }
       });
-    }
   }
 };

core/command/test.js

@@ -1,18 +1,22 @@
 const createBitmaps = require('../util/createBitmaps');
 const { shouldRunDocker, runDocker } = require('../util/runDocker');
+const cleanupBitmapsTestDir = require('../util/cleanupBitmapsTestDir');
 
 // This task will generate a date-named directory with DOM screenshot files as specified in `./capture/config.json` followed by running a report.
 // NOTE: If there is no bitmaps_reference directory or if the bitmaps_reference directory is empty then a new batch of reference files will be generated in the bitmaps_reference directory.  Reporting will be skipped in this case.
 module.exports = {
   execute: function (config) {
-    const executeCommand = require('./index');
-    if (shouldRunDocker(config)) {
-      return runDocker(config, 'test')
-        .finally(() => executeCommand('_openReport', config));
-    } else {
-      return createBitmaps(config, false).then(function () {
-        return executeCommand('_report', config);
+    return cleanupBitmapsTestDir(config)
+      .finally(() => {
+        const executeCommand = require('./index');
+        if (shouldRunDocker(config)) {
+          return runDocker(config, 'test')
+            .finally(() => executeCommand('_openReport', config));
+        } else {
+          return createBitmaps(config, false).then(function () {
+            return executeCommand('_report', config);
+          });
+        }
       });
-    }
   }
 };

core/util/cleanupBitmapsTestDir.js

@@ -0,0 +1,13 @@
+var fs = require('../util/fs');
+var logger = require('../util/logger')('clean');
+
+function cleanupBitmapsTestDir (config) {
+  if (config.cleanupBitmapsTestDir) {
+    return fs.remove(config.bitmaps_test).then(function () {
+      logger.success(config.bitmaps_test + ' was cleaned.');
+    });
+  }
+  return Promise.resolve();
+}
+
+module.exports = cleanupBitmapsTestDir;

core/util/extendConfig.js

@@ -22,6 +22,7 @@ function extendConfig (config, userConfig) {
   config.resembleOutputOptions = userConfig.resembleOutputOptions;
   config.asyncCompareLimit = userConfig.asyncCompareLimit;
   config.backstopVersion = version;
+  config.cleanupBitmapsTestDir = userConfig.cleanupBitmapsTestDir || false;
   return config;
 }
 

package.json

@@ -15,6 +15,7 @@
     "init": "node ./cli/index.js init",
     "reference": "node ./cli/index.js reference",
     "test": "node ./cli/index.js test",
+    "approve": "node ./cli/index.js approve",
     "openReport": "node ./cli/index.js openReport",
     "echo": "node ./cli/index.js echo",
     "unit-test": "mocha --reporter spec --recursive test/cli",