src/allmydata/test/test_helper.py

   1 import os
   2 from twisted.internet import defer
   3 from twisted.trial import unittest
   4 from twisted.application import service
   5
   6 from foolscap.api import Tub, fireEventually, flushEventualQueue
   7
   8 from allmydata.storage.server import si_b2a
   9 from allmydata.storage_client import StorageFarmBroker
  10 from allmydata.immutable import offloaded, upload
  11 from allmydata import uri, client
  12 from allmydata.util import hashutil, fileutil, mathutil
  13 from pycryptopp.cipher.aes import AES
  14
  15 MiB = 1024*1024
  16
  17 DATA = "I need help\n" * 1000
  18
  19 class CHKUploadHelper_fake(offloaded.CHKUploadHelper):
  20     def start_encrypted(self, eu):
  21         d = eu.get_size()
  22         def _got_size(size):
  23             d2 = eu.get_all_encoding_parameters()
  24             def _got_parms(parms):
  25                 # just pretend we did the upload
  26                 needed_shares, happy, total_shares, segsize = parms
  27                 ueb_data = {"needed_shares": needed_shares,
  28                             "total_shares": total_shares,
  29                             "segment_size": segsize,
  30                             "size": size,
  31                             }
  32                 ueb_hash = "fake"
  33                 v = uri.CHKFileVerifierURI(self._storage_index, "x"*32,
  34                                            needed_shares, total_shares, size)
  35                 _UR = upload.UploadResults
  36                 ur = _UR(file_size=size,
  37                          ciphertext_fetched=0,
  38                          preexisting_shares=0,
  39                          pushed_shares=total_shares,
  40                          sharemap={},
  41                          servermap={},
  42                          timings={},
  43                          uri_extension_data=ueb_data,
  44                          uri_extension_hash=ueb_hash,
  45                          verifycapstr=v.to_string())
  46                 self._upload_status.set_results(ur)
  47                 return ur
  48             d2.addCallback(_got_parms)
  49             return d2
  50         d.addCallback(_got_size)
  51         return d
  52
  53 class Helper_fake_upload(offloaded.Helper):
  54     def _make_chk_upload_helper(self, storage_index, lp):
  55         si_s = si_b2a(storage_index)
  56         incoming_file = os.path.join(self._chk_incoming, si_s)
  57         encoding_file = os.path.join(self._chk_encoding, si_s)
  58         uh = CHKUploadHelper_fake(storage_index, self,
  59                                   self._storage_broker,
  60                                   self._secret_holder,
  61                                   incoming_file, encoding_file,
  62                                   lp)
  63         return uh
  64
  65 class Helper_already_uploaded(Helper_fake_upload):
  66     def _check_chk(self, storage_index, lp):
  67         res = upload.HelperUploadResults()
  68         res.uri_extension_hash = hashutil.uri_extension_hash("")
  69
  70         # we're pretending that the file they're trying to upload was already
  71         # present in the grid. We return some information about the file, so
  72         # the client can decide if they like the way it looks. The parameters
  73         # used here are chosen to match the defaults.
  74         PARAMS = FakeClient.DEFAULT_ENCODING_PARAMETERS
  75         ueb_data = {"needed_shares": PARAMS["k"],
  76                     "total_shares": PARAMS["n"],
  77                     "segment_size": min(PARAMS["max_segment_size"], len(DATA)),
  78                     "size": len(DATA),
  79                     }
  80         res.uri_extension_data = ueb_data
  81         return defer.succeed(res)
  82
  83 class FakeClient(service.MultiService):
  84     DEFAULT_ENCODING_PARAMETERS = {"k":25,
  85                                    "happy": 75,
  86                                    "n": 100,
  87                                    "max_segment_size": 1*MiB,
  88                                    }
  89
  90     def get_encoding_parameters(self):
  91         return self.DEFAULT_ENCODING_PARAMETERS
  92
  93 def flush_but_dont_ignore(res):
  94     d = flushEventualQueue()
  95     def _done(ignored):
  96         return res
  97     d.addCallback(_done)
  98     return d
  99
 100 def wait_a_few_turns(ignored=None):
 101     d = fireEventually()
 102     d.addCallback(fireEventually)
 103     d.addCallback(fireEventually)
 104     d.addCallback(fireEventually)
 105     d.addCallback(fireEventually)
 106     d.addCallback(fireEventually)
 107     return d
 108
 109 def upload_data(uploader, data, convergence):
 110     u = upload.Data(data, convergence=convergence)
 111     return uploader.upload(u)
 112
 113 class AssistedUpload(unittest.TestCase):
 114     timeout = 240 # It takes longer than 120 seconds on Francois's arm box.
 115     def setUp(self):
 116         self.s = FakeClient()
 117         self.storage_broker = StorageFarmBroker(None, True)
 118         self.secret_holder = client.SecretHolder("lease secret", "convergence")
 119         self.s.startService()
 120
 121         self.tub = t = Tub()
 122         t.setOption("expose-remote-exception-types", False)
 123         t.setServiceParent(self.s)
 124         self.s.tub = t
 125         # we never actually use this for network traffic, so it can use a
 126         # bogus host/port
 127         t.setLocation("bogus:1234")
 128
 129     def setUpHelper(self, basedir, helper_class=Helper_fake_upload):
 130         fileutil.make_dirs(basedir)
 131         self.helper = h = helper_class(basedir,
 132                                        self.storage_broker,
 133                                        self.secret_holder,
 134                                        None, None)
 135         self.helper_furl = self.tub.registerReference(h)
 136
 137     def tearDown(self):
 138         d = self.s.stopService()
 139         d.addCallback(fireEventually)
 140         d.addBoth(flush_but_dont_ignore)
 141         return d
 142
 143
 144     def test_one(self):
 145         self.basedir = "helper/AssistedUpload/test_one"
 146         self.setUpHelper(self.basedir)
 147         u = upload.Uploader(self.helper_furl)
 148         u.setServiceParent(self.s)
 149
 150         d = wait_a_few_turns()
 151
 152         def _ready(res):
 153             assert u._helper
 154
 155             return upload_data(u, DATA, convergence="some convergence string")
 156         d.addCallback(_ready)
 157         def _uploaded(results):
 158             the_uri = results.uri
 159             assert "CHK" in the_uri
 160         d.addCallback(_uploaded)
 161
 162         def _check_empty(res):
 163             files = os.listdir(os.path.join(self.basedir, "CHK_encoding"))
 164             self.failUnlessEqual(files, [])
 165             files = os.listdir(os.path.join(self.basedir, "CHK_incoming"))
 166             self.failUnlessEqual(files, [])
 167         d.addCallback(_check_empty)
 168
 169         return d
 170
 171     def test_previous_upload_failed(self):
 172         self.basedir = "helper/AssistedUpload/test_previous_upload_failed"
 173         self.setUpHelper(self.basedir)
 174
 175         # we want to make sure that an upload which fails (leaving the
 176         # ciphertext in the CHK_encoding/ directory) does not prevent a later
 177         # attempt to upload that file from working. We simulate this by
 178         # populating the directory manually. The hardest part is guessing the
 179         # storage index.
 180
 181         k = FakeClient.DEFAULT_ENCODING_PARAMETERS["k"]
 182         n = FakeClient.DEFAULT_ENCODING_PARAMETERS["n"]
 183         max_segsize = FakeClient.DEFAULT_ENCODING_PARAMETERS["max_segment_size"]
 184         segsize = min(max_segsize, len(DATA))
 185         # this must be a multiple of 'required_shares'==k
 186         segsize = mathutil.next_multiple(segsize, k)
 187
 188         key = hashutil.convergence_hash(k, n, segsize, DATA, "test convergence string")
 189         assert len(key) == 16
 190         encryptor = AES(key)
 191         SI = hashutil.storage_index_hash(key)
 192         SI_s = si_b2a(SI)
 193         encfile = os.path.join(self.basedir, "CHK_encoding", SI_s)
 194         f = open(encfile, "wb")
 195         f.write(encryptor.process(DATA))
 196         f.close()
 197
 198         u = upload.Uploader(self.helper_furl)
 199         u.setServiceParent(self.s)
 200
 201         d = wait_a_few_turns()
 202
 203         def _ready(res):
 204             assert u._helper
 205             return upload_data(u, DATA, convergence="test convergence string")
 206         d.addCallback(_ready)
 207         def _uploaded(results):
 208             the_uri = results.uri
 209             assert "CHK" in the_uri
 210         d.addCallback(_uploaded)
 211
 212         def _check_empty(res):
 213             files = os.listdir(os.path.join(self.basedir, "CHK_encoding"))
 214             self.failUnlessEqual(files, [])
 215             files = os.listdir(os.path.join(self.basedir, "CHK_incoming"))
 216             self.failUnlessEqual(files, [])
 217         d.addCallback(_check_empty)
 218
 219         return d
 220
 221     def test_already_uploaded(self):
 222         self.basedir = "helper/AssistedUpload/test_already_uploaded"
 223         self.setUpHelper(self.basedir, helper_class=Helper_already_uploaded)
 224         u = upload.Uploader(self.helper_furl)
 225         u.setServiceParent(self.s)
 226
 227         d = wait_a_few_turns()
 228
 229         def _ready(res):
 230             assert u._helper
 231
 232             return upload_data(u, DATA, convergence="some convergence string")
 233         d.addCallback(_ready)
 234         def _uploaded(results):
 235             the_uri = results.uri
 236             assert "CHK" in the_uri
 237         d.addCallback(_uploaded)
 238
 239         def _check_empty(res):
 240             files = os.listdir(os.path.join(self.basedir, "CHK_encoding"))
 241             self.failUnlessEqual(files, [])
 242             files = os.listdir(os.path.join(self.basedir, "CHK_incoming"))
 243             self.failUnlessEqual(files, [])
 244         d.addCallback(_check_empty)
 245
 246         return d