Chrome updater test framework

pyautolib/pyauto_utils.py

 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Utilities for PyAuto."""
 
+import httplib
 import logging
 import os
 import shutil
+import socket
 import sys
 import tempfile
+import unittest
+import urlparse
 import zipfile
 
 
 class ExistingPathReplacer(object):
   """Facilitates backing up a given path (file or dir)..
 
   Often you want to manipulate a directory or file for testing but don't want to
   meddle with the existing contents.  This class lets you make a backup, and
   reinstate the backup when done.  A backup is made in an adjacent directory,
   so you need to make sure you have write permissions to the parent directory.
@@ skipping 162 matching lines @@
   Args:
     pyauto: an instance of pyauto.PyUITest.
     driver: an instance of chrome driver or a web element.
     xpath: the xpath of the element to wait for.
 
   Returns:
     The element if it is found.
     NoSuchElementException if it is not found.
   """
   pyauto.WaitUntil(lambda: len(driver.find_elements_by_xpath(xpath)) > 0)
-  return driver.find_element_by_xpath(xpath)
+  return driver.find_element_by_xpath(xpath)
+
+
+def DoesUrlExist(url):

[dennis_jeffrey, 2012/10/04 21:54:46]

Something similar already exists in other pyauto code here:

http://src.chromium.org/svn/trunk/src/chrome/test/pyautolib/fetch_prebuilt_py...

Can we make sure this utility function only gets implemented once in pyauto?

[nkang, 2012/10/04 22:25:58]

Originally FetchPrebuiltPyauto was part of this CL, and that's part of the
reason I moved this method to pyautolib so it wouldn't be repeated.  Then, after
we switched from PyAuto to ChromeDriver, we dropped FetchPrebuiltPyauto from the
CL because it was no longer needed. I can remove this method from
FetchPrebuiltPyauto, update it, and include it in this CL. Let me know if you're
okay with that.

[dennis_jeffrey, 2012/10/04 22:37:14]

Yeah, I think it would be good to remove the method from fetch_prebuilt_pyauto
and have it use the one here instead.  Is the one here identical to the one in
fetch_prebuilt_pyauto?

fetch_prebuilt_pyauto already imports the current file so we'd might as well
have it use this one rather than having its own copy ;-)

[dennis_jeffrey, 2012/10/05 17:57:23]

Please address this comment and then it'll be good to go from my end.

[nkang, 2012/10/05 18:58:02]

Removed this code from fetch_prebuilt_pyauto.py and updated
fetch_prebuilt_pyauto.py so it uses pyauto_utils.DoesUrlExist instead.

+  """Determines whether a resource exists at the given URL.
+
+  Args:
+    url: URL to be verified.
+
+  Returns:
+    True if url exists, otherwise False.
+  """
+  parsed = urlparse.urlparse(url)
+  try:
+    conn = httplib.HTTPConnection(parsed.netloc)
+    conn.request('HEAD', parsed.path)
+    response = conn.getresponse()
+  except (socket.gaierror, socket.error):    
+    return False
+  finally:
+    conn.close()
+  # Follow both permanent (301) and temporary (302) redirects.
+  if response.status == 302 or response.status == 301:  
+    return DoesUrlExist(response.getheader('location'))
+  return response.status == 200
+
+
+class _GTestTextTestResult(unittest._TextTestResult):

[dennis_jeffrey, 2012/10/04 21:54:46]

This code looks like it already exists for webdriver here:

http://src.chromium.org/svn/trunk/src/chrome/test/webdriver/test/py_unittest_...

Can we find a single place to put it so that we don't have two copies of this
floating around in the codebase?

[nkang, 2012/10/04 22:25:58]

This code also exists in PyAuto.py. PyAuto was originally part of this CL, as
well, but was later dropped in favor of ChromeDriver. I had removed this code
from PyAuto and put it here. I had also updated PyAuto so it imported this class
from pyautolib, but since PyAuto was dropped, we decided to remove it from the
CL. If you want, I can update PyAuto and remove this code from it. I can also
update Webdriver, so it imports from pyautolib. I think that would be better
than having separate copies of this code in PyAuto and Webdriver. Let me know if
you would like me to do that. If you have another place in mind, I'd be open to
that as well.

[dennis_jeffrey, 2012/10/04 22:37:14]

I would like to see only 1 copy of this code in the chrome codebase, but it does
complicate matters that pyauto needs it and ChromeDriver needs it.  Not sure if
it's best to have WebDriver depend on pyautolib though.  It seems like it would
be better to have a more general test utility module that can be imported and
used by both chromedriver and pyauto.  Maybe Ken could comment on that one since
he knows more about the connections between pyauto and chromedriver.

[kkania, 2012/10/05 15:17:41]

It would be nice to just have one copy. I'll take this though in a separate CL,
since it's really my problem, not Navdeep's.

[dennis_jeffrey, 2012/10/05 17:57:23]

Sounds good - thanks!

+  """A test result class that can print formatted text results to a stream.
+
+  Results printed in conformance with gtest output format, like:
+  [ RUN        ] autofill.AutofillTest.testAutofillInvalid: "test desc."
+  [         OK ] autofill.AutofillTest.testAutofillInvalid
+  [ RUN        ] autofill.AutofillTest.testFillProfile: "test desc."
+  [         OK ] autofill.AutofillTest.testFillProfile
+  [ RUN        ] autofill.AutofillTest.testFillProfileCrazyCharacters: "Test."
+  [         OK ] autofill.AutofillTest.testFillProfileCrazyCharacters
+  """
+  
+  def __init__(self, stream, descriptions, verbosity):
+    unittest._TextTestResult.__init__(self, stream, descriptions, verbosity)
+
+  def _GetTestURI(self, test):
+    if sys.version_info[:2] <= (2, 4):
+      return '%s.%s' % (unittest._strclass(test.__class__),
+                        test._TestCase__testMethodName)
+    return '%s.%s' % (unittest._strclass(test.__class__), test._testMethodName)
+
+  def getDescription(self, test):
+    return '%s: "%s"' % (self._GetTestURI(test), test.shortDescription())
+
+  def startTest(self, test):
+    unittest.TestResult.startTest(self, test)
+    self.stream.writeln('[ RUN        ] %s' % self.getDescription(test))
+
+  def addSuccess(self, test):
+    unittest.TestResult.addSuccess(self, test)
+    self.stream.writeln('[         OK ] %s' % self._GetTestURI(test))
+
+  def addError(self, test, err):
+    unittest.TestResult.addError(self, test, err)
+    self.stream.writeln('[      ERROR ] %s' % self._GetTestURI(test))
+
+  def addFailure(self, test, err):
+    unittest.TestResult.addFailure(self, test, err)
+    self.stream.writeln('[     FAILED ] %s' % self._GetTestURI(test))
+
+
+class GTestTextTestRunner(unittest.TextTestRunner):
+  """Test Runner for displaying test results in textual format.
+
+  Results are displayed in conformance with gtest output.
+  """
+  
+  def __init__(self, verbosity=1):
+    unittest.TextTestRunner.__init__(self, stream=sys.stderr,
+                                     verbosity=verbosity)
+
+  def _makeResult(self):
+    return _GTestTextTestResult(self.stream, self.descriptions, self.verbosity)