summaryrefslogtreecommitdiff
path: root/src/leap/soledad/tests/test_soledad.py
blob: 1ddfb6a018db55e59092978382fa301c262f469f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
# -*- coding: utf-8 -*-
# test_soledad.py
# Copyright (C) 2013 LEAP
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.


"""
Tests for general Soledad functionality.
"""


import os
import re
import tempfile
try:
    import simplejson as json
except ImportError:
    import json  # noqa


from mock import Mock
from leap.common.testing.basetest import BaseLeapTest
from leap.soledad.tests import BaseSoledadTest
from leap.soledad import Soledad
from leap.soledad.crypto import SoledadCrypto
from leap.soledad.shared_db import SoledadSharedDatabase
from leap.soledad.backends.leap_backend import LeapDocument


class AuxMethodsTestCase(BaseSoledadTest):

    def test__init_dirs(self):
        sol = self._soledad_instance(prefix='/_init_dirs')
        sol._init_dirs()
        local_db_dir = os.path.dirname(sol._config.get_local_db_path())
        secret_path = os.path.dirname(sol._config.get_secret_path())
        self.assertTrue(os.path.isdir(local_db_dir))
        self.assertTrue(os.path.isdir(secret_path))

    def test__init_db(self):
        sol = self._soledad_instance()
        sol._init_dirs()
        sol._crypto = SoledadCrypto(sol)
        #self._soledad._gpg.import_keys(PUBLIC_KEY)
        if not sol._has_symkey():
            sol._gen_symkey()
        sol._load_symkey()
        sol._init_db()
        from leap.soledad.backends.sqlcipher import SQLCipherDatabase
        self.assertIsInstance(sol._db, SQLCipherDatabase)

    def test__init_config_default(self):
        """
        Test if configuration defaults point to the correct place.
        """
        sol = Soledad('leap@leap.se', passphrase='123', bootstrap=False)
        self.assertTrue(bool(re.match(
            '.*/\.config/leap/soledad/secret.gpg',
            sol._config.get_secret_path())))
        self.assertTrue(bool(re.match(
            '.*/\.config/leap/soledad/soledad.u1db',
            sol._config.get_local_db_path())))
        self.assertEqual(
            'http://provider/soledad/shared',
            sol._config.get_shared_db_url())

    def test__init_config_defaults(self):
        """
        Test if configuration defaults point to the correct place.
        """
        # we use regexp match here because HOME environment variable is
        # changed by the BaseLeapTest class but BaseConfig does not capture
        # that change.
        sol = Soledad('leap@leap.se', passphrase='123', bootstrap=False)
        self.assertTrue(bool(re.match(
            '.*/\.config/leap/soledad/secret.gpg',
            sol._config.get_secret_path())))
        self.assertTrue(bool(re.match(
            '.*/\.config/leap/soledad/soledad.u1db',
            sol._config.get_local_db_path())))
        self.assertEqual(
            'http://provider/soledad/shared',
            sol._config.get_shared_db_url())

    def test__init_config_from_file(self):
        """
        Test if configuration is correctly read from file.
        """
        # we use regexp match here because HOME environment variable is
        # changed by the BaseLeapTest class but BaseConfig does not capture
        # that change.
        config_values = {
            "secret_path": "value_1",
            "local_db_path": "value_2",
            "shared_db_url": "value_3"
        }
        tmpfile = tempfile.mktemp(dir=self.tempdir)
        f = open(tmpfile, 'w')
        f.write(json.dumps(config_values))
        f.close()
        sol = Soledad(
            'leap@leap.se',
            passphrase='123',
            bootstrap=False,
            config_path=tmpfile)
        self.assertEqual('value_1', sol._config.get_secret_path())
        self.assertEqual('value_2', sol._config.get_local_db_path())
        self.assertEqual('value_3', sol._config.get_shared_db_url())

    def test__init_config_from_params(self):
        """
        Test if configuration is correctly read from file.
        """
        # we use regexp match here because HOME environment variable is
        # changed by the BaseLeapTest class but BaseConfig does not capture
        # that change.
        sol = Soledad(
            'leap@leap.se',
            passphrase='123',
            bootstrap=False,
            secret_path='value_3',
            local_db_path='value_2',
            shared_db_url='value_1')
        self.assertEqual('value_3', sol._config.get_secret_path())
        self.assertEqual('value_2', sol._config.get_local_db_path())
        self.assertEqual('value_1', sol._config.get_shared_db_url())


class SoledadSharedDBTestCase(BaseSoledadTest):
    """
    These tests ensure the functionalities of the shared recovery database.
    """

    def setUp(self):
        BaseSoledadTest.setUp(self)
        self._shared_db = SoledadSharedDatabase(
            'https://provider/', LeapDocument, None)

    def test__fetch_keys_from_shared_db(self):
        """
        Ensure the shared db is queried with the correct doc_id.
        """
        self._soledad._shared_db = Mock()
        doc_id = self._soledad._address_hash()
        self._soledad._fetch_keys_from_shared_db()
        self.assertTrue(
            self._soledad._shared_db.get_doc_unauth.assert_called_once(doc_id),
            'Wrong doc_id when fetching recovery document.')

    def test__assert_keys_in_shared_db(self):
        """
        Ensure recovery document is put into shared recover db.
        """

        def _put_doc_side_effect(doc):
            self._doc_put = doc

        class MockSharedDB(object):

            get_doc_unauth = Mock(return_value=None)
            put_doc = Mock(side_effect=_put_doc_side_effect)

            def __call__(self):
                return self

        self._soledad._shared_db = MockSharedDB()
        doc_id = self._soledad._address_hash()
        self._soledad._assert_keys_in_shared_db()
        self.assertTrue(
            self._soledad._shared_db().get_doc_unauth.assert_called_once_with(
                doc_id) is None,
            'Wrong doc_id when fetching recovery document.')
        self.assertTrue(
            self._soledad._shared_db.put_doc.assert_called_once_with(
                self._doc_put) is None,
            'Wrong document when putting recovery document.')
        self.assertTrue(
            self._doc_put.doc_id == doc_id,
            'Wrong doc_id when putting recovery document.')