Add fail & between_equal()

README.md

@@ -83,8 +83,10 @@ These methods do NOT need to be inside of a `with check:` block.
 - **check.greater_equal** - *a >= b*
 - **check.less** - *a < b*
 - **check.less_equal** - *a <= b*
-- **check.between** - *a < b < c*
+- **check.between(b, a, c, ge=False, le=False)** - *a < b < c*
+- **check.between_equal(b, a, c)** - *a <= b <= c*
 - **check.raises** - *func raises given exception* similar to [pytest.raises](https://docs.pytest.org/en/latest/reference/reference.html#pytest-raises)
+- **check.fail(msg)** - *Log a failure*
 
 The httpx example can be rewritten with helper functions:
 

changelog.md

@@ -20,6 +20,13 @@ All notable changes to this project  be documented in this file.
 
 -->
 
+## [2.3.0] - 2024-Jan-17
+
+### Added
+  - `between_equal(b, a c)` 
+    - as a shortcut for `between(b, a, c, ge=True, le=True)`
+  - `fail(msg)` - indicate test failure, but don't stop testing 
+
 ## [2.2.5] - 2024-Jan-17
 
 - fix [155](https://github.com/okken/pytest-check/issues/155)

examples/test_example_functions_fail.py

@@ -102,3 +102,7 @@ def test_between_le():
 
 def test_between_ge_le():
     check.between(21, 0, 20, ge=True, le=True)
+
+
+def test_between_equal():
+    check.between_equal(21, 0, 20, ge=True, le=True)

examples/test_example_functions_pass.py

@@ -106,3 +106,9 @@ def test_between_ge_le():
     check.between(0, 0, 20, ge=True, le=True)
     check.between(10, 0, 20, ge=True, le=True)
     check.between(20, 0, 20, ge=True, le=True)
+
+
+def test_between_equal():
+    check.between_equal(0, 0, 20)
+    check.between_equal(10, 0, 20)
+    check.between_equal(20, 0, 20)

pyproject.toml

@@ -4,7 +4,7 @@ authors = [{name = "Brian Okken"}]
 readme = "README.md"
 license = {file = "LICENSE.txt"}
 description="A pytest plugin that allows multiple failures per test."
-version = "2.2.5"
+version = "2.3.0"
 requires-python = ">=3.7"
 classifiers = [
     "License :: OSI Approved :: MIT License",

src/pytest_check/check_functions.py

@@ -25,7 +25,9 @@
     "less",
     "less_equal",
     "between",
+    "between_equal",
     "check_func",
+    "fail",
 ]
 
 
@@ -243,3 +245,13 @@ def between(b, a, c, msg="", ge=False, le=False):
         else:
             log_failure(f"check {a} < {b} < {c}", msg)
             return False
+
+
+def between_equal(b, a, c, msg=""):
+    __tracebackhide__ = True
+    return between(b, a, c, msg, ge=True, le=True)
+
+
+def fail(msg):
+    __tracebackhide__ = True
+    log_failure(msg)

tests/test_fail_func.py

@@ -0,0 +1,16 @@
+def test_fail_func(pytester):
+    pytester.copy_example("examples/test_example_fail_func.py")
+    result = pytester.runpytest("--check-max-tb=2")
+    result.assert_outcomes(failed=2)
+    result.stdout.fnmatch_lines(
+        [
+            "*FAILURE: one",
+            "*test_one_failure() -> check.fail('one')",
+            "Failed Checks: 1",
+            "*FAILURE: one",
+            "*test_two_failures() -> check.fail('one')",
+            "*FAILURE: two",
+            "*test_two_failures() -> check.fail('two')",
+            "Failed Checks: 2",
+        ],
+    )

tests/test_functions.py

@@ -1,10 +1,10 @@
 def test_passing_check_functions(pytester):
     pytester.copy_example("examples/test_example_functions_pass.py")
     result = pytester.runpytest()
-    result.assert_outcomes(failed=0, passed=22)
+    result.assert_outcomes(failed=0, passed=23)
 
 
 def test_failing_check_functions(pytester):
     pytester.copy_example("examples/test_example_functions_fail.py")
     result = pytester.runpytest()
-    result.assert_outcomes(failed=22, passed=0)
+    result.assert_outcomes(failed=23, passed=0)