smoke_test.py

from datetime import datetime

from .client import *
from .block import *
from .collection import NotionDate


def run_live_smoke_test(token_v2, parent_page_url_or_id):

    client = NotionClient(token_v2=token_v2)

    parent_page = client.get_block(parent_page_url_or_id)

    page = parent_page.children.add_new(
        PageBlock,
        title="Smoke test at {}".format(datetime.now().strftime("%Y-%m-%d %H:%M:%S")),
    )

    print("Created base smoke test page at:", page.get_browseable_url())

    col_list = page.children.add_new(ColumnListBlock)
    col1 = col_list.children.add_new(ColumnBlock)
    col2 = col_list.children.add_new(ColumnBlock)
    col1kid = col1.children.add_new(
        TextBlock, title="Some formatting: *italic*, **bold**, ***both***!"
    )
    assert (
        col1kid.title.replace("_", "*")
        == "Some formatting: *italic*, **bold**, ***both***!"
    )
    assert col1kid.title_plaintext == "Some formatting: italic, bold, both!"
    col2.children.add_new(TodoBlock, title="I should be unchecked")
    col2.children.add_new(TodoBlock, title="I should be checked", checked=True)

    page.children.add_new(HeaderBlock, title="The finest music:")
    video = page.children.add_new(VideoBlock, width=100)
    video.set_source_url("https://www.youtube.com/watch?v=oHg5SJYRHA0")

    assert video in page.children
    assert col_list in page.children
    assert video in page.children.filter(VideoBlock)
    assert col_list not in page.children.filter(VideoBlock)

    # check that the parent does not yet consider this page to be backlinking
    assert page not in parent_page.get_backlinks()

    page.children.add_new(SubheaderBlock, title="A link back to where I came from:")
    alias = page.children.add_alias(parent_page)
    assert alias.is_alias
    assert not page.is_alias
    page.children.add_new(
        QuoteBlock,
        title="Clicking [here]({}) should take you to the same place...".format(
            page.parent.get_browseable_url()
        ),
    )

    # check that the parent now knows about the backlink
    assert page in parent_page.get_backlinks()

    # ensure __repr__ methods are not breaking
    repr(page)
    repr(page.children)
    for child in page.children:
        repr(child)

    page.children.add_new(
        SubheaderBlock, title="The order of the following should be alphabetical:"
    )

    B = page.children.add_new(BulletedListBlock, title="B")
    D = page.children.add_new(BulletedListBlock, title="D")
    C2 = page.children.add_new(BulletedListBlock, title="C2")
    C1 = page.children.add_new(BulletedListBlock, title="C1")
    C = page.children.add_new(BulletedListBlock, title="C")
    A = page.children.add_new(BulletedListBlock, title="A")

    D.move_to(C, "after")
    A.move_to(B, "before")
    C2.move_to(C)
    C1.move_to(C, "first-child")

    page.children.add_new(CalloutBlock, title="I am a callout", icon="🤞")

    cvb = page.children.add_new(CollectionViewBlock)
    cvb.collection = client.get_collection(
        client.create_record("collection", parent=cvb, schema=get_collection_schema())
    )
    cvb.title = "My data!"
    view = cvb.views.add_new(view_type="table")

    special_code = uuid.uuid4().hex[:8]

    # add a row
    row1 = cvb.collection.add_row()
    assert row1.person == []
    row1.name = "Just some data"
    row1.title = "Can reference 'title' field too! " + special_code
    assert row1.name == row1.title
    row1.check_yo_self = True
    row1.estimated_value = None
    row1.estimated_value = 42
    row1.files = [
        "https://www.birdlife.org/sites/default/files/styles/1600/public/slide.jpg"
    ]
    row1.tags = None
    row1.tags = []
    row1.tags = ["A", "C"]
    row1.where_to = "https://learningequality.org"
    row1.category = "A"
    row1.category = ""
    row1.category = None
    row1.category = "B"

    start = datetime.strptime("2020-01-01 09:30", "%Y-%m-%d %H:%M")
    end = datetime.strptime("2020-01-05 20:45", "%Y-%m-%d %H:%M")
    timezone = "America/Los_Angeles"
    reminder = {"unit": "minute", "value": 30}
    row1.some_date = NotionDate(start, end=end, timezone=timezone, reminder=reminder)

    # add another row
    row2 = cvb.collection.add_row(person=client.current_user, title="Metallic penguins")
    assert row2.person == [client.current_user]
    assert row2.name == "Metallic penguins"
    row2.check_yo_self = False
    row2.estimated_value = 22
    row2.files = [
        "https://www.picclickimg.com/d/l400/pict/223603662103_/Vintage-Small-Monet-and-Jones-JNY-Enamel-Metallic.jpg"
    ]
    row2.tags = ["A", "B"]
    row2.where_to = "https://learningequality.org"
    row2.category = "C"

    # check that options "C" have been added to the schema
    for prop in ["=d{|", "=d{q"]:
        assert cvb.collection.get("schema.{}.options.2.value".format(prop)) == "C"

    # check that existing options "A" haven't been affected
    for prop in ["=d{|", "=d{q"]:
        assert (
            cvb.collection.get("schema.{}.options.0.id".format(prop))
            == get_collection_schema()[prop]["options"][0]["id"]
        )

    # check that insert in empty props works
    assert not row2.eselect
    row2.eselect = "A"
    assert cvb.collection.get("schema.{}.options.0.value".format("eselect")) == "A"

    assert not row2.emselect
    row2.emselect = ["A", "B"]
    assert cvb.collection.get("schema.{}.options.0.value".format("emselect")) == "A"

    # Run a filtered/sorted query using the view's default parameters
    result = view.default_query().execute()
    assert row1 == result[0]
    assert row2 == result[1]
    assert len(result) == 2

    # query the collection directly
    assert row1 in cvb.collection.get_rows(search=special_code)
    assert row2 not in cvb.collection.get_rows(search=special_code)
    assert row1 not in cvb.collection.get_rows(search="penguins")
    assert row2 in cvb.collection.get_rows(search="penguins")

    # search the entire space
    assert row1 in client.search_blocks(search=special_code)
    assert row1 not in client.search_blocks(search="penguins")
    assert row2 not in client.search_blocks(search=special_code)
    assert row2 in client.search_blocks(search="penguins")

    # Run an "aggregation" query
    aggregations = [
        {"property": "estimated_value", "aggregator": "sum", "id": "total_value"}
    ]
    result = view.build_query(aggregations=aggregations).execute()
    assert result.get_aggregate("total_value") == 64

    # Run a "filtered" query
    filter_params = {
        "filters": [
            {
                "filter": {
                    "value": {
                        "type": "exact",
                        "value": {"table": "notion_user", "id": client.current_user.id},
                    },
                    "operator": "person_does_not_contain",
                },
                "property": "person",
            }
        ],
        "operator": "and",
    }
    result = view.build_query(filter=filter_params).execute()
    assert row1 in result
    assert row2 not in result

    # Run a "sorted" query
    sort_params = [{"direction": "ascending", "property": "estimated_value"}]
    result = view.build_query(sort=sort_params).execute()
    assert row1 == result[1]
    assert row2 == result[0]

    # Test that reminders and time zone's work properly
    row1.refresh()
    assert row1.some_date.start == start
    assert row1.some_date.end == end
    assert row1.some_date.timezone == timezone
    assert row1.some_date.reminder == reminder

    print(
        "Check it out and make sure it looks good, then press any key here to delete it..."
    )
    input()

    _delete_page_fully(page)


def _delete_page_fully(page):

    id = page.id

    parent_page = page.parent

    assert page.get("alive") == True
    assert page in parent_page.children
    page.remove()
    assert page.get("alive") == False
    assert page not in parent_page.children

    assert (
        page.space_info
    ), "Page {} was fully deleted prematurely, as we can't get space info about it anymore".format(
        id
    )

    page.remove(permanently=True)

    time.sleep(1)

    assert (
        not page.space_info
    ), "Page {} was not really fully deleted, as we can still get space info about it".format(
        id
    )


def get_collection_schema():
    return {
        "%9:q": {"name": "Check Yo'self", "type": "checkbox"},
        "=d{|": {
            "name": "Tags",
            "type": "multi_select",
            "options": [
                {
                    "color": "orange",
                    "id": "79560dab-c776-43d1-9420-27f4011fcaec",
                    "value": "A",
                },
                {
                    "color": "default",
                    "id": "002c7016-ac57-413a-90a6-64afadfb0c44",
                    "value": "B",
                },
            ],
        },
        "=d{q": {
            "name": "Category",
            "type": "select",
            "options": [
                {
                    "color": "orange",
                    "id": "59560dab-c776-43d1-9420-27f4011fcaec",
                    "value": "A",
                },
                {
                    "color": "default",
                    "id": "502c7016-ac57-413a-90a6-64afadfb0c44",
                    "value": "B",
                },
            ],
        },
        "eselect": {
            "name": "eselect",
            "type": "select",
        },
        "emselect": {
            "name": "emselect",
            "type": "multi_select",
        },
        "LL[(": {"name": "Person", "type": "person"},
        "4Jv$": {"name": "Estimated value", "type": "number"},
        "OBcJ": {"name": "Where to?", "type": "url"},
        "TwR:": {"name": "Some Date", "type": "date"},
        "dV$q": {"name": "Files", "type": "file"},
        "title": {"name": "Name", "type": "title"},
    }