Tools/Scripts/webkitpy/w3c/test_parser.py

   1 #!/usr/bin/env python
   2
   3 # Copyright (C) 2013 Adobe Systems Incorporated. All rights reserved.
   4 #
   5 # Redistribution and use in source and binary forms, with or without
   6 # modification, are permitted provided that the following conditions
   7 # are met:
   8 #
   9 # 1. Redistributions of source code must retain the above
  10 #    copyright notice, this list of conditions and the following
  11 #    disclaimer.
  12 # 2. Redistributions in binary form must reproduce the above
  13 #    copyright notice, this list of conditions and the following
  14 #    disclaimer in the documentation and/or other materials
  15 #    provided with the distribution.
  16 #
  17 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER "AS IS" AND ANY
  18 # EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20 # PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE
  21 # LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
  22 # OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23 # PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24 # PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  26 # TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
  27 # THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 # SUCH DAMAGE.
  29
  30 import logging
  31 import re
  32
  33 from webkitpy.common.host import Host
  34 from webkitpy.thirdparty.BeautifulSoup import BeautifulSoup as Parser
  35
  36
  37 _log = logging.getLogger(__name__)
  38
  39
  40 class TestParser(object):
  41
  42     def __init__(self, options, filename, host=Host()):
  43         self.options = options
  44         self.filename = filename
  45         self.host = host
  46         self.filesystem = self.host.filesystem
  47
  48         self.test_doc = None
  49         self.ref_doc = None
  50         self.load_file(filename)
  51
  52     def load_file(self, filename, is_ref=False):
  53         if self.filesystem.isfile(filename):
  54             try:
  55                 doc = Parser(self.filesystem.read_binary_file(filename))
  56             except:
  57                 # FIXME: Figure out what to do if we can't parse the file.
  58                 _log.error("Failed to parse %s", filename)
  59                 doc = None
  60         else:
  61             if self.filesystem.isdir(filename):
  62                 # FIXME: Figure out what is triggering this and what to do about it.
  63                 _log.error("Trying to load %s, which is a directory", filename)
  64             doc = None
  65
  66         if is_ref:
  67             self.ref_doc = doc
  68         else:
  69             self.test_doc = doc
  70
  71     def analyze_test(self, test_contents=None, ref_contents=None):
  72         """ Analyzes a file to determine if it's a test, what type of test, and what reference or support files it requires. Returns all of the test info """
  73
  74         test_info = None
  75
  76         if test_contents is None and self.test_doc is None:
  77             return test_info
  78         if test_contents is not None:
  79             self.test_doc = Parser(test_contents)
  80         if ref_contents is not None:
  81             self.ref_doc = Parser(ref_contents)
  82
  83         # First check if it's a reftest
  84         matches = self.reference_links_of_type('match') + self.reference_links_of_type('mismatch')
  85         if matches:
  86             if len(matches) > 1:
  87                 # FIXME: Is this actually true? We should fix this.
  88                 _log.warning('Multiple references are not supported. Importing the first ref defined in %s',
  89                              self.filesystem.basename(self.filename))
  90
  91             try:
  92                 ref_file = self.filesystem.join(self.filesystem.dirname(self.filename), matches[0]['href'])
  93             except KeyError as e:
  94                 # FIXME: Figure out what to do w/ invalid test files.
  95                 _log.error('%s has a reference link but is missing the "href"', self.filesystem)
  96                 return None
  97
  98             if self.ref_doc is None:
  99                 self.load_file(ref_file, True)
 100
 101             test_info = {'test': self.filename, 'reference': ref_file}
 102
 103             # If the ref file does not live in the same directory as the test file, check it for support files
 104             test_info['reference_support_info'] = {}
 105             if self.filesystem.dirname(ref_file) != self.filesystem.dirname(self.filename):
 106                 reference_support_files = self.support_files(self.ref_doc)
 107                 if len(reference_support_files) > 0:
 108                     reference_relpath = self.filesystem.relpath(self.filesystem.dirname(self.filename), self.filesystem.dirname(ref_file)) + self.filesystem.sep
 109                     test_info['reference_support_info'] = {'reference_relpath': reference_relpath, 'files': reference_support_files}
 110
 111         # not all reference tests have a <link rel='match'> element in WPT repo
 112         elif self.is_wpt_reftest():
 113             test_info = {'test': self.filename, 'reference': self.potential_ref_filename()}
 114             test_info['reference_support_info'] = {}
 115         # we check for wpt manual test before checking for jstest, as some WPT manual tests can be classified as CSS JS tests
 116         elif self.is_wpt_manualtest():
 117             test_info = None
 118         elif self.is_jstest():
 119             test_info = {'test': self.filename, 'jstest': True}
 120         elif self.options['all'] is True and not('-ref' in self.filename) and not('reference' in self.filename):
 121             test_info = {'test': self.filename}
 122
 123         return test_info
 124
 125     def reference_links_of_type(self, reftest_type):
 126         return self.test_doc.findAll(rel=reftest_type)
 127
 128     def is_jstest(self):
 129         """Returns whether the file appears to be a jstest, by searching for usage of W3C-style testharness paths."""
 130         return bool(self.test_doc.find(src=re.compile('[\'\"/]?/resources/testharness')))
 131
 132     def is_wpt_manualtest(self):
 133         """Returns whether the test is a manual test according WPT rules (i.e. file ends with -manual.htm path)."""
 134         return self.filename.endswith('-manual.htm') or self.filename.endswith('-manual.html')
 135
 136     def potential_ref_filename(self):
 137         parts = self.filesystem.splitext(self.filename)
 138         return  parts[0] + '-ref' + parts[1]
 139
 140     def is_wpt_reftest(self):
 141         """Returns whether the test is a ref test according WPT rules (i.e. file has a -ref.html counterpart)."""
 142         parts = self.filesystem.splitext(self.filename)
 143         return  self.filesystem.isfile(self.potential_ref_filename())
 144
 145     def support_files(self, doc):
 146         """ Searches the file for all paths specified in url()'s, href or src attributes."""
 147         support_files = []
 148
 149         if doc is None:
 150             return support_files
 151
 152         elements_with_src_attributes = doc.findAll(src=re.compile('.*'))
 153         elements_with_href_attributes = doc.findAll(href=re.compile('.*'))
 154
 155         url_pattern = re.compile('url\(.*\)')
 156         urls = []
 157         for url in doc.findAll(text=url_pattern):
 158             url = re.search(url_pattern, url)
 159             url = re.sub('url\([\'\"]?', '', url.group(0))
 160             url = re.sub('[\'\"]?\)', '', url)
 161             urls.append(url)
 162
 163         src_paths = [src_tag['src'] for src_tag in elements_with_src_attributes]
 164         href_paths = [href_tag['href'] for href_tag in elements_with_href_attributes]
 165
 166         paths = src_paths + href_paths + urls
 167         for path in paths:
 168             uri_scheme_pattern = re.compile(r"[A-Za-z][A-Za-z+.-]*:")
 169             if not uri_scheme_pattern.match(path):
 170                 support_files.append(path)
 171
 172         return support_files