File: test_uploader.py

package info (click to toggle)
python-tuspy 1.0.3-0.1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 212 kB
  • sloc: python: 884; makefile: 3
file content (211 lines) | stat: -rw-r--r-- 7,829 bytes parent folder | download
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
import os
import io
from base64 import b64encode
from unittest import mock

import responses
from parametrize import parametrize
import pytest

from tusclient import exceptions
from tusclient.storage import filestorage
from tests import mixin


FILEPATH_TEXT = "tests/sample_files/text.txt"
FILEPATH_BINARY = "tests/sample_files/binary.png"


class UploaderTest(mixin.Mixin):

    def mock_request(self, request_mock):
        request_mock = request_mock.return_value
        request_mock.status_code = 204
        request_mock.response_headers = {
            'upload-offset': self.uploader.offset + self.uploader.get_request_length()}
        request_mock.perform.return_value = None
        return request_mock

    def test_instance_attributes(self):
        self.assertEqual(self.uploader.chunk_size, self.uploader.DEFAULT_CHUNK_SIZE)
        self.assertEqual(self.uploader.client, self.client)
        self.assertEqual(self.uploader.offset, 0)

    def test_headers(self):
        self.assertEqual(self.uploader.get_headers(), {"Tus-Resumable": "1.0.0"})

        self.client.set_headers({'foo': 'bar'})
        self.assertEqual(self.uploader.get_headers(), {"Tus-Resumable": "1.0.0", 'foo': 'bar'})

    @responses.activate
    def test_get_offset(self):
        responses.add(responses.HEAD, self.uploader.url,
                      adding_headers={"upload-offset": "300"})
        self.assertEqual(self.uploader.get_offset(), 300)

    def test_encode_metadata(self):
        self.uploader.metadata = {'foo': 'bar', 'red': 'blue'}
        encoded_metadata = ['foo' + ' ' + b64encode(b'bar').decode('ascii'),
                            'red' + ' ' + b64encode(b'blue').decode('ascii')]
        self.assertCountEqual(self.uploader.encode_metadata(), encoded_metadata)

        with pytest.raises(ValueError):
            self.uploader.metadata = {'foo, ': 'bar'}
            self.uploader.encode_metadata()

    def test_encode_metadata_utf8(self):
        self.uploader.metadata = {'foo': 'bär', 'red': '🔵'}
        self.uploader.metadata_encoding = 'utf-8'
        encoded_metadata = [
            'foo ' + b64encode('bär'.encode('utf-8')).decode('ascii'),
            'red ' + b64encode('🔵'.encode('utf-8')).decode('ascii')
        ]
        self.assertCountEqual(self.uploader.encode_metadata(), encoded_metadata)

    @responses.activate
    def test_create_url_absolute(self):
        responses.add(responses.POST, self.client.url,
                      adding_headers={"location": 'http://tusd.tusdemo.net/files/foo'})
        self.assertEqual(self.uploader.create_url(), 'http://tusd.tusdemo.net/files/foo')

    @responses.activate
    def test_create_url_relative(self):
        responses.add(responses.POST, self.client.url,
                      adding_headers={"location": "/files/foo"})
        self.assertEqual(self.uploader.create_url(), 'http://tusd.tusdemo.net/files/foo')

    @parametrize(
        "filename",
        [FILEPATH_TEXT, FILEPATH_BINARY],
    )
    @responses.activate
    def test_url(self, filename: str):
        # test for stored urls
        responses.add(responses.HEAD, 'http://tusd.tusdemo.net/files/foo_bar',
                      adding_headers={"upload-offset": "10"})
        storage_path = '{}/storage_file'.format(os.path.dirname(os.path.abspath(__file__)))
        resumable_uploader = self.client.uploader(
            file_path=filename, store_url=True, url_storage=filestorage.FileStorage(storage_path)
        )
        self.assertEqual(resumable_uploader.url, "http://tusd.tusdemo.net/files/foo_bar")
        self.assertEqual(resumable_uploader.offset, 10)

    def test_request_length(self):
        self.uploader.chunk_size = 200
        self.assertEqual(self.uploader.get_request_length(), 200)

        self.uploader.chunk_size = self.uploader.get_file_size() + 3000
        self.assertEqual(self.uploader.get_request_length(), self.uploader.get_file_size())

    @parametrize(
        "filename",
        [FILEPATH_TEXT, FILEPATH_BINARY],
    )
    def test_get_file_stream(self, filename: str):
        with open(filename, "rb") as fs:
            self.uploader.file_stream = fs
            self.uploader.file_path = None
            self.assertEqual(self.uploader.file_stream, self.uploader.get_file_stream())

        with open(filename, "rb") as fs:
            self.uploader.file_stream = None
            self.uploader.file_path = filename
            with self.uploader.get_file_stream() as stream:
                self.assertEqual(fs.read(), stream.read())

    @parametrize(
        "filename",
        [FILEPATH_TEXT, FILEPATH_BINARY],
    )
    def test_file_size(self, filename: str):
        self.assertEqual(self.uploader.get_file_size(), os.path.getsize(self.uploader.file_path))

        with open(filename, "rb") as fs:
            self.uploader.file_stream = fs
            self.uploader.file_path = None
            self.assertEqual(self.uploader.get_file_size(), os.path.getsize(filename))

    @mock.patch('tusclient.uploader.uploader.TusRequest')
    def test_upload_chunk(self, request_mock):
        self.mock_request(request_mock)

        self.uploader.offset = 0
        request_length = self.uploader.get_request_length()
        self.uploader.upload_chunk()
        self.assertEqual(self.uploader.offset, request_length)

    @responses.activate
    def test_upload_chunk_with_creation(self):
        responses.add(
            responses.POST, self.client.url,
            adding_headers={
                "location": f"{self.client.url}hello"
            }
        )
        responses.add(
            responses.PATCH,
            f"{self.client.url}hello",
            adding_headers={
                "upload-offset": "5"
            }
        )

        uploader = self.client.uploader(
            file_stream=io.BytesIO(b"hello")
        )
        uploader.upload_chunk()

        self.assertEqual(uploader.url, f"{self.client.url}hello")

    @mock.patch('tusclient.uploader.uploader.TusRequest')
    def test_upload(self, request_mock):
        self.mock_request(request_mock)

        self.uploader.upload()
        self.assertEqual(self.uploader.offset, self.uploader.get_file_size())

    @mock.patch('tusclient.uploader.uploader.TusRequest')
    def test_upload_retry(self, request_mock):
        num_of_retries = 3
        self.uploader.retries = num_of_retries
        self.uploader.retry_delay = 3

        request_mock = self.mock_request(request_mock)
        request_mock.status_code = 00

        self.assertEqual(self.uploader._retried, 0)
        with pytest.raises(exceptions.TusCommunicationError):
            self.uploader.upload_chunk()
        self.assertEqual(self.uploader._retried, num_of_retries)

    @responses.activate
    def test_upload_empty(self):
        responses.add(
            responses.POST, self.client.url,
            adding_headers={
                "upload-offset": "0",
                "location": f"{self.client.url}this-is-not-used"
            }
        )
        responses.add(
            responses.PATCH,
            f"{self.client.url}this-is-not-used",
            body=ValueError("PATCH request not allowed for empty file")
        )

        # Upload an empty file
        uploader = self.client.uploader(
            file_stream=io.BytesIO(b"")
        )
        uploader.upload()

        # Upload URL being set means the POST request was sent and the empty
        # file was uploaded without a single PATCH request.
        self.assertTrue(uploader.url)
    
    @mock.patch('tusclient.uploader.uploader.TusRequest')
    def test_upload_checksum(self, request_mock):
        self.mock_request(request_mock)
        self.uploader.upload_checksum = True
        self.uploader.upload()
        self.assertEqual(self.uploader.offset, self.uploader.get_file_size())