test/matchers.py

   1 #
   2 # Wireshark tests
   3 #
   4 # Copyright (c) 2018 Peter Wu <peter@lekensteyn.nl>
   5 #
   6 # SPDX-License-Identifier: GPL-2.0-or-later
   7 #
   8 '''Helpers for matching test results.'''
   9
  10 import re
  11
  12 class MatchAny(object):
  13     '''Matches any other value.'''
  14
  15     def __init__(self, type=None):
  16         self.type = type
  17
  18     def __eq__(self, other):
  19         return self.type is None or self.type == type(other)
  20
  21     def __repr__(self):
  22         return '<MatchAny type=%s>' % (self.type.__name__,)
  23
  24
  25 class MatchObject(object):
  26     '''Matches all expected fields of an object, ignoring excess others.'''
  27
  28     def __init__(self, fields):
  29         self.fields = fields
  30
  31     def __eq__(self, other):
  32         return all(other.get(k) == v for k, v in self.fields.items())
  33
  34     def __repr__(self):
  35         return '<MatchObject fields=%r>' % (self.fields,)
  36
  37
  38 class MatchList(object):
  39     '''Matches elements of a list. Optionally checks list length.'''
  40
  41     def __init__(self, item, n=None, match_element=all):
  42         self.item = item
  43         self.n = n
  44         self.match_element = match_element
  45
  46     def __eq__(self, other):
  47         if self.n is not None and len(other) != self.n:
  48             return False
  49         return self.match_element(self.item == elm for elm in other)
  50
  51     def __repr__(self):
  52         return '<MatchList item=%r n=%r match_element=%s>' % \
  53                 (self.item, self.n, self.match_element.__name__)
  54
  55
  56 class MatchRegExp(object):
  57     '''Matches a string against a regular expression.'''
  58
  59     def __init__(self, pattern):
  60         self.pattern = pattern
  61
  62     def __eq__(self, other):
  63         return type(other) == str and re.match(self.pattern, other)
  64
  65     def __repr__(self):
  66         return '<MatchRegExp pattern=%r>' % (self.pattern)