Merge lp:~coreygoldberg/selenium-simple-test/selftest-server-port2 into lp:selenium-simple-test

[Corey Goldberg]

default django devserver port changed to 8120 and better error handling

default port is now: 8120
if port is in use, it quits with less cryptic "port is in use" error.

[lp:~coreygoldberg/selenium-simple-test/selftest-server-port2]

375. By Corey Goldberg on 2013-04-11

added back missing import

376. By Corey Goldberg on 2013-04-11

fixed whitespace

[Vincent Ladeuil (vila)]

Could you please use DEVSERVERPORT everywhere instead of using the hardcoded 8120 value ? Otherwise changing that value in sst/__init__.py won't make the tests pass.

While there, I think we would even want to use an URL instead of just the port so that we won't have to redo the same work if something similar happen with the hostname.

80 + for desc, cmd, arg in cleanups:

This forces all users to add a needless 'None' parameter when using cleanups while not allowing several parameters to be used if needed. I would rather use cmd(*args) below:

 88 + cmd(arg)

this will also clarify the proposal by avoiding the added parameter for code not directly related to this fix.

204 +def check_devserver_port_used(port):
205 + """check if port is ok to use for django devserver"""

This relies on django using the same SO_REUSEADDR trick, I think it's worth a comment.

Alternatively, you could check that the django server itself is properly running by checking a specific url defined for that purpose in our test application.

review: Needs Fixing

[lp:~coreygoldberg/selenium-simple-test/selftest-server-port2]

377. By Corey Goldberg on 2013-04-11

fix per MP review. paramaterized acceptance test with DEVSERVER_PORT

378. By Corey Goldberg on 2013-04-11

fixed hardcoded devserver ports in acceptance tests

[Corey Goldberg (coreygoldberg)]

fixed per review comments.
also found more hardcoded ports in acceptance tests and fixed (all or converted to parameter for port now).

all unit and acceptance tests run clean.

review: Needs Resubmitting

[lp:~coreygoldberg/selenium-simple-test/selftest-server-port2]

379. By Corey Goldberg on 2013-04-11

fixed port parameters for deverserver in unit test

[Vincent Ladeuil (vila)]

Far better, let's land this.

review: Approve

[Corey Goldberg (coreygoldberg)]

review: Approve

[Corey Goldberg (coreygoldberg)]

landing it now. thanks vila!

=== modified file 'src/sst/__init__.py'
--- src/sst/__init__.py	2013-01-24 06:02:56 +0000
+++ src/sst/__init__.py	2013-04-11 14:32:21 +0000
@@ -19,3 +19,5 @@
 
 
 __version__ = '0.2.3dev'
+
+DEVSERVER_PORT = '8120'  # django devserver for internal acceptance tests

=== modified file 'src/sst/actions.py'
--- src/sst/actions.py	2013-04-09 16:07:17 +0000
+++ src/sst/actions.py	2013-04-11 14:32:21 +0000
@@ -62,7 +62,7 @@
 
 from sst import config
 from sst import bmobproxy
-
+from sst import DEVSERVER_PORT
 
 __all__ = [
     'accept_alert', 'add_cleanup', 'assert_attribute', 'assert_button',
@@ -96,7 +96,7 @@
 _check_flags = True
 _test = None
 
-BASE_URL = 'http://localhost:8000/'
+BASE_URL = 'http://localhost:%s/' % DEVSERVER_PORT 
 __DEFAULT_BASE_URL__ = BASE_URL
 
 logger = logging.getLogger('SST')

=== modified file 'src/sst/scripts/run.py'
--- src/sst/scripts/run.py	2013-03-19 02:55:05 +0000
+++ src/sst/scripts/run.py	2013-04-11 14:32:21 +0000
@@ -29,7 +29,7 @@
 import urllib
 
 import sst
-from sst import runtests
+from sst import runtests, tests
 from sst.command import get_opts_run, clear_old_results
 
 
@@ -55,8 +55,13 @@
 
     if cmd_opts.run_tests:
         cmd_opts.dir_name = 'selftests'
-        run_django()
-        cleanups.append(('\nkilling django...', kill_django))
+        if not tests.check_devserver_port_used(sst.DEVSERVER_PORT):
+            run_django(sst.DEVSERVER_PORT)
+            cleanups.append(('\nkilling django...', kill_django, sst.DEVSERVER_PORT))
+        else:
+            print 'Error: port is in use.'
+            print 'can not launch devserver for internal tests.'
+            sys.exit(1)
 
     if cmd_opts.xserver_headless:
         from sst.xvfbdisplay import Xvfb
@@ -100,19 +105,22 @@
     finally:
 
         print '--------------------------------------------------------------'
-        for desc, cmd in cleanups:
-            # Run cleanups, displaying but not propagating exceptions
+        for cleanup in cleanups:
+            # run cleanups, displaying but not propagating exceptions
+            desc = cleanup[0]
+            cmd = cleanup[1]
+            args = cleanup[2:]
+            print desc
             try:
-                print desc
-                cmd()
+                cmd(*args)
             except Exception:
                 print traceback.format_exc()
 
 
-def run_django():
+def run_django(port):
     """Start django server for running local self-tests."""
     manage_file = './src/testproject/manage.py'
-    url = 'http://localhost:8000/'
+    url = 'http://localhost:%s/' % port
 
     if not os.path.isfile(manage_file):
         print 'Error: can not find the django testproject.'
@@ -125,7 +133,7 @@
         print 'Error: can not find django module.'
         print 'you must have django installed to run the test project.'
         sys.exit(1)
-    subprocess.Popen([manage_file, 'runserver'],
+    proc = subprocess.Popen([manage_file, 'runserver', port],
                      stderr=open(os.devnull, 'w'),
                      stdout=open(os.devnull, 'w')
                      )
@@ -143,11 +151,12 @@
                 print 'Error: can not get response from %r' % url
                 raise
     print 'django found. continuing...'
-
-
-def kill_django():
+    return proc
+
+
+def kill_django(port):
     try:
-        urllib.urlopen('http://localhost:8000/kill_django')
+        urllib.urlopen('http://localhost:%s/kill_django' % port)
     except IOError:
         pass
 

=== modified file 'src/sst/selftests/assert_urls.py'
--- src/sst/selftests/assert_urls.py	2013-04-08 14:50:11 +0000
+++ src/sst/selftests/assert_urls.py	2013-04-11 14:32:21 +0000
@@ -1,27 +1,27 @@
 from sst.actions import *
+from sst import DEVSERVER_PORT
+
 from urlparse import urlparse
 
 
-assert_equal(get_base_url(), 'http://localhost:8000/')
-
 # haven't visited a url yet, so all assert_url* fail
-fails(assert_url, 'http://localhost:8000/')
+fails(assert_url, 'http://localhost:%s/' % DEVSERVER_PORT)
 fails(assert_url_contains, 'localhost')
 fails(assert_url_network_location, 'localhost')
 
 # now visit a url and test assertions
-go_to('/begin')
+go_to('%sbegin' % get_base_url())
 
 assert_url('/begin')
 assert_url('/begin/')
 assert_url('begin/')
-assert_url('http://localhost:8000/begin')
-assert_url('http://localhost:8000/begin/')
+assert_url('http://localhost:%s/begin' % DEVSERVER_PORT)
+assert_url('http://localhost:%s/begin/' % DEVSERVER_PORT)
 assert_url(urlparse('http://wrongurl/begin').path)
 fails(assert_url, 'http://wrongurl/begin')
 
-assert_url_contains('http://localhost:8000/begin')
-assert_url_contains('localhost:8000')
+assert_url_contains('http://localhost:%s/begin' % DEVSERVER_PORT)
+assert_url_contains('localhost:%s' % DEVSERVER_PORT)
 assert_url_contains('.*/begin', regex=True)
 assert_url_contains('http://.*/begin', regex=True)
 assert_url_contains('.*//localhost', regex=True)
@@ -29,14 +29,14 @@
 fails(assert_url_contains, 'foobar')
 fails(assert_url_contains, 'foobar', regex=True)
 
-assert_url_network_location('localhost:8000')
+assert_url_network_location('localhost:%s' % DEVSERVER_PORT)
 fails(assert_url_network_location, 'localhost')
 fails(assert_url_network_location, '')
 
 # visit url with query strings and fragments, then test assertions
 go_to('/begin?query_string#fragment_id')
 
-assert_url('http://localhost:8000/begin?query_string#fragment_id')
+assert_url('http://localhost:%s/begin?query_string#fragment_id' % DEVSERVER_PORT)
 assert_url('/begin?query_string#fragment_id')
 fails(assert_url, '/begin')
-fails(assert_url, 'http://localhost:8000/begin')
+fails(assert_url, 'http://localhost:%s/begin' % DEVSERVER_PORT)

=== modified file 'src/sst/selftests/current_url.py'
--- src/sst/selftests/current_url.py	2012-08-27 14:49:57 +0000
+++ src/sst/selftests/current_url.py	2013-04-11 14:32:21 +0000
@@ -1,13 +1,14 @@
 from sst.actions import *
+from sst import DEVSERVER_PORT
 
 go_to('/')
 url = get_current_url()
 base_url = get_base_url()
-assert_equal(base_url, 'http://localhost:8000/')
-assert_equal(url, 'http://localhost:8000/')
+assert_equal(base_url, 'http://localhost:%s/' % DEVSERVER_PORT)
+assert_equal(url, 'http://localhost:%s/' % DEVSERVER_PORT)
 
 go_to('/begin')
 url = get_current_url()
 base_url = get_base_url()
-assert_equal(base_url, 'http://localhost:8000/')
-assert_equal(url, 'http://localhost:8000/begin')
+assert_equal(base_url, 'http://localhost:%s/' % DEVSERVER_PORT)
+assert_equal(url, 'http://localhost:%s/begin' % DEVSERVER_PORT)

=== modified file 'src/sst/selftests/html5.py'
--- src/sst/selftests/html5.py	2011-12-07 19:35:25 +0000
+++ src/sst/selftests/html5.py	2013-04-11 14:32:21 +0000
@@ -1,4 +1,5 @@
 from sst.actions import *
+from sst import DEVSERVER_PORT
 
 go_to('/html5')
 
@@ -6,7 +7,7 @@
 write_textfield('email', '[e-mail]', check=True)
 
 assert_textfield('url')
-write_textfield('url', 'http://localhost:8000', check=True)
+write_textfield('url', 'http://localhost:%s' % DEVSERVER_PORT, check=True)
 
 assert_textfield('search')
 write_textfield('search', 'something', check=True)

=== modified file 'src/sst/selftests/title.py'
--- src/sst/selftests/title.py	2012-08-27 16:11:28 +0000
+++ src/sst/selftests/title.py	2013-04-11 14:32:21 +0000
@@ -1,4 +1,5 @@
 from sst.actions import *
+from sst import DEVSERVER_PORT
 
 # tests go_to, assert_url, assert_title, set_base_url
 # reset_base_url, get_base_url
@@ -15,24 +16,24 @@
 assert_title_contains('.*Pag[E|e]', regex=True)
 fails(assert_title_contains, 'foobar')
 
-set_base_url('localhost:8000')
-assert get_base_url() == 'http://localhost:8000'
+set_base_url('localhost:%s' % DEVSERVER_PORT)
+assert get_base_url() == 'http://localhost:%s' % DEVSERVER_PORT
 
-set_base_url('http://localhost:8000/')
-assert get_base_url() == 'http://localhost:8000/'
+set_base_url('http://localhost:%s/' % DEVSERVER_PORT)
+assert get_base_url() == 'http://localhost:%s/' % DEVSERVER_PORT
 go_to('/')
 
 # assert_url adds the base url for relative urls
 # so test both ways
-assert_url('http://localhost:8000/')
+assert_url('http://localhost:%s/' % DEVSERVER_PORT)
 assert_url('/')
 
 fails(assert_url, '/begin/')
 
 reset_base_url()
-assert get_base_url() == 'http://localhost:8000/'
+assert get_base_url() == 'http://localhost:%s/' % DEVSERVER_PORT
 go_to('/')
-assert_url('http://localhost:8000/')
+assert_url('http://localhost:%s/' % DEVSERVER_PORT)
 
 # assert_url works also without the trailing slash
-assert_url('http://localhost:8000')
+assert_url('http://localhost:%s' % DEVSERVER_PORT)

=== modified file 'src/sst/tests/__init__.py'
--- src/sst/tests/__init__.py	2013-01-24 06:16:28 +0000
+++ src/sst/tests/__init__.py	2013-04-11 14:32:21 +0000
@@ -18,6 +18,7 @@
 
 import os
 import shutil
+import socket
 import tempfile
 
 from sst import runtests
@@ -45,3 +46,18 @@
     current_dir = os.getcwdu()
     test.addCleanup(os.chdir, current_dir)
     os.chdir(test.test_base_dir)
+
+
+def check_devserver_port_used(port):
+    """check if port is ok to use for django devserver"""
+    sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+    # immediately reuse a local socket in TIME_WAIT state
+    sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+    try:
+        sock.bind(('127.0.0.1', int(port)))
+        used = False
+    except socket.error as e:
+        used = True
+    finally:
+        sock.close()
+    return used

=== added file 'src/sst/tests/test_django_devserver.py'
--- src/sst/tests/test_django_devserver.py	1970-01-01 00:00:00 +0000
+++ src/sst/tests/test_django_devserver.py	2013-04-11 14:32:21 +0000
@@ -0,0 +1,44 @@
+#
+#   Copyright (c) 2013 Canonical Ltd.
+#
+#   This file is part of: SST (selenium-simple-test)
+#   https://launchpad.net/selenium-simple-test
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+#
+
+
+import testtools
+
+from sst.scripts import run
+from sst.tests import check_devserver_port_used
+from sst import DEVSERVER_PORT
+
+
+class TestDjangoDevServer(testtools.TestCase):
+
+    def test_django_start(self):
+        self.addCleanup(run.kill_django, DEVSERVER_PORT)
+        proc = run.run_django(DEVSERVER_PORT)
+        self.assertIsNotNone(proc)
+
+
+    def test_django_devserver_port_used(self):
+        used = check_devserver_port_used(DEVSERVER_PORT)
+        self.assertFalse(used)
+        
+        self.addCleanup(run.kill_django, DEVSERVER_PORT)
+        run.run_django(DEVSERVER_PORT)
+        
+        used = check_devserver_port_used(DEVSERVER_PORT)
+        self.assertTrue(used)