path: root/resources/libraries/python/VppApiCrc.py

# Copyright (c) 2023 Cisco and/or its affiliates.
# 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.

"""Module for keeping track of VPP API CRCs relied on by CSIT."""

import json
import os
import yaml

from robot.api import logger

from resources.libraries.python.Constants import Constants


def _str(text):
    """Convert from possible bytes without interpreting as number.

    :param text: Input to convert.
    :type text: str or unicode
    :returns: Converted text.
    :rtype: str
    """
    return text.decode(u"utf-8") if isinstance(text, bytes) else text


class VppApiCrcChecker:
    """Holder of data related to tracking VPP API CRCs.

    Both message names and crc hexa strings are tracked as
    ordinary Python3 (unicode) string, so _str() is used when input is
    possibly bytes or otherwise not safe.

    Each instance of this class starts with same default state,
    so make sure the calling libraries have appropriate robot library scope.
    For usual testing, it means "GLOBAL" scope."""

    def __init__(
            self, directory, fail_on_mismatch=Constants.FAIL_ON_CRC_MISMATCH):
        """Initialize empty state, then register known collections.

        This also scans directory for .api.json files
        and performs initial checks, but does not report the findings yet.

        :param directory: Root directory of the search for .api.json files.
        :type directory: str
        """

        self.fail_on_mismatch = fail_on_mismatch
        """If True, mismatch leads to test failure, by raising exception.
        If False, the mismatch is logged, but the test is allowed to continue.
        """

        self._expected = dict()
        """Mapping from collection name to mapping from API name to CRC string.

        Collection name should be something useful for logging.

        Order of addition reflects the order collections should be queried.
        If an incompatible CRC is found, affected collections are removed.
        A CRC that would remove all does not, added to _reported instead,
        while causing a failure in single test (if fail_on_mismatch)."""

        self._missing = dict()
        """Mapping from collection name to mapping from API name to CRC string.

        Starts the same as _expected, but each time an encountered api,crc pair
        fits the expectation, the pair is removed from all collections
        within this mapping. It is fine if an api is missing
        from some collections, as long as it is not missing from all collections
        that remained in _expected."""

        self._found = dict()
        """Mapping from API name to CRC string.

        This gets populated with CRCs found in .api.json,
        to serve as a hint when reporting errors."""

        self._options = dict()
        """Mapping from API name to options dictionary.

        This gets populated with options found in .api.json,
        to serve as a hint when reporting errors."""

        self._reported = dict()
        """Mapping from API name to CRC string.

        This gets populated with APIs used, but not found in collections,
        just before the fact is reported in an exception.
        The CRC comes from _found mapping (otherwise left as None).
        The idea is to not report those next time, allowing the job
        to find more problems in a single run."""

        self._initial_conflicts_reported = False
        self._register_all()
        self._check_dir(directory)

    def log_and_raise(self, exc_msg):
        """Log to console, on fail_on_mismatch also raise runtime exception.

        :param exc_msg: The message to include in log or exception.
        :type exc_msg: str
        :raises RuntimeError: With the message, if fail_on_mismatch.
        """
        logger.console("RuntimeError:\n{m}".format(m=exc_msg))
        if self.fail_on_mismatch:
            raise RuntimeError(exc_msg)

    def _register_collection(self, collection_name, name_to_crc_mapping):
        """Add a named (copy of) collection of CRCs.

        :param collection_name: Helpful string describing the collection.
        :param name_to_crc_mapping: Mapping from API names to CRCs.
        :type collection_name: str or unicode
        :type name_to_crc_mapping: dict from str/unicode to str/unicode
        :raises RuntimeError: If the name of a collection is registered already.
        """
        collection_name = _str(collection_name)
        if collection_name in self._expected:
            raise RuntimeError(
                f"Collection {collection_name!r} already registered."
            )
        mapping = {_str(k): _str(v) for k, v in name_to_crc_mapping.items()}
        self._expected[collection_name] = mapping
        self._missing[collection_name] = mapping.copy()

    def _register_all(self):
        """Add all collections this CSIT codebase is tested against."""

        file_path = os.path.normpath(os.path.join(
            os.path.dirname(os.path.abspath(__file__)), u"..", u"..",
            u"api", u"vpp", u"supported_crcs.yaml"))
        with open(file_path, u"rt") as file_in:
            collections_dict = yaml.safe_load(file_in.read())
        for collection_name, name_to_crc_mapping in collections_dict.items():
            self._register_collection(collection_name, name_to_crc_mapping)

    @staticmethod
    def _get_name(msg_obj):
        """Utility function to extract API name from an intermediate json.

        :param msg_obj: Loaded json object, item of "messages" list.
        :type msg_obj: list of various types
        :returns: Name of the message.
        :rtype: str or unicode
        :raises RuntimeError: If no name is found.
        """
        for item in msg_obj:
            if isinstance(item, (dict, list)):
                continue
            return _str(item)
        raise RuntimeError(f"No name found for message: {msg_obj!r}")

    @staticmethod
    def _get_crc(msg_obj):
        """Utility function to extract API CRC from an intermediate json.

        :param msg_obj: Loaded json object, item of "messages" list.
        :type msg_obj: list of various types
        :returns: CRC of the message.
        :rtype: str or unicode
        :raises RuntimeError: If no CRC is found.
        """
        for item in reversed(msg_obj):
            if not isinstance(item, dict):
                continue
            crc = item.get(u"crc", None)
            if crc:
                return _str(crc)
        raise RuntimeError(f"No CRC found for message: {msg_obj!r}")

    @staticmethod
    def _get_options(msg_obj, version):
        """Utility function to extract API options from an intermediate json.

        Empty dict is returned if options are not found,
        so old VPP builds can be tested without spamming.
        If version starts with "0.", add a fake option,
        as the message is treated as "in-progress" by the API upgrade process.

        :param msg_obj: Loaded json object, item of "messages" list.
        :param version: Version string from the .api.json file.
        :type msg_obj: list of various types
        :type version: Optional[str]
        :returns: Object found as value for "options" key.
        :rtype: dict
        """
        options = dict()
        for item in reversed(msg_obj):
            if not isinstance(item, dict):
                continue
            options = item.get(u"options", dict())
            if not options:
                break
        if version is None or version.startswith(u"0."):
            options[u"version"] = version
        return options

    def _process_crc(self, api_name, crc, options):
        """Compare API to verified collections, update class state.

        Here, API stands for (message name, CRC) pair.

        Conflict is NOT when a collection does not recognize the API.
        Such APIs are merely added to _found for later reporting.
        Conflict is when a collection recognizes the API under a different CRC.
        If a partial match happens, only the matching collections are preserved.
        On no match, all current collections are preserved,
        but the offending API is added to _reported mapping.

        Note that it is expected that collections are incompatible
        with each other for some APIs. The removal of collections
        on partial match is there to help identify the intended collection
        for the VPP build under test. But if no collection fits perfectly,
        the last collections to determine the "known" flag
        depends on the order of api_name submitted,
        which tends to be fairly random (depends on order of .api.json files).
        Order of collection registrations does not help much in this regard.

        Attempts to overwrite value in _found or _reported should not happen,
        so the code does not check for that, simply overwriting.

        Options are stored, to be examined later.

        The intended usage is to call this method multiple times,
        and then raise exception listing all _reported.

        :param api_name: API name to check.
        :param crc: Discovered CRC to check for the name.
        :param options: Empty dict or options value for in .api.json
        :type api_name: str
        :type crc: str
        :type options: dict
        """
        # Regardless of the result, remember as found.
        self._found[api_name] = crc
        self._options[api_name] = options
        old_expected = self._expected
        new_expected = old_expected.copy()
        for collection_name, name_to_crc_mapping in old_expected.items():
            if api_name not in name_to_crc_mapping:
                continue
            if name_to_crc_mapping[api_name] == crc:
                self._missing[collection_name].pop(api_name, None)
                continue
            # Remove the offending collection.
            new_expected.pop(collection_name, None)
        if new_expected:
            # Some collections recognized the CRC.
            self._expected = new_expected
            self._missing = {name: self._missing[name] for name in new_expected}
            return
        # No new_expected means some collections knew the api_name,
        # but CRC does not match any. This has to be reported.
        self._reported[api_name] = crc

    def _check_dir(self, directory):
        """Parse every .api.json found under directory, remember conflicts.

        As several collections are supported, each conflict invalidates
        some of them, failure happens only when no collections would be left.
        In that case, set of collections just before the failure is preserved,
        the _reported mapping is filled with conflicting APIs.
        The _found mapping is filled with discovered api names and crcs.

        The exception is not thrown here, but from report_initial_conflicts.

        :param directory: Root directory of the search for .api.json files.
        :type directory: str
        """
        for root, _, files in os.walk(directory):
            for filename in files:
                if not filename.endswith(u".api.json"):
                    continue
                with open(f"{root}/{filename}", u"rt") as file_in:
                    json_obj = json.load(file_in)
                version = json_obj[u"options"].get(u"version", None)
                msgs = json_obj[u"messages"]
                for msg_obj in msgs:
                    msg_name = self._get_name(msg_obj)
                    msg_crc = self._get_crc(msg_obj)
                    msg_options = self._get_options(msg_obj, version)
                    self._process_crc(msg_name, msg_crc, msg_options)
        logger.debug(f"Surviving collections: {self._expected.keys()!r}")

    def report_initial_conflicts(self, report_missing=False):
        """Report issues discovered by _check_dir, if not done that already.

        Intended use: Call once after init, at a time when throwing exception
        is convenient.

        Optionally, report also missing messages.
        Missing reporting is disabled by default, because some messages
        come from plugins that might not be enabled at runtime.

        After the report, clear _reported, so that test cases report them again,
        thus tracking which message is actually used (by which test).

        :param report_missing: Whether to raise on missing messages.
        :type report_missing: bool
        :raises RuntimeError: If CRC mismatch or missing messages are detected,
            and fail_on_mismatch is True.
        """
        if self._initial_conflicts_reported:
            return
        self._initial_conflicts_reported = True
        if self._reported:
            reported_indented = json.dumps(
                self._reported, indent=1, sort_keys=True,
                separators=[u",", u":"]
            )
            self._reported = dict()
            self.log_and_raise(
                f"Incompatible API CRCs found in .api.json files:\n"
                f"{reported_indented}"
            )
        if not report_missing:
            return
        missing = {name: mapp for name, mapp in self._missing.items() if mapp}
        if set(missing.keys()) < set(self._expected.keys()):
            # There is a collection where nothing is missing.
            return
        missing_indented = json.dumps(
            missing, indent=1, sort_keys=True, separators=[u",", u":"]
        )
        self.log_and_raise(
            f"API CRCs missing from .api.json:\n{missing_indented}"
        )

    def check_api_name(self, api_name):
        """Fail if the api_name has no, or different from known CRC associated.

        Print warning if options contain anything more than vat_help.

        Do not fail if this particular failure has been already reported.

        Intended use: Call during test (not in initialization),
        every time an API call is queued or response received.

        :param api_name: VPP API message name to check.
        :type api_name: str or unicode
        :raises RuntimeError: If no verified CRC for the api_name is found.
        """
        api_name = _str(api_name)
        if api_name in self._reported:
            return
        old_expected = self._expected
        new_expected = old_expected.copy()
        for collection_name, name_to_crc_mapping in old_expected.items():
            if api_name in name_to_crc_mapping:
                continue
            # Remove the offending collection.
            new_expected.pop(collection_name, None)
        if new_expected:
            # Some collections recognized the message name.
            self._expected = new_expected
        crc = self._found.get(api_name, None)
        matching = False
        if crc is not None:
            # Regardless of how many collections are remaining,
            # verify the known CRC is on one of them.
            for name_to_crc_mapping in self._expected.values():
                if api_name not in name_to_crc_mapping:
                    continue
                if name_to_crc_mapping[api_name] == crc:
                    matching = True
                    break
        if not matching:
            self._reported[api_name] = crc
            self.log_and_raise(
                f"No active collection has API {api_name!r} with CRC {crc!r}"
            )
        options = self._options.get(api_name, None)
        if not options:
            # None means CSIT is attempting a new API on an old VPP build.
            # If that is an issue, the API has been reported as missing already.
            return
        options.pop(u"vat_help", None)
        if options:
            self._reported[api_name] = crc
            logger.console(f"{api_name} used but has options {options}")

    def print_warnings(self):
        """Call check_api_name for API names in surviving collections.

        Useful for VPP CRC checking job.
        The API name is only checked when it appears
        in all surviving collections.
        """
        api_name_to_crc_maps = self._expected.values()
        api_name_sets = (set(n2c.keys()) for n2c in api_name_to_crc_maps)
        api_names = set.intersection(*api_name_sets)
        for api_name in sorted(api_names):
            self.check_api_name(api_name)