grunt-build-control - npm Package Compare versions

Comparing version 0.1.7 to 0.1.8

package.json

 {
   "name": "grunt-build-control",
   "description": "Automate version control tasks for your project's built code. Keep built code in sync with source code, maintain multiple branches of built code, commit with automatic messages, and push to remote repositories.",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "homepage": "https://github.com/robwierzbowski/grunt-build-control",
@@ -6,0 +6,0 @@ "author": "Rob Wierzbowski <[e-mail]> (http://robwierzbowski)",

tasks/build_control.js

@@ -60,2 +60,4 @@ /*
     function maskSensitive(str) {
+      if (!options.token) return str;
+
       return str
@@ -62,0 +64,0 @@ .replace(options.login + ':' + options.token, '<CREDENTIALS>', 'gm')

test/readme.md

@@ -24,5 +24,5 @@ # Tests
 
-A quick little helper to watch and rerun tests
+A quick little helper to watch and rerun tests (requires `npm install nodemon -g`)
 ```bash
-nodemon -w test -i test/mock-repo --exec 'grunt test'
+nodemon -w test -w tasks/ -i test/mock-repo --exec 'grunt test'
 ```
@@ -45,4 +45,4 @@
 The test case can be found in "/test/tests.js", high level is:
-    - it purges `mock-repo/`
-	- it copies `scanerios/basic deployment/**` to `mock-repo/`
+	- it purges `mock-repo/`
+	- it copies `scenarios/basic deployment/**` to `mock-repo/`
 	- it changes working directory to `mock-repo/`
@@ -58,1 +58,3 @@ - it executes the test case named `basic deployment`
 ```
+
+How does mocha know which scenario folder to copy? By the `describe` suite title of course!

test/tests.js

@@ -27,43 +27,43 @@ /*jshint -W030 */
 var execScenario = function(cb) {
-	var mockRepoDir = path.normalize(__dirname + '/mock-repo');
+  var mockRepoDir = path.normalize(__dirname + '/mock-repo');
 
-	var remoteDir = path.join(mockRepoDir, 'remote');
-	var verifyDir = path.join(mockRepoDir, 'verify');
+  var remoteDir = path.join(mockRepoDir, 'remote');
+  var verifyDir = path.join(mockRepoDir, 'verify');
 
 
-	var tasks = [];
+  var tasks = [];
 
 
-	tasks.push(function createRemote(next) {
-		fs.ensureDirSync(remoteDir);
-		childProcess.exec('git init --bare', {cwd: remoteDir}, function(err) {
-			if (err) throw new Error(err);
-			next(err);
-		});
-	});
+  tasks.push(function createRemote(next) {
+    fs.ensureDirSync(remoteDir);
+    childProcess.exec('git init --bare', {cwd: remoteDir}, function(err) {
+      if (err) throw new Error(err);
+      next(err);
+    });
+  });
 
 
-	tasks.push(function executeGruntCommand(next) {
-		//options
-		GRUNT_EXEC += ' --no-color';
+  tasks.push(function executeGruntCommand(next) {
+    //options
+    GRUNT_EXEC += ' --no-color';
 
-		childProcess.exec(GRUNT_EXEC, {cwd: mockRepoDir}, function(err, stdout, stderr) {
-			next(err, {stdout: stdout, stderr: stderr});
-		});
-	});
+    childProcess.exec(GRUNT_EXEC, {cwd: mockRepoDir}, function(err, stdout, stderr) {
+      next(err, {stdout: stdout, stderr: stderr});
+    });
+  });
 
 
-	tasks.push(function createVerifyFromRemote(next) {
-		fs.removeSync(verifyDir); // since we're cloning from `remote/` we'll just remove the folder if it exists
-		childProcess.exec('git clone remote verify', {cwd: mockRepoDir}, function(err) {
-			if (err) throw new Error(err);
-			next(err);
-		});
-	});
+  tasks.push(function createVerifyFromRemote(next) {
+    fs.removeSync(verifyDir); // since we're cloning from `remote/` we'll just remove the folder if it exists
+    childProcess.exec('git clone remote verify', {cwd: mockRepoDir}, function(err) {
+      if (err) throw new Error(err);
+      next(err);
+    });
+  });
 
 
-	async.series(tasks, function returnCallbackStatus(err, results) {
-		// return results from executeGruntCommand
-		cb(err, results[1]);
-	});
+  async.series(tasks, function returnCallbackStatus(err, results) {
+    // return results from executeGruntCommand
+    cb(err, results[1]);
+  });
 };
@@ -76,148 +76,186 @@
  *
- * Each test is using the perspective as a "user", take a look at the "basic deploy" test.
+ * Each test is using the perspective as a "user", take a look at the "basic deploy" suite.
  *
+ * `describe` suite's title should have the same name as the scenario folder.
+ *
  * Assumptions:
- *    - test name MUST MATCH scenario folder name
  *    - each tests' current working directory has been set to `test/mock-repo`
  */
 describe('buildcontrol', function() {
-	this.timeout(10000);
+  this.timeout(10000);
 
 
-	beforeEach(function(done) {
-		// ensure that we reset to `test/` dir
-		process.chdir(__dirname);
+  beforeEach(function(done) {
+    // ensure that we reset to `test/` dir
+    process.chdir(__dirname);
 
-		// clean testing folder `test/mock-repo`
-		fs.removeSync('mock-repo');
-		fs.ensureDirSync('mock-repo');
+    // clean testing folder `test/mock-repo`
+    fs.removeSync('mock-repo');
+    fs.ensureDirSync('mock-repo');
 
-		// copy scenario to `test/mock-repo`
-		fs.copySync('scenarios/' + this.currentTest.title, 'mock-repo');
+    // copy scenario to `test/mock-repo`
+    fs.copySync('scenarios/' + this.currentTest.parent.title, 'mock-repo');
 
-		// ensure all tests are are using the working directory: `test/mock-repo`
-		process.chdir('mock-repo');
-		done();
-	});
+    // ensure all tests are are using the working directory: `test/mock-repo`
+    process.chdir('mock-repo');
+    done();
+  });
 
 
 
-	it('basic deployment', function(done) {
-		// the working directory is `test/mock-repo`.
-		var tasks = [];
+  describe('basic deployment', function() {
+    it('should have pushed a file and had the correct commit in "verify" repo', function(done) {
+      // the working directory is `test/mock-repo`.
+      var tasks = [];
 
-		/**
-		 * Test case specific setup
-		 */
-		// make `mock-repo` a actual repository
-		tasks.push(function git_init(next) {
-			childProcess.exec('git init', next);
-		});
+      /**
+       * Test case specific setup
+       */
+        // make `mock-repo` a actual repository
+      tasks.push(function git_init(next) {
+        childProcess.exec('git init', next);
+      });
 
-		tasks.push(function git_add(next) {
-			childProcess.exec('git add .', next);
-		});
+      tasks.push(function git_add(next) {
+        childProcess.exec('git add .', next);
+      });
 
-		tasks.push(function git_commit(next) {
-			childProcess.exec('git commit -m "basic deployment"', next);
-		});
+      tasks.push(function git_commit(next) {
+        childProcess.exec('git commit -m "basic deployment"', next);
+      });
 
-		/**
-		 * Execute scenario
-		 */
-		tasks.push(function execute_scenario(next) {
-			execScenario(function(err) {
-				should.not.exist(err);
-				next();
-			});
-		});
+      /**
+       * Execute scenario
+       */
+      tasks.push(function execute_scenario(next) {
+        execScenario(function(err) {
+          should.not.exist(err);
+          next();
+        });
+      });
 
-		/**
-		 * Should style validations
-		 */
-		tasks.push(function verify_file_exists(next) {
-			fs.existsSync('verify/empty_file').should.be.true;
-			next();
-		});
+      /**
+       * Should style validations
+       */
+      tasks.push(function verify_file_exists(next) {
+        fs.existsSync('verify/empty_file').should.be.true;
+        next();
+      });
 
-		tasks.push(function verify_commit_message(next) {
-			childProcess.exec('git rev-parse HEAD', function(err, sha) {
-				sha = sha.substr(0, 7);
+      tasks.push(function verify_commit_message(next) {
+        childProcess.exec('git rev-parse HEAD', function(err, sha) {
+          sha = sha.substr(0, 7);
 
-				childProcess.exec('git log --pretty=oneline --no-color', {cwd: 'verify'}, function(err, stdout) {
-					stdout.should.have.string('from commit ' + sha);
-					next();
-				});
-			});
-		});
+          childProcess.exec('git log --pretty=oneline --no-color', {cwd: 'verify'}, function(err, stdout) {
+            stdout.should.have.string('from commit ' + sha);
+            next();
+          });
+        });
+      });
 
-		async.series(tasks, done);
-	});
+      async.series(tasks, done);
+    });
 
 
-	it('merge multiple repos', function(done) {
-		execScenario(function(err, results) {
-			should.not.exist(err);
-			var numberFile = fs.readFileSync('verify/numbers.txt', {encoding: 'utf8'});
-			numberFile.should.be.eql('0 1 2\n');
-			done();
-		});
-	});
 
 
-	it('simple deploy', function(done) {
-		var tasks = [];
+  });
 
-		tasks.push(function(next) {
-			execScenario(function() {
-				var numberFile = fs.readFileSync('verify/numbers.txt', {encoding: 'utf8'});
-				numberFile.should.be.eql('1 2 3 4\n');
-				next();
-			});
-		});
 
-		tasks.push(function(next) {
-			fs.writeFileSync('dist/numbers.txt', '100 200');
+  describe('merge multiple repos', function() {
+    it('merge multiple repos', function(done) {
+      execScenario(function(err, results) {
+        should.not.exist(err);
+        var numberFile = fs.readFileSync('verify/numbers.txt', {encoding: 'utf8'});
+        numberFile.should.be.eql('0 1 2\n');
+        done();
+      });
+    });
 
-			execScenario(function(err, results) {
-				var numberFile = fs.readFileSync('verify/numbers.txt', {encoding: 'utf8'});
-				numberFile.should.be.eql('100 200');
-				next();
-			});
-		});
+  });
 
-		tasks.push(function(next) {
-			childProcess.exec('git log --pretty=oneline --abbrev-commit --no-color', {cwd: 'verify'}, function(err, stdout) {
-				stdout.match(/simple deploy commit message/g).length.should.be.eql(2);
-				next();
-			});
-		});
 
-		async.series(tasks, done);
-	});
+  describe('simple deploy', function() {
+    it('should deploy multiple times with the correct commit message', function(done) {
+      var tasks = [];
 
+      tasks.push(function(next) {
+        execScenario(function() {
+          var numberFile = fs.readFileSync('verify/numbers.txt', {encoding: 'utf8'});
+          numberFile.should.be.eql('1 2 3 4\n');
+          next();
+        });
+      });
 
-  it('secure endpoint', function(done) {
-		var tasks = [];
+      tasks.push(function(next) {
+        fs.writeFileSync('dist/numbers.txt', '100 200');
 
-		tasks.push(function(next) {
-			execScenario(function(err, results) {
-        results.stdout.should.not.have.string('privateUsername');
-        results.stdout.should.not.have.string('1234567890abcdef');
-        results.stdout.should.have.string('github.com/pubUsername/temp.git');
-        results.stdout.should.have.string('<CREDENTIALS>');
-        next();
+        execScenario(function(err, results) {
+          var numberFile = fs.readFileSync('verify/numbers.txt', {encoding: 'utf8'});
+          numberFile.should.be.eql('100 200');
+          next();
+        });
       });
-		});
 
-    tasks.push(function(next) {
-      childProcess.exec('git remote -v', {cwd: 'dist'}, function(err, stdout) {
-        stdout.should.have.string('https://privateUsername:[e-mail]/pubUsername/temp.git');
-        next();
+      tasks.push(function(next) {
+        childProcess.exec('git log --pretty=oneline --abbrev-commit --no-color', {cwd: 'verify'}, function(err, stdout) {
+          stdout.should.have.string('simple deploy commit message');
+          next();
+        });
       });
+
+      async.series(tasks, done);
     });
 
-		async.series(tasks, done);
-	});
 
+    it('should not have <TOKEN> in the message', function(done) {
+      execScenario(function(err, result) {
+        should.not.exist(err);
+        result.stdout.should.not.have.string('<TOKEN>');
+        done();
+      });
+    });
+
+  });
+
+
+  describe('secure endpoint', function() {
+    it('should not log out secure information', function(done) {
+      var tasks = [];
+
+      tasks.push(function(next) {
+        execScenario(function(err, results) {
+          results.stdout.should.not.have.string('privateUsername');
+          results.stdout.should.not.have.string('1234567890abcdef');
+          results.stdout.should.have.string('github.com/pubUsername/temp.git');
+          results.stdout.should.have.string('<CREDENTIALS>');
+          next();
+        });
+      });
+
+      async.series(tasks, done);
+    });
+
+
+    it('should have the correct remote url in git', function(done) {
+      var tasks = [];
+
+      tasks.push(function(next) {
+        execScenario(function() {
+          next();
+        });
+      });
+
+      tasks.push(function(next) {
+        childProcess.exec('git remote -v', {cwd: 'dist'}, function(err, stdout) {
+          stdout.should.have.string('https://privateUsername:[e-mail]/pubUsername/temp.git');
+          next();
+        });
+      });
+
+      async.series(tasks, done);
+    });
+
+  });
+
 });

No alert changes

Improved metrics

Total package byte prevSize

71803

increased by18.14%

Lines of code

649

increased by4.17%

No dependency changes