tests: add tests for the conditional disable generators

Author: max-moser

tests/test_generators.py

@@ -22,6 +22,8 @@
     AuthenticatedUser,
     ConditionalGenerator,
     Disable,
+    DisableIf,
+    DisableIfReadOnly,
     Generator,
     IfConfig,
     RecordOwners,
@@ -266,3 +268,67 @@ def test_ifconfig(app, create_record):
         UserNeed(2),
         UserNeed(3),
     }
+
+
+def test_disable_if_scalar_value(app):
+    generator = DisableIf(False)
+    assert generator.needs() == []
+    assert generator.excludes() == []
+    assert generator.query_filter() == []
+
+    generator = DisableIf(True)
+    assert generator.needs() == []
+    assert generator.excludes() == [any_user]
+    assert generator.query_filter().to_dict() == {"match_none": {}}
+
+
+def test_disable_if_function(app):
+    def _if_two_kwargs(**kwargs):
+        return len(kwargs) == 2
+
+    # The generator should only disable if 2 keyword arguments are supplied
+    generator = DisableIf(_if_two_kwargs)
+    assert generator.excludes(record=None) == []
+    assert generator.query_filter(record=None) == []
+
+    assert generator.excludes(record=None, second_arg=None) == [any_user]
+    assert generator.query_filter(record=None, second_arg=None).to_dict() == {
+        "match_none": {}
+    }
+
+    assert generator.excludes(record=None, second_arg=None, third_arg=None) == []
+    assert generator.query_filter(record=None, second_arg=None, third_arg=None) == []
+
+
+def test_disable_if_read_only(app):
+    generator = DisableIfReadOnly()
+
+    # Normal operation
+    app.config["RECORDS_PERMISSIONS_READ_ONLY"] = False
+    assert generator.excludes(record=None) == []
+    assert generator.query_filter(record=None) == []
+
+    # System is in read-only mode
+    app.config["RECORDS_PERMISSIONS_READ_ONLY"] = True
+    assert generator.excludes(record=None) == [any_user]
+    assert generator.query_filter(record=None).to_dict() == {"match_none": {}}
+
+
+def test_disable_if_read_only_function(app):
+    def _some_function(record, **kwargs):
+        return record is None and not kwargs.get("exception", False)
+
+    app.config["RECORDS_PERMISSIONS_READ_ONLY"] = _some_function
+    generator = DisableIfReadOnly()
+
+    # Don't deny on non-None records
+    assert generator.excludes(record={}) == []
+    assert generator.query_filter(record={}) == []
+
+    # Deny if the record is None
+    assert generator.excludes(record=None) == [any_user]
+    assert generator.query_filter(record=None).to_dict() == {"match_none": {}}
+
+    # Make an exception if requested
+    assert generator.excludes(record=None, exception=True) == []
+    assert generator.query_filter(record=None, exception=True) == []