Added unit converter tests and extra checks for malformed input data

QutEcoacoustics · Jul 4, 2014 · 8ed63e5 · 8ed63e5
1 parent 67bc7e4
commit 8ed63e5
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 18 deletions.
diff --git a/src/components/services/unitConverter.js b/src/components/services/unitConverter.js
@@ -7,6 +7,8 @@ uc.factory("bawApp.unitConverter", ['conf.constants', function (constants) {
         return Math.abs(fraction - 1);
     }
 
+    var keysToCheck = ["sampleRate", "spectrogramWindowSize", "startOffset", "endOffset"];
+
     function calculateUnitConversions(data) {
         var result = {
             pixelsPerSecond: NaN,
@@ -15,15 +17,18 @@ uc.factory("bawApp.unitConverter", ['conf.constants', function (constants) {
             enforcedImageWidth: NaN,
             enforcedImageHeight: NaN
         };
-
-        if (data.sampleRate === undefined ||
-            data.spectrogramWindowSize === undefined ||
-            data.startOffset === undefined ||
-            data.endOffset === undefined) {
+
+        if (keysToCheck.some(function (key) { return data[key] === undefined; })) {
             console.warn("unitConverter:calculateUnitConversions: not enough information available to calculate unit conversions");
             return result;
         }
 
+        keysToCheck.forEach(function(key) {
+            if (!angular.isNumber(data[key])) {
+                throw "Input data field `" + key + "` should be a number!";
+            }
+        });
+
         // based on meta data only
         var duration = data.endOffset - data.startOffset,
             nyquistFrequency = (data.sampleRate / 2.0),

diff --git a/src/components/services/unitConverters.spec.js b/src/components/services/unitConverters.spec.js
@@ -1,26 +1,20 @@
 describe("The unitConverter service", function () {
 
     var unitConverter;
-    var inputArgs = {
-        sampleRate: null,
-        spectrogramWindowSize: null,
-        endOffset: null,
-        startOffset: null,
-        imageElement: null
-    };
+    var inputArgs = {};
 
     beforeEach(module('bawApp.services.unitConverter'));
 
     beforeEach(inject(["bawApp.unitConverter", function (providedUnitConverted) {
         unitConverter = providedUnitConverted;
 
         inputArgs = {
-            sampleRate: null,
-            spectrogramWindowSize: null,
-            endOffset: null,
-            startOffset: null,
-            imageElement: null,
-            audioRecordingAbsoluteStartDate: null
+            sampleRate: undefined,
+            spectrogramWindowSize: undefined,
+            endOffset: undefined,
+            startOffset: undefined,
+            imageElement: undefined,
+            audioRecordingAbsoluteStartDate: undefined
         };
     }]));
 
@@ -75,6 +69,19 @@ describe("The unitConverter service", function () {
             expect(converters.input).toBe(inputArgs);
         });
 
+        ["sampleRate", "spectrogramWindowSize", "startOffset", "endOffset"].forEach(function (key) {
+            it("requires " + key + " be provided as a number", function () {
+
+                var f = function () {
+                    var local = angular.extend({}, inputArgs);
+                    local[key] = inputArgs[key].toString();
+                    unitConverter.getConversions(local);
+                };
+
+                expect(f).toThrowError("Input data field `" + key + "` should be a number!");
+            });
+        });
+
         it("ensure the absolute start date of the input object is output and is a date", function(){
             var isDate = converters.input.audioRecordingAbsoluteStartDate instanceof Date;