Reviving the old range request PR

This commit basically just adds the codes from the PR
https://github.com/micahflee/onionshare/pull/804/commits
on the newly structured and refactored code and also
fixes import dependencies and changed any code that was
relevant with the new code of onionshare
This commit is contained in:
Saptak S 2021-03-30 20:26:16 +05:30
parent 48be6f58dc
commit a36e90eeaf
3 changed files with 533 additions and 94 deletions

View file

@ -1,15 +1,23 @@
import os
import random
import re
import socket
import subprocess
import time
import zipfile
import tempfile
import base64
import pytest
from contextlib import contextmanager
from multiprocessing import Process
from urllib.request import urlopen
from werkzeug.datastructures import Headers
from werkzeug.exceptions import RequestedRangeNotSatisfiable
from onionshare_cli.common import Common
from onionshare_cli.web import Web
from onionshare_cli.web.share_mode import parse_range_header
from onionshare_cli.settings import Settings
from onionshare_cli.mode_settings import ModeSettings
@ -224,3 +232,229 @@ class TestZipWriterCustom:
def test_custom_callback(self, custom_zw):
assert custom_zw.processed_size_callback(None) == "custom_callback"
def check_unsupported(cmd: str, args: list):
cmd_args = [cmd]
cmd_args.extend(args)
skip = False
try:
subprocess.check_call(cmd_args)
except Exception:
skip = True
return pytest.mark.skipif(skip, reason='Command {!r} not supported'.format(cmd))
@contextmanager
def live_server(web):
s = socket.socket()
s.bind(("localhost", 0))
port = s.getsockname()[1]
s.close()
def run():
web.app.run(host='127.0.0.1', port=port, debug=False)
proc = Process(target=run)
proc.start()
url = 'http://127.0.0.1:{}'.format(port)
attempts = 20
while True:
try:
urlopen(url)
break
except Exception:
attempts -= 1
if attempts > 0:
time.sleep(0.5)
else:
raise
yield url + '/download'
proc.terminate()
class TestRangeRequests:
VALID_RANGES = [
(None, 500, [(0, 499)]),
('bytes=0', 500, [(0, 499)]),
('bytes=100', 500, [(100, 499)]),
('bytes=100-', 500, [(100, 499)]), # not in the RFC, but how curl sends
('bytes=0-99', 500, [(0, 99)]),
('bytes=0-599', 500, [(0, 499)]),
('bytes=0-0', 500, [(0, 0)]),
('bytes=-100', 500, [(400, 499)]),
('bytes=0-99,100-199', 500, [(0, 199)]),
('bytes=0-100,100-199', 500, [(0, 199)]),
('bytes=0-99,101-199', 500, [(0, 99), (101, 199)]),
('bytes=0-199,100-299', 500, [(0, 299)]),
('bytes=0-99,200-299', 500, [(0, 99), (200, 299)]),
]
INVALID_RANGES = [
'bytes=200-100',
'bytes=0-100,300-200',
]
def test_parse_ranges(self):
for case in self.VALID_RANGES:
(header, target_size, expected) = case
parsed = parse_range_header(header, target_size)
assert parsed == expected, case
for invalid in self.INVALID_RANGES:
with pytest.raises(RequestedRangeNotSatisfiable):
parse_range_header(invalid, 500)
def test_headers(self, common_obj):
web = web_obj(common_obj, 'share', 3)
web.stay_open = True
url = '/download'
with web.app.test_client() as client:
resp = client.get(url, headers=self._make_auth_headers(web.password))
assert resp.headers['ETag'].startswith('"sha256:')
assert resp.headers['Accept-Ranges'] == 'bytes'
assert resp.headers.get('Last-Modified') is not None
assert resp.headers.get('Content-Length') is not None
assert 'Accept-Encoding' in resp.headers['Vary']
def test_basic(self, common_obj):
web = web_obj(common_obj, 'share', 3)
web.stay_open = True
url = '/download'
with open(web.share_mode.download_filename, 'rb') as f:
contents = f.read()
with web.app.test_client() as client:
resp = client.get(url, headers=self._make_auth_headers(web.password))
assert resp.status_code == 200
assert resp.data == contents
def test_reassemble(self, common_obj):
web = web_obj(common_obj, 'share', 3)
web.stay_open = True
url = '/download'
with open(web.share_mode.download_filename, 'rb') as f:
contents = f.read()
with web.app.test_client() as client:
headers = self._make_auth_headers(web.password)
headers.extend({'Range': 'bytes=0-10'})
resp = client.get(url, headers=headers)
assert resp.status_code == 206
content_range = resp.headers['Content-Range']
assert content_range == 'bytes {}-{}/{}'.format(0, 10, web.share_mode.download_filesize)
bytes_out = resp.data
headers.update({'Range': 'bytes=11-100000'})
resp = client.get(url, headers=headers)
assert resp.status_code == 206
content_range = resp.headers['Content-Range']
assert content_range == 'bytes {}-{}/{}'.format(
11, web.share_mode.download_filesize - 1, web.share_mode.download_filesize)
bytes_out += resp.data
assert bytes_out == contents
def test_mismatched_etags(self, common_obj):
'''RFC 7233 Section 3.2
The "If-Range" header field allows a client to "short-circuit" the second request.
Informally, its meaning is as follows: if the representation is unchanged, send me the
part(s) that I am requesting in Range; otherwise, send me the entire representation.
'''
web = web_obj(common_obj, 'share', 3)
web.stay_open = True
url = '/download'
with open(web.share_mode.download_filename, 'rb') as f:
contents = f.read()
with web.app.test_client() as client:
headers = self._make_auth_headers(web.password)
resp = client.get(url, headers=headers)
assert resp.status_code == 200
headers.extend({'If-Range': 'mismatched etag',
'Range': 'bytes=10-100'})
resp = client.get(url, headers=headers)
assert resp.status_code == 200
assert resp.data == contents
def test_if_unmodified_since(self, common_obj):
web = web_obj(common_obj, 'share', 3)
web.stay_open = True
url = '/download'
with web.app.test_client() as client:
headers = self._make_auth_headers(web.password)
resp = client.get(url, headers=headers)
assert resp.status_code == 200
last_mod = resp.headers['Last-Modified']
headers.extend({'If-Unmodified-Since': last_mod})
resp = client.get(url, headers=headers)
assert resp.status_code == 304
def test_firefox_like_behavior(self, common_obj):
web = web_obj(common_obj, 'share', 3)
web.stay_open = True
url = '/download'
with web.app.test_client() as client:
headers = self._make_auth_headers(web.password)
resp = client.get(url, headers=headers)
assert resp.status_code == 200
# Firefox sends these with all range requests
etag = resp.headers['ETag']
last_mod = resp.headers['Last-Modified']
# make a request that uses the full header set
headers.extend({'Range': 'bytes=0-10',
'If-Unmodified-Since': last_mod,
'If-Range': etag})
resp = client.get(url, headers=headers)
assert resp.status_code == 206
def _make_auth_headers(self, password):
auth = base64.b64encode(b"onionshare:" + password.encode()).decode()
h = Headers()
h.add("Authorization", "Basic " + auth)
return h
@check_unsupported('curl', ['--version'])
def test_curl(self, common_obj):
web = web_obj(common_obj, 'share', 3)
web.stay_open = True
with live_server(web) as url:
# Debugging help from `man curl`, on error 33
# 33 HTTP range error. The range "command" didn't work.
subprocess.check_call(['curl', '--continue-at', '10', url])
@check_unsupported('wget', ['--version'])
def test_wget(self, tmpdir, common_obj):
web = web_obj(common_obj, 'share', 3)
web.stay_open = True
# wget needs a file to exist to continue
download = tmpdir.join('download')
download.write('x' * 10)
with live_server(web) as url:
subprocess.check_call(['wget', '--continue', '-O', str(download), url])
@check_unsupported('http', ['--version'])
def test_httpie(self, common_obj):
web = web_obj(common_obj, 'share', 3)
web.stay_open = True
with live_server(web) as url:
subprocess.check_call(['http', url, 'Range: bytes=10'])