Merge pull request #7 from NativeScript/add-e2e-tests

Add Mocha e2e tests

Author: angeltsvetkov

.gitignore

@@ -1,7 +1,8 @@
 #JavaScript
 *.tgz
 *.js
-!tests/*.js
+!prepare-tests.js
+!test/*.js
 *.js.map
 
 #Node
@@ -11,4 +12,4 @@ node_modules/
 #OSX
 .DS_Store
 
-tests/docsroot-output/
+test/docsroot-output/

.npmignore

@@ -3,4 +3,4 @@
 tags
 tsconfig.json
 
-tests/
+test/

README.md

@@ -162,4 +162,12 @@ When injected, a snippet is formatted using the default MarkDown code-snippet fo
 ```
 mdinject --root=. --docsroot=../ --sourceext=".java|.cs" --targetext=".md|.txt" --snippettitles="Java|C#"
 ```
+
+## Run e2e tests
+1. Clone repo
+2. npm install
+3. npm test
+
+E2E tests are developed with [Mocha](https://mochajs.org).
+
 > Note that the order of the snippet titles must be the related to the order of the source extension types so that they match.

package.json

@@ -11,7 +11,8 @@
     "definition": "index.d.ts"
   },
   "scripts": {
-    "prepublish": "tsc -p ."
+    "prepublish": "tsc -p .",
+    "test": "mocha"
   },
   "keywords": [
     "markdown",
@@ -22,10 +23,11 @@
   "author": "Deyan Ginev",
   "license": "MIT",
   "dependencies": {
-    "yargs": "^4.1.0",
-    "typescript": "^1.7.5"
+    "typescript": "^1.7.5",
+    "yargs": "^4.1.0"
   },
   "devDependencies": {
+    "mocha": "^3.2.0",
     "shelljs": "^0.6.0"
   }
 }

tests/prepare-tests.js renamed to prepare-tests.js

@@ -4,9 +4,9 @@ var shelljs = require("shelljs");
 
 shelljs.echo('Preparing for tests ...');
 
-shelljs.rm('-rf', 'tests/docsroot-output');
+shelljs.rm('-rf', 'test/docsroot-output');
 
-shelljs.cp("-R", "tests/docsroot", "tests/docsroot-output");
+shelljs.cp("-R", "test/docsroot", "test/docsroot-output");
 
 shelljs.echo('Preparing for tests ... DONE');
 

tests/docsroot/test.md renamed to test/docsroot/test.md

@@ -0,0 +1,57 @@
+var assert = require('assert'),
+  fs = require('fs'),
+  shelljs = require("shelljs"),
+  rootFolder = "test/root",
+  docsrootFolder = "./test/docsroot-output";
+
+function preparedemo() {
+  console.log('Preparing for tests ...');
+  shelljs.rm('-rf', docsrootFolder);
+  shelljs.cp("-R", "test/docsroot", docsrootFolder);
+  console.log('Preparing for tests ... DONE');
+}
+
+function hasPattern(pattern, shouldExists, callback) {
+  fs.readFile(docsrootFolder + '/test.md', function read(err, data) {
+    if (err) {
+      callback('Pattern ' + pattern + ' is NOT found because of an error: ' + err);
+    } else {
+      if (data.toString().indexOf(pattern) === -1) {
+        callback(shouldExists ? 'Pattern ' + pattern + ' is NOT found' : null);
+      } else {
+        callback(shouldExists ? null : 'Pattern ' + pattern + ' WAS found. This is NOT expected.');
+      }
+
+    }
+  });
+}
+
+describe('markdown-snippet-injector', function () {
+
+  beforeEach(function (done) {
+    preparedemo();
+    done();
+  });
+
+  //TODO: Add tests for hidden fields
+
+  it('should process XML snippets', function (done) {
+    shelljs.exec('node index.js --root=./test/root --docsroot=./test/docsroot-output --sourceext=".xml"');
+    hasPattern("<snippet id='xml-snippet'/>", false, done);
+  });
+
+  it('should process TypeScript snippets', function (done) {
+    shelljs.exec('node index.js --root=./test/root --docsroot=./test/docsroot-output --sourceext=".ts"');
+    hasPattern("<snippet id='ts-snippet'/>", false, done);
+  });
+
+  it('should process CSS snippets', function (done) {
+    shelljs.exec('node index.js --root=./test/root --docsroot=./test/docsroot-output --sourceext=".css"');
+    hasPattern("<snippet id='css-snippet'/>", false, done);
+  });
+
+  it('should NOT process snippetIds that are not defined in source', function (done) {
+    shelljs.exec('node index.js --root=./test/root --docsroot=./test/docsroot-output --sourceext=".css"');
+    hasPattern("<snippet id='cssSnippet'/>", true, done);
+  });
+});