cordova-plugin-screen-orientation/tests/tests.js

/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 */

exports.defineAutoTests = function () {
    var isLockable = false;

    beforeAll(function () {
        // Mobile devices are expected to have a lockable orientation, while
        // desktop devices does not
        // (Chrome on desktop will return:
        //  DOMException: screen.orientation.lock() is not available on this device)
        // Using an user agent check sucks, but this is a unit test,
        // - using browser window size is unreliable cause the browser can be resized.
        // - Using max touch support is unreliable cause some laptops will have touch support
        //   but still lack support for locking the orientation.
        isLockable = /Android|iPhone|iPad|iPod/gi.test(window.navigator.userAgent);
    });

    describe('window.screen', function () {
        it('should be defined', function () {
            expect(window.screen).toBeDefined();
        });
    });

    describe('window.screen.orientation', function () {
        it('should be defined', function () {
            expect(window.screen.orientation).toBeDefined();
        });

        it('should have a `lock` function', function () {
            expect(window.screen.orientation.lock).toBeDefined();
            expect(typeof window.screen.orientation.lock).toBe('function');
        });

        it('should have an `unlock` function', function () {
            expect(window.screen.orientation.unlock).toBeDefined();
            expect(typeof window.screen.orientation.unlock).toBe('function');
        });

        it('should have a `type` property (string)', function () {
            expect(window.screen.orientation.type).toBeDefined();
            expect(typeof window.screen.orientation.type).toBe('string');
        });

        it('should have an `angle` property (number)', function () {
            expect(window.screen.orientation.angle).toBeDefined();
            expect(typeof window.screen.orientation.angle).toBe('number');
        });

        it('should have an `onchange` settable function', function () {
            // it should be null to start
            expect(window.screen.orientation.onchange).toBe(null);
            // then we set it
            var funk = function () {};
            window.screen.orientation.onchange = funk;
            // now it should exist
            expect(window.screen.orientation.onchange).toBeDefined();
            expect(window.screen.orientation.onchange).toBe(funk);
            // clear it
            window.screen.orientation.onchange = null;
            // it should be null again
            expect(window.screen.orientation.onchange).toBe(null);
        });

        it('should have an eventListener interface', function () {
            expect(window.screen.orientation.addEventListener).toBeDefined();
            expect(typeof window.screen.orientation.addEventListener).toBe('function');

            expect(window.screen.orientation.removeEventListener).toBeDefined();
            expect(typeof window.screen.orientation.removeEventListener).toBe('function');
        });
    });

    describe('OrientationType', function () {
        it('should be defined', function () {
            expect(window.OrientationType).toBeDefined();
        });

        it('should have defined types', function () {
            expect(window.OrientationType['portrait-primary']).toBeDefined();
            expect(window.OrientationType['portrait-secondary']).toBeDefined();
            expect(window.OrientationType['landscape-primary']).toBeDefined();
            expect(window.OrientationType['landscape-secondary']).toBeDefined();
        });
    });

    describe('OrientationLockType', function () {
        it('should be defined', function () {
            expect(window.OrientationLockType).toBeDefined();
        });

        it('should have defined types', function () {
            expect(window.OrientationLockType['portrait-primary']).toBeDefined();
            expect(window.OrientationLockType['portrait-secondary']).toBeDefined();
            expect(window.OrientationLockType['landscape-primary']).toBeDefined();
            expect(window.OrientationLockType['landscape-secondary']).toBeDefined();
            expect(window.OrientationLockType.portrait).toBeDefined();
            expect(window.OrientationLockType.landscape).toBeDefined();
            expect(window.OrientationLockType.any).toBeDefined();
        });
    });

    // TODO:
    // test addEventListener('change') works
    // test onchange works
    describe('window.screen.orientation', function () {
        if (isLockable) {
            it('should successfully lock and unlock screen orientation', function () {
                return window.screen.orientation.lock('portrait').then(function () {
                    expect(window.screen.orientation.type).toMatch(/^portrait-/);
                    expect(window.screen.orientation.unlock).not.toThrow();
                });
            });
        }
        // We do not test "not isLockable" states because it isn't testable.
        // The error stating it's not supported is not actually passed to the
        // promise reject function, so the error is not catchable. The error
        // is only ever printed to the JS console if nothing catches errors.
        // The promise itself is fulfilled successfully, despite the action
        // not doing what is expected.
        // I believe this might be a privacy security mechanism to avoid device
        // fingerprinting.
    });
};
exports.defineManualTests = function (contentEl, createActionButton) {
    createActionButton('Listen to orientationchange events', function () {
        window.addEventListener('orientationchange', function () {
            contentEl.innerHTML += '<p>Orientation changed! ' + screen.orientation.type + '</p>';
        });
    });
    createActionButton('Unlock orientation', function () {
        screen.orientation.unlock();
        contentEl.innerHTML += '<p>Orientation unlocked.</p>';
    });
    createActionButton('Lock to portrait', function () {
        screen.orientation.lock('portrait');
        contentEl.innerHTML += '<p>Orientation locked to portrait.</p>';
    });
    createActionButton('Lock to landscape', function () {
        screen.orientation.lock('landscape');
        contentEl.innerHTML += '<p>Orientation locked to landscape.</p>';
    });
};