feat(test): new fixture loading mechanism

Author: dignifiedquire

README.md

@@ -84,6 +84,53 @@ You will need
 - `SAUCE_USERNAME=<username>`
 - `SAUCE_ACCESS_KEY=<access key>`
 
+#### Fixtures
+
+Loading fixture files in node and the browser can be painful, that's why aegir provides
+a method to do this. For it to work you have to put your fixtures in the folder `test/fixtures`, and then
+
+```js
+// test/awesome.spec.js
+const loadFixture = require('aegir/fixtures')
+
+const myFixture = loadFixture(__dirname, 'fixtures/largefixture')
+```
+
+If you write a module like [interface-ipfs-core](https://github.com/ipfs/interface-ipfs-core)
+which is to be consumed by other modules tests you need to pass in a third parameter such that
+the server is able to serve the correct files.
+
+For example
+
+```js
+// awesome-tests module
+const loadFixture = require('aegir/fixtures'
+
+const myFixture = loadFixture(__dirname, 'fixtures/coolfixture', 'awesome-tests')
+```
+
+```js
+// tests for module using the awesome-tests
+require('awesome-tests')
+```
+
+```js
+// .aegir.js file in the module using the awesome-tests module
+'use strict'
+
+module.exports = {
+  karma: {
+    files: [{
+      pattern: 'node_modules/awesome-tests/test/fixtures/**/*',
+      watched: false,
+      served: true,
+      included: false
+    }]
+  }
+}
+```
+
+
 ### Coverage
 
 You can run it using

config/karma.conf.js

@@ -2,6 +2,18 @@
 
 const webpackConfig = require('./webpack')
 const timeout = require('./custom').timeout
+const user = require('./user').customConfig
+
+let userFiles = []
+if (user.karma && user.karma.files) {
+  userFiles = user.karma.files
+}
+
+const files = [
+  'test/browser.js',
+  'test/**/*.spec.js',
+  {pattern: 'test/fixtures/**/*', watched: false, served: true, included: false}
+].concat(userFiles)
 
 let concurrency = 1
 let reporters = ['mocha-own']
@@ -78,17 +90,13 @@ module.exports = function (config) {
         timeout: timeout
       }
     },
-    files: [
-      'test/browser.js',
-      'test/**/*.spec.js'
-    ],
-    exclude: [],
+    files: files,
     preprocessors: {
-      'test/**/*': ['webpack', 'sourcemap']
+      'test/**/*.js': ['webpack', 'sourcemap']
     },
     webpack: webpackConfig,
     webpackMiddleware: {
-      noInfo: true
+      noInfo: false
     },
     reporters: reporters,
     mochaOwnReporter: {

config/user.js

@@ -0,0 +1,16 @@
+'use strict'
+
+const path = require('path')
+const pkg = require(path.resolve('package.json'))
+
+let customConfig = {}
+try {
+  customConfig = require(path.resolve('.aegir.js'))
+} catch (err) {
+}
+
+module.exports = {
+  pkg: pkg,
+  customPkg: pkg.aegir || {},
+  customConfig: customConfig || {}
+}

config/webpack.js

@@ -5,28 +5,11 @@ const upperFirst = require('lodash.upperfirst')
 const camelCase = require('lodash.camelcase')
 const merge = require('webpack-merge')
 
-const pkg = require(path.resolve('package.json'))
-let customConfig = {}
-try {
-  customConfig = require(path.resolve('.aegir.js'))
-} catch (err) {
-}
+let user = require('./user')
 
 // e.g. peer-id -> PeerId
-const libraryName = upperFirst(camelCase(pkg.name))
-
-let custom1 = {}
-let custom2 = {}
-
-if (pkg.aegir && pkg.aegir.webpack) {
-  custom1 = pkg.aegir.webpack
-}
-
-if (customConfig && customConfig.webpack) {
-  custom2 = customConfig.webpack
-}
-
-const specific = merge(custom1, custom2)
+const libraryName = upperFirst(camelCase(user.pkg.name))
+const specific = merge(user.customPkg || {}, user.customPkg || {})
 
 const shared = {
   entry: [
@@ -41,7 +24,10 @@ const shared = {
     modules: [
       'node_modules',
       path.resolve(__dirname, '../node_modules')
-    ]
+    ],
+    alias: {
+      zlib: 'browserify-zlib'
+    }
   },
   resolveLoader: {
     modules: [

fixtures.js

@@ -0,0 +1,37 @@
+'use strict'
+
+const isNode = require('detect-node')
+const path = require('path')
+
+module.exports = function loadFixtures (dirname, file, module) {
+  if (isNode) {
+    return require('fs').readFileSync(path.join(dirname, file))
+  } else {
+    return syncXhr(file, module)
+  }
+}
+
+// I know this is considered bad practice, but it makes testing life so much nicer!
+function syncXhr (url, module) {
+  let target
+  if (module) {
+    target = path.join('base', 'node_modules', module, 'test', url)
+  } else {
+    target = path.join('base', 'test', url)
+  }
+  const request = new window.XMLHttpRequest()
+  request.open('GET', target, false)
+  request.overrideMimeType('text/plain; charset=x-user-defined')
+  request.send(null)
+
+  if (request.status === 200) {
+    const filestream = request.responseText
+    let res = new Uint8Array(filestream.length)
+
+    for (let i = 0; i < filestream.length; i++) {
+      res[i] = filestream.charCodeAt(i) & 0xff
+    }
+
+    return new Buffer(res)
+  }
+}

package.json

@@ -3,6 +3,9 @@
   "version": "9.0.1",
   "description": "JavaScript project management",
   "main": "index.js",
+  "browser": {
+    "fs": false
+  },
   "bin": {
     "aegir-lint": "bin/lint",
     "aegir-build": "bin/build",
@@ -27,12 +30,13 @@
     "chalk": "^1.1.3",
     "conventional-github-releaser": "^1.1.3",
     "coveralls": "^2.11.14",
-    "eslint": "^3.8.1",
+    "detect-node": "^2.0.3",
+    "eslint": "^3.9.1",
     "eslint-config-standard": "^6.2.1",
     "eslint-plugin-promise": "^3.3.0",
     "eslint-plugin-standard": "^2.0.1",
     "gulp": "^3.9.1",
-    "gulp-bump": "^2.4.0",
+    "gulp-bump": "^2.5.0",
     "gulp-conventional-changelog": "^1.1.0",
     "gulp-eslint": "^3.0.1",
     "gulp-filter": "^4.0.0",
@@ -65,7 +69,7 @@
     "run-sequence": "^1.2.2",
     "semver": "^5.3.0",
     "signal-exit": "^3.0.1",
-    "stream-http": "^2.4.0",
+    "stream-http": "^2.4.1",
     "transform-loader": "^0.2.3",
     "uglify-js": "github:mishoo/UglifyJS2#harmony",
     "webpack": "^2.1.0-beta.25",
@@ -86,4 +90,4 @@
     "greenkeeperio-bot <[email protected]>",
     "npmcdn-to-unpkg-bot <[email protected]>"
   ]
-}
+}

tasks/lint.js

@@ -11,7 +11,8 @@ module.exports = (gulp) => {
       'test/**/*.js',
       'src/**/*.js',
       'tasks/**/*.js',
-      'examples/**/*.js'
+      'examples/**/*.js',
+      'benchmarks/**/*.js'
     ])
       .pipe(eslint(`${__dirname}/../config/eslintrc.yml`))
       .pipe(eslint.format())