rename project to git-http-mock-server

Author: billiegoose

README.md

@@ -1,43 +1,74 @@
-# karma-git-http-server-middleware 
+# git-http-mock-server
 
-A karma middleware for '[git-http-backend](https://github.com/substack/git-http-backend)',
-originally inspired by '[git-http-server](https://github.com/bahamas10/node-git-http-server)'
+Clone and push to git repository test fixtures over HTTP.
+
+## What it does
+
+Given a directory of bare git repositories, `git-http-mock-server` will serve those repositories using the
+native `git-http-backend` process built into `git` (which needs to be installed on the machine).
+You can then run tests that clone or push to git repositories (regardless of whether Github is down)
+and you can run those tests in parallel without them interfering with each other.
+(It uses copy-on-write so that pushing to the repo doesn't actually alter the repo.)
+Because it uses `git-http-backend` git hooks (such as `hooks/update` and `hooks/post-receive`) are automatically supported.
+
+It also supports HTTP Basic Auth password protection of repos so you can test how your code handles 401 errors.
 
 ## How to use
 
 ```sh
-npm install --save-dev karma-git-http-server-middleware
+npm install --save-dev git-http-mock-server
 ```
 
-In your `karma.config.js`, add:
+Now `cd` to a directory in which you have some bare git repos
+and run this server:
 
+```sh
+> cd __fixtures__
+> ls
+test-repo1.git    test-repo2.git   imaginatively-named-repo.git
+> git-http-mock-server
 ```
-    beforeMiddleware: ['git-http-server'],
-    gitHttpServer: {
-      root: '__tests__/__fixtures__',
-      route: 'git-server'
-    },
+
+Now clone away...
+```sh
+> git clone https://localhost:8174/imaginatively-named-repo.git
 ```
 
-Then in your JS code, you can reference git repos on disk via `http://localhost:9876/git-server/name-of-repo.git`.
+### Environment Variables
 
-This is useful for testing `isomorphic-git` and applications built using it.
+- `GIT_HTTP_MOCK_SERVER_PORT` default is 8174 (to be compatible with [git-http-server](https://github.com/bahamas10/node-git-http-server))
+- `GIT_HTTP_MOCK_SERVER_ROUTE` default is `/`
+- `GIT_HTTP_MOCK_SERVER_ROOT` default is `process.cwd()`
 
-## Examples
+### .htpasswd support
 
-See <https://github.com/isomorphic-git/isomorphic-git/tree/master/__tests__>
+You can place an Apache-style `.htpasswd` file in a bare repo to protect it with Basic Authentication.
+
+```sh
+> cd __fixtures__/test-repo1.git
+> htpasswd -cb .htpasswd testuser testpassword
+Adding password for user testuser.
+> cat .htpasswd
+testuser:$apr1$BRdvH4Mu$3HrpeyBrWiS88GcSPidgq/
+```
+
+If you don't have `htpasswd` on your machine, you can use [htpasswd](https://npm.im/htpasswd) which is
+a cross-platform Node implementation of `htpasswd`.
 
 ## Dependencies
 
-- [fixturez](https://github.com/thejameskyle/fixturez): Easily create and maintain test fixtures in the file system
-- [git-http-backend](https://github.com/substack/git-http-backend): serve a git repository over http
+- [basic-auth](https://ghub.io/basic-auth): node.js basic auth parser
+- [chalk](https://ghub.io/chalk): Terminal string styling done right
+- [fixturez](https://ghub.io/fixturez): Easily create and maintain test fixtures in the file system
+- [git-http-backend](https://ghub.io/git-http-backend): serve a git repository over http
+- [htpasswd-js](https://ghub.io/htpasswd-js): Pure JS htpasswd authentication
+
+originally inspired by '[git-http-server](https://github.com/bahamas10/node-git-http-server)'
 
 ## License
 
 MIT
 
 ## Changelog
 
-1.0.0 - Initial release
-
-2.0.0 - Copy repo on push (so repo stays untouched)
+1.0.0 - Initial release

bin.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+// Standalone server for use without karma!
+var http = require('http')
+var path = require('path')
+var factory = require('./middleware')
+
+var config = {
+  root: path.resolve(process.cwd(), process.env.GIT_HTTP_MOCK_SERVER_ROOT || '.'),
+  glob: '*',
+  route: process.env.GIT_HTTP_MOCK_SERVER_ROUTE || '/'
+}
+
+var server = http.createServer(factory(config))
+server.listen(process.env.GIT_HTTP_MOCK_SERVER_PORT || 8174)

middleware.js

@@ -1,57 +1,104 @@
-var spawn = require('child_process').spawn;
-var path = require('path').posix;
-var url = require('url');
-var backend = require('git-http-backend');
-var fixturez = require('fixturez');
+var spawn = require('child_process').spawn
+var fs = require('fs')
+var path = require('path')
+var url = require('url')
+
+var auth = require('basic-auth')
+var chalk = require('chalk')
+var fixturez = require('fixturez')
+var backend = require('git-http-backend')
+var htpasswd = require('htpasswd-js')
 
 function factory (config) {
   if (!config.root) throw new Error('Missing required "gitHttpServer.root" config option')
   if (!config.route) throw new Error('Missing required "gitHttpServer.route" config option')
   if (!config.route.startsWith('/')) throw new Error('"gitHttpServer.route" must start with a "/"')
   // TODO: Make this configurable in karma.conf.js
-  var f = fixturez(config.root, {root: process.cwd()})
+  var f = fixturez(config.root, {root: process.cwd(), glob: config.glob})
 
   function getGitDir (req) {
     var u = url.parse(req.url)
     if (u.pathname.startsWith(config.route)) {
       if (req.method === 'GET' && u.pathname.endsWith('/info/refs')) {
         let gitdir = u.pathname.replace(config.route, '').replace(/\/info\/refs$/, '').replace(/^\//, '')
-        let fixtureName = path.basename(gitdir)
+        let fixtureName = path.posix.basename(gitdir)
         return f.find(fixtureName)
       }
       if (req.method === 'POST' && req.headers['content-type'] === 'application/x-git-upload-pack-request') {
         let gitdir = u.pathname.replace(config.route, '').replace(/\/git-upload-pack$/, '').replace(/^\//, '')
-        let fixtureName = path.basename(gitdir)
+        let fixtureName = path.posix.basename(gitdir)
         return f.find(fixtureName)
       }
       if (req.method === 'POST' && req.headers['content-type'] === 'application/x-git-receive-pack-request') {
         let gitdir = u.pathname.replace(config.route, '').replace(/\/git-receive-pack$/, '').replace(/^\//, '')
-        let fixtureName = path.basename(gitdir)
+        let fixtureName = path.posix.basename(gitdir)
         return f.copy(fixtureName)
       }
     }
     return null
   }
 
-  return function middleware (req, res, next) {
-    var gitdir = getGitDir(req);
-    if (gitdir == null) return next();
+  return async function middleware (req, res, next) {
+    if (!next) next = () => void(0)
+    try {
+      var gitdir = getGitDir(req)
+    } catch (err) {
+      res.statusCode = 404
+      res.end(err.message + '\n')
+      console.log(chalk.red('[git-http-server] 404 ' + req.url))
+      return
+    }
+    if (gitdir == null) return next()
+
+    // Check for a .htaccess file
+    let data = null
+    try {
+      data = fs.readFileSync(path.join(gitdir, '.htpasswd'), 'utf8')
+    } catch (err) {
+      // no .htaccess file, proceed without authentication
+    }
+    if (data) {
+      // The previous line would have failed if there wasn't an .htaccess file, so
+      // we must treat this as protected.
+      let cred = auth.parse(req.headers['authorization'])
+      if (cred === undefined) {
+        res.statusCode = 401
+        res.setHeader('WWW-Authenticate', 'Basic')
+        res.end('Unauthorized' + '\n')
+        console.log(chalk.red('[git-http-server] 401 ' + req.url))
+        return
+      }
+      let valid = await htpasswd.authenticate({
+        username: cred.name,
+        password: cred.pass,
+        data
+      })
+      if (!valid) {
+        res.statusCode = 401
+        res.setHeader('WWW-Authenticate', 'Basic')
+        res.end('Bad credentials' + '\n')
+        console.log(chalk.red('[git-http-server] 401 ' + req.url))
+        return
+      }
+    }
 
     req.pipe(backend(req.url, function (err, service) {
       if (err) {
-        res.statusCode = 500;
-        res.end(err + '\n');
-        return;
+        res.statusCode = 500
+        res.end(err + '\n')
+        console.log(chalk.red('[git-http-server] 500 ' + req.url))
+        return
       }
 
-      res.setHeader('content-type', service.type);
-      console.log('[git-http-server] ' + service.cmd + ' ' + service.args.concat(gitdir).join(' '))
-      var ps = spawn(service.cmd, service.args.concat(gitdir));
-      ps.stdout.pipe(service.createStream()).pipe(ps.stdin);
-    })).pipe(res);
+      res.setHeader('content-type', service.type)
+      console.log(chalk.green('[git-http-server] 200 ' + req.url))
+      // console.log('[git-http-server] ' + service.cmd + ' ' + service.args.concat(gitdir).join(' '))
+      var ps = spawn(service.cmd, service.args.concat(gitdir))
+      ps.stdout.pipe(service.createStream()).pipe(ps.stdin)
+    })).pipe(res)
   }
 }
 
 factory.$inject = ['config.gitHttpServer']
 
-module.exports = factory
+module.exports = factory

package.json

@@ -1,16 +1,19 @@
 {
-  "name": "karma-git-http-server-middleware",
+  "name": "git-http-mock-server",
   "version": "0.0.0-development",
-  "description": "A karma middleware for 'git-http-backend'",
+  "description": "Clone and push to git repository test fixtures over HTTP.",
   "main": "index.js",
+  "bin": {
+    "git-http-mock-server": "bin.js"
+  },
   "scripts": {
     "test": "echo \"No tests\"",
     "semantic-release": "semantic-release",
     "travis-deploy-once": "travis-deploy-once"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/isomorphic-git/karma-git-http-server-middleware.git"
+    "url": "https://github.com/isomorphic-git/git-http-mock-server.git"
   },
   "keywords": [
     "karma-plugin",
@@ -21,12 +24,15 @@
   "author": "William Hilton <wmhilton@gmail.com>",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/isomorphic-git/karma-git-http-server-middleware/issues"
+    "url": "https://github.com/isomorphic-git/git-http-mock-server/issues"
   },
-  "homepage": "https://github.com/isomorphic-git/karma-git-http-server-middleware#readme",
+  "homepage": "https://github.com/isomorphic-git/git-http-mock-server#readme",
   "dependencies": {
+    "basic-auth": "^2.0.0",
+    "chalk": "^2.4.1",
     "fixturez": "^1.1.0",
-    "git-http-backend": "^1.0.2"
+    "git-http-backend": "^1.0.2",
+    "htpasswd-js": "^1.0.2"
   },
   "devDependencies": {
     "semantic-release": "15.1.7",