resources/libraries/python/VppApiCrc.py

   1 # Copyright (c) 2019 Cisco and/or its affiliates.
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14 """Module for keeping track of VPP API CRCs relied on by CSIT."""
  15
  16 import json
  17 import os
  18 import yaml
  19
  20 from robot.api import logger
  21
  22 from resources.libraries.python.Constants import Constants
  23
  24 def _str(text):
  25     """Convert from possible unicode without interpreting as number.
  26
  27     :param text: Input to convert.
  28     :type text: str or unicode
  29     :returns: Converted text.
  30     :rtype: str
  31     """
  32     return text.encode("utf-8") if isinstance(text, unicode) else text
  33
  34
  35 class VppApiCrcChecker(object):
  36     """Holder of data related to tracking VPP API CRCs.
  37
  38     Both message names and crc hexa strings are tracked as
  39     ordinary Python2 (bytes) string, so _str() is used when input is
  40     possibly unicode or otherwise not safe.
  41
  42     Each instance of this class starts with same default state,
  43     so make sure the calling libraries have appropriate robot library scope.
  44     For usual testing, it means "GLOBAL" scope."""
  45
  46     def __init__(
  47             self, directory, fail_on_mismatch=Constants.FAIL_ON_CRC_MISMATCH):
  48         """Initialize empty state, then register known collections.
  49
  50         This also scans directory for .api.json files
  51         and performs initial checks, but does not report the findings yet.
  52
  53         :param directory: Root directory of the search for .api.json files.
  54         :type directory: str
  55         """
  56
  57         self.fail_on_mismatch = fail_on_mismatch
  58         """If True, mismatch leads to test failure, by raising exception.
  59         If False, the mismatch is logged, but the test is allowed to continue.
  60         """
  61
  62         self._expected = dict()
  63         """Mapping from collection name to mapping from API name to CRC string.
  64
  65         Colection name should be something useful for logging.
  66
  67         Order of addition reflects the order colections should be queried.
  68         If an incompatible CRC is found, affected collections are removed.
  69         A CRC that would remove all does not, added to _reported instead,
  70         while causing a failure in single test (if fail_on_mismatch)."""
  71
  72         self._missing = dict()
  73         """Mapping from collection name to mapping from API name to CRC string.
  74
  75         Starts the same as _expected, but each time an encountered api,crc pair
  76         fits the expectation, the pair is removed from all collections
  77         within this mapping. Ideally, the active mappings will become empty.
  78         If not, it is an error, VPP removed or renamed a message CSIT needs."""
  79
  80         self._found = dict()
  81         """Mapping from API name to CRC string.
  82
  83         This gets populated with CRCs found in .api.json,
  84         to serve as a hint when reporting errors."""
  85
  86         self._reported = dict()
  87         """Mapping from API name to CRC string.
  88
  89         This gets populated with APIs used, but not found in collections,
  90         just before the fact is reported in an exception.
  91         The CRC comes from _found mapping (otherwise left as None).
  92         The idea is to not report those next time, allowing the job
  93         to find more problems in a single run."""
  94
  95         self._initial_conflicts_reported = False
  96         self._register_all()
  97         self._check_dir(directory)
  98
  99     def log_and_raise(self, exc_msg):
 100         """Log to console, on fail_on_mismatch also raise runtime exception.
 101
 102         :param exc_msg: The message to include in log or exception.
 103         :type exception: str
 104         :raises RuntimeError: With the message, if fail_on_mismatch.
 105         """
 106         logger.console("RuntimeError:\n{m}".format(m=exc_msg))
 107         if self.fail_on_mismatch:
 108             raise RuntimeError(exc_msg)
 109
 110     def _register_collection(self, collection_name, name_to_crc_mapping):
 111         """Add a named (copy of) collection of CRCs.
 112
 113         :param collection_name: Helpful string describing the collection.
 114         :param name_to_crc_mapping: Mapping from API names to CRCs.
 115         :type collection_name: str or unicode
 116         :type name_to_crc_mapping: dict from str/unicode to str/unicode
 117         :raises RuntimeError: If the name of a collection is registered already.
 118         """
 119         collection_name = _str(collection_name)
 120         if collection_name in self._expected:
 121             raise RuntimeError("Collection {cn!r} already registered.".format(
 122                 cn=collection_name))
 123         mapping = {_str(k): _str(v) for k, v in name_to_crc_mapping.items()}
 124         self._expected[collection_name] = mapping
 125         self._missing[collection_name] = mapping.copy()
 126
 127     def _register_all(self):
 128         """Add all collections this CSIT codebase is tested against."""
 129
 130         file_path = os.path.normpath(os.path.join(
 131             os.path.dirname(os.path.abspath(__file__)), "..", "..",
 132             "api", "vpp", "supported_crcs.yaml"))
 133         with open(file_path, "r") as file_in:
 134             collections_dict = yaml.load(file_in.read())
 135         for collection_name, name_to_crc_mapping in collections_dict.items():
 136             self._register_collection(collection_name, name_to_crc_mapping)
 137
 138     @staticmethod
 139     def _get_name(msg_obj):
 140         """Utility function to extract API name from an intermediate json.
 141
 142         :param msg_obj: Loaded json object, item of "messages" list.
 143         :type msg_obj: list of various types
 144         :returns: Name of the message.
 145         :rtype: str or unicode
 146         :raises RuntimeError: If no name is found.
 147         """
 148         for item in msg_obj:
 149             if isinstance(item, (dict, list)):
 150                 continue
 151             return _str(item)
 152         raise RuntimeError("No name found for message: {obj!r}".format(
 153             obj=msg_obj))
 154
 155     @staticmethod
 156     def _get_crc(msg_obj):
 157         """Utility function to extract API CRC from an intermediate json.
 158
 159         :param msg_obj: Loaded json object, item of "messages" list.
 160         :type msg_obj: list of various types
 161         :returns: CRC of the message.
 162         :rtype: str or unicode
 163         :raises RuntimeError: If no CRC is found.
 164         """
 165         for item in reversed(msg_obj):
 166             if not isinstance(item, dict):
 167                 continue
 168             crc = item.get("crc", None)
 169             if crc:
 170                 return _str(crc)
 171         raise RuntimeError("No CRC found for message: {obj!r}".format(
 172             obj=msg_obj))
 173
 174     def _process_crc(self, api_name, crc):
 175         """Compare API to verified collections, update class state.
 176
 177         Here, API stands for (message name, CRC) pair.
 178
 179         Conflict is NOT when a collection does not recognize the API.
 180         Such APIs are merely added to _found for later reporting.
 181         Conflict is when a collection recognizes the API under a different CRC.
 182         If a partial match happens, only the matching collections are preserved.
 183         On no match, all current collections are preserved,
 184         but the offending API is added to _reported mapping.
 185
 186         Note that it is expected that collections are incompatible
 187         with each other for some APIs. The removal of collections
 188         on partial match is there to help identify the intended collection
 189         for the VPP build under test. But if no collection fits perfectly,
 190         the last collections to determine the "known" flag
 191         depends on the order of api_name submitted,
 192         which tends to be fairly random (depends on order of .api.json files).
 193         Order of collection registrations does not help much in this regard.
 194
 195         Attempts to overwrite value in _found or _reported should not happen,
 196         so the code does not check for that, simply overwriting.
 197
 198         The intended usage is to call this method multiple times,
 199         and then raise exception listing all _reported.
 200
 201         :param api_name: API name to check.
 202         :param crc: Discovered CRC to check for the name.
 203         :type api_name: str
 204         :type crc: str
 205         """
 206         # Regardless of the result, remember as found.
 207         self._found[api_name] = crc
 208         old_expected = self._expected
 209         new_expected = old_expected.copy()
 210         for collection_name, name_to_crc_mapping in old_expected.items():
 211             if api_name not in name_to_crc_mapping:
 212                 continue
 213             if name_to_crc_mapping[api_name] == crc:
 214                 self._missing[collection_name].pop(api_name, None)
 215                 continue
 216             # Remove the offending collection.
 217             new_expected.pop(collection_name, None)
 218         if new_expected:
 219             # Some collections recognized the CRC.
 220             self._expected = new_expected
 221             self._missing = {name: self._missing[name] for name in new_expected}
 222             return
 223         # No new_expected means some colections knew the api_name,
 224         # but CRC does not match any. This has to be reported.
 225         self._reported[api_name] = crc
 226
 227     def _check_dir(self, directory):
 228         """Parse every .api.json found under directory, remember conflicts.
 229
 230         As several collections are supported, each conflict invalidates
 231         some of them, failure happens only when no collections would be left.
 232         In that case, set of collections just before the failure is preserved,
 233         the _reported mapping is filled with conflicting APIs.
 234         The _found mapping is filled with discovered api names and crcs.
 235
 236         The exception is not thrown here, but from report_initial_conflicts.
 237
 238         :param directory: Root directory of the search for .api.json files.
 239         :type directory: str
 240         """
 241         for root, _, files in os.walk(directory):
 242             for filename in files:
 243                 if not filename.endswith(".api.json"):
 244                     continue
 245                 with open(root + '/' + filename, "r") as file_in:
 246                     json_obj = json.load(file_in)
 247                 msgs = json_obj["messages"]
 248                 for msg_obj in msgs:
 249                     msg_name = self._get_name(msg_obj)
 250                     msg_crc = self._get_crc(msg_obj)
 251                     self._process_crc(msg_name, msg_crc)
 252         logger.debug("Surviving collections: {col!r}".format(
 253             col=self._expected.keys()))
 254
 255     def report_initial_conflicts(self, report_missing=False):
 256         """Report issues discovered by _check_dir, if not done that already.
 257
 258         Intended use: Call once after init, at a time when throwing exception
 259         is convenient.
 260
 261         Optionally, report also missing messages.
 262         Missing reporting is disabled by default, because some messages
 263         come from plugins that might not be enabled at runtime.
 264
 265         After the report, clear _reported, so that test cases report them again,
 266         thus tracking which message is actually used (by which test).
 267
 268         :param report_missing: Whether to raise on missing messages.
 269         :type report_missing: bool
 270         :raises RuntimeError: If CRC mismatch or missing messages are detected,
 271             and fail_on_mismatch is True.
 272         """
 273         if self._initial_conflicts_reported:
 274             return
 275         self._initial_conflicts_reported = True
 276         if self._reported:
 277             reported_indented = json.dumps(
 278                 self._reported, indent=1, sort_keys=True, separators=[",", ":"])
 279             self._reported = dict()
 280             self.log_and_raise(
 281                 "Incompatible API CRCs found in .api.json files:\n{ri}".format(
 282                     ri=reported_indented))
 283         if not report_missing:
 284             return
 285         missing = {name: mapp for name, mapp in self._missing.items() if mapp}
 286         if missing:
 287             missing_indented = json.dumps(
 288                 missing, indent=1, sort_keys=True, separators=[",", ":"])
 289             self.log_and_raise("API CRCs missing from .api.json:\n{mi}".format(
 290                 mi=missing_indented))
 291
 292     def check_api_name(self, api_name):
 293         """Fail if the api_name has no, or different from known CRC associated.
 294
 295         Do not fail if this particular failure has been already reported.
 296
 297         Intended use: Call during test (not in initialization),
 298         everytime an API call is queued or response received.
 299
 300         :param api_name: VPP API messagee name to check.
 301         :type api_name: str or unicode
 302         :raises RuntimeError: If no verified CRC for the api_name is found.
 303         """
 304         api_name = _str(api_name)
 305         if api_name in self._reported:
 306             return
 307         old_expected = self._expected
 308         new_expected = old_expected.copy()
 309         for collection_name, name_to_crc_mapping in old_expected.items():
 310             if api_name in name_to_crc_mapping:
 311                 continue
 312             # Remove the offending collection.
 313             new_expected.pop(collection_name, None)
 314         if new_expected:
 315             # Some collections recognized the message name.
 316             self._expected = new_expected
 317         crc = self._found.get(api_name, None)
 318         matching = False
 319         if crc is not None:
 320             # Regardless of how many collections are remaining,
 321             # verify the known CRC is on one of them.
 322             for name_to_crc_mapping in self._expected.values():
 323                 if api_name not in name_to_crc_mapping:
 324                     continue
 325                 if name_to_crc_mapping[api_name] == crc:
 326                     matching = True
 327                     break
 328         if matching:
 329             return
 330         self._reported[api_name] = crc
 331         self.log_and_raise("No active collection contains API {api!r}"
 332                            " with CRC {crc!r}".format(api=api_name, crc=crc))