128-reviva by VianneyMI · Pull Request #130 · VianneyMI/monggregate

VianneyMI · 2025-05-20T21:53:51Z

Description

Revamped online documentation (without publishing the changes yet)
Refactored tests to follow the package structure so that it is easier to know where is the test for a given function.

- About to write new tests - Respecting the structure of the package

…unset and unwind

github-actions · 2025-05-20T21:54:14Z

-    with open('docs/index.md', 'r') as index_file:
+    with open("docs/index.md", "r", encoding="utf-8") as index_file:
        index = index_file.readlines()
    assert readme == index, f"""README.md and docs/index.md files are not in sync.


[black-format] _{reported by reviewdog 🐶}

Suggested change

assert readme == index, f"""README.md and docs/index.md files are not in sync.

assert (

readme == index

), f"""README.md and docs/index.md files are not in sync.

github-actions · 2025-05-20T21:54:14Z

+        assert all(checks_constants_in_enum) and all(checks_enum_in_constants), (
+            error_message
+        )


[black-format] _{reported by reviewdog 🐶}

Suggested change

assert all(checks_constants_in_enum) and all(checks_enum_in_constants), (

error_message

)

assert all(checks_constants_in_enum) and all(

checks_enum_in_constants

), error_message

github-actions · 2025-05-20T21:54:20Z

@@ -0,0 +1,120 @@
+import pytest


[Ruff] _{reported by reviewdog 🐶}
F401 [*] pytest imported but unused

github-actions · 2025-05-20T21:54:20Z

+    AggregationVariableEnum,
+    Dollar,
+    DollarDollar,
+    CLUSTER_TIME,


[Ruff] _{reported by reviewdog 🐶}
F401 [*] monggregate.dollar.CLUSTER_TIME imported but unused

github-actions · 2025-05-20T21:54:20Z

+    Dollar,
+    DollarDollar,
+    CLUSTER_TIME,
+    NOW,


[Ruff] _{reported by reviewdog 🐶}
F401 [*] monggregate.dollar.NOW imported but unused

github-actions · 2025-05-20T21:54:20Z

+    DollarDollar,
+    CLUSTER_TIME,
+    NOW,
+    ROOT,


[Ruff] _{reported by reviewdog 🐶}
F401 [*] monggregate.dollar.ROOT imported but unused

github-actions · 2025-05-20T21:54:20Z

+    CLUSTER_TIME,
+    NOW,
+    ROOT,
+    CURRENT,


[Ruff] _{reported by reviewdog 🐶}
F401 [*] monggregate.dollar.CURRENT imported but unused

github-actions · 2025-05-20T21:54:23Z

+
+        # NOTE: This should raise a ValueError
+        with pytest.raises(ValueError):
+            project = Project(include=True, exclude=True, fields=["field1", "field2"])


[Ruff] _{reported by reviewdog 🐶}
F841 Local variable project is assigned to but never used

github-actions · 2025-05-20T21:54:23Z

+        assert issubclass(DummyStage, Stage)
+
+        with pytest.raises(TypeError):
+            dummy_stage = DummyStage()


[Ruff] _{reported by reviewdog 🐶}
F841 Local variable dummy_stage is assigned to but never used

github-actions · 2025-05-20T21:54:23Z

@@ -0,0 +1,33 @@
+"""Tests for the UnionWith stage."""
+
+import pytest


[Ruff] _{reported by reviewdog 🐶}
F401 [*] pytest imported but unused

github-actions · 2025-05-20T21:54:23Z

@@ -0,0 +1,26 @@
+"""Tests for the Unset stage."""
+
+import pytest


[Ruff] _{reported by reviewdog 🐶}
F401 [*] pytest imported but unused

github-actions · 2025-05-20T21:54:23Z

@@ -0,0 +1,36 @@
+"""Tests for the Unwind stage."""
+
+import pytest


[Ruff] _{reported by reviewdog 🐶}
F401 [*] pytest imported but unused

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

mypy

github-actions · 2025-05-20T21:54:57Z


-    def __getattr__(self, name)->str|Any:
-        """Overloads the __getattr__ method. 
+    def __getattr__(self, name) -> str | Any:


🚫 [mypy] _{reported by reviewdog 🐶}
Function is missing a type annotation for one or more arguments [no-untyped-def]

github-actions · 2025-05-20T21:54:57Z

-                    "as":self.name
+                "$lookup": {
+                    "from": self.right,
+                    "let": self.let,


🚫 [mypy] _{reported by reviewdog 🐶}
Dict entry 1 has incompatible type "str": "dict[Any, Any] | None"; expected "str": "str | None" [dict-item]

github-actions · 2025-05-20T21:54:57Z

+                "$lookup": {
+                    "from": self.right,
+                    "let": self.let,
+                    "pipeline": self.pipeline,


🚫 [mypy] _{reported by reviewdog 🐶}
Dict entry 2 has incompatible type "str": "list[dict[Any, Any]] | None"; expected "str": "str | None" [dict-item]

github-actions · 2025-05-20T21:54:57Z

+                    "from": self.right,
+                    "localField": self.right_on,
+                    "foreignField": self.right_on,
+                    "let": self.let,


🚫 [mypy] _{reported by reviewdog 🐶}
Dict entry 3 has incompatible type "str": "dict[Any, Any] | None"; expected "str": "str | None" [dict-item]

github-actions · 2025-05-20T21:54:57Z

+                    "localField": self.right_on,
+                    "foreignField": self.right_on,
+                    "let": self.let,
+                    "pipeline": self.pipeline,


🚫 [mypy] _{reported by reviewdog 🐶}
Dict entry 4 has incompatible type "str": "list[dict[Any, Any]] | None"; expected "str": "str | None" [dict-item]

github-actions · 2025-05-20T21:55:00Z

+
+        assert pipeline[0].expression == {"$match": {"name": "John"}}
+
+    def test__getitem__index_out_of_range(self):


🚫 [mypy] _{reported by reviewdog 🐶}
Function is missing a return type annotation [no-untyped-def]

github-actions · 2025-05-20T21:55:00Z

+
+        assert pipeline[0].expression == {"$match": {"name": "John"}}
+
+    def test__getitem__index_out_of_range(self):


📝 [mypy] _{reported by reviewdog 🐶}
Use "-> None" if function does not return a value

github-actions · 2025-05-20T21:55:00Z

+        with pytest.raises(IndexError):
+            pipeline[2]
+
+    def test__setitem__(self):


🚫 [mypy] _{reported by reviewdog 🐶}
Function is missing a return type annotation [no-untyped-def]

github-actions · 2025-05-20T21:55:00Z

+        with pytest.raises(IndexError):
+            pipeline[2]
+
+    def test__setitem__(self):


📝 [mypy] _{reported by reviewdog 🐶}
Use "-> None" if function does not return a value

github-actions · 2025-05-20T21:55:00Z

+
+        assert isinstance(pipeline[index], Project)
+
+    def test__setitem__index_out_of_range(self):


🚫 [mypy] _{reported by reviewdog 🐶}
Function is missing a return type annotation [no-untyped-def]

github-actions · 2025-05-27T21:20:51Z

+        full_test_path = test_root / expected_test_file
+
+        if not full_test_path.exists():
+            src_full_path = src_root / src_file


[Ruff] _{reported by reviewdog 🐶}
F841 Local variable src_full_path is assigned to but never used

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

mypy

tests/tests_monggregate/test_fields.py|110 col 5| Use "-> None" if function does not return a value
tests/tests_monggregate/test_fields.py|119 col 5| Function is missing a return type annotation [no-untyped-def]
tests/tests_monggregate/test_fields.py|119 col 5| Use "-> None" if function does not return a value
tests/tests_monggregate/test_fields.py|128 col 5| Function is missing a return type annotation [no-untyped-def]
tests/tests_monggregate/test_fields.py|128 col 5| Use "-> None" if function does not return a value
tests/tests_monggregate/test_fields.py|140 col 1| Function is missing a return type annotation [no-untyped-def]
tests/tests_monggregate/test_fields.py|140 col 1| Use "-> None" if function does not return a value
tests/tests_monggregate/test_dollar.py|23 col 5| Function is missing a return type annotation [no-untyped-def]
tests/tests_monggregate/test_dollar.py|23 col 5| Use "-> None" if function does not return a value
tests/tests_monggregate/test_dollar.py|39 col 5| Function is missing a return type annotation [no-untyped-def]
tests/tests_monggregate/test_dollar.py|39 col 5| Use "-> None" if function does not return a value
tests/tests_monggregate/test_dollar.py|77 col 5| Function is missing a return type annotation [no-untyped-def]
tests/tests_monggregate/test_dollar.py|77 col 5| Use "-> None" if function does not return a value
tests/tests_monggregate/test_dollar.py|83 col 5| Function is missing a return type annotation [no-untyped-def]
tests/tests_monggregate/test_dollar.py|83 col 5| Use "-> None" if function does not return a value
tests/tests_monggregate/test_dollar.py|89 col 5| Function is missing a return type annotation [no-untyped-def]
tests/tests_monggregate/test_dollar.py|89 col 5| Use "-> None" if function does not return a value
tests/tests_monggregate/test_dollar.py|95 col 5| Function is missing a return type annotation [no-untyped-def]
tests/tests_monggregate/test_dollar.py|95 col 5| Use "-> None" if function does not return a value
tests/tests_monggregate/test_dollar.py|111 col 5| Function is missing a return type annotation [no-untyped-def]
tests/tests_monggregate/test_dollar.py|111 col 5| Use "-> None" if function does not return a value
tests/tests_monggregate/test_dollar.py|117 col 5| Function is missing a return type annotation [no-untyped-def]
tests/tests_monggregate/test_dollar.py|117 col 5| Use "-> None" if function does not return a value
tests/tests_monggregate/test_base.py|22 col 1| Function is missing a return type annotation [no-untyped-def]
tests/tests_monggregate/test_base.py|22 col 1| Use "-> None" if function does not return a value
tests/tests_monggregate/test_base.py|33 col 1| Function is missing a return type annotation [no-untyped-def]
tests/tests_monggregate/test_base.py|33 col 1| Use "-> None" if function does not return a value
tests/tests_monggregate/test_base.py|49 col 1| Function is missing a return type annotation [no-untyped-def]
tests/tests_monggregate/test_base.py|49 col 1| Use "-> None" if function does not return a value
tests/tests_monggregate/test_base.py|69 col 5| Function is missing a return type annotation [no-untyped-def]
tests/tests_monggregate/test_base.py|69 col 5| Use "-> None" if function does not return a value
tests/tests_monggregate/test_base.py|78 col 5| Function is missing a return type annotation [no-untyped-def]
tests/tests_monggregate/test_base.py|78 col 5| Use "-> None" if function does not return a value
tests/tests_monggregate/test_base.py|94 col 5| Function is missing a return type annotation [no-untyped-def]
tests/tests_monggregate/test_base.py|94 col 5| Use "-> None" if function does not return a value
tests/tests_monggregate/test_base.py|113 col 5| Function is missing a return type annotation [no-untyped-def]
tests/tests_monggregate/test_base.py|113 col 5| Use "-> None" if function does not return a value

github-actions · 2025-05-27T21:21:28Z

+
+        assert isinstance(pipeline[index], Project)
+
+    def test__setitem__index_out_of_range(self):


📝 [mypy] _{reported by reviewdog 🐶}
Use "-> None" if function does not return a value

github-actions · 2025-05-27T21:21:28Z

+        with pytest.raises(IndexError):
+            pipeline[index] = Project(fields=["name", "age"], include=True)
+
+    def test__delitem__(self):


🚫 [mypy] _{reported by reviewdog 🐶}
Function is missing a return type annotation [no-untyped-def]

github-actions · 2025-05-27T21:21:28Z

+        with pytest.raises(IndexError):
+            pipeline[index] = Project(fields=["name", "age"], include=True)
+
+    def test__delitem__(self):


📝 [mypy] _{reported by reviewdog 🐶}
Use "-> None" if function does not return a value

github-actions · 2025-05-27T21:21:28Z

+        del pipeline[0]
+        assert pipeline.export() == [{"$match": {"name": "John"}}]
+
+    def test__len__(self):


🚫 [mypy] _{reported by reviewdog 🐶}
Function is missing a return type annotation [no-untyped-def]

github-actions · 2025-05-27T21:21:28Z

+        del pipeline[0]
+        assert pipeline.export() == [{"$match": {"name": "John"}}]
+
+    def test__len__(self):


📝 [mypy] _{reported by reviewdog 🐶}
Use "-> None" if function does not return a value

github-actions · 2025-05-27T21:21:30Z

+        reason="This passes but should fail. Need to be fixed in the code"
+    )
+
+    def test_validate_edge_case_single_dollar(self):


🚫 [mypy] _{reported by reviewdog 🐶}
Function is missing a return type annotation [no-untyped-def]

github-actions · 2025-05-27T21:21:30Z

+        reason="This passes but should fail. Need to be fixed in the code"
+    )
+
+    def test_validate_edge_case_single_dollar(self):


📝 [mypy] _{reported by reviewdog 🐶}
Use "-> None" if function does not return a value

github-actions · 2025-05-27T21:21:31Z

+class TestVariable:
+    """Test the Variable class."""
+
+    def test_validate_valid_variable(self):


🚫 [mypy] _{reported by reviewdog 🐶}
Function is missing a return type annotation [no-untyped-def]

github-actions · 2025-05-27T21:21:31Z

+class TestVariable:
+    """Test the Variable class."""
+
+    def test_validate_valid_variable(self):


📝 [mypy] _{reported by reviewdog 🐶}
Use "-> None" if function does not return a value

github-actions · 2025-05-27T21:21:31Z

+        # Assert
+        assert result == variable
+
+    def test_validate_invalid_variable_without_dollars(self):


🚫 [mypy] _{reported by reviewdog 🐶}
Function is missing a return type annotation [no-untyped-def]

VianneyMI added 30 commits April 24, 2025 23:40

update docs

c2c2178

Move to uv

8bb8a33

Syncing readme and index

de6eb4b

Synced docs

e82bc71

Updated mongodb-umbrella page

bae9537

Improved the why-use-monggregate page

e527778

Update doc

a09519d

Improved how to guides

1075741

Docs improvements

276d917

Improved look and feel

8e418e6

Promote one level up the common pipelines use cases

6a16f6a

Added context about dollar sign

da23dce

Updated changelog

1794ca7

WIP improving code snippets look and feel

e156c81

Improved look and feel of code snippets

38da957

Refactoring tests

28112f6

Move old test to test_legacy

ebd6b5a

- About to write new tests - Respecting the structure of the package

Covering each module with a dedicated test file

0ce4cab

Add test on base

07c0d17

Test dollar

3515271

Add tests on fields

6fb46e7

Add test on pipeline

f0a5e8f

test utils

a0e7f69

Add tests bucket auto

833d38f

Tests bucket

efc3057

test for count, group and limit

e7b102c

Renamed stages in tests as tests_stages

6a16660

test -> tests for tests folders

bab561b

Tests lookup

cb0948b

Tests on match and lookup

3ca02bf

VianneyMI added 3 commits May 15, 2025 20:19

Tests out and replace_root

da46f70

Tests fir sample, set, skip, sort_by_count, sort, stage, union_with, …

114408b

…unset and unwind

test vector search

e95f96a

VianneyMI linked an issue May 20, 2025 that may be closed by this pull request

Revival #128

Closed

6 tasks

github-actions Bot reviewed May 20, 2025

View reviewed changes

Fixed tests

5499a55

github-actions Bot reviewed May 27, 2025

View reviewed changes

VianneyMI removed a link to an issue May 27, 2025

Revival #128

Closed

6 tasks

VianneyMI marked this pull request as ready for review May 27, 2025 21:26

VianneyMI merged commit 4b65c90 into main May 27, 2025
2 checks passed

		@@ -0,0 +1,33 @@
		"""Tests for the UnionWith stage."""

		import pytest

		@@ -0,0 +1,26 @@
		"""Tests for the Unset stage."""

		import pytest

		@@ -0,0 +1,36 @@
		"""Tests for the Unwind stage."""

		import pytest


		assert pipeline[0].expression == {"$match": {"name": "John"}}

		def test__getitem__index_out_of_range(self):


		assert isinstance(pipeline[index], Project)

		def test__setitem__index_out_of_range(self):

Conversation

VianneyMI commented May 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 20, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot May 27, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions Bot left a comment

Choose a reason for hiding this comment

Uh oh!

VianneyMI commented May 20, 2025 •

edited

Loading