annotate wibble/client/ServerProxy.py @ 4:ad5a8748afcf

Add test framework
author Ben Croston <ben@croston.org>
date Wed, 31 Aug 2011 21:35:14 +0100
parents client/ServerProxy2.py@c7a236de5214
children f5e3ba8cfcd0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
ad5a8748afcf Add test framework
Ben Croston <ben@croston.org>
parents: 2
diff changeset
1 #!/usr/bin/env python
0
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
2 from uuid import uuid4
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
3 from urlparse import urlparse
4
ad5a8748afcf Add test framework
Ben Croston <ben@croston.org>
parents: 2
diff changeset
4 import json
0
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
5 import httplib
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
6 import copy
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
7 import socket
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
8 import hashlib
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
9
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
10 class _Method(object):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
11 def __init__(self, call, name, username=None, password=None):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
12 self.call = call
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
13 self.name = name
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
14 self._username = username
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
15 self._password = password
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
16
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
17 def __call__(self, *args, **kwargs):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
18 request = {}
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
19 request['id'] = str(uuid4())
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
20 request['method'] = self.name
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
21
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
22 if len(kwargs) is not 0:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
23 params = copy.copy(kwargs)
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
24 index = 0
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
25 for arg in args:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
26 params[str(index)] = arg
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
27 index = index + 1
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
28 elif len(args) is not 0:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
29 params = copy.copy(args)
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
30 else:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
31 params = None
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
32 request['params'] = params
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
33
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
34 if self._username is not None:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
35 request['username'] = self._username
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
36 if self._password is not None:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
37 request['password'] = hashlib.md5(self._password).hexdigest()
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
38
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
39 resp = self.call(json.dumps(request))
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
40 if resp is not None and resp['error'] is None and resp['id'] == request['id']:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
41 return resp['result']
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
42 else:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
43 raise Exception('This is not supposed to happen -- btc') ########
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
44
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
45 def __getattr__(self, name):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
46 return _Method(self.call, "%s.%s" % (self.name, name), self._username, self._password)
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
47
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
48 class _JSONRPCTransport(object):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
49 headers = {'Content-Type':'application/json',
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
50 'Accept':'application/json'}
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
51
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
52 def __init__(self, uri, proxy_uri=None, user_agent=None):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
53 self.headers['User-Agent'] = user_agent if user_agent is not None else 'jsonrpclib'
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
54 if proxy_uri is not None:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
55 self.connection_url = urlparse(proxy_uri)
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
56 self.request_path = uri
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
57 else:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
58 self.connection_url = urlparse(uri)
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
59 self.request_path = self.connection_url.path
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
60
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
61 def request(self, request_body):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
62 if self.connection_url.scheme == 'http':
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
63 if self.connection_url.port is None:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
64 port = 80
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
65 else:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
66 port = self.connection_url.port
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
67 connection = httplib.HTTPConnection(self.connection_url.hostname+':'+str(port))
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
68 elif self.connection_url.scheme == 'https':
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
69 if self.connection_url.port is None:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
70 port = 443
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
71 else:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
72 port = self.connection_url.port
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
73 connection = httplib.HTTPSConnection(self.connection_url.hostname+':'+str(port))
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
74 else:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
75 raise Exception('unsupported transport')
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
76 connection.request('POST', self.request_path, body=request_body, headers=self.headers)
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
77 return connection.getresponse()
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
78
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
79 class BadRequestException(Exception):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
80 """HTTP 400 - Bad Request"""
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
81 def __init__(self):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
82 Exception.__init__(self,'HTTP 400 - Bad Request')
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
83
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
84 class UnauthorisedException(Exception):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
85 """HTTP 401 - Unauthorised"""
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
86 def __init__(self):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
87 Exception.__init__(self,'HTTP 401 - Unauthorised')
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
88
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
89 class ForbiddenException(Exception):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
90 """HTTP 403 - Forbidden"""
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
91 def __init__(self):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
92 Exception.__init__(self,'HTTP 403 - Forbidden')
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
93
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
94 class NotFoundException(Exception):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
95 """HTTP 404 - Not Found"""
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
96 def __init__(self):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
97 Exception.__init__(self,'HTTP 404 - Not Found')
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
98
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
99 class NetworkSocketException(Exception):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
100 def __init__(self):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
101 Exception.__init__(self,'Network socket exception')
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
102
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
103 class BadGatewayException(Exception):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
104 """HTTP 502 - Bad Gateway"""
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
105 def __init__(self):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
106 Exception.__init__(self,'HTTP 502 - Bad Gateway')
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
107
4
ad5a8748afcf Add test framework
Ben Croston <ben@croston.org>
parents: 2
diff changeset
108 class ServerProxy(object):
0
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
109 def __init__(self, uri=None, transport=None, proxy_uri=None, user_agent=None, username=None, password=None):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
110 if uri is None and transport is None:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
111 raise Exception('either uri or transport needs to be specified')
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
112
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
113 if transport is None:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
114 transport = _JSONRPCTransport(uri, proxy_uri=proxy_uri, user_agent=user_agent)
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
115 self.__transport = transport
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
116 self._username = username
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
117 self._password = password
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
118
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
119 def __request(self, request):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
120 # call a method on the remote server
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
121 try:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
122 response = self.__transport.request(request)
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
123 except socket.error:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
124 raise NetworkSocketException
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
125 if response.status == 200:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
126 return json.loads(response.read())
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
127 elif response.status == 400:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
128 raise BadRequestException
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
129 elif response.status == 401:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
130 raise UnauthorisedException
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
131 elif response.status == 403:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
132 raise ForbiddenException
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
133 elif response.status == 404:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
134 raise NotFoundException
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
135 elif response.status == 500:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
136 msg = json.loads(response.read())
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
137 raise Exception('JSONRPCError\n%s'%msg['error']['error'])
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
138 elif response.status == 502:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
139 raise BadGatewayException
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
140 else:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
141 raise Exception('HTTP Status %s'%response.status)
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
142
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
143 def __repr__(self):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
144 return (
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
145 "<ServerProxy for %s%s>" %
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
146 (self.__host, self.__handler)
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
147 )
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
148
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
149 __str__ = __repr__
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
150
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
151 def __getattr__(self, name):
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
152 # magic method dispatcher
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
153 return _Method(self.__request, name, self._username, self._password)
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
154
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
155 if __name__ == '__main__':
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
156 ##### btc fixme
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
157 jsonrpc_client = ServerProxy2('http://localhost:1337/', username='testuser', password='', user_agent='Py2NotInternetExploiter')
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
158 #jsonrpc_client = ServerProxy2('https://www.croston.org/test/index.py',
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
159 # username='testuser',
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
160 # password='',
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
161 # user_agent='Py2NotInternetExploiter')
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
162 assert jsonrpc_client.api.mymethod() == jsonrpc_client.mymethod()
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
163 try:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
164 print(jsonrpc_client.wibble('this should fail'))
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
165 except BadRequestException:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
166 pass # test passed
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
167 else:
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
168 raise Exception('Test failed (calling unknown method)')
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
169
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
170 print 'All tests passed'
6a61cfdf6930 Initial version
Ben Croston <ben@croston.org>
parents:
diff changeset
171