VulpesOS/gaia/apps/system/test/unit/wifi_test.js

/* global ScreenManager, Service, SettingsListener,
          Wifi, WifiIcon, WifiWakeLockManager,
          MockFtuLauncher, MocksHelper, MockLazyLoader, MockLock, MockMozPower,
          MockNavigatorSettings, MockSettingsListener, MockWifiManager */

'use strict';

require('/test/unit/mock_wifi_manager.js');
require('/shared/test/unit/mocks/mock_navigator_moz_power.js');
require('/shared/test/unit/mocks/mock_navigator_moz_settings.js');
require('/shared/test/unit/mocks/mock_settings_listener.js');
require('/shared/test/unit/mocks/mock_lazy_loader.js');
requireApp('system/test/unit/mock_ftu_launcher.js');
requireApp('system/js/service.js');
requireApp('system/js/base_ui.js');
requireApp('system/js/base_icon.js');
requireApp('system/js/wifi_icon.js');
require('/js/wake_lock_manager.js');

var MockScreenManager = {
  name: 'ScreenManager',
  screenEnabled: true
};

var MockMozSetMessageHandler_listeners = {};
function MockMozSetMessageHandler(event, listener) {
  MockMozSetMessageHandler_listeners[event] = listener;
}

var MockMozAlarms = {
  _time: null,
  _timezone: null,
  _func: null,
  _id: null,
  _mCallbacks: {},

  add: function add(time, timezone, func) {
    this._timezone = timezone;
    this._func = func;
    return this._mCallbacks;
  },
  remove: function remove(id) {
    this._id = id;
  }
};

var MockDevice = {
  name: null,
  isLocked: false,
  unlock: function unlock() {
    this.isLocked = false;
  },
  lock: function lock() {
    this.isLocked = true;
  }
};

function MockRequestWakeLock(device) {
  MockDevice.name = device;
  return MockDevice;
}

var MockEventListener = {};
function MockAddEventListener(event, listener) {
  MockEventListener[event] = listener;
}

var mocksForWifi = new MocksHelper([
  'LazyLoader'
]).init();

suite('WiFi > ', function() {
  var stubRequestWakeLock;
  var stubAddEventListener;
  var stubWifiWakeLockManager;
  mocksForWifi.attachTestHelpers();

  var fakeClock;

  var realSettingsListener;
  var realScreenManager;
  var realMozSetMessageHandler;
  var realBattery;
  var realMozPower;
  var realMozSettings;
  var realWifiManager;

  var firstRequire = true;

  setup(function(done) {
    MockLazyLoader.mLoadRightAway = true;
    MockFtuLauncher.mReadyRightAway = true;
    this.sinon.spy(MockLazyLoader, 'load');
    stubRequestWakeLock = this.sinon.stub(navigator,
      'requestWakeLock', MockRequestWakeLock);

    stubWifiWakeLockManager =
      this.sinon.stub(WifiWakeLockManager.prototype);
    stubWifiWakeLockManager.isHeld = false;
    this.sinon.stub(window, 'WifiWakeLockManager')
      .returns(stubWifiWakeLockManager);

    fakeClock = this.sinon.useFakeTimers();

    realMozSettings = navigator.mozSettings;
    navigator.mozSettings = MockNavigatorSettings;
    realScreenManager = window.ScreenManager;
    window.ScreenManager = MockScreenManager;
    realSettingsListener = window.SettingsListener;
    window.SettingsListener = MockSettingsListener;
    realMozSetMessageHandler = navigator.mozSetMessageHandler;
    navigator.mozSetMessageHandler = MockMozSetMessageHandler;
    realWifiManager = navigator.mozWifiManager;
    navigator.mozWifiManager = MockWifiManager;

    realBattery = navigator.battery;
    Object.defineProperty(navigator, 'battery', {
      writable: true
    });
    navigator.battery = realBattery;

    realMozPower = navigator.mozPower;
    Object.defineProperty(navigator, 'mozPower', {
      writable: true
    });
    navigator.mozPower = MockMozPower;

    // Ensure |navigator| has property |mozAlarm| to create sinon stubs.
    if (!navigator.hasOwnProperty('mozAlarms')) {
      Object.defineProperty(navigator, 'mozAlarms', {
        writable: true
      });
    }

    Service.registerState('screenEnabled', ScreenManager);

    require('/js/wifi.js', function() {
      // Wifi.init() at the end of the wifi.js only executed once when
      // require() includes the script for real.
      if (firstRequire) {
        Wifi.start();
      } else {
        firstRequire = false;
      }

      done();
    });
  });

  teardown(function() {
    stubRequestWakeLock.restore();
    fakeClock.restore();

    navigator.mozSettings = realMozSettings;
    window.SettingsListener = realSettingsListener;
    window.ScreenManager = realScreenManager;
    navigator.mozSetMessageHandler = realMozSetMessageHandler;
    navigator.mozPower = realMozPower;
    navigator.mozWifiManager = realWifiManager;
    navigator.battery = realBattery;
  });

  test('Should lazy load icon', function(done) {
    assert.isFalse(MockLazyLoader.load.calledWith(['js/wifi_icon.js']));
    Service.register('stepReady', MockFtuLauncher);
    Service.request('stepReady', 'test').then(function() {
      assert.isTrue(MockLazyLoader.load.calledWith(['js/wifi_icon.js']));
      done();
    });
  });

  suite('Init', function() {
    setup(function() {
      Wifi.icon = new WifiIcon(Wifi);
      this.sinon.stub(Wifi.icon, 'update');
    });
    teardown(function() {
      Wifi.icon = null;
    });
    test('Test Wifi.handleEvent is bind', function() {
      var isMaybeToggleWifiCalled = false;
      var stubWifiMaybeToggleWifi =
        this.sinon.stub(Wifi, 'maybeToggleWifi', function(evt) {
          isMaybeToggleWifiCalled = true;
        });

      var evt = document.createEvent('CustomEvent');
      evt.initCustomEvent('screenchange',
        /* canBubble */ true, /* cancelable */ false, null);
      window.dispatchEvent(evt);
      assert.equal(isMaybeToggleWifiCalled, true);

      isMaybeToggleWifiCalled = false;

      evt = document.createEvent('CustomEvent');
      evt.initCustomEvent('chargingchange',
        /* canBubble */ true, /* cancelable */ false, null);
      window.navigator.battery.dispatchEvent(evt);
      assert.equal(isMaybeToggleWifiCalled, true);

      stubWifiMaybeToggleWifi.restore();
    });

    test('Test wifiManager event is dispatched', function() {
      var localEvent;
      var stubDispatchEvent =
        this.sinon.stub(window, 'dispatchEvent', function(evt) {
          localEvent = evt;
        });

      navigator.mozWifiManager.onenabled();
      assert.equal(localEvent.type, 'wifi-enabled');
      assert.isTrue(Wifi.icon.update.called);
      navigator.mozWifiManager.ondisabled();
      assert.equal(localEvent.type, 'wifi-disabled');
      assert.isTrue(Wifi.icon.update.calledTwice);
      navigator.mozWifiManager.onstatuschange();
      assert.equal(localEvent.type, 'wifi-statuschange');
      assert.isTrue(Wifi.icon.update.calledThrice);

      stubDispatchEvent.restore();
    });

    test('Test SettingsListener callback wifi.screen_off_timeout', function() {
      SettingsListener.mCallbacks['wifi.screen_off_timeout'](2000);
      assert.equal(Wifi.screenOffTimeout, 2000);
    });

    test('Test SettingsListener callback wifi.sleepMode is set to true',
      function() {
        Wifi.wifiSleepMode = false;
        SettingsListener.mCallbacks['wifi.sleepMode'](true);
        assert.equal(Wifi.wifiSleepMode, true);
    });

    test('Test SettingsListener callback wifi.sleepMode is set to false',
      function() {
        Wifi.wifiSleepMode = true;
        SettingsListener.mCallbacks['wifi.sleepMode'](false);
        assert.equal(Wifi.wifiSleepMode, false);
    });

    test('Test SettingsListener callback wifi.enabled is set to true',
      function() {
        Wifi.wifiEnabled = false;
        SettingsListener.mCallbacks['wifi.enabled'](true);
        assert.equal(Wifi.wifiEnabled, true);
        assert.isTrue(Wifi.icon.update.called);
    });

    test('Test SettingsListener callback wifi.enabled is set to false',
      function() {
        Wifi.wifiEnabled = true;
        SettingsListener.mCallbacks['wifi.enabled'](false);
        assert.equal(Wifi.wifiEnabled, false);
        assert.isTrue(Wifi.icon.update.called);
    });

    test('Test WifiWakeLockManager is started', function() {
      assert.isTrue(stubWifiWakeLockManager.start.calledOnce);
    });
  });

  suite('maybeToggleWifi', function() {
    test('Test turn wifi back on', function() {
      SettingsListener.mCallbacks['wifi.screen_off_timeout'](100);
      Wifi.wifiDisabledByWakelock = true;

      MockLock.clear();

      Wifi.maybeToggleWifi();

      assert.equal(Wifi.wifiDisabledByWakelock, false);
      assert.equal(MockLock.locks[0]['wifi.enabled'], true);
      assert.equal(MockLock.locks[1]['wifi.disabled_by_wakelock'], false);
    });

    test('Test remove should be called when _alarmId exists', function() {
      SettingsListener.mCallbacks['wifi.screen_off_timeout'](100);
      Wifi.wifiDisabledByWakelock = true;
      Wifi._alarmId = 'test-id';

      var stubMozAlarms = this.sinon.stub(navigator,
        'mozAlarms', MockMozAlarms);

      Wifi.maybeToggleWifi();

      assert.equal(MockMozAlarms._id, 'test-id');
      assert.equal(Wifi._alarmId, null);

      stubMozAlarms.restore();
    });

    test('Test getNetworks should be called', function() {
      SettingsListener.mCallbacks['wifi.screen_off_timeout'](100);
      Wifi.wifiDisabledByWakelock = true;
      Wifi.wifiEnabled = true;

      var isGetNetworksCalled = false;
      var stubMozWifiManager = this.sinon.stub(navigator,
        'mozWifiManager', {
          connection: {
            status: 'disconnected'
          },
          getNetworks: function getNetworks() {
            isGetNetworksCalled = true;
          }
        });

      Wifi.maybeToggleWifi();

      assert.equal(isGetNetworksCalled, true);
      stubMozWifiManager.restore();
    });

    test('Test sleep should be called when mozAlarms doesnt exist', function() {
      SettingsListener.mCallbacks['wifi.screen_off_timeout'](100);

      ScreenManager.screenEnabled = false;
      Wifi.wifiDisabledByWakelock = true;
      stubWifiWakeLockManager.isHeld = false;
      Wifi.wifiEnabled = true;

      var isSleepCalled = false;
      var stubSleep = this.sinon.stub(Wifi, 'sleep', function() {
        isSleepCalled = true;
      });

      var stubMozAlarms = this.sinon.stub(navigator,
        'mozAlarms', null);
      navigator.battery = { charging: false };

      Wifi.maybeToggleWifi();

      assert.equal(isSleepCalled, true);

      navigator.battery = realBattery;
      stubMozAlarms.restore();
      stubSleep.restore();
    });

    test('Test starting with a timer if turn on wifi sleep mode', function() {
      SettingsListener.mCallbacks['wifi.screen_off_timeout'](100);
      SettingsListener.mCallbacks['wifi.sleepMode'](true);

      ScreenManager.screenEnabled = false;
      Wifi.wifiDisabledByWakelock = true;
      stubWifiWakeLockManager.isHeld = false;
      Wifi.wifiEnabled = true;

      var stubMozAlarms = this.sinon.stub(navigator,
        'mozAlarms', MockMozAlarms);
      var isSetSystemMessageHandlerCalled = false;
      var stubSetSystemMessageHandler =
        this.sinon.stub(Wifi, 'setSystemMessageHandler', function() {
          isSetSystemMessageHandlerCalled = true;
        });

      navigator.battery = { charging: false };

      Wifi.maybeToggleWifi();
      if (Wifi.wifiSleepMode === true) {
        assert.equal(isSetSystemMessageHandlerCalled, true);
        assert.equal(MockMozAlarms._timezone, 'ignoreTimezone');
        assert.equal(MockMozAlarms._func, 'wifi-off');
      }

      navigator.battery = realBattery;
      stubMozAlarms.restore();
      stubSetSystemMessageHandler.restore();
    });

    test('Test starting with a timer if turn off wifi sleep mode', function() {
      SettingsListener.mCallbacks['wifi.screen_off_timeout'](100);
      SettingsListener.mCallbacks['wifi.sleepMode'](false);

      ScreenManager.screenEnabled = false;
      Wifi.wifiDisabledByWakelock = true;
      stubWifiWakeLockManager.isHeld = false;
      Wifi.wifiEnabled = true;
      Wifi.wifiSleepMode = false;
      Wifi._hasAlarm = false;
      Wifi._alarmId = null;

      assert.equal(Wifi.wifiSleepMode, false);
      var stubMozAlarms = this.sinon.stub(navigator,
        'mozAlarms', MockMozAlarms);
      var isSetSystemMessageHandlerCalled = false;
      var stubSetSystemMessageHandler =
        this.sinon.stub(Wifi, 'setSystemMessageHandler', function() {
          isSetSystemMessageHandlerCalled = true;
      });

      navigator.battery = { charging: false };

      Wifi.maybeToggleWifi();
      if (Wifi.wifiSleepMode === true) {
        assert.equal(isSetSystemMessageHandlerCalled, true);
        assert.equal(MockMozAlarms._timezone, 'ignoreTimezone');
        assert.equal(MockMozAlarms._func, 'wifi-off');
      }

      navigator.battery = realBattery;
      stubMozAlarms.restore();
      stubSetSystemMessageHandler.restore();
    });

    test('Test alarm should not be set twice.', function() {
      SettingsListener.mCallbacks['wifi.screen_off_timeout'](100);
      SettingsListener.mCallbacks['wifi.sleepMode'](true);

      ScreenManager.screenEnabled = false;
      Wifi.wifiDisabledByWakelock = true;
      stubWifiWakeLockManager.isHeld = false;
      Wifi.wifiEnabled = true;
      Wifi._hasAlarm = false;
      Wifi._alarmId = null;

      var stubMozAlarms = this.sinon.stub(navigator,
        'mozAlarms', MockMozAlarms);
      this.sinon.spy(MockMozAlarms, 'add');

      var isSetSystemMessageHandlerCalled = false;
      var stubSetSystemMessageHandler =
        this.sinon.stub(Wifi, 'setSystemMessageHandler', function() {
          isSetSystemMessageHandlerCalled = true;
        });

      navigator.battery = { charging: false };

      Wifi.maybeToggleWifi();
      assert.isTrue(MockMozAlarms.add.calledOnce);

      Wifi.maybeToggleWifi();
      assert.isFalse(MockMozAlarms.add.calledTwice);

      navigator.battery = realBattery;
      MockMozAlarms.add.restore();
      stubMozAlarms.restore();
      stubSetSystemMessageHandler.restore();
    });
  });

  suite('sleep', function() {
    setup(function() {
      Wifi.wifiDisabledByWakelock = false;

      MockLock.clear();
      MockDevice.lock();

      stubAddEventListener = this.sinon.stub(window,
        'addEventListener', MockAddEventListener);

      Wifi.sleep();
    });

    teardown(function() {
      stubAddEventListener.restore();
    });

    test('Test wakeLockForWifi should be unlocked', function() {
      fakeClock.tick(30010);

      assert.equal(MockDevice.name, 'cpu');
      assert.equal(MockDevice.isLocked, false);
    });

    test('Test event wifi-disabled listener should be bind', function() {
      MockDevice.lock();
      MockEventListener['wifi-disabled']();

      assert.equal(MockDevice.isLocked, false);
    });

    test('Test locks should be set', function() {
      assert.equal(MockLock.locks[0]['wifi.enabled'], false);
      assert.equal(MockLock.locks[1]['wifi.disabled_by_wakelock'], true);
    });
  });

  suite('setSystemMessageHandler', function() {
    setup(function() {
      Wifi._systemMessageHandlerRegistered = false;
      Wifi.setSystemMessageHandler();
    });

    test('Test _systemMessageHandlerRegistered should be changed', function() {
      assert.equal(Wifi._systemMessageHandlerRegistered, true);
    });
  });

  suite('mozSetMessageHandler callback', function() {
    test('should call sleep', function() {
      ScreenManager.screenEnabled = false;
      Wifi.wifiDisabledByWakelock = false;
      stubWifiWakeLockManager.isHeld = false;
      Wifi.wifiEnabled = true;
      Wifi.wifiSleepMode = true;
      Wifi._hasAlarm = true;
      Wifi._alarmId = 1;
      navigator.battery = { charging: false };

      this.sinon.stub(Wifi, 'sleep');

      MockMozSetMessageHandler_listeners.alarm({ data: 'wifi-off' });

      assert.isTrue(Wifi.sleep.calledOnce);

      navigator.battery = realBattery;
    });

    test('should not call sleep if screen is on', function() {
      ScreenManager.screenEnabled = true;
      Wifi.wifiDisabledByWakelock = false;
      stubWifiWakeLockManager.isHeld = false;
      Wifi.wifiEnabled = true;
      Wifi.wifiSleepMode = true;
      Wifi._hasAlarm = true;
      Wifi._alarmId = 1;
      navigator.battery = { charging: false };

      this.sinon.stub(Wifi, 'sleep');

      MockMozSetMessageHandler_listeners.alarm({ data: 'wifi-off' });

      assert.isFalse(Wifi.sleep.calledOnce);
    });
  });

  suite('wifiWakeLock', function() {
    test('Test wifi should stay enabled', function() {
      // Test flow : Wifi Enabled, Hold Wifi Lock
      //             -> Screen off
      //             ->maybeToggleWifi()
      SettingsListener.mCallbacks['wifi.screen_off_timeout'](100);

      // Screen off while wifi wake lock held.
      MockScreenManager.screenEnabled = false;
      Wifi.wifiDisabledByWakelock = true;
      Wifi.wifiEnabled = true;
      navigator.battery = { charging: false };

      Wifi.maybeToggleWifi();

      // Expect wifi stay enabled.
      fakeClock.tick(1000);
      assert.equal(Wifi.wifiEnabled, true);
      assert.equal(Wifi.wifiDisabledByWakelock, true);
    });

    test('Test wifi should be turned on', function() {
      // Scenario : Screen off, Wifi Disabled by screen off
      //            -> Hold Wifi Wake Lock
      //            -> maybeToggleWifi()
      SettingsListener.mCallbacks['wifi.screen_off_timeout'](100);

      // wifi wake lock is held after wifi disabled by screen off.
      MockScreenManager.screenEnabled = false;
      Wifi.wifiDisabledByWakelock = true;
      stubWifiWakeLockManager.isHeld = true;
      Wifi.wifiEnabled = false;
      navigator.battery = { charging: false };

      MockLock.clear();
      stubWifiWakeLockManager.onwakelockchange(true);

      // Expect wifi becomes enabled.
      assert.equal(MockLock.locks[0]['wifi.enabled'], true);
      assert.equal(MockLock.locks[1]['wifi.disabled_by_wakelock'], false);

      // Trigger event to notify Wifi is enabled.
      var evt = document.createEvent('CustomEvent');
      evt.initCustomEvent('wifi-enabled',
        /* canBubble */ true, /* cancelable */ false, null);
      window.dispatchEvent(evt);

      assert.equal(Wifi.wifiDisabledByWakelock, false);

      Wifi.wifiEnabled = true;
      stubWifiWakeLockManager.isHeld = true;
      Wifi.wifiDisabledByWakelock = false;
    });

    test('Test wifi should stay disabled', function() {
      // Scenario : Screen off, Wifi Disabled by user
      //            -> Hold Wifi Wake Lock
      //            -> maybeToggleWifi()
      SettingsListener.mCallbacks['wifi.screen_off_timeout'](100);

      // wifi wake lock is held after wifi disabled by screen off.
      MockScreenManager.screenEnabled = false;
      Wifi.wifiDisabledByWakelock = false;
      stubWifiWakeLockManager.isHeld = true;
      Wifi.wifiEnabled = false;
      navigator.battery = { charging: false };

      stubWifiWakeLockManager.onwakelockchange(true);

      // Expect wifi stay enabled and enter power saving mode.
      assert.equal(Wifi.wifiEnabled, false);
      assert.equal(Wifi.wifiDisabledByWakelock, false);

      Wifi.wifiEnabled = false;
      stubWifiWakeLockManager.isHeld = false;
      Wifi.wifiDisabledByWakelock = false;
    });

    test('Test wifi should be turned on, then turn off.',
      function() {
      // Scenario : Screen off, Wifi Disabled by screen off
      //            -> Hold Wifi Wake Lock
      //            -> maybeToggleWifi()
      //            -> release Wifi Wake Lock
      //            -> maybeToggleWifi()
      SettingsListener.mCallbacks['wifi.screen_off_timeout'](100);

      // wifi wake lock is held after wifi disabled by screen off.
      MockScreenManager.screenEnabled = false;
      Wifi.wifiDisabledByWakelock = true;
      stubWifiWakeLockManager.isHeld = true;
      Wifi.wifiEnabled = false;
      navigator.battery = { charging: false };

      MockLock.clear();
      stubWifiWakeLockManager.onwakelockchange(false);

      // Expect wifi becomes enabled.
      assert.equal(MockLock.locks[0]['wifi.enabled'], true);
      assert.equal(MockLock.locks[1]['wifi.disabled_by_wakelock'], false);

      // Trigger event to notify Wifi is enabled.
      var evt = document.createEvent('CustomEvent');
      evt.initCustomEvent('wifi-enabled',
        /* canBubble */ true, /* cancelable */ false, null);
      window.dispatchEvent(evt);

      assert.equal(Wifi.wifiDisabledByWakelock, false);

      // Release Wifi wake lock.
      MockLock.clear();
      Wifi.wifiEnabled = true;
      stubWifiWakeLockManager.isHeld = false;
      Wifi.maybeToggleWifi();

      // Expect wifi becomes disabled.
      fakeClock.tick(110);
      assert.equal(MockLock.locks[0]['wifi.enabled'], false);
      assert.equal(MockLock.locks[1]['wifi.disabled_by_wakelock'], true);

      Wifi.wifiEnabled = false;
      Wifi.wifiWakeLocked = true;
      Wifi.wifiDisabledByWakelock = true;
    });
  });
});