source: trunk/integration/test_web.py

"""
These tests were originally written to achieve some level of
coverage for the WebAPI functionality during Python3 porting (there
aren't many tests of the Web API period).

Most of the tests have cursory asserts and encode 'what the WebAPI did
at the time of testing' -- not necessarily a cohesive idea of what the
WebAPI *should* do in every situation. It's not clear the latter
exists anywhere, however.
"""

from __future__ import annotations

import time
from base64 import urlsafe_b64encode
from urllib.parse import unquote as url_unquote, quote as url_quote

from cryptography.hazmat.primitives.serialization import load_pem_private_key
from twisted.internet.threads import deferToThread
from twisted.python.filepath import FilePath

import allmydata.uri
from allmydata.crypto.rsa import (
    create_signing_keypair,
    der_string_from_signing_key,
    PrivateKey,
    PublicKey,
)
from allmydata.mutable.common import derive_mutable_keys
from allmydata.util import jsonbytes as json

from . import util
from .util import run_in_thread

import requests
import html5lib
from bs4 import BeautifulSoup

import pytest_twisted


DATA_PATH = FilePath(__file__).parent().sibling("src").child("allmydata").child("test").child("data")


@run_in_thread
def test_index(alice):
    """
    we can download the index file
    """
    util.web_get(alice.process, u"")


@run_in_thread
def test_index_json(alice):
    """
    we can download the index file as json
    """
    data = util.web_get(alice.process, u"", params={u"t": u"json"})
    # it should be valid json
    json.loads(data)


@run_in_thread
def test_upload_download(alice):
    """
    upload a file, then download it via readcap
    """

    FILE_CONTENTS = u"some contents"

    readcap = util.web_post(
        alice.process, u"uri",
        data={
            u"t": u"upload",
            u"format": u"mdmf",
        },
        files={
            u"file": FILE_CONTENTS,
        },
    )
    readcap = readcap.strip()

    data = util.web_get(
        alice.process, u"uri",
        params={
            u"uri": readcap,
            u"filename": u"boom",
        }
    )
    assert str(data, "utf-8") == FILE_CONTENTS


@run_in_thread
def test_put(alice):
    """
    use PUT to create a file
    """

    FILE_CONTENTS = b"added via PUT" * 20

    resp = requests.put(
        util.node_url(alice.process.node_dir, u"uri"),
        data=FILE_CONTENTS,
    )
    cap = allmydata.uri.from_string(resp.text.strip().encode('ascii'))
    cfg = alice.process.get_config()
    assert isinstance(cap, allmydata.uri.CHKFileURI)
    assert cap.size == len(FILE_CONTENTS)
    assert cap.total_shares == int(cfg.get_config("client", "shares.total"))
    assert cap.needed_shares == int(cfg.get_config("client", "shares.needed"))


@run_in_thread
def test_helper_status(storage_nodes):
    """
    successfully GET the /helper_status page
    """

    url = util.node_url(storage_nodes[0].process.node_dir, "helper_status")
    resp = requests.get(url)
    assert resp.status_code >= 200 and resp.status_code < 300
    dom = BeautifulSoup(resp.content, "html5lib")
    assert str(dom.h1.string) == u"Helper Status"


@run_in_thread
def test_deep_stats(alice):
    """
    create a directory, do deep-stats on it and prove the /operations/
    URIs work
    """
    resp = requests.post(
        util.node_url(alice.process.node_dir, "uri"),
        params={
            "format": "sdmf",
            "t": "mkdir",
            "redirect_to_result": "true",
        },
    )
    assert resp.status_code >= 200 and resp.status_code < 300

    # when creating a directory, we'll be re-directed to a URL
    # containing our writecap..
    uri = url_unquote(resp.url)
    assert 'URI:DIR2:' in uri
    dircap = uri[uri.find("URI:DIR2:"):].rstrip('/')
    dircap_uri = util.node_url(alice.process.node_dir, "uri/{}".format(url_quote(dircap)))

    # POST a file into this directory
    FILE_CONTENTS = u"a file in a directory"

    resp = requests.post(
        dircap_uri,
        data={
            u"t": u"upload",
        },
        files={
            u"file": FILE_CONTENTS,
        },
    )
    resp.raise_for_status()

    # confirm the file is in the directory
    resp = requests.get(
        dircap_uri,
        params={
            u"t": u"json",
        },
    )
    d = json.loads(resp.content)
    k, data = d
    assert k == u"dirnode"
    assert len(data['children']) == 1
    k, child = list(data['children'].values())[0]
    assert k == u"filenode"
    assert child['size'] == len(FILE_CONTENTS)

    # perform deep-stats on it...
    resp = requests.post(
        dircap_uri,
        data={
            u"t": u"start-deep-stats",
            u"ophandle": u"something_random",
        },
    )
    assert resp.status_code >= 200 and resp.status_code < 300

    # confirm we get information from the op .. after its done
    tries = 10
    while tries > 0:
        tries -= 1
        resp = requests.get(
            util.node_url(alice.process.node_dir, u"operations/something_random"),
        )
        d = json.loads(resp.content)
        if d['size-literal-files'] == len(FILE_CONTENTS):
            print("stats completed successfully")
            break
        else:
            print("{} != {}; waiting".format(d['size-literal-files'], len(FILE_CONTENTS)))
        time.sleep(.5)


@run_in_thread
def test_status(alice):
    """
    confirm we get something sensible from /status and the various sub-types
    """

    # upload a file
    # (because of the nature of the integration-tests, we can only
    # assert things about "our" file because we don't know what other
    # operations may have happened in the grid before our test runs).

    FILE_CONTENTS = u"all the Important Data of alice\n" * 1200

    resp = requests.put(
        util.node_url(alice.process.node_dir, u"uri"),
        data=FILE_CONTENTS,
    )
    cap = resp.text.strip()

    print("Uploaded data, cap={}".format(cap))
    resp = requests.get(
        util.node_url(alice.process.node_dir, u"uri/{}".format(url_quote(cap))),
    )

    print("Downloaded {} bytes of data".format(len(resp.content)))
    assert str(resp.content, "ascii") == FILE_CONTENTS

    resp = requests.get(
        util.node_url(alice.process.node_dir, "status"),
    )
    dom = html5lib.parse(resp.content)

    hrefs = [
        a.get('href')
        for a in dom.iter(u'{http://www.w3.org/1999/xhtml}a')
    ]

    found_upload = False
    found_download = False
    for href in hrefs:
        if href == u"/" or not href:
            continue
        resp = requests.get(util.node_url(alice.process.node_dir, href))
        if href.startswith(u"/status/up"):
            assert b"File Upload Status" in resp.content
            if b"Total Size: %d" % (len(FILE_CONTENTS),) in resp.content:
                found_upload = True
        elif href.startswith(u"/status/down"):
            assert b"File Download Status" in resp.content
            if b"Total Size: %d" % (len(FILE_CONTENTS),) in resp.content:
                found_download = True

                # download the specialized event information
                resp = requests.get(
                    util.node_url(alice.process.node_dir, u"{}/event_json".format(href)),
                )
                js = json.loads(resp.content)
                # there's usually just one "read" operation, but this can handle many ..
                total_bytes = sum([st['bytes_returned'] for st in js['read']], 0)
                assert total_bytes == len(FILE_CONTENTS)


    assert found_upload, "Failed to find the file we uploaded in the status-page"
    assert found_download, "Failed to find the file we downloaded in the status-page"


@pytest_twisted.ensureDeferred
async def test_directory_deep_check(reactor, request, alice):
    """
    use deep-check and confirm the result pages work
    """
    # Make sure the node is configured compatibly with expectations of this
    # test.
    happy = 3
    required = 2
    total = 4

    await alice.reconfigure_zfec(reactor, (happy, required, total), convergence=None)
    await deferToThread(_test_directory_deep_check_blocking, alice)


def _test_directory_deep_check_blocking(alice):
    # create a directory
    resp = requests.post(
        util.node_url(alice.process.node_dir, u"uri"),
        params={
            u"t": u"mkdir",
            u"redirect_to_result": u"true",
        }
    )

    # get json information about our directory
    dircap_url = resp.url
    resp = requests.get(
        dircap_url,
        params={u"t": u"json"},
    )
    # Just verify it is valid JSON.
    json.loads(resp.content)

    # upload a file of pangrams into the directory
    FILE_CONTENTS = u"Sphinx of black quartz, judge my vow.\n" * (2048*10)

    resp = requests.post(
        dircap_url,
        params={
            u"t": u"upload",
            u"upload-chk": u"upload-chk",
        },
        files={
            u"file": FILE_CONTENTS,
        }
    )
    cap0 = resp.content
    print("Uploaded data0, cap={}".format(cap0))

    # a different pangram
    FILE_CONTENTS = u"The five boxing wizards jump quickly.\n" * (2048*10)

    resp = requests.post(
        dircap_url,
        params={
            u"t": u"upload",
            u"upload-chk": u"upload-chk",
        },
        files={
            u"file": FILE_CONTENTS,
        }
    )
    cap1 = resp.content
    print("Uploaded data1, cap={}".format(cap1))

    resp = requests.get(
        util.node_url(alice.process.node_dir, u"uri/{}".format(url_quote(cap0))),
        params={u"t": u"info"},
    )

    def check_repair_data(checkdata):
        assert checkdata["healthy"]
        assert checkdata["count-happiness"] == 4
        assert checkdata["count-good-share-hosts"] == 4
        assert checkdata["count-shares-good"] == 4
        assert checkdata["count-corrupt-shares"] == 0
        assert checkdata["list-corrupt-shares"] == []

    # do a "check" (once for HTML, then with JSON for easier asserts)
    resp = requests.post(
        dircap_url,
        params={
            u"t": u"check",
            u"return_to": u".",
            u"verify": u"true",
        }
    )
    resp = requests.post(
        dircap_url,
        params={
            u"t": u"check",
            u"return_to": u".",
            u"verify": u"true",
            u"output": u"JSON",
        }
    )
    check_repair_data(json.loads(resp.content)["results"])

    # "check and repair"
    resp = requests.post(
        dircap_url,
        params={
            u"t": u"check",
            u"return_to": u".",
            u"verify": u"true",
            u"repair": u"true",
        }
    )
    resp = requests.post(
        dircap_url,
        params={
            u"t": u"check",
            u"return_to": u".",
            u"verify": u"true",
            u"repair": u"true",
            u"output": u"JSON",
        }
    )
    check_repair_data(json.loads(resp.content)["post-repair-results"]["results"])

    # start a "deep check and repair"
    resp = requests.post(
        dircap_url,
        params={
            u"t": u"start-deep-check",
            u"return_to": u".",
            u"verify": u"on",
            u"repair": u"on",
            u"output": u"JSON",
            u"ophandle": u"deadbeef",
        }
    )
    deepcheck_uri = resp.url

    data = json.loads(resp.content)
    tries = 10
    while not data['finished'] and tries > 0:
        tries -= 1
        time.sleep(0.5)
        print("deep-check not finished, reloading")
        resp = requests.get(deepcheck_uri, params={u"output": "JSON"})
        data = json.loads(resp.content)
    print("deep-check finished")
    assert data[u"stats"][u"count-immutable-files"] == 1
    assert data[u"stats"][u"count-literal-files"] == 0
    assert data[u"stats"][u"largest-immutable-file"] == 778240
    assert data[u"count-objects-checked"] == 2

    # also get the HTML version
    resp = requests.post(
        dircap_url,
        params={
            u"t": u"start-deep-check",
            u"return_to": u".",
            u"verify": u"on",
            u"repair": u"on",
            u"ophandle": u"definitely_random",
        }
    )
    deepcheck_uri = resp.url

    # if the operations isn't done, there's an <H2> tag with the
    # reload link; otherwise there's only an <H1> tag..wait up to 5
    # seconds for this to respond properly.
    for _ in range(5):
        resp = requests.get(deepcheck_uri)
        dom = BeautifulSoup(resp.content, "html5lib")
        if dom.h1 and u'Results' in str(dom.h1.string):
            break
        if dom.h2 and dom.h2.a and u"Reload" in str(dom.h2.a.string):
            dom = None
            time.sleep(1)
    assert dom is not None, "Operation never completed"


@run_in_thread
def test_storage_info(storage_nodes):
    """
    retrieve and confirm /storage URI for one storage node
    """
    storage0 = storage_nodes[0]

    requests.get(
        util.node_url(storage0.process.node_dir, u"storage"),
    )


@run_in_thread
def test_storage_info_json(storage_nodes):
    """
    retrieve and confirm /storage?t=json URI for one storage node
    """
    storage0 = storage_nodes[0]

    resp = requests.get(
        util.node_url(storage0.process.node_dir, u"storage"),
        params={u"t": u"json"},
    )
    data = json.loads(resp.content)
    assert data[u"stats"][u"storage_server.reserved_space"] == 1000000000


@run_in_thread
def test_introducer_info(introducer):
    """
    retrieve and confirm /introducer URI for the introducer
    """
    resp = requests.get(
        util.node_url(introducer.process.node_dir, u""),
    )
    assert b"Introducer" in resp.content

    resp = requests.get(
        util.node_url(introducer.process.node_dir, u""),
        params={u"t": u"json"},
    )
    data = json.loads(resp.content)
    assert "announcement_summary" in data
    assert "subscription_summary" in data


@run_in_thread
def test_mkdir_with_children(alice):
    """
    create a directory using ?t=mkdir-with-children
    """

    # create a file to put in our directory
    FILE_CONTENTS = u"some file contents\n" * 500
    resp = requests.put(
        util.node_url(alice.process.node_dir, u"uri"),
        data=FILE_CONTENTS,
    )
    filecap = resp.content.strip()

    # create a (sub) directory to put in our directory
    resp = requests.post(
        util.node_url(alice.process.node_dir, u"uri"),
        params={
            u"t": u"mkdir",
        }
    )
    # (we need both the read-write and read-only URIs I guess)
    dircap = resp.content
    dircap_obj = allmydata.uri.from_string(dircap)
    dircap_ro = dircap_obj.get_readonly().to_string()

    # create json information about our directory
    meta = {
        "a_file": [
            "filenode", {
                "ro_uri": filecap,
                "metadata": {
                    "ctime": 1202777696.7564139,
                    "mtime": 1202777696.7564139,
                    "tahoe": {
                        "linkcrtime": 1202777696.7564139,
                        "linkmotime": 1202777696.7564139
                    }
                }
            }
        ],
        "some_subdir": [
            "dirnode", {
                "rw_uri": dircap,
                "ro_uri": dircap_ro,
                "metadata": {
                    "ctime": 1202778102.7589991,
                    "mtime": 1202778111.2160511,
                    "tahoe": {
                        "linkcrtime": 1202777696.7564139,
                        "linkmotime": 1202777696.7564139
                    }
                }
            }
        ]
    }

    # create a new directory with one file and one sub-dir (all-at-once)
    resp = util.web_post(
        alice.process, u"uri",
        params={u"t": "mkdir-with-children"},
        data=json.dumps(meta),
    )
    assert resp.startswith(b"URI:DIR2")
    cap = allmydata.uri.from_string(resp)
    assert isinstance(cap, allmydata.uri.DirectoryURI)


@run_in_thread
def test_mkdir_with_random_private_key(alice):
    """
    Create a new directory with ?t=mkdir&private-key=... using a
    randomly-generated RSA private key.

    The writekey and fingerprint derived from the provided RSA key
    should match those of the newly-created directory capability.
    """

    privkey, pubkey = create_signing_keypair(2048)

    writekey, _, fingerprint = derive_mutable_keys((pubkey, privkey))

    # The "private-key" parameter takes a DER-encoded RSA private key
    # encoded in URL-safe base64; PEM blocks are not supported.
    privkey_der = der_string_from_signing_key(privkey)
    privkey_encoded = urlsafe_b64encode(privkey_der).decode("ascii")

    resp = util.web_post(
        alice.process, u"uri",
        params={
            u"t": "mkdir",
            u"private-key": privkey_encoded,
        },
    )
    assert resp.startswith(b"URI:DIR2")

    dircap = allmydata.uri.from_string(resp)
    assert isinstance(dircap, allmydata.uri.DirectoryURI)

    # DirectoryURI objects lack 'writekey' and 'fingerprint' attributes
    # so extract them from the enclosed WriteableSSKFileURI object.
    filecap = dircap.get_filenode_cap()
    assert isinstance(filecap, allmydata.uri.WriteableSSKFileURI)

    assert (writekey, fingerprint) == (filecap.writekey, filecap.fingerprint)


@run_in_thread
def test_mkdir_with_known_private_key(alice):
    """
    Create a new directory with ?t=mkdir&private-key=... using a
    known-in-advance RSA private key.

    The writekey and fingerprint derived from the provided RSA key
    should match those of the newly-created directory capability.
    In addition, because the writekey and fingerprint are derived
    deterministically, given the same RSA private key, the resultant
    directory capability should always be the same.
    """
    # Generated with `openssl genrsa -out openssl-rsa-2048-3.txt 2048`
    pempath = DATA_PATH.child("openssl-rsa-2048-3.txt")
    privkey = load_pem_private_key(pempath.getContent(), password=None)
    assert isinstance(privkey, PrivateKey)
    pubkey = privkey.public_key()
    assert isinstance(pubkey, PublicKey)

    writekey, _, fingerprint = derive_mutable_keys((pubkey, privkey))

    # The "private-key" parameter takes a DER-encoded RSA private key
    # encoded in URL-safe base64; PEM blocks are not supported.
    privkey_der = der_string_from_signing_key(privkey)
    privkey_encoded = urlsafe_b64encode(privkey_der).decode("ascii")

    resp = util.web_post(
        alice.process, u"uri",
        params={
            u"t": "mkdir",
            u"private-key": privkey_encoded,
        },
    )
    assert resp.startswith(b"URI:DIR2")

    dircap = allmydata.uri.from_string(resp)
    assert isinstance(dircap, allmydata.uri.DirectoryURI)

    # DirectoryURI objects lack 'writekey' and 'fingerprint' attributes
    # so extract them from the enclosed WriteableSSKFileURI object.
    filecap = dircap.get_filenode_cap()
    assert isinstance(filecap, allmydata.uri.WriteableSSKFileURI)

    assert (writekey, fingerprint) == (filecap.writekey, filecap.fingerprint)

    assert resp == b"URI:DIR2:3oo7j7f7qqxnet2z2lf57ucup4:cpktmsxlqnd5yeekytxjxvff5e6d6fv7py6rftugcndvss7tzd2a"


@run_in_thread
def test_mkdir_with_children_and_random_private_key(alice):
    """
    Create a new directory with ?t=mkdir-with-children&private-key=...
    using a randomly-generated RSA private key.

    The writekey and fingerprint derived from the provided RSA key
    should match those of the newly-created directory capability.
    """

    # create a file to put in our directory
    FILE_CONTENTS = u"some file contents\n" * 500
    resp = requests.put(
        util.node_url(alice.process.node_dir, u"uri"),
        data=FILE_CONTENTS,
    )
    filecap = resp.content.strip()

    # create a (sub) directory to put in our directory
    resp = requests.post(
        util.node_url(alice.process.node_dir, u"uri"),
        params={
            u"t": u"mkdir",
        }
    )
    # (we need both the read-write and read-only URIs I guess)
    dircap = resp.content
    dircap_obj = allmydata.uri.from_string(dircap)
    dircap_ro = dircap_obj.get_readonly().to_string()

    # create json information about our directory
    meta = {
        "a_file": [
            "filenode", {
                "ro_uri": filecap,
                "metadata": {
                    "ctime": 1202777696.7564139,
                    "mtime": 1202777696.7564139,
                    "tahoe": {
                        "linkcrtime": 1202777696.7564139,
                        "linkmotime": 1202777696.7564139
                    }
                }
            }
        ],
        "some_subdir": [
            "dirnode", {
                "rw_uri": dircap,
                "ro_uri": dircap_ro,
                "metadata": {
                    "ctime": 1202778102.7589991,
                    "mtime": 1202778111.2160511,
                    "tahoe": {
                        "linkcrtime": 1202777696.7564139,
                        "linkmotime": 1202777696.7564139
                    }
                }
            }
        ]
    }

    privkey, pubkey = create_signing_keypair(2048)

    writekey, _, fingerprint = derive_mutable_keys((pubkey, privkey))

    # The "private-key" parameter takes a DER-encoded RSA private key
    # encoded in URL-safe base64; PEM blocks are not supported.
    privkey_der = der_string_from_signing_key(privkey)
    privkey_encoded = urlsafe_b64encode(privkey_der).decode("ascii")

    # create a new directory with one file and one sub-dir (all-at-once)
    # with the supplied RSA private key
    resp = util.web_post(
        alice.process, u"uri",
        params={
            u"t": "mkdir-with-children",
            u"private-key": privkey_encoded,
        },
        data=json.dumps(meta),
    )
    assert resp.startswith(b"URI:DIR2")

    dircap = allmydata.uri.from_string(resp)
    assert isinstance(dircap, allmydata.uri.DirectoryURI)

    # DirectoryURI objects lack 'writekey' and 'fingerprint' attributes
    # so extract them from the enclosed WriteableSSKFileURI object.
    filecap = dircap.get_filenode_cap()
    assert isinstance(filecap, allmydata.uri.WriteableSSKFileURI)

    assert (writekey, fingerprint) == (filecap.writekey, filecap.fingerprint)


@run_in_thread
def test_mkdir_with_children_and_known_private_key(alice):
    """
    Create a new directory with ?t=mkdir-with-children&private-key=...
    using a known-in-advance RSA private key.


    The writekey and fingerprint derived from the provided RSA key
    should match those of the newly-created directory capability.
    In addition, because the writekey and fingerprint are derived
    deterministically, given the same RSA private key, the resultant
    directory capability should always be the same.
    """

    # create a file to put in our directory
    FILE_CONTENTS = u"some file contents\n" * 500
    resp = requests.put(
        util.node_url(alice.process.node_dir, u"uri"),
        data=FILE_CONTENTS,
    )
    filecap = resp.content.strip()

    # create a (sub) directory to put in our directory
    resp = requests.post(
        util.node_url(alice.process.node_dir, u"uri"),
        params={
            u"t": u"mkdir",
        }
    )
    # (we need both the read-write and read-only URIs I guess)
    dircap = resp.content
    dircap_obj = allmydata.uri.from_string(dircap)
    dircap_ro = dircap_obj.get_readonly().to_string()

    # create json information about our directory
    meta = {
        "a_file": [
            "filenode", {
                "ro_uri": filecap,
                "metadata": {
                    "ctime": 1202777696.7564139,
                    "mtime": 1202777696.7564139,
                    "tahoe": {
                        "linkcrtime": 1202777696.7564139,
                        "linkmotime": 1202777696.7564139
                    }
                }
            }
        ],
        "some_subdir": [
            "dirnode", {
                "rw_uri": dircap,
                "ro_uri": dircap_ro,
                "metadata": {
                    "ctime": 1202778102.7589991,
                    "mtime": 1202778111.2160511,
                    "tahoe": {
                        "linkcrtime": 1202777696.7564139,
                        "linkmotime": 1202777696.7564139
                    }
                }
            }
        ]
    }

    # Generated with `openssl genrsa -out openssl-rsa-2048-4.txt 2048`
    pempath = DATA_PATH.child("openssl-rsa-2048-4.txt")
    privkey = load_pem_private_key(pempath.getContent(), password=None)
    assert isinstance(privkey, PrivateKey)
    pubkey = privkey.public_key()
    assert isinstance(pubkey, PublicKey)

    writekey, _, fingerprint = derive_mutable_keys((pubkey, privkey))

    # The "private-key" parameter takes a DER-encoded RSA private key
    # encoded in URL-safe base64; PEM blocks are not supported.
    privkey_der = der_string_from_signing_key(privkey)
    privkey_encoded = urlsafe_b64encode(privkey_der).decode("ascii")

    # create a new directory with one file and one sub-dir (all-at-once)
    # with the supplied RSA private key
    resp = util.web_post(
        alice.process, u"uri",
        params={
            u"t": "mkdir-with-children",
            u"private-key": privkey_encoded,
        },
        data=json.dumps(meta),
    )
    assert resp.startswith(b"URI:DIR2")

    dircap = allmydata.uri.from_string(resp)
    assert isinstance(dircap, allmydata.uri.DirectoryURI)

    # DirectoryURI objects lack 'writekey' and 'fingerprint' attributes
    # so extract them from the enclosed WriteableSSKFileURI object.
    filecap = dircap.get_filenode_cap()
    assert isinstance(filecap, allmydata.uri.WriteableSSKFileURI)

    assert (writekey, fingerprint) == (filecap.writekey, filecap.fingerprint)

    assert resp == b"URI:DIR2:ppwzpwrd37xi7tpribxyaa25uy:imdws47wwpzfkc5vfllo4ugspb36iit4cqps6ttuhaouc66jb2da"