py/test/pytests/model_sku.py

# Copyright 2017 The ChromiumOS Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

"""A test to confirm and set SKU information.

Description
-----------
A test to confirm SKU information, then apply SKU or model specific settings.
And there are two modes:

1. manually ask to operator to confirm SKU information.
2. automatically compare SKU information with device data - component.sku.

If device data - component.sku is set then this test will go to automatic mode
or manual mode will be executed.

This is a test to verify hardware root of trust, so there's no options to
set auto verification for this test. Instead, either it relies on the operator
to check manually or compares with device data from shopfloor which would need
to be configured in advance.

After the SKU is confirmed, the test will load a JSON configuration specified by
``config_name``. The config should be a dictionary containing what device data
(usually ``component.*``) to set for matched model and SKU. For example, to set
if the touchscreen is available for model 'coral' with default True, and only
False for product_name `Coral` SKU 3::

  {
    "model": {
      "coral": {
        "component.has_touchscreen": true
      }
    },
    "product_sku": {
      "Coral": {
        "3": {
          "component.has_touchscreen": false
        }
      }
    }
  }

Test Procedure
--------------
The test runs following commands:

- cros_config / name
- cros_config /identity sku-id
- cros_config / brand-code

And then asks OP to press ENTER/ESC to confirm if these values are correct.

Dependency
----------
- ``mosys`` utility.

Examples
--------
To ask OP to confirm sku information, add this in test list::

  {
    "pytest_name": "model_sku"
  }
"""

import logging
import os

from cros.factory.device import device_utils
from cros.factory.test import device_data
from cros.factory.test.i18n import _
from cros.factory.test import state
from cros.factory.test import test_case
from cros.factory.test import test_ui
from cros.factory.test import ui_templates
from cros.factory.test.utils import model_sku_utils
from cros.factory.utils.arg_utils import Arg

from cros.factory.external.chromeos_cli import cros_config as cros_config_module


_KEY_COMPONENT_SKU = device_data.JoinKeys(device_data.KEY_COMPONENT, 'sku')

_PLATFORM_DATA = ['model', 'sku', 'brand']


class PlatformSKUModelTest(test_case.TestCase):
  """A test to confirm and set SKU and model information."""
  related_components = tuple()


  ARGS = [
      Arg(
          'config_name', str,
          f'Name of JSON config to load for setting device data. Set this '
          f'argument to {model_sku_utils.BOXSTER} if you want to load boxster '
          f'data.', default=None),
      Arg('schema_name', str,
          'Name of JSON schema to load for setting device data.', default=None),
      Arg(
          'product_name', str,
          f'The product_name of the device. If not specified, read from '
          f'{model_sku_utils.PRODUCT_NAME_PATH} on x86 devices and '
          f'{model_sku_utils.DEVICE_TREE_COMPATIBLE_PATH} on ARM devices.',
          default=None),
  ]

  def setUp(self):
    self._dut = device_utils.CreateDUTInterface()
    self._platform = {}
    self._goofy_rpc = state.GetInstance()

  def ApplyConfig(self):
    # yapf: disable
    if self.args.config_name is None:  # type: ignore #TODO(b/338318729) Fixit! # pylint: disable=line-too-long
      # yapf: enable
      config_name = os.path.splitext(os.path.basename(__file__))[0]
    else:
      # yapf: disable
      config_name = self.args.config_name  # type: ignore #TODO(b/338318729) Fixit! # pylint: disable=line-too-long
      # yapf: enable
    model_config = model_sku_utils.GetDesignConfig(
        self._dut, default_config_dirs=os.path.dirname(__file__),
        # yapf: disable
        product_name=self.args.product_name, sku_id=self._platform['sku'],  # type: ignore #TODO(b/338318729) Fixit! # pylint: disable=line-too-long
        # yapf: enable
        # yapf: disable
        config_name=config_name, schema_name=self.args.schema_name)  # type: ignore #TODO(b/338318729) Fixit! # pylint: disable=line-too-long
    # yapf: enable
    if model_config:
      logging.info('Apply model/SKU config: %r', model_config)
      device_data.UpdateDeviceData(model_config)
      # Device data might affect which tests are skipped/waived. Reload the test
      # list to correctly identify those tests.
      self._goofy_rpc.ReloadTestList()

  def CheckByOperator(self):
    # yapf: disable
    self.ui.SetInstruction(_('Please confirm following values'))  # type: ignore #TODO(b/338318729) Fixit! # pylint: disable=line-too-long
    # yapf: enable

    table = ui_templates.Table(
        rows=len(_PLATFORM_DATA) + 1, cols=2, element_id='mosys_table')
    table.SetContent(0, 0, '<strong>Key</strong>')
    table.SetContent(0, 1, '<strong>Value</strong>')
    for i, arg in enumerate(_PLATFORM_DATA, 1):
      table.SetContent(i, 0, arg)
      table.SetContent(
          i, 1,
          self._platform[arg] if self._platform[arg] is not None else 'N/A')

    # yapf: disable
    self.ui.SetState([table.GenerateHTML(), test_ui.PASS_FAIL_KEY_LABEL])  # type: ignore #TODO(b/338318729) Fixit! # pylint: disable=line-too-long
    # yapf: enable

    # yapf: disable
    key = self.ui.WaitKeysOnce([test_ui.ENTER_KEY, test_ui.ESCAPE_KEY])  # type: ignore #TODO(b/338318729) Fixit! # pylint: disable=line-too-long
    # yapf: enable
    if key == test_ui.ESCAPE_KEY:
      self.FailTask('Failed by operator')

  def CheckByDeviceData(self):
    try:
      # yapf: disable
      value = device_data.GetDeviceData(_KEY_COMPONENT_SKU, data_type=int,  # type: ignore #TODO(b/338318729) Fixit! # pylint: disable=line-too-long
      # yapf: enable
                                        throw_if_none=True)
    except KeyError:
      return False
    if value is None:
      return False

    self.assertEqual(
        str(value), self._platform['sku'],
        f"Value [{self._platform['sku']}] from \"cros_config /identity sku-id\""
        f" does not match device data [{value}]")

    return True

  def GetPlatformData(self):
    cros_config = cros_config_module.CrosConfig(dut=self._dut)
    self._platform['model'] = cros_config.GetModelName()
    self._platform['sku'] = cros_config.GetSkuID()
    self._platform['brand'] = cros_config.GetBrandCode()

  def runTest(self):
    self.GetPlatformData()

    if not self.CheckByDeviceData():
      self.CheckByOperator()

    self.ApplyConfig()