py/test/pytests/write_protect_switch.py

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

"""Verifies that the write-protect switch is on."""

import logging
import re
from typing import Tuple
import unittest

from cros.factory.device import device_utils
from cros.factory.test import test_tags
from cros.factory.utils.arg_utils import Arg


class WriteProtectSwitchArgs:
  has_ectool: bool


class WriteProtectSwitchTest(unittest.TestCase):
  """Tests that write-protect switch is on."""
  related_components: Tuple[test_tags.TestCategory, ...] = ()
  ARGS = [
      Arg('has_ectool', bool, 'Has ectool utility or not.', default=True),
  ]

  args: WriteProtectSwitchArgs

  def setUp(self):
    self.dut = device_utils.CreateDUTInterface()

  def runTest(self):
    logging.warning(
        'If this device uses H1-controlled hardware write protection rather '
        'than write protect screw, then this pytest is not needed and is '
        'expected to fail.')
    self.assertEqual(
        1,
        int(self.dut.CheckOutput(['crossystem', 'wpsw_cur'], log=True).strip()))

    if self.args.has_ectool:
      ectool_flashprotect = self.dut.CheckOutput(['ectool', 'flashprotect'],
                                                 log=True)

      logging.info('ectool flashprotect:\n%s', ectool_flashprotect)
      # Multiline is important: we need to see wp_gpio_asserted on
      # the same line.
      self.assertTrue(
          re.search('^Flash protect flags:.+wp_gpio_asserted',
                    ectool_flashprotect, re.MULTILINE),
          'ectool flashprotect is missing wp_gpio_asserted')