Clean up ports allocated by perf windows tests on CNS external server.

chrome/test/functional/media/cns_test_base.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.
 
 """Constrained network server (CNS) test base."""
 
 import logging
 import os
 import Queue
 import subprocess
 import sys
 import threading
 import urllib2
 
 import pyauto
 import pyauto_paths
 
-WINDOWS = 'win32' in sys.platform
 
 # List of commonly used network constraints settings.
 # Each setting is a tuppe of the form:
 #    ('TEST_NAME', [BANDWIDTH_Kbps, LATENCY_ms, PACKET_LOSS_%])
 #
 # Note: The test name should satisfy the regex [\w\.-]+ (check
 # tools/perf_expectations/tests/perf_expectations_unittest.py for details). It
 # is used to name the result graphs on the dashboards.
 #
 # The WiFi, DSL, and Cable settings were taken from webpagetest.org as
 # approximations of their respective real world networks. The settings were
 # based on 2011 FCC Broadband Data report (http://www.fcc.gov/document/
 # measuring-broadband-america-report-consumer-broadband-performance-us).
 DialUp = ('DialUp', [56, 120, 5])
 Slow = ('Slow', [256, 105, 1])
 Wifi = ('Wifi', [1024, 60, 0])
 DSL = ('DSL', [1541, 50, 0])
 Cable = ('Cable', [5120, 28, 0])
 NoConstraints = ('NoConstraints', [0, 0, 0])
 
 # Path to CNS executable relative to source root.
 _CNS_PATH = os.path.join(
     'media', 'tools', 'constrained_network_server', 'cns.py')
 
 # Port to start the CNS on.
 _CNS_PORT = 9000
 
+# A flag to determine whether to launch a local CNS instance or to connect
+# to the external CNS server.  Default to True since all current bots use an
+# external instance. Set to false when running a local test.
+USE_EXTERNAL_SERVER = False

[DaleCurtis, 2012/08/16 00:15:58]

Can we make this a command line option? Also the comment says default to True?

[shadi, 2012/08/16 19:49:27]

After offline discussion, we decided to use an environment variable to switch
this flag. 

+
 # Base CNS URL, only requires & separated parameter names appended.
-if WINDOWS:
+if USE_EXTERNAL_SERVER:
   CNS_BASE_URL = 'http://chromeperf34:%d/ServeConstrained?' % _CNS_PORT
+  CNS_CLEANUP_URL = 'http://chromeperf34:%d/Cleanup' % _CNS_PORT
 else:
   CNS_BASE_URL = 'http://127.0.0.1:%d/ServeConstrained?' % _CNS_PORT
 
 # Used for server sanity check.
 _TEST_VIDEO = 'roller.webm'
 
 # Directory root to serve files from.
 _ROOT_PATH = os.path.join(pyauto.PyUITest.DataDir(), 'pyauto_private', 'media')
 
 
 class CNSTestBase(pyauto.PyUITest):
   """CNS test base hadles startup and teardown of CNS server."""
 
   def __init__(self, *args, **kwargs):
     """Initialize CNSTestBase by setting the arguments for CNS server.
 
     Args:
         Check cns.py command line argument list for details.
     """
     self._port = kwargs.get('port', _CNS_PORT)
     self._interface = kwargs.get('interface', 'lo')
     self._www_root = kwargs.get('www_root', _ROOT_PATH)
     self._verbose = kwargs.get('verbose', True)
     self._expiry_time = kwargs.get('expiry_time', 0)
     self._socket_timeout = kwargs.get('socket_timeout')
     pyauto.PyUITest.__init__(self, *args, **kwargs)
 
   def setUp(self):
     """Ensures the Constrained Network Server (CNS) server is up and running."""
-    if WINDOWS:
-      self._SetUpWin()
+    if USE_EXTERNAL_SERVER:
+      self._SetUpExternal()
     else:
-      self._SetUpLinux()
+      self._SetUpLocal()
 
-  def _SetUpWin(self):
+  def _SetUpExternal(self):
     """Ensures the test can connect to the external CNS server."""
     if self.WaitUntil(self._CanAccessServer, retry_sleep=3, timeout=30,
                       debug=False):
       pyauto.PyUITest.setUp(self)
     else:
       self.fail('Failed to connect to CNS.')
 
-  def _SetUpLinux(self):
+  def _SetUpLocal(self):
     """Starts the CNS server locally."""
     cmd = [sys.executable, os.path.join(pyauto_paths.GetSourceDir(), _CNS_PATH),
            '--port', str(self._port),
            '--interface', self._interface,
            '--www-root', self._www_root,
            '--expiry-time', str(self._expiry_time)]
 
     if self._socket_timeout:
       cmd.extend(['--socket-timeout', str(self._socket_timeout)])
     if self._verbose:
@@ skipping 13 matching lines @@
   def _CanAccessServer(self):
     """Checks if the CNS server can serve a file with no network constraints."""
     test_url = ''.join([CNS_BASE_URL, 'f=', _TEST_VIDEO])
     try:
       return urllib2.urlopen(test_url) is not None
     except Exception:
       return False
 
   def tearDown(self):
     """Stops the Constrained Network Server (CNS)."""
-    pyauto.PyUITest.tearDown(self)
-    if not WINDOWS:
+    if USE_EXTERNAL_SERVER:
+      # Call CNS Cleanup to remove all ports created by this client.
+      self.NavigateToURL(CNS_CLEANUP_URL)
+    else:
       logging.debug('Stopping CNS server.')
       # Do not use process.kill(), it will not clean up cns.
       self.Kill(self._cns_process.pid)
       # Need to wait since the process logger has a lock on the process stderr.
       self._cns_process.wait()
       self.assertFalse(self._cns_process.returncode is None)
       logging.debug('CNS server stopped.')
+    pyauto.PyUITest.tearDown(self)
 
 
 class ProcessLogger(threading.Thread):
   """A thread to log a process's stderr output."""
 
   def __init__(self, process):
     """Starts the process logger thread.
 
     Args:
       process: The process to log.
@@ skipping 38 matching lines @@
   """
   # Convert relative test path into an absolute path.
   tasks = Queue.Queue()
   for file_name in test_media_files:
     for series_name, settings in network_constraints_settings:
       logging.debug('Add test: %s\tSettings: %s\tMedia: %s', series_name,
                     settings, file_name)
       tasks.put((series_name, settings, file_name))
 
   return tasks