2 from twisted.trial import unittest
3 from twisted.application import service
5 from foolscap import Tub, eventual
6 from foolscap.logging import log
8 from allmydata import storage
9 from allmydata.immutable import offloaded, upload
10 from allmydata import uri
11 from allmydata.util import hashutil, fileutil, mathutil
12 from pycryptopp.cipher.aes import AES
16 DATA = "I need help\n" * 1000
18 class CHKUploadHelper_fake(offloaded.CHKUploadHelper):
19 def start_encrypted(self, eu):
22 d2 = eu.get_all_encoding_parameters()
23 def _got_parms(parms):
24 needed_shares, happy, total_shares, segsize = parms
25 ueb_data = {"needed_shares": needed_shares,
26 "total_shares": total_shares,
27 "segment_size": segsize,
30 self._results.uri_extension_data = ueb_data
31 self._results.verifycapstr = uri.CHKFileVerifierURI(self._storage_index, "x"*32,
32 needed_shares, total_shares,
35 d2.addCallback(_got_parms)
37 d.addCallback(_got_size)
40 class CHKUploadHelper_already_uploaded(offloaded.CHKUploadHelper):
42 res = upload.UploadResults()
43 res.uri_extension_hash = hashutil.uri_extension_hash("")
45 # we're pretending that the file they're trying to upload was already
46 # present in the grid. We return some information about the file, so
47 # the client can decide if they like the way it looks. The parameters
48 # used here are chosen to match the defaults.
49 PARAMS = FakeClient.DEFAULT_ENCODING_PARAMETERS
50 ueb_data = {"needed_shares": PARAMS["k"],
51 "total_shares": PARAMS["n"],
52 "segment_size": min(PARAMS["max_segment_size"], len(DATA)),
55 res.uri_extension_data = ueb_data
58 class FakeClient(service.MultiService):
59 DEFAULT_ENCODING_PARAMETERS = {"k":25,
62 "max_segment_size": 1*MiB,
65 def log(self, *args, **kwargs):
66 return log.msg(*args, **kwargs)
67 def get_encoding_parameters(self):
68 return self.DEFAULT_ENCODING_PARAMETERS
69 def get_permuted_peers(self, service_name, storage_index):
72 def flush_but_dont_ignore(res):
73 d = eventual.flushEventualQueue()
79 def wait_a_few_turns(ignored=None):
80 d = eventual.fireEventually()
81 d.addCallback(eventual.fireEventually)
82 d.addCallback(eventual.fireEventually)
83 d.addCallback(eventual.fireEventually)
84 d.addCallback(eventual.fireEventually)
85 d.addCallback(eventual.fireEventually)
88 def upload_data(uploader, data, convergence):
89 u = upload.Data(data, convergence=convergence)
90 return uploader.upload(u)
92 class AssistedUpload(unittest.TestCase):
98 t.setServiceParent(self.s)
100 # we never actually use this for network traffic, so it can use a
102 t.setLocation("bogus:1234")
104 def setUpHelper(self, basedir):
105 fileutil.make_dirs(basedir)
106 self.helper = h = offloaded.Helper(basedir)
107 h.chk_upload_helper_class = CHKUploadHelper_fake
108 h.setServiceParent(self.s)
109 self.helper_furl = self.tub.registerReference(h)
112 d = self.s.stopService()
113 d.addCallback(eventual.fireEventually)
114 d.addBoth(flush_but_dont_ignore)
119 self.basedir = "helper/AssistedUpload/test_one"
120 self.setUpHelper(self.basedir)
121 u = upload.Uploader(self.helper_furl)
122 u.setServiceParent(self.s)
124 d = wait_a_few_turns()
129 return upload_data(u, DATA, convergence="some convergence string")
130 d.addCallback(_ready)
131 def _uploaded(results):
132 the_uri = results.uri
133 assert "CHK" in the_uri
134 d.addCallback(_uploaded)
136 def _check_empty(res):
137 files = os.listdir(os.path.join(self.basedir, "CHK_encoding"))
138 self.failUnlessEqual(files, [])
139 files = os.listdir(os.path.join(self.basedir, "CHK_incoming"))
140 self.failUnlessEqual(files, [])
141 d.addCallback(_check_empty)
145 def test_previous_upload_failed(self):
146 self.basedir = "helper/AssistedUpload/test_previous_upload_failed"
147 self.setUpHelper(self.basedir)
149 # we want to make sure that an upload which fails (leaving the
150 # ciphertext in the CHK_encoding/ directory) does not prevent a later
151 # attempt to upload that file from working. We simulate this by
152 # populating the directory manually. The hardest part is guessing the
155 k = FakeClient.DEFAULT_ENCODING_PARAMETERS["k"]
156 n = FakeClient.DEFAULT_ENCODING_PARAMETERS["n"]
157 max_segsize = FakeClient.DEFAULT_ENCODING_PARAMETERS["max_segment_size"]
158 segsize = min(max_segsize, len(DATA))
159 # this must be a multiple of 'required_shares'==k
160 segsize = mathutil.next_multiple(segsize, k)
162 key = hashutil.convergence_hash(k, n, segsize, DATA, "test convergence string")
163 assert len(key) == 16
165 SI = hashutil.storage_index_hash(key)
166 SI_s = storage.si_b2a(SI)
167 encfile = os.path.join(self.basedir, "CHK_encoding", SI_s)
168 f = open(encfile, "wb")
169 f.write(encryptor.process(DATA))
172 u = upload.Uploader(self.helper_furl)
173 u.setServiceParent(self.s)
175 d = wait_a_few_turns()
179 return upload_data(u, DATA, convergence="test convergence string")
180 d.addCallback(_ready)
181 def _uploaded(results):
182 the_uri = results.uri
183 assert "CHK" in the_uri
184 d.addCallback(_uploaded)
186 def _check_empty(res):
187 files = os.listdir(os.path.join(self.basedir, "CHK_encoding"))
188 self.failUnlessEqual(files, [])
189 files = os.listdir(os.path.join(self.basedir, "CHK_incoming"))
190 self.failUnlessEqual(files, [])
191 d.addCallback(_check_empty)
195 def test_already_uploaded(self):
196 self.basedir = "helper/AssistedUpload/test_already_uploaded"
197 self.setUpHelper(self.basedir)
198 self.helper.chk_upload_helper_class = CHKUploadHelper_already_uploaded
199 u = upload.Uploader(self.helper_furl)
200 u.setServiceParent(self.s)
202 d = wait_a_few_turns()
207 return upload_data(u, DATA, convergence="some convergence string")
208 d.addCallback(_ready)
209 def _uploaded(results):
210 the_uri = results.uri
211 assert "CHK" in the_uri
212 d.addCallback(_uploaded)
214 def _check_empty(res):
215 files = os.listdir(os.path.join(self.basedir, "CHK_encoding"))
216 self.failUnlessEqual(files, [])
217 files = os.listdir(os.path.join(self.basedir, "CHK_incoming"))
218 self.failUnlessEqual(files, [])
219 d.addCallback(_check_empty)