xref: /aosp_15_r20/external/openthread/tools/harness-automation/autothreadharness/helpers.py (revision cfb92d1480a9e65faed56933e9c12405f45898b4)

#!/usr/bin/env python
#
# Copyright (c) 2016, The OpenThread Authors.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
# 3. Neither the name of the copyright holder nor the
#    names of its contributors may be used to endorse or promote products
#    derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#

import json
import logging


class HistoryHelper(object):
    logger = logging.getLogger(__name__)

    def __init__(self, filename='./history.json'):
        self.filename = filename
        try:
            self.data = json.load(open(filename, 'r'))
        except Exception:
            self.logger.exception('file may not exists')
            self.data = {'golden_device_denylist': []}
            self.save()

    def save(self):
        json.dump(self.data, open(self.filename, 'w'), indent=2)

    def mark_bad_golden_device(self, port):
        self.logger.warning('mark serial port[%s] as bad', port)
        self.data['golden_device_denylist'].append(port)
        self.save()

    def is_bad_golden_device(self, port):
        return port in self.data['golden_device_denylist']

    def __str__(self):
        return json.dumps(self.data, indent=2)