@hurenkam/hue-services 0.6.0

package/test/Resource_spec.js

@@ -0,0 +1,392 @@
+const Resource = require('../src/clip/Resource')
+const assert = require('assert');
+const sinon = require('sinon');
+
+class TestClip {
+    static mock = {}
+
+    get(rtype,rid) {
+        if (TestClip.mock.get) {
+            return TestClip.mock.get(rtype,rid);
+        }
+    }
+    put(rtype,rid,data) {
+        if (TestClip.mock.put) {
+            return TestClip.mock.put(rtype,rid,data);
+        }
+    }
+    getResource() {
+        if (TestClip.mock.getResource) {
+            return TestClip.mock.getResource();
+        }
+    }
+}
+
+describe('Resource', function () {
+    beforeEach(()=>{
+        sandbox = sinon.createSandbox();
+    });
+
+    afterEach(function () {
+        sandbox.restore();
+    });
+
+
+    it('should construct and destruct', function (done) {
+        sandbox.stub(Resource.prototype,'id').callsFake(() => "id");
+        var resource = new Resource();
+        resource.destructor();
+        done();
+    });
+
+    it('should return data', function (done) {
+        sandbox.stub(Resource.prototype,'id').callsFake(() => "id");
+        var resource = new Resource({
+            id: "1801c6af-fff3-40b4-b5fa-2a056ce7a192",
+            type: "button",
+        });
+        var data = resource.data();
+        assert.equal(data.type,"button");
+        done();
+    });
+
+    it('should return clip', function (done) {
+        sandbox.stub(Resource.prototype,'id').callsFake(() => "id");
+        var resource = new Resource({
+            id: "1801c6af-fff3-40b4-b5fa-2a056ce7a192",
+            type: "button",
+        }, {
+            name: "clip"
+        });
+        var clip = resource.clip();
+        assert.equal(clip.name,"clip");
+        done();
+    });
+
+    it('should return rid', function (done) {
+        sandbox.stub(Resource.prototype,'id').callsFake(() => "id");
+        var resource = new Resource({
+            id: "1801c6af-fff3-40b4-b5fa-2a056ce7a192",
+            type: "button",
+        }, {
+            name: "clip"
+        });
+        var rid = resource.rid();
+        assert.equal(rid,"1801c6af-fff3-40b4-b5fa-2a056ce7a192");
+        done();
+    });
+
+    it('should return rtype', function (done) {
+        sandbox.stub(Resource.prototype,'id').callsFake(() => "id");
+        var resource = new Resource({
+            id: "1801c6af-fff3-40b4-b5fa-2a056ce7a192",
+            type: "button",
+        }, {
+            name: "clip"
+        });
+        var rtype = resource.rtype();
+        assert.equal(rtype,"button");
+        done();
+    });
+
+    it('should return data().metadata.name if present and name() is called', function (done) {
+        TestClip.mock = {
+            getResource: function() {
+                return "clip.getResource"
+            }
+        }
+
+        sandbox.stub(Resource.prototype,'id').callsFake(() => "id");
+        var resource = new Resource({
+            id: "1801c6af-fff3-40b4-b5fa-2a056ce7a192",
+            type: "button",
+            metadata: {
+                name: "Button"
+            }
+        }, new TestClip());
+        var name = resource.name();
+        assert.equal(name,"Button");
+        done();
+    });
+
+    it('should return owner().name() if present and name() is called with no data().metadata available', function (done) {
+        TestClip.mock = {
+            getResource: function() {
+                return {
+                    rid: "c8867c84-f519-4012-9da9-79b801fc0a70",
+                    name: function() {
+                        return "Owner"
+                    }
+                }
+            }
+        }
+
+        sandbox.stub(Resource.prototype,'id').callsFake(() => "id");
+        var resource = new Resource({
+            id: "1801c6af-fff3-40b4-b5fa-2a056ce7a192",
+            type: "button",
+            owner: {
+                rid: "c8867c84-f519-4012-9da9-79b801fc0a70"
+            },
+        }, new TestClip());
+        var name = resource.name();
+        assert.equal(name,"Owner");
+        done();
+    });
+
+    it('should call clip.getResource when looking up owner() if owner was set', function (done) {
+        TestClip.mock = {
+            getResource: function() {
+                return {
+                    rid: "0c0f44df-e613-46aa-8da8-d4b378ed4d12",
+                    name: function() {
+                        return "Owner"
+                    }
+                }
+            }
+        }
+
+        sandbox.stub(Resource.prototype,'id').callsFake(() => "id");
+        var resource = new Resource({
+            id: "1801c6af-fff3-40b4-b5fa-2a056ce7a192",
+            type: "button",
+            owner: { 
+                rid: "0c0f44df-e613-46aa-8da8-d4b378ed4d12"
+            }
+        }, new TestClip());
+
+        var rid = resource.owner().rid;
+        assert.equal(rid,"0c0f44df-e613-46aa-8da8-d4b378ed4d12");
+        done();
+    });
+
+    it('should return null when looking up owner() if owner was not set', function (done) {
+        sandbox.stub(Resource.prototype,'id').callsFake(() => "id");
+        var resource = new Resource({
+            id: "1801c6af-fff3-40b4-b5fa-2a056ce7a192",
+            type: "button",
+        }, new TestClip());
+        var owner = resource.owner();
+        assert.equal(owner,null);
+        done();
+    });
+
+    it('should return type as typeName if no control_id is present', function (done) {
+        sandbox.stub(Resource.prototype,'id').callsFake(() => "id");
+        var resource = new Resource({
+            id: "1801c6af-fff3-40b4-b5fa-2a056ce7a192",
+            type: "button",
+        }, {
+            name: "clip"
+        });
+        var typeName = resource.typeName();
+        assert.equal(typeName,"button");
+        done();
+    });
+
+    it('should return type with number as typeName if control_id is present', function (done) {
+        sandbox.stub(Resource.prototype,'id').callsFake(() => "id");
+        var resource = new Resource({
+            id: "1801c6af-fff3-40b4-b5fa-2a056ce7a192",
+            type: "button",
+            metadata: { 
+                control_id: 3
+            }
+        }, {
+            name: "clip"
+        });
+        var typeName = resource.typeName();
+        assert.equal(typeName,"button3");
+        done();
+    });
+
+    it('should lookup service resources if services() is called and data().services is not empty', function (done) {
+        TestClip.mock = {
+            getResource: function() {
+                return {
+                    rid: "0c0f44df-e613-46aa-8da8-d4b378ed4d12",
+                    name: function() {
+                        return "Owner"
+                    }
+                }
+            }
+        }
+
+        sandbox.stub(Resource.prototype,'id').callsFake(() => "id");
+        var resource = new Resource({
+            id: "1801c6af-fff3-40b4-b5fa-2a056ce7a192",
+            type: "device",
+            services: [{
+                    rid: "2194dc5c-42ac-4f8b-845d-4af234cc1e6b",
+                    rtype: "button"
+                },{
+                    rid: "08f8c311-9e2c-4028-8a2d-625a0c260cb4",
+                    rtype: "button"
+                }
+            ]
+        }, new TestClip());
+        var services = resource.services();
+        assert.equal(Object.keys(services).length,2);
+        done();
+    });
+
+    it('should return empty list if services() is called and data().services is not present', function (done) {
+        TestClip.mock = {
+            getResource: function() {
+                return {
+                    rid: "0c0f44df-e613-46aa-8da8-d4b378ed4d12",
+                    name: function() {
+                        return "Owner"
+                    }
+                }
+            }
+        }
+
+        sandbox.stub(Resource.prototype,'id').callsFake(() => "id");
+        var resource = new Resource({
+            id: "1801c6af-fff3-40b4-b5fa-2a056ce7a192",
+            type: "device",
+        }, new TestClip());
+        var services = resource.services();
+        assert.equal(Object.keys(services).length,0);
+        done();
+    });
+
+    it('should return empty list if services() is called and resource lookup fails', function (done) {
+        TestClip.mock = {
+            getResource: function() {
+                return null;
+            }
+        }
+
+        sandbox.stub(Resource.prototype,'id').callsFake(() => "id");
+        var resource = new Resource({
+            id: "1801c6af-fff3-40b4-b5fa-2a056ce7a192",
+            type: "device",
+            services: [{
+                    rid: "2194dc5c-42ac-4f8b-845d-4af234cc1e6b",
+                    rtype: "button"
+                },{
+                    rid: "08f8c311-9e2c-4028-8a2d-625a0c260cb4",
+                    rtype: "button"
+                }
+            ]
+        }, new TestClip());
+        var services = resource.services();
+        assert.equal(Object.keys(services).length,0);
+        done();
+    });
+
+    it('should forward get() to clip().get() with rtype() and rid() as parameters', function (done) {
+        TestClip.mock = {
+            get: function(rtype,rid) {
+                assert.equal(rtype,"device");
+                assert.equal(rid,"1801c6af-fff3-40b4-b5fa-2a056ce7a192");
+                done();
+            },
+        }
+
+        sandbox.stub(Resource.prototype,'id').callsFake(() => "id");
+        var resource = new Resource({
+            id: "1801c6af-fff3-40b4-b5fa-2a056ce7a192",
+            type: "device",
+            metadata: {
+                name: "Device"
+            }
+        }, new TestClip());
+        resource.get();
+    });
+
+    it('should forward put() to clip().put() with rtype() and rid() as parameters', function (done) {
+        TestClip.mock = {
+            put: function(rtype,rid,data) {
+                assert.equal(rtype,"device");
+                assert.equal(rid,"1801c6af-fff3-40b4-b5fa-2a056ce7a192");
+                assert.equal(data,"testdata");
+                done();
+            },
+        }
+
+        sandbox.stub(Resource.prototype,'id').callsFake(() => "id");
+        var resource = new Resource({
+            id: "1801c6af-fff3-40b4-b5fa-2a056ce7a192",
+            type: "device",
+            metadata: {
+                name: "Device"
+            }
+        }, new TestClip());
+        resource.put("testdata");
+    });
+
+    it('should appropriate data fields with information from event provided in updateStatus(event) call', function (done) {
+        TestClip.mock = {
+        }
+
+        sandbox.stub(Resource.prototype,'id').callsFake(() => "id");
+        var resource = new Resource({
+            id: "1801c6af-fff3-40b4-b5fa-2a056ce7a192",
+            type: "device",
+            metadata: {
+                name: "Device"
+            }
+        }, new TestClip());
+        resource.updateStatus({
+            id: "new_id",
+            button: { 
+                last_event: "initial_press"
+            }
+        });
+        var data = resource.data();
+
+        // button event should be updated
+        assert.equal(data.button.last_event,"initial_press");
+
+        // id should not be updated
+        assert.equal(data.id,"1801c6af-fff3-40b4-b5fa-2a056ce7a192");
+
+        done();
+    });
+
+    it('should call updateStatus(event) when onEvent(event) is callled', function (done) {
+        TestClip.mock = {}
+        
+        sandbox.stub(Resource.prototype,'id').callsFake(() => "id");
+        sandbox.stub(Resource.prototype,'updateStatus').callsFake(() => done());
+        var resource = new Resource({
+            id: "1801c6af-fff3-40b4-b5fa-2a056ce7a192",
+            type: "device",
+            metadata: {
+                name: "Device"
+            }
+        }, new TestClip());
+        resource.onEvent({
+            id: "new_id",
+            button: { 
+                last_event: "initial_press"
+            }
+        });
+    });
+
+    it('should emit update event when onEvent(event) is callled', function (done) {
+        TestClip.mock = {}
+
+        sandbox.stub(Resource.prototype,'id').callsFake(() => "id");
+        sandbox.stub(Resource.prototype,'updateStatus').callsFake(() => {});
+        var resource = new Resource({
+            id: "1801c6af-fff3-40b4-b5fa-2a056ce7a192",
+            type: "device",
+            metadata: {
+                name: "Device"
+            }
+        }, new TestClip());
+        resource.on("update",function(event) {
+            done();
+        })
+        resource.onEvent({
+            id: "new_id",
+            button: { 
+                last_event: "initial_press"
+            }
+        });
+    });
+});

package/test/SceneNode_spec.js

@@ -0,0 +1,33 @@
+var helper = require("node-red-node-test-helper");
+var testnodes = function(RED) {
+    "use strict";
+
+    const BaseNode = require('../src/nodes/BaseNode');
+    const SceneNode = require('../src/nodes/SceneNode');
+    
+    BaseNode.nodeAPI = RED;
+    RED.nodes.registerType("SceneNode",SceneNode);
+}
+
+describe('Scene Node', function () {
+  afterEach(function () {
+    helper.unload();
+  });
+
+  it('should be loaded', function (done) {
+    //this.timeout(60000);
+    var flow = [{ 
+        id: "n1",
+        type: "SceneNode",
+        name: "scene node",
+    }];
+
+    helper.load(testnodes, flow, function () {
+      var n1 = helper.getNode("n1");
+      var config = n1.config;
+      //console.log(config);
+      config.should.have.property('name', 'scene node');
+      done();
+    });
+  });
+});

package/test/ServiceNode_spec.js

@@ -0,0 +1,33 @@
+var helper = require("node-red-node-test-helper");
+var testnodes = function(RED) {
+    "use strict";
+
+    const BaseNode = require('../src/nodes/BaseNode');
+    const ServiceNode = require('../src/nodes/ServiceNode');
+    
+    BaseNode.nodeAPI = RED;
+    RED.nodes.registerType("ServiceNode",ServiceNode);
+}
+
+describe('Service Node', function () {
+  afterEach(function () {
+    helper.unload();
+  });
+
+  it('should be loaded', function (done) {
+    //this.timeout(60000);
+    var flow = [{ 
+        id: "n1",
+        type: "ServiceNode",
+        name: "service node",
+    }];
+
+    helper.load(testnodes, flow, function () {
+      var n1 = helper.getNode("n1");
+      var config = n1.config;
+      //console.log(config);
+      config.should.have.property('name', 'service node');
+      done();
+    });
+  });
+});

package/test/TemperatureNode_spec.js

@@ -0,0 +1,153 @@
+const helper = require("node-red-node-test-helper");
+const assert = require('assert');
+const sinon = require('sinon');
+
+const testnodes = function(RED) {
+    "use strict";
+
+    const BaseNode = require('../src/nodes/BaseNode');
+    BaseNode.nodeAPI = RED;
+
+    RED.nodes.registerType("TemperatureNode",TemperatureNode);
+}
+const TemperatureNode = require('../src/nodes/TemperatureNode');
+const { isNull } = require("util");
+
+describe('TemperatureNode', function () {
+    beforeEach(()=>{
+        sandbox = sinon.createSandbox();
+    });
+
+    afterEach(function () {
+        sandbox.restore();
+        helper.unload();
+      });
+  
+    it('should load', function (done) {
+        var flow = [{
+            id: "n1",
+            type: "TemperatureNode",
+            name: "temperature node",
+        }];
+
+        helper.load(testnodes, flow, function () {
+            var n1 = helper.getNode("n1");
+            n1.should.have.property('config');
+
+            var config = n1.config;
+            config.should.have.property('name', 'temperature node');
+            done();
+        });
+    });
+
+    it('should call updateStatus() when onUpdate(event) is called', function (done) {
+        const fakeStatus = sandbox.fake(() => {
+            done()
+        });
+        sandbox.replace(TemperatureNode.prototype,'updateStatus',fakeStatus);
+    
+        var flow = [{
+            id: "n1",
+            type: "TemperatureNode",
+            name: "temperature node",
+        }];
+
+        helper.load(testnodes, flow, function () {
+            var n1 = helper.getNode("n1");
+            n1.onUpdate({
+                name: "event"
+            });
+        });
+    });
+
+    it('should call status() with "green/dot/25c"', function (done) {
+        const fakeResource = sandbox.fake.returns({
+            data: function() {
+                return { temperature: { temperature: 25 } }
+            }
+        });
+        sandbox.replace(TemperatureNode.prototype,'resource',fakeResource);
+        const fakeStatus = sandbox.fake(() => {
+            args = fakeStatus.firstArg;
+            assert.equal(args.fill,"green");
+            assert.equal(args.shape,"dot");
+            assert.equal(args.text,"25c");
+
+            done()
+        });
+        sandbox.replace(TemperatureNode.prototype,'status',fakeStatus);
+
+        var flow = [{
+            id: "n1",
+            type: "TemperatureNode",
+            name: "temperature node",
+        }];
+
+        helper.load(testnodes, flow, function () {
+            var n1 = helper.getNode("n1");
+            n1.onUpdate({
+                temperature: { temperature: 25 }
+            });
+        });
+    });
+
+    it('should call status() with "green/dot/" when resource==null', function (done) {
+        const fakeResource = sandbox.fake.returns(null);
+        sandbox.replace(TemperatureNode.prototype,'resource',fakeResource);
+        const fakeStatus = sandbox.fake(() => {
+
+            args = fakeStatus.firstArg;
+            assert.equal(args.fill,"grey");
+            assert.equal(args.shape,"dot");
+            assert.equal(args.text,"");
+
+            done()
+        });
+        sandbox.replace(TemperatureNode.prototype,'status',fakeStatus);
+
+        var flow = [{
+            id: "n1",
+            type: "TemperatureNode",
+            name: "temperature node",
+        }];
+
+        helper.load(testnodes, flow, function () {
+            var n1 = helper.getNode("n1");
+            n1.onUpdate({
+                temperature: { temperature: 25 }
+            });
+        });
+    });
+
+    it('should call status() with "green/dot/" when temperature==null', function (done) {
+        const fakeResource = sandbox.fake.returns({
+            data: function() {
+                return { temperature: { temperature: null } }
+            }
+        });
+        sandbox.replace(TemperatureNode.prototype,'resource',fakeResource);
+        const fakeStatus = sandbox.fake(() => {
+
+            args = fakeStatus.firstArg;
+            assert.equal(args.fill,"grey");
+            assert.equal(args.shape,"dot");
+            assert.equal(args.text,"");
+
+            done()
+        });
+        sandbox.replace(TemperatureNode.prototype,'status',fakeStatus);
+
+        var flow = [{
+            id: "n1",
+            type: "TemperatureNode",
+            name: "temperature node",
+        }];
+
+        helper.load(testnodes, flow, function () {
+            var n1 = helper.getNode("n1");
+            n1.onUpdate({
+                temperature: { temperature: 25 }
+            });
+        });
+    });
+});