py/test/pytests/wait_fixture_ready.py

# Copyright 2018 The ChromiumOS Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Waits Fixture until it's ready.

Description
-----------
This test will try to set up a connection to the given fixture, when the
connection is established, the test will pass.  Otherwise, it will keep
retrying.

Test Procedure
--------------
This is an automated test without user interaction.

Dependency
----------
Depends on how to connect to the fixture, it can be SSH or ADB or something
else.

Examples
--------
NA.
"""

from cros.factory.test.fixture import bft_fixture
from cros.factory.test import test_case
from cros.factory.utils.arg_utils import Arg
from cros.factory.utils import sync_utils


_CHECK_INTERVAL_SECS = 0.2


class WaitBFTReady(test_case.TestCase):
  related_components = tuple()
  ARGS = [
      Arg('bft_fixture', dict, bft_fixture.TEST_ARG_HELP),
  ]

  def runTest(self):
    # yapf: disable
    self.ui.SetState('Wait Fixture Ready...')  # type: ignore #TODO(b/338318729) Fixit! # pylint: disable=line-too-long
    # yapf: enable

    @sync_utils.RetryDecorator(
        interval_sec=_CHECK_INTERVAL_SECS,
        exceptions_to_catch=[bft_fixture.BFTFixtureException])
    def _CreateBFTFixture():
      # The following line will setup the connect to BFT fixture, so if it can
      # be done without exception, the fixture should be ready.
      # yapf: disable
      bft_fixture.CreateBFTFixture(**self.args.bft_fixture)  # type: ignore #TODO(b/338318729) Fixit! # pylint: disable=line-too-long
      # yapf: enable

    _CreateBFTFixture()