Adding tests

lib/settings/index.js

@@ -1,39 +1,15 @@
 var _ = require("underscore"),
     path = require("path"),
-    fs = require("fs");
+    fs = require("fs"),
+    load = require("./load.js");
 
-var settings = tryToLoad("settings/index.js"),
-    themes = tryToLoad("settings/themes.json");
+var settings = load("settings/index.js"),
+    themes = load("settings/themes.json");
 
 // Validate settings
-require("./validate-settings.js")(settings);
+settings = require("./validate-settings.js")(settings);
 
 // Validate themes
-require("./validate-themes.js")(themes);
+themes = require("./validate-themes.js")(themes);
 
 module.exports = settings;
-
-// Try to load modules
-function tryToLoad(filename) {
-
-  var loaded;
-
-  try {
-    loaded = require(path.join(__dirname, "..", "..", filename));
-    if (!loaded) {
-      throw new Error("Couldn't load contents of " + filename + ".");
-    }
-  } catch(e) {
-    if (e.code === "MODULE_NOT_FOUND") {
-      throw new Error("No " + filename + " file found.");
-    } else if (e instanceof SyntaxError) {
-      console.warn("Error parsing " + filename);
-      throw e;
-    } else {
-      throw e;
-    }
-  }
-
-  return loaded;
-
-}

lib/settings/load.js

@@ -0,0 +1,26 @@
+var path = require("path");
+
+// Try to load module
+module.exports = function(filename) {
+
+  var loaded;
+
+  try {
+    loaded = require(path.join(__dirname, "..", "..", filename));
+    if (!loaded) {
+      throw new Error("Couldn't load contents of " + filename + ".");
+    }
+  } catch(e) {
+    if (e.code === "MODULE_NOT_FOUND") {
+      throw new Error("No " + filename + " file found.");
+    } else if (e instanceof SyntaxError) {
+      console.warn("Error parsing " + filename + ".");
+      throw e;
+    } else {
+      throw e;
+    }
+  }
+
+  return loaded;
+
+}

lib/settings/validate-settings.js

@@ -1,12 +1,14 @@
 var fs = require("fs"),
     path = require("path"),
-    Canvas = require("canvas");
+    mkdirp = require("mkdirp"),
+    Canvas = require("canvas"),
+    _ = require("underscore");
 
 module.exports = function(settings) {
 
   // Check paths
   if (typeof settings.workingDirectory !== "string") {
-    throw new Error("settings.workingDirectory is required. See https://github.com/nypublicradio/audiogram/blob/master/SERVER.md#all-settings for details.").
+    throw new Error("settings.workingDirectory is required. See https://github.com/nypublicradio/audiogram/blob/master/SERVER.md#all-settings for details.");
   }
 
   if (typeof settings.storagePath !== "string" && typeof settings.s3Bucket !== "string") {
@@ -15,14 +17,14 @@ module.exports = function(settings) {
 
   // TODO normalize workingDirectory, s3Bucket, and storagePath
   settings.workingDirectory = normalize(settings.workingDirectory);
-  tryToCreate("workingDirectory");
+  tryToCreate(settings.workingDirectory, "workingDirectory");
 
   if (typeof settings.s3Bucket === "string") {
 
     // Remove s3:// and trailing slash, bucket name only
     settings.s3Bucket = settings.s3Bucket.replace(/^(s3[:]\/\/)|\/$/g, "");
 
-    if (settings.storagePath) {
+    if (typeof settings.storagePath === "string") {
 
       // No leading slash, one trailing slash
       settings.storagePath = settings.storagePath.replace(/^\/|\/$/g, "");
@@ -37,7 +39,7 @@ module.exports = function(settings) {
 
   } else {
     settings.storagePath = normalize(settings.storagePath);
-    tryToCreate("storagePath");
+    tryToCreate(settings.storagePath, "storagePath");
   }
 
   // Check maxUploadSize
@@ -63,24 +65,22 @@ module.exports = function(settings) {
         fs.accessSync(font.file);
         Canvas.registerFont(font.file, _.pick(font, "family", "weight", "style"));
       } catch(e) {
-        // TODO catch font registration error
-        console.warn(e);
         return console.warn("Font file " + font.file + " does not exist or is not readable.");
       }
 
     });
   }
 
+  return settings;
+
 };
 
-function tryToCreate(key) {
+function tryToCreate(dir, key) {
   try {
-    mkdirp.sync(settings[key]);
-    fs.accessSync(settings[key]);
+    mkdirp.sync(dir);
+    fs.accessSync(dir);
   } catch(e) {
-    // TODO more helpful msg
-    console.warn(e);
-    throw e;
+    throw new Error("Could not create/access settings." + key + " at " + dir + "");
   }
 }
 

lib/settings/validate-themes.js

@@ -5,7 +5,7 @@ var path = require("path"),
 module.exports = function(themes) {
 
   if (!themes || !_.keys(_.omit(themes, "default")).length) {
-    throw new Error("No themes found in settings/themes.json. See https://github.com/nypublicradio/audiogram/blob/master/THEMES.md for details.");
+    return console.warn("No themes found in settings/themes.json. See https://github.com/nypublicradio/audiogram/blob/master/THEMES.md for details.");
   }
 
   for (var key in themes) {
@@ -14,6 +14,8 @@ module.exports = function(themes) {
     }
   }
 
+  return themes;
+
 };
 
 function validateTheme(name, options) {
@@ -31,7 +33,12 @@ function validateTheme(name, options) {
   });
 
   if (typeof options.backgroundImage === "string") {
-    fullBackgroundImagePath = path.join(__dirname, "..", "..", "settings/backgrounds/", options.backgroundImage);
+
+    fullBackgroundImagePath = options.backgroundImage;
+
+    if (!path.isAbsolute(options.backgroundImage)) {
+      fullBackgroundImagePath = path.join(__dirname, "..", "..", "settings/backgrounds/", options.backgroundImage);
+    }
 
     try {
       fs.accessSync(fullBackgroundImagePath);

test/settings-test.js

@@ -0,0 +1,324 @@
+var tape = require("tape"),
+    path = require("path"),
+    validateSettings = require("../lib/settings/validate-settings.js"),
+    validateThemes = require("../lib/settings/validate-themes.js"),
+    load = require("../lib/settings/load.js");
+
+tape("Load test", function(test) {
+
+  test.throws(function(){
+    load("settings/blah.js");
+  }, /No .+ file found/);
+
+  test.throws(function(){
+    load("README.md");
+  }, /SyntaxError/);
+
+  test.doesNotThrow(function(){
+    load("settings/themes.json");
+  });
+
+  test.doesNotThrow(function(){
+    load("settings/index.js");
+  });
+
+  test.end();
+
+});
+
+tape("Required fields", function(test) {
+
+  test.throws(function(){
+    validateSettings({});
+  }, /settings.workingDirectory is required/);
+
+  test.throws(function(){
+    validateSettings({ workingDirectory: 1 });
+  }, /settings.workingDirectory is required/);
+
+  test.throws(function(){
+    validateSettings({ workingDirectory: "" });
+  }, /settings.storagePath/);
+
+  test.throws(function(){
+    validateSettings({ workingDirectory: "", storagePath: 1 });
+  }, /settings.storagePath/);
+
+  test.doesNotThrow(function(){
+    validateSettings({ workingDirectory: path.join(__dirname), storagePath: path.join(__dirname) });
+  }, /settings.storagePath/);
+
+  test.doesNotThrow(function(){
+    validateSettings({ workingDirectory: path.join(__dirname), s3Bucket: "bucket" });
+  }, /settings.storagePath/);
+
+  test.end();
+
+});
+
+tape("Max upload size", function(test) {
+
+  test.throws(function(){
+    validateSettings({ workingDirectory: path.join(__dirname), storagePath: path.join(__dirname), maxUploadSize: "a lot" });
+  }, /settings.maxUploadSize/);
+
+  test.end();
+
+});
+
+tape("Normalizing paths", function(test) {
+
+  var relative = validateSettings({
+    storagePath: "test/",
+    workingDirectory: "test/"
+  });
+
+  var absolute = validateSettings({
+    storagePath: path.join(__dirname),
+    workingDirectory: path.join(__dirname)
+  });
+
+  var relative2 = validateSettings({
+    storagePath: "test",
+    workingDirectory: "test"
+  });
+
+  test.equal(path.relative(relative.storagePath, absolute.storagePath), "");
+  test.equal(path.relative(relative.workingDirectory, absolute.workingDirectory), "");
+  test.equal(path.relative(relative2.storagePath, absolute.storagePath), "");
+  test.equal(path.relative(relative2.workingDirectory, absolute.workingDirectory), "");
+
+  test.end();
+
+});
+
+tape("Normalize S3 bucket", function(test) {
+
+  var settings = validateSettings({
+    s3Bucket: "bucket",
+    workingDirectory: "test/"
+  });
+
+  test.equal(settings.s3Bucket, "bucket");
+  test.equal(settings.storagePath, "");
+
+  var settings = validateSettings({
+    s3Bucket: "s3://bucket",
+    workingDirectory: "test/"
+  });
+
+  test.equal(settings.s3Bucket, "bucket");
+  test.equal(settings.storagePath, "");
+
+  settings = validateSettings({
+    s3Bucket: "s3://bucket/",
+    workingDirectory: "test/"
+  });
+
+  test.equal(settings.s3Bucket, "bucket");
+  test.equal(settings.storagePath, "");
+
+  settings = validateSettings({
+    s3Bucket: "s3://bucket/",
+    storagePath: "/",
+    workingDirectory: "test/"
+  });
+
+  test.equal(settings.s3Bucket, "bucket");
+  test.equal(settings.storagePath, "");
+
+  settings = validateSettings({
+    s3Bucket: "s3://bucket/",
+    storagePath: "dir",
+    workingDirectory: "test/"
+  });
+
+  test.equal(settings.s3Bucket, "bucket");
+  test.equal(settings.storagePath, "dir/");
+
+  settings = validateSettings({
+    s3Bucket: "s3://bucket/",
+    storagePath: "dir/",
+    workingDirectory: "test/"
+  });
+
+  test.equal(settings.s3Bucket, "bucket");
+  test.equal(settings.storagePath, "dir/");
+
+  settings = validateSettings({
+    s3Bucket: "s3://bucket/",
+    storagePath: "/dir/",
+    workingDirectory: "test/"
+  });
+
+  test.equal(settings.s3Bucket, "bucket");
+  test.equal(settings.storagePath, "dir/");
+
+  test.end();
+
+});
+
+tape("Fonts", function(test) {
+
+  test.throws(function(){
+    validateSettings({
+      s3Bucket: "bucket",
+      workingDirectory: "test/",
+      fonts: 1
+    });
+  }, /settings.fonts/);
+
+  test.throws(function(){
+    validateSettings({
+      s3Bucket: "bucket",
+      workingDirectory: "test/",
+      fonts: {}
+    });
+  }, /settings.fonts/);
+
+  doesWarn(test, function(){
+    validateSettings({
+      s3Bucket: "bucket",
+      workingDirectory: "test/",
+      fonts: [
+        {}
+      ]
+    });
+  }, /settings.fonts.+missing/);
+
+  doesWarn(test, function(){
+    validateSettings({
+      s3Bucket: "bucket",
+      workingDirectory: "test/",
+      fonts: [
+        { family: "" }
+      ]
+    });
+  }, /settings.fonts.+missing/);
+
+  doesWarn(test, function(){
+    validateSettings({
+      s3Bucket: "bucket",
+      workingDirectory: "test/",
+      fonts: [
+        { file: "" }
+      ]
+    });
+  }, /settings.fonts.+missing/);
+
+  doesWarn(test, function(){
+    validateSettings({
+      s3Bucket: "bucket",
+      workingDirectory: "test/",
+      fonts: [
+        { file: "notarealfont.ttf", family: "fake" }
+      ]
+    });
+  }, /Font file.+does not exist/);
+
+  doesNotWarn(test, function(){
+    validateSettings({
+      s3Bucket: "bucket",
+      workingDirectory: "test/",
+      fonts: [
+        { file: "settings/fonts/SourceSansPro-Light.ttf", family: "Source Sans Pro" },
+        { file: path.join(__dirname, "..", "settings/fonts/SourceSansPro-Bold.ttf"), family: "Source Sans Pro", weight: "bold" }
+      ]
+    });
+  });
+
+  test.end();
+
+});
+
+tape("Themes", function(test) {
+
+  doesWarn(test, function(){
+    validateThemes({});
+  }, /No themes/);
+
+  doesWarn(test, function(){
+    validateThemes([]);
+  }, /No themes/);
+
+  doesWarn(test, function(){
+    validateThemes({ "default": {} });
+  }, /No themes/);
+
+  doesNotWarn(test, function(){
+    validateThemes({ "default": { width: 0, height: 0, framesPerSecond: 0, samplesPerFrame: 0 }, "theme": {} });
+  });
+
+  doesNotWarn(test, function(){
+    validateThemes({ "default": { framesPerSecond: 0, samplesPerFrame: 0 }, "theme": { width: 0, height: 0 } });
+  });
+
+  doesWarn(test, function(){
+    validateThemes({ "default": { height: 0, framesPerSecond: 0, samplesPerFrame: 0 }, "theme": {} });
+  }, /required property 'width'/);
+
+  doesWarn(test, function(){
+    validateThemes({ "default": { width: 0, framesPerSecond: 0, samplesPerFrame: 0 }, "theme": {} });
+  }, /required property 'height'/);
+
+  doesWarn(test, function(){
+    validateThemes({ "default": { width: 0, height: 0, samplesPerFrame: 0 }, "theme": {} });
+  }, /required property 'framesPerSecond'/);
+
+  doesWarn(test, function(){
+    validateThemes({ "default": { width: 0, height: 0, framesPerSecond: 0 }, "theme": {} });
+  }, /required property 'samplesPerFrame'/);
+
+  doesWarn(test, function(){
+    validateThemes({ "default": { width: 0, height: 0, framesPerSecond: 0, samplesPerFrame: 0 }, "theme": { backgroundImage: "doesnotexist.jpg" } });
+  }, /Background image.+does not exist/);
+
+  doesNotWarn(test, function(){
+    validateThemes({ "default": { width: 0, height: 0, framesPerSecond: 0, samplesPerFrame: 0 }, "theme": { backgroundImage: "subway.jpg" } });
+  });
+
+  doesNotWarn(test, function(){
+    validateThemes({ "default": { width: 0, height: 0, framesPerSecond: 0, samplesPerFrame: 0 }, "theme": { backgroundImage: path.join(__dirname, "..", "settings/backgrounds/subway.jpg") } });
+  });
+
+  test.end();
+
+});
+
+function doesNotWarn(test, fn) {
+  doesWarn(test, fn, "");
+}
+
+function doesWarn(test, fn, regexp) {
+
+  var output = capture();
+
+  fn();
+
+  if (arguments.length > 2) {
+    if (typeof regexp === "string") {
+      test.equal(output(), regexp);
+    } else {
+      test.assert(regexp.test(output()));
+    }
+  } else {
+    test.assert(output().length);
+  }
+
+}
+
+function capture(){
+
+  var write = process.stderr.write,
+      out = "";
+
+  process.stderr.write = function(str) {
+    out += str;
+  };
+
+  return function(){
+    process.stderr.write = write;
+    return out;
+  }
+
+}