Issue 7019 - [CMS] Refactor `test_server.py`

tests/test_page_outputs.py

 import os
 import sys
 import runpy
-from threading import Thread
 
 import mock
 import pytest
-import urllib2
 
 from .conftest import ROOTPATH
-from .utils import get_dir_contents, run_test_server
+from .utils import get_dir_contents, exception_test
 from cms.sources import FileSource
-import cms.bin.test_server as test_server
-
-
-class ParametersTestServer:
-    def __init__(self):
-        pass
-    source = None
-    host = 'localhost'
-    port = 5001
-    base_url = 'http://{0}:{1}/'.format(host, port)
+from cms.bin.test_server import DynamicServerHandler
 
 
 def get_expected_outputs(test_type):
     expected_out_path = os.path.join(ROOTPATH, 'tests', 'expected_output')
     outputs = get_dir_contents(expected_out_path)
     for filename in list(outputs):
         # Move test-type-specific expected outputs (e.g. "xyz@static" -> "xyz")
         # There are cases where we need to test outputs which differ depending
         # on how they are generated; either statically or dynamically
         if filename.endswith('@' + test_type):
@@ skipping 12 matching lines @@
 @pytest.fixture(scope='session')
 def static_output(request, temp_site):
     static_out_path = os.path.join(temp_site, 'static_out')
     sys.argv = ['filler', temp_site, static_out_path]
     with mock.patch('cms.sources.FileSource.version', 1):
         runpy.run_module('cms.bin.generate_static_pages', run_name='__main__')
     return static_out_path
 
 
 @pytest.fixture(scope='session')
-def dynamic_server(temp_site):
-    with run_test_server(temp_site) as ts:
-        yield ts
-
-
-@pytest.fixture(scope='function')
-def dynamic_server_failing_import(temp_site, monkeypatch):

[Vasily Kuznetsov, 2018/10/16 13:18:23]

This fixture should probably just be called `dynamic_builtins_server` or
something like that since we're not doing the failing import thingie anymore.

[Tudor Avram, 2018/10/18 13:44:05]

Done.

-
-    mock_params = ParametersTestServer()
-    mock_params.source = FileSource(str(temp_site))
-
-    test_server.Parameters = mock_params
-
-    run_fn = test_server.make_builtins_server()
-
-    thread = Thread(target=run_fn, args=(mock_params.host, mock_params.port,
-                                         test_server.handler),
-                    kwargs={'use_reloader': True, 'use_debugger': True})
-    thread.daemon = True
-    thread.start()
-
-    yield mock_params.base_url
-
-    monkeypatch.setattr(test_server, 'get_data', lambda x: sys.exit())
-    with pytest.raises(urllib2.HTTPError):
-        urllib2.urlopen(mock_params.base_url + 'some_page')

[Vasily Kuznetsov, 2018/10/16 13:18:23]

I think it would be better to join the thread here, just to make sure it ends as
we expect.

[Tudor Avram, 2018/10/18 13:44:05]

No longer relevant

-
-
-@pytest.fixture(scope='session')
 def output_pages(static_output):
     return get_dir_contents(static_output)
 
 
 @pytest.mark.parametrize('filename,expected_output', static_expected_outputs)
 def test_static(output_pages, filename, expected_output):
     if expected_output.startswith('## MISSING'):
         assert filename not in output_pages
     else:
         assert expected_output == output_pages[filename]
 
 
-@pytest.mark.parametrize('filename,expected_output', dynamic_expected_outputs)
-def test_dynamic(dynamic_server, filename, expected_output):
-    response = urllib2.urlopen(dynamic_server + filename)
-    assert expected_output == response.read().strip()
-
-
 def test_cache(output_pages):
     source = FileSource(os.path.join('test_site'))
     assert source.get_cache_dir() == os.path.join('test_site', 'cache')
 
 
-def test_dynamic_builtins(dynamic_server_failing_import):
-    page, expected_output = dynamic_expected_outputs[0]
+@pytest.mark.parametrize('filename,expected_output', dynamic_expected_outputs)
+def test_dynamic_server_handler(filename, expected_output, temp_site):
+    def cleanup(page):
+        return page.replace(os.linesep, '').strip()
 
-    response = urllib2.urlopen(dynamic_server_failing_import + page)
+    handler = DynamicServerHandler('localhost', 5000, str(temp_site))
+    environ = {'PATH_INFO': filename}
 
-    assert expected_output in response.read().strip()
+    generated_page = handler(environ, lambda x, y: None)
+
+    assert cleanup(expected_output) == cleanup(generated_page[0])
+
+
+@pytest.mark.parametrize('page', ['en/translate', '/en/translate'])
+def test_dynamic_server_handler_with_conflicts(page, temp_site_with_conflicts):
+    handler = DynamicServerHandler('localhost', 5000,
+                                   str(temp_site_with_conflicts))
+    environ = {'PATH_INFO': page}
+    exp_msg = 'The requested page conflicts with another page.'
+
+    exception_test(handler, Exception, exp_msg, environ, lambda x, y: None)