Implement prune jobs, rename command files

Author: Ilya Radchenko

README.md

@@ -20,7 +20,7 @@ command
   upgrade       Replace a plugin with the the latest version
   init          Initialize a new plugin for development
   runTest       Run a test and optionally deploy
-  cleanupJobs   Cleanup all jobs except for the latest 20 or custom
+  pruneJobs     Cleanup all jobs except for the latest 20 or custom
 
 Options:
    -v, --version       Print version and exit
@@ -96,12 +96,13 @@ Options:
   -d Deploy on green (optional) (flag)
 ```
 
-### cleanupJobs
+### pruneJobs
 
 Cleanup all jobs except for the latest 20 or custom
 
 ```
 Options:
   -k Number of latest jobs to keep, defaults to 20
   -p Project to targer, defaults to all projects
+  -d Just print stats about what will be removed, but do not remove any jobs
 ```

commands/addUser.js commands/add-user.jscommands/addUser.js renamed to commands/add-user.js

@@ -1,14 +1,15 @@
 'use strict';
 
 var order = [
-  require('./addUser'),
+  require('./add-user'),
   require('./restart'),
   require('./list'),
   require('./install'),
   require('./uninstall'),
   require('./upgrade'),
   require('./init'),
-  require('./runTest')
+  require('./run-test'),
+  require('./prune-jobs')
 ];
 
 module.exports.setup = function (deps, parser) {

commands/cleanupJobs.js

@@ -0,0 +1,32 @@
+'use strict';
+
+module.exports = function (deps, parser) {
+  var cleanupJobs = require('../lib/cleanup-jobs')(deps);
+
+  parser.command('pruneJobs')
+    .option('project', {
+      abbr: 'p',
+      help: 'Project to targer, defaults to all projects if not specified',
+    })
+    .option('keepJobs', {
+      abbr: 'k',
+      help: 'Number of latest jobs to keep',
+      default: 20
+    })
+    .option('dryRun', {
+      abbr: 'd',
+      help: 'Just print stats about what will be removed, but do not remove any jobs',
+      flag: true,
+      default: false
+    })
+    .callback(function (opts) {
+      deps.connect(function (err) {
+        if (err) {
+          throw err;
+        }
+
+        cleanupJobs(opts.keepJobs, opts.project, opts.dryRun);
+      });
+    })
+    .help('Cleanup all jobs except for the latest 20 or custom');
+};

commands/index.js

@@ -0,0 +1,103 @@
+'use strict';
+
+var Bluebird = require('bluebird');
+var colors = require('colors');
+
+module.exports = function(deps) {
+  var models = deps.models();
+  var Project = models.Project;
+  var Job = models.Job;
+
+  return function pruneJobs(keepNumJobs, projectName, dryRun) {
+    if (dryRun) {
+      console.log('** Dry Run **\n');
+    }
+
+    findProjects(projectName, Project).then(function (projects) {
+      return Bluebird.map(projects, function (project) {
+        return removeJobsAfterLatest(keepNumJobs, project.name, dryRun, Job);
+      })
+    }).catch(function (err) {
+      console.log(colors.red(err.message || err));
+    }).finally(function () {
+      process.exit(1);
+    });
+  };
+};
+
+/**
+ * Find all projects, or just the one specified
+ * 
+ * @private
+ * @param {String} name name identified or project, user/name format
+ * @param {Model<Project>} Project mongoose model
+ * @returns {Promise} resolves to an array of projects
+ */
+function findProjects(name, Project) {
+  var query;
+
+  if (name) {
+    query = Project.findOne({ name: name }).exec();
+  } else {
+    query = Project.find().exec();
+  }
+
+  return query.then(function (res) {
+    return res.length ? res : [res];
+  });
+}
+
+/**
+ * Finds all jobs for project, and removes if not a dry run;
+ * 
+ * @private
+ * @param {Number} keepJobs number of jobs to keep, defaults to 20
+ * @param {String} projectName user/name format
+ * @param {Boolean} dryRun just print the stats, no actual removal done
+ * @returns {Promise} resolves once stats printed, or jobs removed
+ */
+function removeJobsAfterLatest(keepJobs, projectName, dryRun, Job) {
+  return Job.find({ project: projectName })
+    .select('created')
+    .sort('-created')
+    .exec().then(function (jobs) {
+      var toRemove = jobs.slice(keepJobs);
+
+      logStats(projectName, jobs, toRemove, dryRun);
+
+      if (!dryRun && toRemove.length) {
+        return Bluebird.map(toRemove, function (job) {
+          return job.remove();
+        }).then(function () {
+          console.log(colors.yellow('    ' + toRemove.length + ' jobs removed'));
+        });
+      }
+    });
+}
+
+/**
+ * Log stats for job removal of a project
+ * 
+ * @private
+ * @param {String} projectName
+ * @param {Array<Job>} allJobs
+ * @param {Array<Job>} toRemove
+ */
+function logStats(projectName, allJobs, toRemove) {
+  if (!toRemove.length) {
+    return console.log(colors.green('No jobs to remove'));
+  }
+
+  var log = [
+    colors.green(colors.bold('Removing jobs for "' + projectName + '":')),
+    '    Keeping Latest ' + (allJobs.length - toRemove.length) + ' jobs.',
+    '      Total Jobs: ' + allJobs.length,
+    '      Latest job created on: ' + allJobs[0].created,
+    '      Oldest job created on: ' + allJobs[allJobs.length - 1].created,
+    '    Jobs To Remove: ' + toRemove.length,
+    '      Latest job created on: ' + toRemove[0].created,
+    '      Oldest job created on: ' + toRemove[toRemove.length - 1].created
+  ];
+
+  console.log(log.join('\n'));
+}

commands/prune-jobs.js

@@ -17,8 +17,10 @@
   },
   "homepage": "https://github.com/Strider-CD/strider-cli",
   "dependencies": {
+    "bluebird": "^3.4.7",
     "chokidar": "^0.9.0",
     "cli-table": "^0.3.0",
+    "colors": "^1.1.2",
     "debug": "^2.1.1",
     "glob": "^4.0.6",
     "lodash": "^2.4.1",