Merge pull request #19 from electron/add-tests

Add initial tests

Author: kevinsawicki

.gitmodules

@@ -1,3 +1,3 @@
 [submodule "deps/breakpad"]
 	path = deps/breakpad
-	url = https://github.com/atom/chromium-breakpad.git
+	url = https://github.com/electron/chromium-breakpad.git

.npmignore

@@ -0,0 +1,4 @@
+.gitmodules
+.npmignore
+.travis.yml
+test

.travis.yml

@@ -1,17 +1,18 @@
 language: node_js
 
 node_js:
-  - "0.11"
-  - "0.10"
-  - "0.8"
+  - "node"
+
+os:
+- osx
 
 notifications:
   email:
     on_success: never
     on_failure: change
 
 before_install:
-  git submodule sync && git submodule update --init --recursive
+  - git submodule sync && git submodule update --init --recursive
 
 branches:
   only:

README.md

@@ -1,4 +1,4 @@
-# minidump - Process minidump files [![Build Status](https://travis-ci.org/atom/node-minidump.svg?branch=master)](https://travis-ci.org/atom/node-minidump)
+# minidump - Process minidump files [![Build Status](https://travis-ci.org/electron/node-minidump.svg?branch=master)](https://travis-ci.org/electron/node-minidump)
 
 ## Installing
 

lib/minidump.js

@@ -51,7 +51,7 @@ module.exports.walkStack = function(minidump, symbolPaths, callback) {
 
   var stackwalk = searchCommand('minidump_stackwalk');
   if (!stackwalk) {
-    callback('Unable to find the "minidump_stackwalk"');
+    callback(new Error('Unable to find "minidump_stackwalk"'));
     return;
   }
 
@@ -62,7 +62,7 @@ module.exports.walkStack = function(minidump, symbolPaths, callback) {
 module.exports.dumpSymbol = function(binary, callback) {
   var dumpsyms = searchCommand('dump_syms');
   if (!dumpsyms) {
-    callback('Unable to find the "dump_syms"');
+    callback(new Error('Unable to find "dump_syms"'));
     return;
   }
 

package.json

@@ -6,17 +6,21 @@
   "bin": {
     "minidump_stackwalk": "bin/minidump_stackwalk"
   },
-  "licenses": [
-    {
-      "type": "MIT",
-      "url": "http://github.com/atom/node-minidump/raw/master/LICENSE.md"
-    }
-  ],
+  "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/atom/node-minidump.git"
+    "url": "https://github.com/electron/node-minidump.git"
   },
   "bugs": {
-    "url": "https://github.com/atom/node-minidump/issues"
+    "url": "https://github.com/electron/node-minidump/issues"
+  },
+  "scripts": {
+    "test": "mocha test"
+  },
+  "devDependencies": {
+    "electron-download": "^3.0.1",
+    "extract-zip": "^1.5.0",
+    "mocha": "^3.1.2",
+    "temp": "^0.8.3"
   }
 }

test/fixtures/mac.dmp

@@ -0,0 +1,105 @@
+var assert = require('assert')
+var path = require('path')
+
+var minidump = require('..')
+var electronDownload = require('electron-download')
+var extractZip = require('extract-zip')
+var temp = require('temp').track()
+
+describe('minidump', function () {
+  this.timeout(60000)
+
+  describe('walkStack()', function () {
+    describe('macOS dump', function () {
+      it('calls back with a report', function (done) {
+        downloadElectronSymbols('darwin', function (error, symbolsPath) {
+          if (error) return done(error)
+
+          var dumpPath = path.join(__dirname, 'fixtures', 'mac.dmp')
+          minidump.walkStack(dumpPath, symbolsPath, function (error, report) {
+            if (error) return done(error)
+
+            assert.equal(Buffer.isBuffer(report), true)
+            assert.notEqual(report.length, 0)
+
+            report = report.toString()
+            assert.notEqual(report.indexOf('Electron Framework!atom::(anonymous namespace)::Crash() [atom_bindings.cc : 27 + 0x0]'), -1)
+            done()
+          })
+        })
+      })
+    })
+
+    describe('Windows dump', function () {
+      it('calls back with a report', function (done) {
+        downloadElectronSymbols('win32', function (error, symbolsPath) {
+          if (error) return done(error)
+
+          var dumpPath = path.join(__dirname, 'fixtures', 'windows.dmp')
+          minidump.walkStack(dumpPath, symbolsPath, function (error, report) {
+            if (error) return done(error)
+
+            assert.equal(Buffer.isBuffer(report), true)
+            assert.notEqual(report.length, 0)
+
+            report = report.toString()
+            assert.notEqual(report.indexOf('electron.exe!atom::`anonymous namespace\'::Crash [atom_bindings.cc : 27 + 0x0]'), -1)
+            done()
+          })
+        })
+      })
+    })
+  })
+
+  describe('dumpSymbol()', function () {
+    it('calls back with a minidump', function (done) {
+      if (process.platform !== 'darwin') return this.skip()
+
+      downloadElectron(function (error, binaryPath) {
+        if (error) return done(error)
+        minidump.dumpSymbol(binaryPath, function (error, minidump) {
+          if (error) return done(error)
+
+          assert.equal(Buffer.isBuffer(minidump), true)
+          assert.notEqual(minidump.length, 0)
+          done()
+        })
+      })
+    })
+  })
+})
+
+var downloadElectron = function (callback) {
+  electronDownload({
+    version: '1.4.3',
+    arch: 'x64',
+    platform: 'darwin',
+    quiet: true
+  }, function (error, zipPath) {
+    if (error) return callback(error)
+
+    var electronPath = temp.mkdirSync('node-minidump-')
+    extractZip(zipPath, {dir: electronPath}, function (error) {
+      if (error) return callback(error)
+      callback(null, path.join(electronPath, 'Electron.app', 'Contents', 'MacOS', 'Electron'))
+   })
+  })
+}
+
+var downloadElectronSymbols = function (platform, callback) {
+  electronDownload({
+    version: '1.4.3', // Dumps were generated with Electron 1.4.3 x64
+    arch: 'x64',
+    platform: platform,
+    symbols: true,
+    quiet: true
+  }, function (error, zipPath) {
+    if (error) return callback(error)
+
+    var symbolsPath = temp.mkdirSync('node-minidump-')
+    extractZip(zipPath, {dir: symbolsPath}, function (error) {
+      if (error) return callback(error)
+      callback(null, path.join(symbolsPath, 'electron.breakpad.syms'))
+   })
+  })
+}