initial commit
[leap_pycommon.git] / src / leap / common / testing / https_server.py
1 # -*- coding: utf-8 -*-
2 # leap.common.testing.https_server.py
3 # Copyright (C) 2013 LEAP
4 #
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation, either version 3 of the License, or
8 # (at your option) any later version.
9 #
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 """
18 A simple HTTPS server to be used in tests
19 """
20 from BaseHTTPServer import HTTPServer
21 import os
22 import ssl
23 import SocketServer
24 import threading
25 import unittest
26
27 _where = os.path.split(__file__)[0]
28
29
30 def where(filename):
31     return os.path.join(_where, filename)
32
33
34 class HTTPSServer(HTTPServer):
35     def server_bind(self):
36         SocketServer.TCPServer.server_bind(self)
37         self.socket = ssl.wrap_socket(
38             self.socket, server_side=True,
39             certfile=where("leaptestscert.pem"),
40             keyfile=where("leaptestskey.pem"),
41             ca_certs=where("cacert.pem"),
42             ssl_version=ssl.PROTOCOL_SSLv23)
43
44
45 class TestServerThread(threading.Thread):
46     def __init__(self, test_object, request_handler):
47         threading.Thread.__init__(self)
48         self.request_handler = request_handler
49         self.test_object = test_object
50
51     def run(self):
52         self.server = HTTPSServer(('localhost', 0), self.request_handler)
53         host, port = self.server.socket.getsockname()
54         self.test_object.HOST, self.test_object.PORT = host, port
55         self.test_object.server_started.set()
56         self.test_object = None
57         try:
58             self.server.serve_forever(0.05)
59         finally:
60             self.server.server_close()
61
62     def stop(self):
63         self.server.shutdown()
64
65
66 class BaseHTTPSServerTestCase(unittest.TestCase):
67     """
68     derived classes need to implement a request_handler
69     """
70     def setUp(self):
71         self.server_started = threading.Event()
72         self.thread = TestServerThread(self, self.request_handler)
73         self.thread.start()
74         self.server_started.wait()
75
76     def tearDown(self):
77         self.thread.stop()
78
79     def get_server(self):
80         host, port = self.HOST, self.PORT
81         if host == "127.0.0.1":
82             host = "localhost"
83         return "%s:%s" % (host, port)
84
85
86 if __name__ == "__main__":
87     unittest.main()