| # |
| # Copyright (c) 2021 Project CHIP Authors |
| # |
| # Licensed 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. |
| |
| import logging |
| import os |
| import shutil |
| import subprocess |
| import tempfile |
| import threading |
| import time |
| import typing |
| from dataclasses import dataclass, field |
| from datetime import datetime |
| from enum import Enum, auto |
| |
| TEST_NODE_ID = '0x12344321' |
| |
| |
| class App: |
| |
| def __init__(self, runner, command): |
| self.process = None |
| self.outpipe = None |
| self.runner = runner |
| self.command = command |
| self.cv_stopped = threading.Condition() |
| self.stopped = True |
| self.lastLogIndex = 0 |
| self.kvsPathSet = {'/tmp/chip_kvs'} |
| self.options = None |
| self.killed = False |
| |
| def start(self, options=None): |
| if not self.process: |
| # Cache command line options to be used for reboots |
| if options: |
| self.options = options |
| # Make sure to assign self.process before we do any operations that |
| # might fail, so attempts to kill us on failure actually work. |
| self.process, self.outpipe, errpipe = self.__startServer( |
| self.runner, self.command) |
| self.waitForAnyAdvertisement() |
| self.__updateSetUpCode() |
| with self.cv_stopped: |
| self.stopped = False |
| self.cv_stopped.notify() |
| return True |
| return False |
| |
| def stop(self): |
| if self.process: |
| with self.cv_stopped: |
| self.stopped = True |
| self.cv_stopped.notify() |
| self.__terminateProcess() |
| return True |
| return False |
| |
| def factoryReset(self): |
| wasRunning = (not self.killed) and self.stop() |
| |
| for kvs in self.kvsPathSet: |
| if os.path.exists(kvs): |
| os.unlink(kvs) |
| |
| if wasRunning: |
| return self.start() |
| |
| return True |
| |
| def waitForAnyAdvertisement(self): |
| self.__waitFor("mDNS service published:", self.process, self.outpipe) |
| |
| def waitForMessage(self, message, timeoutInSeconds=10): |
| self.__waitFor(message, self.process, self.outpipe, timeoutInSeconds) |
| return True |
| |
| def kill(self): |
| self.__terminateProcess() |
| self.killed = True |
| |
| def wait(self, timeout=None): |
| while True: |
| # If the App was never started, AND was killed, exit immediately |
| if self.killed: |
| return 0 |
| # If the App was never started, wait cannot be called on the process |
| if self.process is None: |
| time.sleep(0.1) |
| continue |
| code = self.process.wait(timeout) |
| with self.cv_stopped: |
| if not self.stopped: |
| return code |
| # When the server is manually stopped, process waiting is |
| # overridden so the other processes that depends on the |
| # accessory beeing alive does not stop. |
| while self.stopped: |
| self.cv_stopped.wait() |
| |
| def __startServer(self, runner, command): |
| app_cmd = command + ['--interface-id', str(-1)] |
| |
| if not self.options: |
| logging.debug('Executing application under test with default args') |
| else: |
| logging.debug('Executing application under test with the following args:') |
| for key, value in self.options.items(): |
| logging.debug(' %s: %s' % (key, value)) |
| app_cmd = app_cmd + [key, value] |
| if key == '--KVS': |
| self.kvsPathSet.add(value) |
| return runner.RunSubprocess(app_cmd, name='APP ', wait=False) |
| |
| def __waitFor(self, waitForString, server_process, outpipe, timeoutInSeconds=10): |
| logging.debug('Waiting for %s' % waitForString) |
| |
| start_time = time.monotonic() |
| ready, self.lastLogIndex = outpipe.CapturedLogContains( |
| waitForString, self.lastLogIndex) |
| if ready: |
| self.lastLogIndex += 1 |
| |
| while not ready: |
| if server_process.poll() is not None: |
| died_str = ('Server died while waiting for %s, returncode %d' % |
| (waitForString, server_process.returncode)) |
| logging.error(died_str) |
| raise Exception(died_str) |
| if time.monotonic() - start_time > timeoutInSeconds: |
| raise Exception('Timeout while waiting for %s' % waitForString) |
| time.sleep(0.1) |
| ready, self.lastLogIndex = outpipe.CapturedLogContains( |
| waitForString, self.lastLogIndex) |
| if ready: |
| self.lastLogIndex += 1 |
| |
| logging.debug('Success waiting for: %s' % waitForString) |
| |
| def __updateSetUpCode(self): |
| qrLine = self.outpipe.FindLastMatchingLine('.*SetupQRCode: *\\[(.*)]') |
| if not qrLine: |
| raise Exception("Unable to find QR code") |
| self.setupCode = qrLine.group(1) |
| |
| def __terminateProcess(self): |
| if self.process: |
| self.process.terminate() # sends SIGTERM |
| try: |
| self.process.wait(10) |
| except subprocess.TimeoutExpired: |
| logging.debug('Subprocess did not terminate on SIGTERM, killing it now') |
| self.process.kill() |
| self.process.wait(10) |
| self.process = None |
| self.outpipe = None |
| |
| |
| class TestTarget(Enum): |
| ALL_CLUSTERS = auto() |
| TV = auto() |
| LOCK = auto() |
| OTA = auto() |
| BRIDGE = auto() |
| LIT_ICD = auto() |
| MWO = auto() |
| |
| |
| @dataclass |
| class ApplicationPaths: |
| chip_tool: typing.List[str] |
| all_clusters_app: typing.List[str] |
| lock_app: typing.List[str] |
| ota_provider_app: typing.List[str] |
| ota_requestor_app: typing.List[str] |
| tv_app: typing.List[str] |
| bridge_app: typing.List[str] |
| lit_icd_app: typing.List[str] |
| microwave_oven_app: typing.List[str] |
| chip_repl_yaml_tester_cmd: typing.List[str] |
| chip_tool_with_python_cmd: typing.List[str] |
| |
| def items(self): |
| return [self.chip_tool, self.all_clusters_app, self.lock_app, self.ota_provider_app, self.ota_requestor_app, |
| self.tv_app, self.bridge_app, self.lit_icd_app, self.microwave_oven_app, self.chip_repl_yaml_tester_cmd, self.chip_tool_with_python_cmd] |
| |
| |
| @dataclass |
| class CaptureLine: |
| when: datetime |
| source: str |
| line: str |
| |
| |
| class ExecutionCapture: |
| """ |
| Keeps track of output lines in a process, to help debug failures. |
| """ |
| |
| def __init__(self): |
| self.lock = threading.Lock() |
| self.captures = [] |
| |
| def Log(self, source, line): |
| with self.lock: |
| self.captures.append(CaptureLine( |
| when=datetime.now(), |
| source=source, |
| line=line.strip('\n') |
| )) |
| |
| def LogContents(self): |
| logging.error('================ CAPTURED LOG START ==================') |
| with self.lock: |
| for entry in self.captures: |
| logging.error('%02d:%02d:%02d.%03d - %-10s: %s', |
| entry.when.hour, |
| entry.when.minute, |
| entry.when.second, |
| entry.when.microsecond/1000, |
| entry.source, |
| entry.line |
| ) |
| logging.error('================ CAPTURED LOG END ====================') |
| |
| |
| class TestTag(Enum): |
| MANUAL = auto() # requires manual input. Generally not run automatically |
| SLOW = auto() # test uses Sleep and is generally slow (>=10s is a typical threshold) |
| FLAKY = auto() # test is considered flaky (usually a bug/time dependent issue) |
| IN_DEVELOPMENT = auto() # test may not pass or undergoes changes |
| CHIP_TOOL_PYTHON_ONLY = auto() # test uses YAML features only supported by the CHIP_TOOL_PYTHON runner. |
| EXTRA_SLOW = auto() # test uses Sleep and is generally _very_ slow (>= 60s is a typical threshold) |
| PURPOSEFUL_FAILURE = auto() # test fails on purpose |
| |
| def to_s(self): |
| for (k, v) in TestTag.__members__.items(): |
| if self == v: |
| return k |
| raise Exception("Unknown tag: %r" % self) |
| |
| |
| class TestRunTime(Enum): |
| CHIP_TOOL_PYTHON = auto() # use the python yaml test parser with chip-tool |
| DARWIN_FRAMEWORK_TOOL_PYTHON = auto() # use the python yaml test parser with chip-tool |
| CHIP_REPL_PYTHON = auto() # use the python yaml test runner |
| |
| |
| @dataclass |
| class TestDefinition: |
| name: str |
| run_name: str |
| target: TestTarget |
| tags: typing.Set[TestTag] = field(default_factory=set) |
| |
| @property |
| def is_manual(self) -> bool: |
| return TestTag.MANUAL in self.tags |
| |
| @property |
| def is_slow(self) -> bool: |
| return TestTag.SLOW in self.tags |
| |
| @property |
| def is_flaky(self) -> bool: |
| return TestTag.FLAKY in self.tags |
| |
| def tags_str(self) -> str: |
| """Get a human readable list of tags applied to this test""" |
| return ", ".join([t.to_s() for t in self.tags]) |
| |
| def Run(self, runner, apps_register, paths: ApplicationPaths, pics_file: str, |
| timeout_seconds: typing.Optional[int], dry_run=False, test_runtime: TestRunTime = TestRunTime.CHIP_TOOL_PYTHON): |
| """ |
| Executes the given test case using the provided runner for execution. |
| """ |
| runner.capture_delegate = ExecutionCapture() |
| |
| tool_storage_dir = None |
| |
| try: |
| if self.target == TestTarget.ALL_CLUSTERS: |
| target_app = paths.all_clusters_app |
| elif self.target == TestTarget.TV: |
| target_app = paths.tv_app |
| elif self.target == TestTarget.LOCK: |
| target_app = paths.lock_app |
| elif self.target == TestTarget.OTA: |
| target_app = paths.ota_requestor_app |
| elif self.target == TestTarget.BRIDGE: |
| target_app = paths.bridge_app |
| elif self.target == TestTarget.LIT_ICD: |
| target_app = paths.lit_icd_app |
| elif self.target == TestTarget.MWO: |
| target_app = paths.microwave_oven_app |
| else: |
| raise Exception("Unknown test target - " |
| "don't know which application to run") |
| |
| if not dry_run: |
| for path in paths.items(): |
| # Do not add chip-tool or chip-repl-yaml-tester-cmd to the register |
| if path == paths.chip_tool or path == paths.chip_repl_yaml_tester_cmd or path == paths.chip_tool_with_python_cmd: |
| continue |
| |
| # Skip items where we don't actually have a path. This can |
| # happen if the relevant application does not exist. It's |
| # non-fatal as long as we are not trying to run any tests that |
| # need that application. |
| if path[-1] is None: |
| continue |
| |
| # For the app indicated by self.target, give it the 'default' key to add to the register |
| if path == target_app: |
| key = 'default' |
| else: |
| key = os.path.basename(path[-1]) |
| |
| app = App(runner, path) |
| # Add the App to the register immediately, so if it fails during |
| # start() we will be able to clean things up properly. |
| apps_register.add(key, app) |
| # Remove server application storage (factory reset), |
| # so it will be commissionable again. |
| app.factoryReset() |
| |
| # It may sometimes be useful to run the same app multiple times depending |
| # on the implementation. So this code creates a duplicate entry but with a different |
| # key. |
| app = App(runner, path) |
| apps_register.add(f'{key}#2', app) |
| app.factoryReset() |
| |
| if dry_run: |
| tool_storage_dir = None |
| tool_storage_args = [] |
| else: |
| tool_storage_dir = tempfile.mkdtemp() |
| tool_storage_args = ['--storage-directory', tool_storage_dir] |
| |
| # Only start and pair the default app |
| if dry_run: |
| setupCode = '${SETUP_PAYLOAD}' |
| else: |
| app = apps_register.get('default') |
| app.start() |
| setupCode = app.setupCode |
| |
| if test_runtime == TestRunTime.CHIP_REPL_PYTHON: |
| chip_repl_yaml_tester_cmd = paths.chip_repl_yaml_tester_cmd |
| python_cmd = chip_repl_yaml_tester_cmd + \ |
| ['--setup-code', setupCode] + ['--yaml-path', self.run_name] + ["--pics-file", pics_file] |
| if dry_run: |
| logging.info(" ".join(python_cmd)) |
| else: |
| runner.RunSubprocess(python_cmd, name='CHIP_REPL_YAML_TESTER', |
| dependencies=[apps_register], timeout_seconds=timeout_seconds) |
| else: |
| pairing_cmd = paths.chip_tool_with_python_cmd + ['pairing', 'code', TEST_NODE_ID, setupCode] |
| test_cmd = paths.chip_tool_with_python_cmd + ['tests', self.run_name] + ['--PICS', pics_file] |
| server_args = ['--server_path', paths.chip_tool[-1]] + \ |
| ['--server_arguments', 'interactive server' + |
| (' ' if len(tool_storage_args) else '') + ' '.join(tool_storage_args)] |
| pairing_cmd += server_args |
| test_cmd += server_args |
| |
| if dry_run: |
| # Some of our command arguments have spaces in them, so if we are |
| # trying to log commands people can run we should quote those. |
| def quoter(arg): return f"'{arg}'" if ' ' in arg else arg |
| logging.info(" ".join(map(quoter, pairing_cmd))) |
| logging.info(" ".join(map(quoter, test_cmd))) |
| else: |
| runner.RunSubprocess(pairing_cmd, |
| name='PAIR', dependencies=[apps_register]) |
| runner.RunSubprocess( |
| test_cmd, |
| name='TEST', dependencies=[apps_register], |
| timeout_seconds=timeout_seconds) |
| |
| except Exception: |
| logging.error("!!!!!!!!!!!!!!!!!!!! ERROR !!!!!!!!!!!!!!!!!!!!!!") |
| runner.capture_delegate.LogContents() |
| raise |
| finally: |
| apps_register.killAll() |
| apps_register.factoryResetAll() |
| apps_register.removeAll() |
| if tool_storage_dir is not None: |
| shutil.rmtree(tool_storage_dir, ignore_errors=True) |
