[tests] Added a test case for run all the examples

* I changed all the ports across examples to be different and can run at same time

examples/balancer/simple-balancer-with-websockets.js

@@ -80,5 +80,5 @@ server.on('upgrade', function (req, socket, head) {
   nextProxy().ws(req, socket, head);
 });
 
-server.listen(8080);  
+server.listen(8001);
   

examples/balancer/simple-balancer.js

@@ -59,6 +59,6 @@ http.createServer(function (req, res) {
   // ...and then the server you just used becomes the last item in the list.
   //
   addresses.push(target);
-}).listen(8000);
+}).listen(8021);
 
 // Rinse; repeat; enjoy.

examples/http/basic-proxy.js

@@ -44,8 +44,8 @@ util.puts(welcome.rainbow.bold);
 // Basic Http Proxy Server
 //
 httpProxy.createServer({
-  target:'http://localhost:9000'
+  target:'http://localhost:9003'
-}).listen(8000);
+}).listen(8003);
 
 //
 // Target Http Server
@@ -54,7 +54,7 @@ http.createServer(function (req, res) {
   res.writeHead(200, { 'Content-Type': 'text/plain' });
   res.write('request successfully proxied to: ' + req.url + '\n' + JSON.stringify(req.headers, true, 2));
   res.end();
-}).listen(9000);
+}).listen(9003);
 
-util.puts('http proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8000'.yellow);
+util.puts('http proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8003'.yellow);
-util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9000 '.yellow);
+util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9003 '.yellow);

examples/http/concurrent-proxy.js

@@ -33,8 +33,8 @@ var util = require('util'),
 // Basic Http Proxy Server
 //
 httpProxy.createServer({
-  target:'http://localhost:9000'
+  target:'http://localhost:9004'
-}).listen(8000);
+}).listen(8004);
 
 //
 // Target Http Server
@@ -62,7 +62,7 @@ http.createServer(function (req, res) {
       connections.shift()();
     }
   }
-}).listen(9000);
+}).listen(9004);
 
-util.puts('http proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8000'.yellow);
+util.puts('http proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8004'.yellow);
-util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9000 '.yellow);
+util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9004 '.yellow);

examples/http/custom-proxy-error.js

@@ -33,13 +33,13 @@ var util = require('util'),
 // Http Proxy Server with bad target
 //
 var proxy = httpProxy.createServer({
-  target:'http://localhost:9000'
+  target:'http://localhost:9005'
 });
 
 //
 // Tell the proxy to listen on port 8000
 //
-proxy.listen(8000);
+proxy.listen(8005);
 
 //
 // Listen for the `error` event on `proxy`.
@@ -52,4 +52,4 @@ proxy.on('error', function (err, req, res) {
 });
 
 
-util.puts('http proxy server '.blue + 'started '.green.bold + 'on port '.blue + '8000 '.yellow + 'with custom error message'.magenta.underline);
+util.puts('http proxy server '.blue + 'started '.green.bold + 'on port '.blue + '8005 '.yellow + 'with custom error message'.magenta.underline);

examples/http/forward-and-target-proxy.js

@@ -34,14 +34,14 @@ var util = require('util'),
 //
 httpProxy.createServer({
   target: {
-    port: 9000,
+    port: 9006,
     host: 'localhost'
   },
   forward: {
-    port: 9001,
+    port: 9007,
     host: 'localhost'
   }
-}).listen(8000);
+}).listen(8006);
 
 //
 // Target Http Server
@@ -50,7 +50,7 @@ http.createServer(function (req, res) {
   res.writeHead(200, { 'Content-Type': 'text/plain' });
   res.write('request successfully proxied to: ' + req.url + '\n' + JSON.stringify(req.headers, true, 2));
   res.end();
-}).listen(9000);
+}).listen(9006);
 
 //
 // Target Http Forwarding Server
@@ -60,8 +60,8 @@ http.createServer(function (req, res) {
   res.writeHead(200, { 'Content-Type': 'text/plain' });
   res.write('request successfully forwarded to: ' + req.url + '\n' + JSON.stringify(req.headers, true, 2));
   res.end();
-}).listen(9001);
+}).listen(9007);
 
-util.puts('http proxy server '.blue + 'started '.green.bold + 'on port '.blue + '8000 '.yellow + 'with forward proxy'.magenta.underline);
+util.puts('http proxy server '.blue + 'started '.green.bold + 'on port '.blue + '8006 '.yellow + 'with forward proxy'.magenta.underline);
-util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9000 '.yellow);
+util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9006 '.yellow);
-util.puts('http forward server '.blue + 'started '.green.bold + 'on port '.blue + '9001 '.yellow);
+util.puts('http forward server '.blue + 'started '.green.bold + 'on port '.blue + '9007 '.yellow);

examples/http/forward-proxy.js

@@ -34,10 +34,10 @@ var util = require('util'),
 //
 httpProxy.createServer({
   forward: {
-    port: 9000,
+    port: 9019,
     host: 'localhost'
   }
-}).listen(8000);
+}).listen(8019);
 
 //
 // Target Http Forwarding Server
@@ -47,7 +47,7 @@ http.createServer(function (req, res) {
   res.writeHead(200, { 'Content-Type': 'text/plain' });
   res.write('request successfully forwarded to: ' + req.url + '\n' + JSON.stringify(req.headers, true, 2));
   res.end();
-}).listen(9000);
+}).listen(9019);
 
-util.puts('http proxy server '.blue + 'started '.green.bold + 'on port '.blue + '8000 '.yellow + 'with forward proxy'.magenta.underline);
+util.puts('http proxy server '.blue + 'started '.green.bold + 'on port '.blue + '8019 '.yellow + 'with forward proxy'.magenta.underline);
-util.puts('http forward server '.blue + 'started '.green.bold + 'on port '.blue + '9000 '.yellow);
+util.puts('http forward server '.blue + 'started '.green.bold + 'on port '.blue + '9019 '.yellow);

examples/http/latent-proxy.js

@@ -36,10 +36,10 @@ var proxy = httpProxy.createProxyServer();
 http.createServer(function (req, res) {
   setTimeout(function () {
     proxy.web(req, res, {
-      target: 'http://localhost:9000'
+      target: 'http://localhost:9008'
     });
   }, 500);
-}).listen(8000);
+}).listen(8008);
 
 //
 // Target Http Server
@@ -48,7 +48,7 @@ http.createServer(function (req, res) {
   res.writeHead(200, { 'Content-Type': 'text/plain' });
   res.write('request successfully proxied to: ' + req.url + '\n' + JSON.stringify(req.headers, true, 2));
   res.end();
-}).listen(9000);
+}).listen(9008);
 
-util.puts('http proxy server '.blue + 'started '.green.bold + 'on port '.blue + '8000 '.yellow + 'with latency'.magenta.underline);
+util.puts('http proxy server '.blue + 'started '.green.bold + 'on port '.blue + '8008 '.yellow + 'with latency'.magenta.underline);
-util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9000 '.yellow);
+util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9008 '.yellow);

examples/http/proxy-http-to-https.js

@@ -41,6 +41,6 @@ httpProxy.createProxyServer({
   headers: {
     host: 'google.com'
   }
-}).listen(8000);
+}).listen(8011);
 
-util.puts('http proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8000'.yellow);
+util.puts('http proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8011'.yellow);

examples/http/proxy-https-to-http.js

@@ -40,7 +40,7 @@ http.createServer(function (req, res) {
   res.writeHead(200, { 'Content-Type': 'text/plain' });
   res.write('hello http over https\n');
 	res.end();
-}).listen(9000);
+}).listen(9009);
 
 //
 // Create the HTTPS proxy server listening on port 8000
@@ -48,13 +48,13 @@ http.createServer(function (req, res) {
 httpProxy.createServer({
   target: {
     host: 'localhost',
-    port: 9000
+    port: 9009
   },
   ssl: {
     key: fs.readFileSync(path.join(fixturesDir, 'agent2-key.pem'), 'utf8'),
     cert: fs.readFileSync(path.join(fixturesDir, 'agent2-cert.pem'), 'utf8')
   }
-}).listen(8000);
+}).listen(8009);
 
-util.puts('https proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8000'.yellow);
+util.puts('https proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8009'.yellow);
-util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9000 '.yellow);
+util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9009 '.yellow);

examples/http/proxy-https-to-https.js

@@ -44,16 +44,16 @@ https.createServer(httpsOpts, function (req, res) {
   res.writeHead(200, { 'Content-Type': 'text/plain' });
   res.write('hello https\n');
 	res.end();
-}).listen(9000);
+}).listen(9010);
 
 //
 // Create the proxy server listening on port 443
 //
 httpProxy.createServer({
   ssl: httpsOpts,
-  target: 'https://localhost:9000',
+  target: 'https://localhost:9010',
   secure: false
-}).listen(8000);
+}).listen(8010);
 
-util.puts('https proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8000'.yellow);
+util.puts('https proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8010'.yellow);
-util.puts('https server '.blue + 'started '.green.bold + 'on port '.blue + '9000 '.yellow);
+util.puts('https server '.blue + 'started '.green.bold + 'on port '.blue + '9010 '.yellow);

examples/http/standalone-proxy.js

@@ -36,10 +36,10 @@ var proxy = new httpProxy.createProxyServer();
 http.createServer(function (req, res) {
   setTimeout(function () {
     proxy.web(req, res, {
-      target: 'http://localhost:9000'
+      target: 'http://localhost:9002'
     });
   }, 200);
-}).listen(8000);
+}).listen(8002);
 
 //
 // Target Http Server
@@ -48,7 +48,7 @@ http.createServer(function (req, res) {
   res.writeHead(200, { 'Content-Type': 'text/plain' });
   res.write('request successfully proxied to: ' + req.url + '\n' + JSON.stringify(req.headers, true, 2));
   res.end();
-}).listen(9000);
+}).listen(9002);
 
-util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '8000 '.yellow + 'with proxy.web() handler'.cyan.underline + ' and latency'.magenta);
+util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '8002 '.yellow + 'with proxy.web() handler'.cyan.underline + ' and latency'.magenta);
-util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9000 '.yellow);
+util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9001 '.yellow);

examples/middleware/gzip-middleware.js

@@ -43,13 +43,13 @@ connect.createServer(
   function (req, res) {
     proxy.web(req, res);
   }
-).listen(8000);
+).listen(8012);
 
 //
 // Basic Http Proxy Server
 //
 var proxy = httpProxy.createProxyServer({
-  target: 'http://localhost:9000'
+  target: 'http://localhost:9012'
 });
 
 //
@@ -59,7 +59,7 @@ http.createServer(function (req, res) {
   res.writeHead(200, { 'Content-Type': 'text/plain' });
   res.write('request successfully proxied to: ' + req.url + '\n' + JSON.stringify(req.headers, true, 2));
   res.end();
-}).listen(9000);
+}).listen(9012);
 
-util.puts('http proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8000'.yellow);
+util.puts('http proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8012'.yellow);
-util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9000 '.yellow);
+util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9012 '.yellow);

examples/middleware/modifyResponse-middleware.js

@@ -45,13 +45,13 @@ connect.createServer(
   function (req, res) {
     proxy.web(req, res);
   }
-).listen(8000);
+).listen(8013);
 
 //
 // Basic Http Proxy Server
 //
 var proxy = httpProxy.createProxyServer({
-  target: 'http://localhost:9000'
+  target: 'http://localhost:9013'
 });
 
 //
@@ -60,8 +60,8 @@ var proxy = httpProxy.createProxyServer({
 http.createServer(function (req, res) {
   res.writeHead(200, { 'Content-Type': 'text/plain' });
   res.end('Hello, I know Ruby\n');
-}).listen(9000);
+}).listen(9013);
 
-util.puts('http proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8000'.yellow);
+util.puts('http proxy server'.blue + ' started '.green.bold + 'on port '.blue + '8013'.yellow);
-util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9000 '.yellow);
+util.puts('http server '.blue + 'started '.green.bold + 'on port '.blue + '9013 '.yellow);
 

examples/websocket/latent-websocket-proxy.js

@@ -43,7 +43,7 @@ catch (ex) {
 // Create the target HTTP server and setup
 // socket.io on it.
 //
-var server = io.listen(9000);
+var server = io.listen(9016);
 server.sockets.on('connection', function (client) {
   util.debug('Got websocket connection');
 
@@ -60,7 +60,7 @@ server.sockets.on('connection', function (client) {
 var proxy = new httpProxy.createProxyServer({
   target: {
     host: 'localhost', 
-    port: 9000
+    port: 9016
   }
 });
 
@@ -78,12 +78,12 @@ proxyServer.on('upgrade', function (req, socket, head) {
   }, 1000);
 });
 
-proxyServer.listen(8000);
+proxyServer.listen(8016);
 
 //
 // Setup the socket.io client against our proxy
 //
-var ws = client.connect('ws://localhost:8000');
+var ws = client.connect('ws://localhost:8016');
 
 ws.on('message', function (msg) {
   util.debug('Got message: ' + msg);

examples/websocket/standalone-websocket-proxy.js

@@ -43,7 +43,7 @@ catch (ex) {
 // Create the target HTTP server and setup
 // socket.io on it.
 //
-var server = io.listen(9000);
+var server = io.listen(9015);
 server.sockets.on('connection', function (client) {
   util.debug('Got websocket connection');
 
@@ -60,7 +60,7 @@ server.sockets.on('connection', function (client) {
 var proxy = new httpProxy.createProxyServer({
   target: {
     host: 'localhost',
-    port: 9000
+    port: 9015
   }
 });
 var proxyServer = http.createServer(function (req, res) {
@@ -75,12 +75,12 @@ proxyServer.on('upgrade', function (req, socket, head) {
   proxy.ws(req, socket, head);
 });
 
-proxyServer.listen(8000);
+proxyServer.listen(8015);
 
 //
 // Setup the socket.io client against our proxy
 //
-var ws = client.connect('ws://localhost:8000');
+var ws = client.connect('ws://localhost:8015');
 
 ws.on('message', function (msg) {
   util.debug('Got message: ' + msg);

examples/websocket/websocket-proxy.js

@@ -43,7 +43,7 @@ catch (ex) {
 // Create the target HTTP server and setup
 // socket.io on it.
 //
-var server = io.listen(9000);
+var server = io.listen(9014);
 server.sockets.on('connection', function (client) {
   util.debug('Got websocket connection');
 
@@ -57,12 +57,12 @@ server.sockets.on('connection', function (client) {
 //
 // Create a proxy server with node-http-proxy
 //
-httpProxy.createServer({ target: 'ws://localhost:9000', ws: true }).listen(8000);
+httpProxy.createServer({ target: 'ws://localhost:9014', ws: true }).listen(8014);
 
 //
 // Setup the socket.io client against our proxy
 //
-var ws = client.connect('ws://localhost:8000');
+var ws = client.connect('ws://localhost:8014');
 
 ws.on('message', function (msg) {
   util.debug('Got message: ' + msg);

package.json

@@ -22,7 +22,8 @@
     "blanket"            : "*",
     "ws"                 : "*",
     "socket.io"          : "*",
-    "socket.io-client"   : "*"
+    "socket.io-client"   : "*",
+    "async"              : "*"
   },
   "scripts"        : {
     "coveralls"          : "mocha --require blanket --reporter mocha-lcov-reporter | ./node_modules/coveralls/bin/coveralls.js",

test/examples-test.js

@@ -0,0 +1,71 @@
+/*
+  examples-test.js: Test to run all the examples
+
+  Copyright (c) Nodejitsu 2013
+
+*/
+var path = require('path'),
+    fs   = require('fs'),
+    spawn = require('child_process').spawn,
+    expect = require('expect.js'),
+    async = require('async');
+
+var rootDir = path.join(__dirname, '..'),
+    examplesDir = path.join(rootDir, 'examples');
+
+describe('http-proxy examples', function () {
+  describe('Before testing examples', function () {
+    // Set a timeout to avoid this error
+    this.timeout(30 * 1000);
+    it('should have installed dependencies', function (done) {
+      async.waterfall([
+        //
+        // 1. Read files in examples dir
+        //
+        async.apply(fs.readdir, examplesDir),
+        //
+        // 2. If node_modules exists, continue. Otherwise
+        // exec `npm` to install them
+        //
+        function checkNodeModules(files, next) {
+          if (files.indexOf('node_modules') !== -1) {
+            return next();
+          }
+
+          console.log('Warning: installing dependencies, this operation could take a while');
+
+          var child = spawn('npm', ['install', '-f'], {
+            cwd: examplesDir
+          });
+
+          child.on('exit', function (code) {
+            return code
+              ? next(new Error('npm install exited with non-zero exit code'))
+              : next();
+          });
+        },
+        //
+        // 3. Read files in examples dir again to ensure the install
+        // worked as expected.
+        //
+        async.apply(fs.readdir, examplesDir),
+      ], done);
+    })
+  });
+
+  describe('Requiring all the examples', function () {
+    it('should have no errors', function (done) {
+      async.each(['balancer', 'http', 'middleware', 'websocket'], function (dir, cb) {
+        var name = 'examples/' + dir,
+        files = fs.readdirSync(path.join(rootDir, 'examples', dir));
+
+        async.each(files, function (file, callback) {
+          var example;
+          expect(function () { example = require(path.join(examplesDir, dir, file)); }).to.not.throwException();
+          expect(example).to.be.an('object');
+          callback();
+        }, cb);
+      }, done);
+    })
+  })
+})