manufacturer_test.py

#!/usr/bin/python
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Library General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# manufacturer_test.py
# Copyright (C) 2015 Simon Newton

import unittest
import urllib2
import pprint
from socket import error as SocketError
from urllib2 import HTTPError
from urllib2 import URLError
from ssl import SSLError


class TestManufacturers(unittest.TestCase):
  """ Test the manufacturer data files are valid."""
  def setUp(self):
    globals = {}
    locals = {}
    execfile("data/manufacturer_data.py", globals, locals)
    self.data = locals['MANUFACTURER_DATA']
    globals = {}
    locals = {}
    execfile("data/manufacturer_links.py", globals, locals)
    self.links = locals['MANUFACTURER_LINKS']

  def test_ManufacturerData(self):
    seen_ids = set()

    for manufacturer_data in self.data:
      self.assertEqual(tuple, type(manufacturer_data))
      self.assertEqual(2, len(manufacturer_data))
      esta_id, name = manufacturer_data
      self.assertEqual(int, type(esta_id))
      self.assertEqual(str, type(name))

      self.assertNotIn(esta_id, seen_ids,
                       ("ESTA ID 0x%04x is present twice in manufacturers" %
                        esta_id))
      seen_ids.add(esta_id)

    # check that ESTA exists
    self.assertIn(0, seen_ids)
    # check that an ESTA test ID at the end of the file exists
    self.assertIn(0x7FF0, seen_ids)

  def test_ManufacturerLinks(self):
    esta_ids = set()
    seen_ids = set()
    for manufacturer_data in self.data:
      esta_id, name = manufacturer_data
      esta_ids.add(esta_id)

    opener = urllib2.build_opener(urllib2.HTTPCookieProcessor())

    for manufacturer_link in self.links:
      self.assertEqual(tuple, type(manufacturer_link))
      self.assertEqual(2, len(manufacturer_link))
      esta_id, link = manufacturer_link
      self.assertEqual(int, type(esta_id))
      self.assertEqual(str, type(link))

      # Check we have a corresponding entry in the manufacturer data
      self.assertIn(esta_id, esta_ids,
                    ("ESTA ID 0x%04x is not present in the manufacturer data" %
                     esta_id))

      # Check we've not seen a URL for this ID before
      self.assertNotIn(esta_id, seen_ids,
                       "ESTA ID 0x%04x is present twice in links" % esta_id)
      seen_ids.add(esta_id)

      # Check the link is valid
      try:
        # Some web servers, and Cloudflare, block us unless we have a
        # non-python User Agent
        ua = {'User-Agent': 'Mozilla/5.0 (KHTML, like Gecko)',
              'referer': 'http://example.com'}

        request = urllib2.Request(link, headers=ua)
        response = opener.open(request)
      except URLError as e:
        if hasattr(e, 'reason'):
          if hasattr(e, 'code'):
            pprint.pprint(e.code)
          if hasattr(e, 'headers'):
            pprint.pprint(vars(e.headers))
          # TODO(Peter): Various URLs fail SSL validation due to an incomplete
          # chain, others just don't like our CI testing of valid pages,
          # skip all these error for now
          if not ((type(e.reason) is SSLError and
                   (link == 'https://www.arri.com/' or
                    link == 'https://www.diconfiberoptics.com/' or
                    link == 'https://www.enttec.com/')) or
                  (type(e) is HTTPError and
                   (link == 'http://www.compulite.com/' or
                    link == 'https://www.lutron.com/en-US/Pages/default.aspx' or
                    link == 'https://www.panasonic.com/'))):
            self.fail("Link %s failed due to %s, reason type: %s" % (link, e.reason, type(e)))
        elif hasattr(e, 'code'):
          self.fail("The server couldn't fulfill the request for %s. Error "
                    "code: %s, reason type: %s" % (link, e.code, type(e.reason)))
      except SocketError as e:
        if hasattr(e, 'errno'):
          self.fail("Link %s failed due to socket error %s" % (link, e.errno))
      else:
        self.assertEqual(response.code, 200,
                         "Failed to fetch URL %s got status %d" %
                         (link, response.code))

    # optional, check that ESTA exists
    self.assertIn(0, seen_ids)


if __name__ == '__main__':
  unittest.main()