Changing base to root + tests

nicola · nicola · commit 364f5969c755 · 2015-07-14T01:50:15.000+02:00
diff --git a/Makefile b/Makefile
@@ -1,23 +1,23 @@
 # see also JSON validator  http://jsonformatter.curiousconcept.com for the package.json file
 
 run-for-test:
-	node bin/ldnode.js -p 3456 -v --uri http://localhost:3456/test/ --base `pwd`/test/
+	node bin/ldnode.js -p 3456 -v --uri http://localhost:3456/test/ --root `pwd`/test/
 
 run-for-test-login:
-	node bin/ldnode.js -p 3456 -v --webid --uri https://localhost:3456/test/ --base `pwd`/test/
+	node bin/ldnode.js -p 3456 -v --webid --uri https://localhost:3456/test/ --root `pwd`/test/
 
 run-for-live-test:
 	NODE_PATH=.:../tabulator-firefox/content/js/rdf/dist/ node server.js \
-		p 3456 -v --live --uri http://localhost:3456/test/ --base `pwd`/test/
+		p 3456 -v --live --uri http://localhost:3456/test/ --root `pwd`/test/
 
 run-for-test-special:
 	NODE_PATH=.:../tabulator-firefox/content/js/rdf/dist/ node server.js \
-		-p 3456 -v --uri http://localhost:3456/test/ --base `pwd`/test/
+		-p 3456 -v --uri http://localhost:3456/test/ --root `pwd`/test/
 
 # use --debug to run or --debug-brk to break immediately
 run-for-test-special-debug:
 	NODE_PATH=.:../tabulator-firefox/content/js/rdf/dist/ node --debug-brk server.js \
-		-p 3456 -v --uri http://localhost:3456/test/ --base `pwd`/test/
+		-p 3456 -v --uri http://localhost:3456/test/ --root `pwd`/test/
 	# Then run node-inspector and open Chrome as it suggests
 	# (If necessary, npm install -g node-inspector)
 
diff --git a/README.md b/README.md
@@ -74,7 +74,7 @@ Options:
    -v, --verbose           Print the logs to console
    --version               Print current ldnode version
    -m, --mount             Where to mount Linked Data Platform (default: '/')
-   -b, --base              Base location to serve resources
+   -r, --root              Root location on the filesystem to serve resources
    -p, --port              Port to use
    -c, --cache             Set cache time (in seconds), 0 for no cache
    -K, --key               Path to the ssl key
diff --git a/acl.js b/acl.js
@@ -20,8 +20,8 @@ function allow(mode, req, res) {
 
     var accessType = "accessTo";
 
-    var filepath = file.uriToFilename(req.path, options.base);
-    var relativePath = file.uriToRelativeFilename(req.path, options.base);
+    var filepath = file.uriToFilename(req.path, options.root);
+    var relativePath = file.uriToRelativeFilename(req.path, options.root);
     var depth = relativePath.split('/');
 
     //Handle glob requests
@@ -36,8 +36,8 @@ function allow(mode, req, res) {
         var pathAcl = S(filepath).endsWith(options.suffixAcl) ?
                 filepath : filepath + options.suffixAcl;
         var uri = file.uriAbs(req);
-        var pathUri = file.filenameToBaseUri(filepath, uri, options.base);
-        relativePath = path.relative(options.base, filepath);
+        var pathUri = file.filenameToBaseUri(filepath, uri, options.root);
+        relativePath = path.relative(options.root, filepath);
 
         debug("Checking " + accessType + "<" + mode + "> to " +
             pathUri + " for WebID: " + req.session.userId);
@@ -202,19 +202,19 @@ function allow(mode, req, res) {
         accessType = "defaultForNew";
         if (i === 0) {
             if (path.dirname(path.dirname(relativePath)) == '.') {
-                filepath = options.base;
+                filepath = options.root;
             } else if (S(relativePath).endsWith("/")) {
-                filepath = options.base + path.dirname(path.dirname(relativePath));
+                filepath = options.root + path.dirname(path.dirname(relativePath));
             } else {
-                filepath = options.base + path.dirname(relativePath);
+                filepath = options.root + path.dirname(relativePath);
             }
         } else {
             if (relativePath.length === 0) {
                 break;
             } else if (path.dirname(path.dirname(relativePath)) === '.') {
-                filepath = options.base;
+                filepath = options.root;
             } else {
-                filepath = options.base + path.dirname(path.dirname(relativePath));
+                filepath = options.root + path.dirname(path.dirname(relativePath));
             }
         }
 
diff --git a/bin/ldnode.js b/bin/ldnode.js
@@ -23,10 +23,9 @@ var argv = require('nomnom')
     abbr: 'm',
     help: 'Where to mount Linked Data Platform (default: \'/\')'
   })
-  .option('base', {
-    abbr: 'b',
-    full: 'base',
-    help: 'Base location to serve resources'
+  .option('root', {
+    abbr: 'r',
+    help: 'Root location on the filesystem to serve resources'
   })
   .option('port', {
     abbr: 'p',
diff --git a/handlers/delete.js b/handlers/delete.js
@@ -10,7 +10,7 @@ var metadata = require('../metadata.js');
 function handler(req, res) {
     var options = req.app.locals.ldp;
     debug('DELETE -- ' + req.path);
-    var filename = file.uriToFilename(req.path, options.base);
+    var filename = file.uriToFilename(req.path, options.root);
     fs.stat(filename, function(err, stats) {
         if (err) {
             debug("DELETE -- unlink() error: " + err);
diff --git a/handlers/get.js b/handlers/get.js
@@ -46,7 +46,7 @@ function get(req, res, includeBody) {
         debug('HEAD -- ' + req.path);
     }
 
-    var filename = file.uriToFilename(req.path, options.base);
+    var filename = file.uriToFilename(req.path, options.root);
     fs.stat(filename, function(err, stats) {
         if (err) {
             if (glob.hasMagic(filename)) {
@@ -118,7 +118,7 @@ function get(req, res, includeBody) {
                     try {
                         var fileData = fs.readFileSync(match,
                             {encoding: "utf8"});
-                        var baseUri = file.filenameToBaseUri(match, uri, options.base);
+                        var baseUri = file.filenameToBaseUri(match, uri, options.root);
                         //TODO integrate ACL
                         if (S(match).endsWith(".ttl") && aclAllow(match)) {
                             $rdf.parse(fileData, globGraph, baseUri,
@@ -140,7 +140,7 @@ function get(req, res, includeBody) {
             return true;
         } else {
             var relativePath = '/' +
-                    path.relative(options.base, match);
+                    path.relative(options.root, match);
             req.path = relativePath;
             var allow = acl.allow("Read", req, res);
             if (allow.status === 200) {
@@ -153,7 +153,7 @@ function get(req, res, includeBody) {
 
     function parseLinkedData(turtleData) {
         var accept = header.parseAcceptHeader(req);
-        var baseUri = file.filenameToBaseUri(filename, uri, options.base);
+        var baseUri = file.filenameToBaseUri(filename, uri, options.root);
 
         // Handle Turtle Accept header
         if (accept === undefined || accept === null) {
@@ -190,7 +190,7 @@ function get(req, res, includeBody) {
 
     function parseContainer(containerData) {
         //Handle other file types
-        var baseUri = file.filenameToBaseUri(filename, uri, options.base);
+        var baseUri = file.filenameToBaseUri(filename, uri, options.root);
         var resourceGraph = $rdf.graph();
         try {
             $rdf.parse(containerData, resourceGraph, baseUri, 'text/turtle');
diff --git a/handlers/patch.js b/handlers/patch.js
@@ -15,7 +15,7 @@ function handler(req, res) {
     debug('PATCH -- ' +req.path);
     debug('PATCH -- text length: ' + (req.text ? req.text.length : 'undefined2'));
     res.header('MS-Author-Via' , 'SPARQL' );
-    var filename = file.uriToFilename(req.path, options.base);
+    var filename = file.uriToFilename(req.path, options.root);
     var patchContentType = req.get('content-type').split(';')[0].trim(); // Ignore parameters
     var targetContentType = mime.lookup(filename);
     var targetURI = file.uriAbs(req) + req.path;
diff --git a/handlers/post.js b/handlers/post.js
@@ -41,7 +41,7 @@ function handler(req, res) {
     }
 
 
-    var containerPath = file.uriToFilename(req.path, options.base);
+    var containerPath = file.uriToFilename(req.path, options.root);
     debug("POST -- Container path: " + containerPath);
     
     // Container not found/invalid
@@ -81,7 +81,7 @@ function handler(req, res) {
     var resourceBaseUri = file.filenameToBaseUri(
         resourcePath,
         uri,
-        options.base);
+        options.root);
 
     try {
         $rdf.parse(
@@ -109,7 +109,7 @@ function handler(req, res) {
     } else {
         container.createNewResource(
             options.usedURIs,
-            options.base,
+            options.root,
             uri,
             resourcePath,
             resourceGraph,
diff --git a/handlers/put.js b/handlers/put.js
@@ -18,7 +18,7 @@ function handler(req, res) {
     debug("PUT -- Text length: " + (req.text ? req.text.length : 'undefined'));
     res.header('MS-Author-Via' , 'SPARQL' );
 
-    var filePath = file.uriToFilename(req.path, options.base);
+    var filePath = file.uriToFilename(req.path, options.root);
 
     // PUT requests not supported on containers. Use POST instead
     if (filePath[filePath.length - 1] === '/') {
diff --git a/index.js b/index.js
@@ -48,7 +48,7 @@ function ldnode (argv) {
     }));
 
     // Creating root container
-    container.createRootContainer(opts.base, opts.mount);
+    container.createRootContainer(opts.root, opts.mount);
 
     // Setting up routes
     app.use('/', routes());
diff --git a/metadata.js b/metadata.js
@@ -47,7 +47,7 @@ function deleteContainerMetadata(directory, callback) {
 
 function linksHandler(req, res, next) {
     var options = req.app.locals.ldp;
-    var filename = file.uriToFilename(req.url, options.base);
+    var filename = file.uriToFilename(req.url, options.root);
     filename = path.join(filename, req.path);
     if (module.exports.isMetadataFile(filename)) {
         debug("Trying to access metadata file as regular file.");
diff --git a/options.js b/options.js
@@ -15,7 +15,7 @@ function params(argv) {
   // From input
   opts.cache = argv.cache;
   opts.live = argv.live;
-  opts.path = opts.base = argv.base || argv.fileBase || process.cwd();
+  opts.root = argv.root || process.cwd();
   opts.port = argv.port;
   opts.secret = argv.secret;
   opts.cert = argv.cert;
@@ -30,8 +30,8 @@ function params(argv) {
   opts.suffixChanges = argv.suffixChanges || '.changes';
   opts.suffixSSE = argv.suffixSSE || '.events';
 
-  if (!(S(opts.base).endsWith('/'))) {
-      opts.base += '/';
+  if (!(S(opts.root).endsWith('/'))) {
+      opts.root += '/';
   }
 
   opts.pathFilter = regexp().start(opts.mount).toRegExp();
@@ -42,6 +42,7 @@ function params(argv) {
   opts.usedURIs = {};
 
   debug("mount: " + opts.mount);
+  debug("root: " + opts.root);
   debug("URI path filter regexp: " + opts.pathFilter);
   debug("Verbose: " + !!opts.verbose);
   debug("WebID: " + !!opts.webid);
diff --git a/test/params.js b/test/params.js
@@ -1,6 +1,27 @@
-var expect = require('chai').expect;
+var assert = require('chai').assert;
 var ldnode = require('../index');
 var supertest = require('supertest');
+var fs = require('fs');
+
+function cp (src, dest) {
+  return fsExtra.copySync(
+    __dirname + '/' + src,
+    __dirname + '/' + dest);
+}
+
+function read (file) {
+  return fs.readFileSync(__dirname + '/' + file, {
+      'encoding': 'utf8'
+    });
+}
+
+function rm (file) {
+  return fs.unlinkSync(__dirname + '/' + file);
+}
+
+function write (text, file) {
+  return fs.writeFileSync(__dirname + '/' + file, text);
+}
 
 describe('params', function () {
 
@@ -32,17 +53,57 @@ describe('params', function () {
   //       done();
   //     })
   //   })
-  })
-
-  describe('base', function () {
+  });
 
+  describe('root', function () {
     describe('not passed', function () {
-      it ('should fallback on current working directory', function (done) {
-        done()
-      })
-    })
+      var ldp = ldnode();
+      var server = supertest(ldp);
+      
+      it ('should fallback on current working directory', function () {
+        assert.equal(ldp.locals.ldp.root, process.cwd() + ldp.locals.ldp.mount);
+      });
+
+      it ('should find resource in correct path', function(done) {
+        write(
+          '<#current> <#temp> 123 .',
+          'testfiles/example.ttl');
+
+        // This assums npm test is run from the folder that contains package.js
+        server.get('/test/testfiles/example.ttl')
+          .expect('Link', /http:\/\/www.w3.org\/ns\/ldp#Resource/)
+          .expect(200)
+          .end(function(err, res, body) {
+            assert.equal(read('testfiles/example.ttl'), '<#current> <#temp> 123 .');
+            rm('testfiles/example.ttl');
+            done(err);
+          });
+      });
+    });
 
     describe('passed', function() {
-    })
-  })
-})
+      var ldp = ldnode({root:'test'});
+      var server = supertest(ldp);
+
+      it ('should fallback on current working directory', function () {
+        assert.equal(ldp.locals.ldp.root, 'test' + ldp.locals.ldp.mount);
+      });
+
+      it ('should find resource in correct path', function(done) {
+        write(
+          '<#current> <#temp> 123 .',
+          'testfiles/example.ttl');
+
+        // This assums npm test is run from the folder that contains package.js
+        server.get('/testfiles/example.ttl')
+          .expect('Link', /http:\/\/www.w3.org\/ns\/ldp#Resource/)
+          .expect(200)
+          .end(function(err, res, body) {
+            assert.equal(read('testfiles/example.ttl'), '<#current> <#temp> 123 .');
+            rm('testfiles/example.ttl');
+            done(err);
+          });
+      });
+    });
+  });
+});
diff --git a/test/patch.js b/test/patch.js
@@ -11,11 +11,13 @@ function cp (src, dest) {
     __dirname + '/' + src,
     __dirname + '/' + dest);
 }
+
 function read (file) {
   return fs.readFileSync(__dirname + '/' + file, {
       'encoding': 'utf8'
     });
 }
+
 function rm (file) {
   return fs.unlinkSync(__dirname + '/' + file);
 }
@@ -27,7 +29,7 @@ function write (text, file) {
 
 describe('PATCH', function () {
   var ldp = ldnode.createServer({
-    base: __dirname + '/testfiles',
+    root: __dirname + '/testfiles',
     mount: '/test'
   });
   ldp.listen(3453);
@@ -50,6 +52,5 @@ describe('PATCH', function () {
           done(err);
         });
     });
-
   });
 });
diff --git a/test/secure-test.js b/test/secure-test.js
@@ -16,7 +16,7 @@ describe('ACL', function() {
 
     var ldp = ldnode.createServer({
         mount: '/test',
-        base: __dirname,
+        root: __dirname,
         key: __dirname + '/key.pem',
         cert: __dirname + '/cert.pem',
         webid: true
diff --git a/test/test.js b/test/test.js
@@ -8,7 +8,7 @@ var S = require('string');
 describe('ldnode', function() {
   var address = 'http://localhost:3457';
   var ldp = ldnode.createServer({
-    base: __dirname
+    root: __dirname
   });
   ldp.listen(3457);
 
