Groups.test.js 19.9 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662
'use strict';

const expect = require('chai').expect
  , v3Api = require('../v3').api
  , discovery = require('../v3').discovery
  , testValues = require('../../test/support/testValues.js')
  , model = require('@peter-murray/hue-bridge-model').model
  , instanceChecks = model.instanceChecks
  , LightGroup = model.LightGroup
  , Zone = model.Zone
  , Room = model.Room
  , Entertainment = model.Entertainment
  , util = require('../util')
;

const NEW_GROUP_NAME = 'd4b3af3ab4df72d10666726d';


describe('Hue API #groups', function () {

  this.timeout(5000);

  const GROUP_LIGHTS = [2, 3]
    , ZONE_LIGHTS = [2, 3, 4]
  ;

  let hue;

  before(async () => {
    const searchResults = await discovery.nupnpSearch();
    expect(searchResults).to.have.length.at.least(1);
    const localApi = v3Api.createLocal(searchResults[0].ipaddress);
    hue = await localApi.connect(testValues.username);
  });


  describe('#getAll()', () => {

    it('should return all groups', async () => {
      const result = await hue.groups.getAll();

      expect(result).to.be.instanceof(Array);

      // The injected all lights special group
      expect(result[0]).to.have.property('name', 'Group 0');
      expect(result[0]).to.have.property('id', 0);

      // TODO this is now a Group object test the values
      expect(result[1]).to.have.property('name');
      expect(result[1]).to.have.property('lights');
      expect(result[1]).to.have.property('type');
      expect(result[1]).to.have.property('state');
      expect(result[1]).to.have.property('recycle');
      expect(result[1]).to.have.property('action');
    });
  });


  describe('#getGroup()', () => {

    let existingGroup;

    before(async () => {
      const allGroups = await hue.groups.getAll();

      // Use the last group as the group to test on
      existingGroup = allGroups[allGroups.length - 1];
    });

    it('should get the All Lights Group', async () => {
      const result = await hue.groups.getGroup(0);

      expect(result.name).to.equal('Group 0');
      expect(result.id).to.equal(0);
    });


    it('should get a room group', async () => {
      const result = await hue.groups.getGroup(existingGroup.id);

      expect(result).to.have.property('id').to.equal(existingGroup.id);
      expect(result).to.have.property('name').to.equal(existingGroup.name);
      //TODO could do more checks here
    });


    it('should fail to resolve a group for an invalid id number', async () => {
      try {
        await hue.groups.getGroup(65534);
        expect.fail('should not get here');
      } catch (err) {
        expect(err.message).to.contain('not available');
      }
    });


    it('should fail to resolve a group for an invalid id as a string', async () => {
      try {
        await hue.groups.getGroup('ab62c6');
        expect.fail('should not get here');
      } catch (err) {
        expect(err.message).to.contain('not a parsable number');
      }
    });
  });


  describe('#getGroupByName()', () => {

    it('should get an existing group', async () => {
      const allGroups = await hue.groups.getAll()
        , targetGroupName = allGroups[1].name
        , groups = await hue.groups.getGroupByName(targetGroupName)
      ;

      expect(groups).to.be.instanceof(Array);
      expect(groups).to.have.length.greaterThan(0);
      expect(groups[0]).to.have.property('name').to.equal(targetGroupName);
    });
  });


  describe('creating groups', () => {

    function deleteExistingGroups(name) {
      return hue.groups.getGroupByName(name)
        .then(matchedGroups => {
          if (matchedGroups && matchedGroups.length > 0) {
            const promises = [];

            matchedGroups.forEach(group => {
              promises.push(hue.groups.deleteGroup(group.id));
            });

            return Promise.all(promises);
          } else {
            return true;
          }
        });
    }

    beforeEach('remove group before creation', async () => {
      await deleteExistingGroups(NEW_GROUP_NAME);
    });

    afterEach('cleanup created group', async () => {
      await deleteExistingGroups(NEW_GROUP_NAME);
    });

    describe('#createRoom()', () => {

      it('should work on deprecated function', async () => {
        const name = NEW_GROUP_NAME
          , lights = []
        ;

        const result = await hue.groups.createRoom(name, lights);
        expect(result).to.have.property('name').to.equal(name);
        expect(result).to.have.property('lights').to.have.members(util.toStringArray(lights));
      });
    });

    describe('#createZone()', () => {

      it('should work on deprecated function', async () => {
        const name = NEW_GROUP_NAME
          , lights = GROUP_LIGHTS
        ;

        const result = await hue.groups.createZone(name, lights);
        expect(result).to.have.property('name').to.equal(name);
        expect(result).to.have.property('lights').to.have.members(util.toStringArray(lights));
      });
    });

    describe('#createGroup()', () => {

      describe('old deprecated parameters', () => {

        it('should create a new group', async () => {
          const name = NEW_GROUP_NAME
            , lights = GROUP_LIGHTS
          ;

          const result = await hue.groups.createGroup(name, lights);
          expect(result).to.have.property('name').to.equal(name);
          expect(result).to.have.property('lights').to.have.members(util.toStringArray(lights));
        });
      });

      describe('LightGroup', () => {

        it('should create a new group', async () => {
          const group = new LightGroup();
          group.name = NEW_GROUP_NAME;
          group.lights = GROUP_LIGHTS;

          const result = await hue.groups.createGroup(group);
          expect(result instanceof model.Group).to.be.true;
          expect(result).to.have.property('id').to.be.greaterThan(0);
          expect(result).to.have.property('name').to.equal(NEW_GROUP_NAME);
          expect(result).to.have.property('lights').to.have.members(util.toStringArray(GROUP_LIGHTS));
          expect(result).to.have.property('recycle').to.be.false;
        });
      });
    });


    describe('Room', () => {

      it('should create a new room', async () => {
        const name = NEW_GROUP_NAME
          , roomClass = 'Gym'
        ;

        const room = new Room();
        room.name = NEW_GROUP_NAME;
        room.class = roomClass;

        const result = await hue.groups.createGroup(room);
        expect(instanceChecks.isGroupInstance(result)).to.be.true;
        expect(result).to.have.property('id').to.be.greaterThan(0);
        expect(result).to.have.property('name').to.equal(name);
        expect(result).to.have.property('type').to.equal('Room');
        expect(result).to.have.property('class').to.equal(roomClass);
        expect(result).to.have.property('lights').to.be.empty;
      });


      it('should create a room when only providing a name', async () => {
        const room = new Room();
        room.name = NEW_GROUP_NAME;

        const result = await hue.groups.createGroup(room);
        expect(instanceChecks.isGroupInstance(result)).to.be.true;
        expect(result).to.have.property('id').to.be.greaterThan(0);
        expect(result).to.have.property('name').to.equal(NEW_GROUP_NAME);
        expect(result).to.have.property('type').to.equal('Room');
        expect(result).to.have.property('class').to.equal('Other');
      });
    });


    describe('Zone', () => {

      it('should create a new zone', async () => {
        const zone = new Zone();
        zone.name = NEW_GROUP_NAME;
        zone.lights = ZONE_LIGHTS;

        const result = await hue.groups.createGroup(zone);
        expect(instanceChecks.isGroupInstance(result)).to.be.true;
        expect(result).to.have.property('id').to.be.greaterThan(0);
        expect(result).to.have.property('name').to.equal(NEW_GROUP_NAME);
        expect(result).to.have.property('lights').to.have.members(util.toStringArray(ZONE_LIGHTS));
        expect(result).to.have.property('type').to.equal('Zone');
      });
    });


    describe('Entertainment', () => {

      it('should create a new entertainment group', async () => {
        const entertainment = new Entertainment();
        entertainment.name = NEW_GROUP_NAME;
        // entertainment.lights = [];

        const result = await hue.groups.createGroup(entertainment);
        expect(instanceChecks.isGroupInstance(result)).to.be.true;
        expect(result).to.have.property('id').to.be.greaterThan(0);
        expect(result).to.have.property('name').to.equal(NEW_GROUP_NAME);
        expect(result).to.have.property('lights').to.be.empty;
        expect(result).to.have.property('type').to.equal('Entertainment');
      });
    });
  });


  describe('#deleteGroup()', () => {

    const DELETE_GROUP_NAME = 'TestGroupToBeDeleted';

    let groupToBeDeleted;


    afterEach(async() => {
      if (groupToBeDeleted) {
        const groups = await hue.groups.getGroupByName(DELETE_GROUP_NAME);

        let promises;
        if (groups && groups.length > 0) {
          promises = groups.map(group => hue.groups.deleteGroup(group));
        }

        if (promises) {
          await Promise.all(promises);
        }
      }
    });


    describe('LightGroup', () => {

      beforeEach('create LightGroup', async () => {
        const group = new LightGroup();
        group.name = DELETE_GROUP_NAME;
        group.lights = GROUP_LIGHTS;

        groupToBeDeleted = await hue.groups.createGroup(group);
      });


      it('should delete using a group object', async () => {
        const result = await hue.groups.deleteGroup(groupToBeDeleted);
        expect(result).to.be.true;
      });

      it('should delete using a group id', async () => {
        const result = await hue.groups.deleteGroup(groupToBeDeleted.id);
        expect(result).to.be.true;
      });
    });


    describe('Zone', () => {

      beforeEach('create Zone', async () => {
        const group = new Zone();
        group.name = DELETE_GROUP_NAME;
        group.lights = ZONE_LIGHTS;

        groupToBeDeleted = await hue.groups.createGroup(group);
      });


      it('should delete using a group object', async () => {
        const result = await hue.groups.deleteGroup(groupToBeDeleted);
        expect(result).to.be.true;
      });

      it('should delete using a group id', async () => {
        const result = await hue.groups.deleteGroup(groupToBeDeleted.id);
        expect(result).to.be.true;
      });
    });


    describe('Room', () => {

      beforeEach('create Room', async () => {
        const group = new Room();
        group.name = DELETE_GROUP_NAME;

        groupToBeDeleted = await hue.groups.createGroup(group);
      });


      it('should delete using a group object', async () => {
        const result = await hue.groups.deleteGroup(groupToBeDeleted);
        expect(result).to.be.true;
      });

      it('should delete using a group id', async () => {
        const result = await hue.groups.deleteGroup(groupToBeDeleted.id);
        expect(result).to.be.true;
      });

    });

    describe('Entertainment', () => {

      beforeEach('create Entertainment Group', async () => {
        const group = new Entertainment();
        group.name = DELETE_GROUP_NAME;

        groupToBeDeleted = await hue.groups.createGroup(group);
      });


      it('should delete using a group object', async () => {
        const result = await hue.groups.deleteGroup(groupToBeDeleted);
        expect(result).to.be.true;
      });

      it('should delete using a group id', async () => {
        const result = await hue.groups.deleteGroup(groupToBeDeleted.id);
        expect(result).to.be.true;
      });
    });
  });


  describe('#updateAttributes()', () => {

    let group = null;

    afterEach('delete updated group', async () => {
      if (group) {
        await hue.groups.deleteGroup(group);
      }
    });


    describe('LightGroup', () => {

      beforeEach('createGroup group for update', async () => {
        const newGroup = new LightGroup();
        newGroup.name = 'LightGroup Updates';
        newGroup.lights = [2];

        group = await hue.groups.createGroup(newGroup);
      });


      it('should update the name', async () => {
        const newName = `renamed-new ${Date.now()}`;
        group.name = newName;

        const result = await hue.groups.updateGroupAttributes(group)
          , updatedGroup = await hue.groups.getGroup(group)
        ;

        expect(result).to.be.true;
        expect(updatedGroup).to.have.property('id').to.equal(group.id);
        expect(updatedGroup).to.have.property('name').to.equal(newName);
        expect(updatedGroup).to.have.property('lights').to.have.members(group.lights);
      });

      it('should update the lights', async () => {
        const newLights = [2, 3, 4];
        group.lights = newLights;

        const result = await hue.groups.updateGroupAttributes(group)
          , updatedGroup = await hue.groups.getGroup(group)
        ;

        expect(result).to.be.true;
        expect(updatedGroup).to.have.property('id').to.equal(group.id);
        expect(updatedGroup).to.have.property('name').to.equal(group.name);
        expect(updatedGroup).to.have.property('lights').to.have.members(util.toStringArray(newLights));
      });

      it('should update the name and lights', async () => {
        const newLights = [4, 5]
          , newName = `renamed-${Date.now()}`
          ;
        group.name = newName;
        group.lights = newLights;

        const result = await hue.groups.updateGroupAttributes(group)
          , updatedGroup = await hue.groups.getGroup(group)
        ;

        expect(result).to.be.true;
        expect(updatedGroup).to.have.property('id').to.equal(group.id);
        expect(updatedGroup).to.have.property('name').to.equal(newName);
        expect(updatedGroup).to.have.property('lights').to.have.members(util.toStringArray(newLights));
      });
    });


    describe('Room', () => {

      beforeEach('create room for update', async () => {
        const newGroup = new Room();
        newGroup.name = 'Custom Room';
        newGroup.class = 'Gym';

        group = await hue.groups.createGroup(newGroup);
      });


      it('should update the name', async () => {
        const name = 'Custom Room Updated';

        group.name = name;

        const result = await hue.groups.updateGroupAttributes(group)
          , updatedGroup = await hue.groups.getGroup(group)
        ;

        expect(result).to.be.true;
        expect(updatedGroup).to.have.property('id').to.equal(group.id);
        expect(updatedGroup).to.have.property('name').to.equal(name);
      });

      // lights can only be assigned to a single room and all mine are assigned
      it.skip('should update the lights', async () => {
        const lights = [4];

        group.lights = lights;

        const result = await hue.groups.updateAttributes(group)
          , updatedGroup = await hue.groups.get(group)
        ;

        expect(result).to.be.true;
        expect(updatedGroup).to.have.property('id').to.equal(group.id);
        expect(updatedGroup).to.have.property('lights').to.equal(util.toStringArray(lights));
      });

      it('should change the class', async () => {
        group.class = 'Other';
        const result = await hue.groups.updateGroupAttributes(group)
          , updatedGroup = await hue.groups.getGroup(group)
        ;

        expect(result).to.be.true;
        expect(updatedGroup).to.have.property('id').to.equal(group.id);
        expect(updatedGroup).to.have.property('class').to.equal('Other');
      });
    });


    describe('Zone', () => {

      beforeEach('create zone for update', async () => {
        const newGroup = new Zone();
        newGroup.name = 'Custom Zone';
        newGroup.class = 'Lounge';

        group = await hue.groups.createGroup(newGroup);
      });


      it('should update the name', async () => {
        const name = 'Custom Zone Updated';

        group.name = name;

        const result = await hue.groups.updateGroupAttributes(group)
          , updatedGroup = await hue.groups.getGroup(group)
        ;

        expect(result).to.be.true;
        expect(updatedGroup).to.have.property('id').to.equal(group.id);
        expect(updatedGroup).to.have.property('name').to.equal(name);
      });

      it('should update the lights', async () => {
        const lights = [4];

        group.lights = lights;

        const result = await hue.groups.updateGroupAttributes(group)
          , updatedGroup = await hue.groups.getGroup(group)
        ;

        expect(result).to.be.true;
        expect(updatedGroup).to.have.property('id').to.equal(group.id);
        expect(updatedGroup).to.have.property('lights').to.have.members(util.toStringArray(lights));
      });

      it('should change the class', async () => {
        group.class = 'Nursery';
        const result = await hue.groups.updateGroupAttributes(group)
          , updatedGroup = await hue.groups.getGroup(group)
        ;

        expect(result).to.be.true;
        expect(updatedGroup).to.have.property('id').to.equal(group.id);
        expect(updatedGroup).to.have.property('class').to.equal('Nursery');
      });
    });


    describe('Entertainment', () => {

      beforeEach('create entertainment for update', async () => {
        const newGroup = new Entertainment();
        newGroup.name = 'Custom Entertainment';

        group = await hue.groups.createGroup(newGroup);
      });


      it('should update the name', async () => {
        const name = 'Custom Name';

        group.name = name;

        const result = await hue.groups.updateGroupAttributes(group)
          , updatedGroup = await hue.groups.getGroup(group)
        ;

        expect(result).to.be.true;
        expect(updatedGroup).to.have.property('id').to.equal(group.id);
        expect(updatedGroup).to.have.property('name').to.equal(name);
      });

      it('should update the lights', async () => {
        const lights = [testValues.streamingLightId];

        group.lights = lights;

        const result = await hue.groups.updateGroupAttributes(group)
          , updatedGroup = await hue.groups.getGroup(group)
        ;

        expect(result).to.be.true;
        expect(updatedGroup).to.have.property('id').to.equal(group.id);
        expect(updatedGroup).to.have.property('lights').to.have.members(util.toStringArray(lights));
      });

      it('should change the class', async () => {
        group.class = 'Other';
        const result = await hue.groups.updateGroupAttributes(group)
          , updatedGroup = await hue.groups.getGroup(group)
        ;

        expect(result).to.be.true;
        expect(updatedGroup).to.have.property('id').to.equal(group.id);
        expect(updatedGroup).to.have.property('class').to.equal('Other');
      });
    });
  });


  describe('#setGroupState()', () => {

    let group;

    beforeEach('create LightGroup for setState', async () => {
      const groupToCreate = new LightGroup();
      groupToCreate.name = 'setGroupState Tests';
      groupToCreate.lights = testValues.streamingLightId;

      group = await hue.groups.createGroup(groupToCreate);
    });

    afterEach('delete test group for setState', async () => {
      if (group) {
        await hue.groups.deleteGroup(group);
      }
    });

    it('should set on state to true', async () => {
      const lightState = {on: true}
        , result = await hue.groups.setGroupState(group, lightState)
        , groupStatus = await hue.groups.getGroup(group)
      ;

      expect(result).to.be.true;
      expect(groupStatus).to.have.property('action');
      expect(groupStatus.action).to.have.property('on').to.be.true;
    });

    it('should set on state to false using GroupState', async () => {
      const lightState = new model.lightStates.GroupLightState().off()
        , result = await hue.groups.setGroupState(group, lightState)
        , groupStatus = await hue.groups.getGroup(group)
      ;

      expect(result).to.be.true;
      expect(groupStatus).to.have.property('action');
      expect(groupStatus.action).to.have.property('on').to.be.false;
    });

    //TODO could expand tests to rooms, zone and entertainment, but if it works for one should work for all
  });

});