pytest

Author: TheCommCraft

.github/workflows/pytest.yml

@@ -0,0 +1,39 @@
+# This workflow will run pytest in the repository directory
+# This runs on pull request or on any push to the repository
+# based on https://www.youtube.com/watch?v=uFcXrWT4f80
+name: Run tests
+
+on:
+  pull_request:
+    branches: ['main']
+  push:
+    branches: ['main']
+  release:
+    types: [prereleased, published]
+  workflow_dispatch:
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    environment: release
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          pip install pytest
+          pip install cryptography
+
+      - name: Test with pytest
+        env:
+          FERNET_KEY: ${{ secrets.FERNET_KEY }}
+        run: |
+          pytest tests/

tests/test_activity.py

@@ -0,0 +1,32 @@
+import sys
+from datetime import datetime, timedelta, timezone
+import warnings
+
+
+
+def test_activity():
+    sys.path.insert(0, ".")
+    import scratchattach as sa
+    from scratchattach.utils import exceptions
+    import util
+    if not util.credentials_available():
+        warnings.warn("Skipped test_activity because there were no credentials available.")
+        return
+    sess = util.session()
+
+    # we cannot do assertions, but we can probe for any errors.
+    messages = sess.messages()
+    for msg in messages:
+        print(msg, end=' ')
+
+        try:
+            target = msg.target()
+        except exceptions.CommentNotFound:
+            target = None
+            raise
+
+        print(target)
+
+
+if __name__ == "__main__":
+    test_activity()

tests/test_auth.py

@@ -0,0 +1,15 @@
+import sys
+import os
+import warnings
+
+def test_auth():
+    sys.path.insert(0, ".")
+    import util
+    if not util.credentials_available():
+        warnings.warn("Skipped test_auth because there were no credentials available.")
+        return
+    sess = util.session()
+
+    assert "FERNET_KEY" in os.environ
+    assert len(os.environ["FERNET_KEY"]) == 32
+    assert sess.username == "ScratchAttachV2"

tests/test_comment.py

@@ -0,0 +1,70 @@
+import sys
+from datetime import datetime, timedelta, timezone
+import warnings
+
+def test_comment():
+    sys.path.insert(0, ".")
+    import scratchattach as sa
+    import util
+    if not util.credentials_available():
+        warnings.warn("Skipped test_comment because there were no credentials available.")
+        return
+    sess = util.session()
+
+    user = sess.connect_linked_user()
+    proj = sess.connect_project(1108326850)
+    studio = sess.connect_studio(50809872)
+
+    comment = user.comments(limit=1)[0]
+
+    assert comment.id == "387076703"
+    assert comment.source == sa.CommentSource.USER_PROFILE
+    assert comment.source_id == "ScratchAttachV2"
+    assert comment.parent_id is None
+    assert comment.content == "Sample comment"
+    assert datetime.fromisoformat(comment.datetime_created) - datetime(2025, 8, 25, tzinfo=timezone.utc) < timedelta(days=1)
+    assert comment.reply_count == 0
+    assert comment.text == "Sample comment"
+
+    comment = proj.comments(limit=1)[0]
+
+    assert comment.id == 494890468
+    assert comment.source == sa.CommentSource.PROJECT
+    assert comment.source_id == 1108326850
+    assert comment.parent_id is None
+    assert comment.content == ("&lt;&amp;;&apos;!\n"
+                               "newline\n"
+                               "testing escaping")
+    assert datetime.fromisoformat(comment.datetime_created) - datetime(2025, 9, 20, tzinfo=timezone.utc) < timedelta(days=1)
+    assert comment.reply_count == 0
+    assert comment.text == ("<&;'!\n"
+                            "newline\n"
+                            "testing escaping")
+
+    comment = studio.comments(limit=1)[0]
+
+    assert comment.id == 302129887
+    assert comment.source == sa.CommentSource.STUDIO
+    assert comment.source_id == 50809872
+    assert comment.parent_id is None
+    assert comment.content == "Sample"
+    assert datetime.fromisoformat(comment.datetime_created) - datetime(2025, 8, 26, tzinfo=timezone.utc) < timedelta(days=1)
+    assert comment.reply_count == 1
+    assert not comment.written_by_scratchteam
+    assert comment.text == "Sample"
+
+    comment = comment.replies(limit=1)[0]
+
+    assert comment.id == 302129910
+    assert comment.source == sa.CommentSource.STUDIO
+    assert comment.source_id == 50809872
+    assert comment.parent_id == 302129887
+    assert comment.commentee_id == 58743127
+    assert comment.content == "text"
+    assert datetime.fromisoformat(comment.datetime_created) - datetime(2025, 8, 26, tzinfo=timezone.utc) < timedelta(days=1)
+    assert comment.reply_count == 0
+    assert not comment.written_by_scratchteam
+    assert comment.text == "text"
+
+if __name__ == "__main__":
+    test_comment()

tests/test_editor_integration.py

@@ -0,0 +1,22 @@
+import pprint
+import sys
+import warnings
+
+def test_project():
+    sys.path.insert(0, ".")
+    import scratchattach as sa
+    import util
+    if not util.credentials_available():
+        warnings.warn("Skipped test_project because there were no credentials available.")
+        return
+    sess = util.session()
+
+
+    project = sess.connect_project(104)
+    body = project.body()
+    body.to_json()  # do nothing with the data, just make sure it works.
+
+
+
+if __name__ == '__main__':
+    test_project()

tests/test_editor_obfuscation.py

@@ -0,0 +1,27 @@
+import pprint
+import sys
+from pathlib import Path
+
+
+def test_project():
+    sys.path.insert(0, ".")
+    import scratchattach as sa
+
+    path = Path(__file__).parent.parent / "intro for kelmare (yoda tour) (p2).sb3"
+
+    if path.exists():
+        print(f"loading cached {path}")
+        body = sa.editor.Project.from_sb3(path.open("rb"))
+    else:
+        print(f"Could not find {path}")
+        project = sa.get_project(1074489898)
+        body = project.body()
+
+    body.obfuscate()
+
+    # body.save_json("obfuscated")
+    body.export("obfuscated.sb3")
+
+
+if __name__ == '__main__':
+    test_project()

tests/test_editor_project.py

@@ -0,0 +1,9 @@
+import sys
+
+
+def test_import():
+    sys.path.insert(0, ".")
+    import scratchattach as sa
+
+    proj = sa.get_project(104)
+    body = proj.body()

tests/test_import.py

@@ -1,4 +1,4 @@
 import sys
 def test_import():
-  sys.path.insert(0, ".")
-  import scratchattach
+    sys.path.insert(0, ".")
+    import scratchattach as sa

tests/test_other_apis.py

@@ -0,0 +1,66 @@
+import pprint
+import sys
+from datetime import datetime, timedelta, timezone
+import warnings
+
+
+def test_other_apis():
+    sys.path.insert(0, ".")
+    import scratchattach as sa
+    from scratchattach.utils import exceptions
+    import util
+
+    assert sa.check_email("example@example.com")
+    assert not sa.check_email("bad_email")
+
+    news = sa.get_news()
+    found_wiki_wednesday = False
+    for newsitem in news:
+        if newsitem["headline"] == "Wiki Wednesday!":
+            found_wiki_wednesday = True
+    if not found_wiki_wednesday:
+        warnings.warn(f"Did not find wiki wednesday! News dict: {news}")
+
+    featured_projects = sa.featured_projects()
+    featured_studios = sa.featured_studios()
+    top_loved = sa.top_loved()
+    top_remixed = sa.top_remixed()
+    newest_projects = sa.newest_projects()
+    curated_projects = sa.curated_projects()
+    design_studio_projects = sa.design_studio_projects()
+
+    def test_featured_data(_name, data: list[sa.Project | sa.Studio]):
+        if not data:
+            warnings.warn(f"Did not find {_name}! {data}")
+        else:
+            print(data)
+
+    test_featured_data("featured featured_projects", featured_projects)
+    test_featured_data("featured featured_studios", featured_studios)
+    test_featured_data("featured top_loved", top_loved)
+    test_featured_data("featured top_remixed", top_remixed)
+    test_featured_data("featured newest_projects", newest_projects)
+    test_featured_data("featured curated_projects", curated_projects)
+    test_featured_data("featured design_studio_projects", design_studio_projects)
+
+    stats = sa.total_site_stats()
+    assert stats["PROJECT_COUNT"] >= 164307034
+    assert stats["USER_COUNT"] >= 135078559
+    assert stats["STUDIO_COMMENT_COUNT"] >= 259801679
+    assert stats["PROFILE_COMMENT_COUNT"] >= 330786513
+    assert stats["STUDIO_COUNT"] >= 34866300
+    assert stats["COMMENT_COUNT"] >= 989937824
+    assert stats["PROJECT_COMMENT_COUNT"] >= 399349632
+
+    site_traffic = sa.monthly_site_traffic()
+    assert int(site_traffic["pageviews"]) > 10000
+    assert int(site_traffic["users"]) > 10000
+    assert int(site_traffic["sessions"]) > 10000
+
+    country_counts = sa.country_counts()
+    for name, count in country_counts.items():
+        assert count > 0, f"country_counts[{name!r}] = {count}"
+
+
+if __name__ == "__main__":
+    test_other_apis()

tests/test_project.py

@@ -0,0 +1,72 @@
+import pprint
+import sys
+import warnings
+
+def test_project():
+    sys.path.insert(0, ".")
+    import scratchattach as sa
+    from util import session, credentials_available
+    if not credentials_available():
+        warnings.warn("Skipped test_project because there were no credentials available.")
+        return
+    sess = session()
+
+
+    project = sess.connect_project(104)
+    tree = project.remix_tree_pretty()
+    assert len(tree) > 1000 # there is a lot of chars. Just assert that sth is generated
+
+    project = sess.connect_project(1209355136)
+
+    assert project
+    assert project.title == "Sample project #1"
+    assert project.author_name == "ScratchAttachV2"
+    assert project.embed_url == "https://scratch.mit.edu/projects/1209355136/embed"
+    assert project.is_shared()
+    # create_remix
+    # load_description
+    # download
+    # get_json
+    # body
+    # raw_json
+    # raw_json_or_empty
+    # creator_agent
+    assert project.author().id == 147905216
+    # studios
+    comment = project.comments()[0]  # TODO: move this to a separate comment tester
+    # comment_by_id
+    # comment_replies
+    # comment by id
+    # (un)love
+    # (un)favorite
+    # pos_view
+    # set_fields
+    # turn on/off/toggle commenting
+    # (un)share
+    # set thumb
+    # delete comment
+    # report comment
+    # post/reply comment
+    # set body/json/upload json from
+    # set title/instruction/notes
+    # visibility
+
+    assert comment.id == 489648029
+
+    remix = project.remixes()[0]
+    assert remix.id == 1209582809
+    assert remix.title == "Sample remix"
+    assert remix.author_name == "ScratchAttachV2"
+    assert remix.embed_url == "https://scratch.mit.edu/projects/1209582809/embed"
+
+    assert sess.connect_project(414601586).moderation_status() == "notsafe"
+    assert sess.connect_project(1207314193).moderation_status() == "safe"
+    assert sess.connect_project(
+        1233).moderation_status() == "notreviewed"  # if this becomes reviewed, please update this
+    # ^^ also this project is an infinite remix loop!
+
+    assert sa.explore_projects()
+    assert sa.search_projects(query="scratchattach")
+
+if __name__ == '__main__':
+    test_project()