server/site_tests/privetd_PrivetInfo/privetd_PrivetInfo.py

# Copyright 2014 The Chromium OS Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

from autotest_lib.client.common_lib import error
from autotest_lib.client.common_lib.cros.tendo import privetd_helper
from autotest_lib.server import test

def _assert_equal(expected, actual):
    """Compares objects.

    @param expected: the expected value.
    @param actual: the actual value.

    """
    if expected != actual:
        raise error.TestFail('Expected: %r, actual: %r' % (expected, actual))


def _assert_not_empty(dictionary, key):
    """Compares objects.

    @param expected: the expected value.
    @param actual: the actual value.

    """
    if not key in dictionary:
        raise error.TestFail('Missing key: %s' % key)

    if not dictionary[key]:
        raise error.TestFail('Key "%s" is empty' % key)


class privetd_PrivetInfo(test.test):
    """This test verifies that the privetd responds to /privet/info request and
    returns the expected JSON response object.
    """
    version = 1

    def warmup(self, host):
        config = privetd_helper.PrivetdConfig(log_verbosity=3, enable_ping=True)
        config.restart_with_config(host=host)


    def cleanup(self, host):
        privetd_helper.PrivetdConfig.naive_restart(host=host)


    def validate_api(self, apis):
        """Validates the 'api' section.

        @param apis: an array of API urls from JSON.

        """
        expected = ['/privet/info',
                    '/privet/v3/auth',
                    '/privet/v3/commandDefs',
                    '/privet/v3/commands/cancel',
                    '/privet/v3/commands/execute',
                    '/privet/v3/commands/execute',
                    '/privet/v3/commands/list',
                    '/privet/v3/commands/status',
                    '/privet/v3/pairing/cancel',
                    '/privet/v3/pairing/confirm',
                    '/privet/v3/pairing/start',
                    '/privet/v3/setup/start',
                    '/privet/v3/setup/status']
        api_diff = set(expected) - set(apis)
        if api_diff:
           raise error.TestFail('Missing API items: %s' % api_diff)


    def run_once(self, host):
        helper = privetd_helper.PrivetdHelper(host=host)
        helper.ping_server()  # Make sure the server is up and running.
        info = helper.send_privet_request(privetd_helper.URL_INFO)

        # Do some sanity checks on the returned JSON object.
        if info['version'] != '3.0':
            raise error.TestFail('Expected privet version 3.0')
        self.validate_api(info['api'])

        _assert_equal({'crypto': ['p224_spake2'],
                       'mode': ['anonymous', 'pairing'],
                       'pairing': ['pinCode']}, info['authentication'])

        _assert_not_empty(info, 'name')
        _assert_not_empty(info, 'id')

        _assert_not_empty(info, 'modelManifestId')
        _assert_equal(5, len(info['modelManifestId']))

        manifest = info['basicModelManifest']
        _assert_not_empty(manifest, 'modelName')
        _assert_not_empty(manifest, 'oemName')
        _assert_not_empty(manifest, 'uiDeviceKind')
        
        _assert_equal({'id': '', 'status': 'unconfigured'}, info['gcd'])