feat: improved project coverage and minor code fixes (#36)

* branch coverage is now at 90% for all project * invalid `expression` was returning `true` instead of `failing` (`onFailure` is used when evaluating invalid expressions) * `Kotlin` evaluator was not considering unprotected string `"null"` as `null` value, `"\"null\""` is still considered as `string` with value `null`
rapatao · Jul 27, 2024 · 22a68f9 · 22a68f9
1 parent 8d19c9a
commit 22a68f9
Show file tree

Hide file tree

Showing 18 changed files with 276 additions and 121 deletions.
diff --git a/JSON.md b/JSON.md
@@ -261,18 +261,66 @@ To see more details, check its source: [here](src/test/kotlin/com/rapatao/projec
 }
 ```
 
+```json
+{
+  "left" : "\"null\"",
+  "operator" : "equals",
+  "right" : "\"null\""
+}
+```
+
+```json
+{
+  "left" : 10.2,
+  "operator" : "equals",
+  "right" : 10.2
+}
+```
+
+```json
+{
+  "left" : 10,
+  "operator" : "equals",
+  "right" : 10
+}
+```
+
 ```json
 {
   "left" : "item.price",
   "operator" : "not_equals",
-  "right" : 0
+  "right" : 10
 }
 ```
 
 ```json
 {
   "left" : "item.price",
   "operator" : "not_equals",
+  "right" : 0
+}
+```
+
+```json
+{
+  "left" : "\"null\"",
+  "operator" : "not_equals",
+  "right" : "\"null\""
+}
+```
+
+```json
+{
+  "left" : 10.2,
+  "operator" : "not_equals",
+  "right" : 10.2
+}
+```
+
+```json
+{
+  "left" : 10,
+  "operator" : "not_equals",
   "right" : 10
 }
 ```
@@ -1907,6 +1955,33 @@ To see more details, check its source: [here](src/test/kotlin/com/rapatao/projec
 }
 ```
 
+```json
+{
+  "left" : "10",
+  "operator" : "contains",
+  "right" : "\"different value\"",
+  "onFailure" : "FALSE"
+}
+```
+
+```json
+{
+  "left" : "item.name",
+  "operator" : "contains",
+  "right" : "10",
+  "onFailure" : "FALSE"
+}
+```
+
+```json
+{
+  "left" : "null",
+  "operator" : "contains",
+  "right" : "10",
+  "onFailure" : "FALSE"
+}
+```
+
 ```json
 {
   "left" : "item.name",

diff --git a/build.gradle b/build.gradle
@@ -1,3 +1,5 @@
+import kotlinx.kover.gradle.plugin.dsl.CoverageUnit
+
 plugins {
     id "java-library"
     id "signing"
@@ -9,6 +11,40 @@ plugins {
     id "com.github.ben-manes.versions" version "${BenManerVersionsVersion}"
 }
 
+kover {
+    reports {
+        total {
+            verify {
+                rule {
+                    bound {
+                        coverageUnits = CoverageUnit.BRANCH
+                        it.minValue = 90
+                    }
+                    bound {
+                        coverageUnits = CoverageUnit.INSTRUCTION
+                        it.minValue = 90
+                    }
+                    bound {
+                        coverageUnits = CoverageUnit.BRANCH
+                        it.minValue = 90
+                    }
+                }
+            }
+            it.html {
+                onCheck = true
+            }
+        }
+    }
+}
+
+dependencies {
+    kover(project(":core"))
+    kover(project(":graaljs-evaluator"))
+    kover(project(":kotlin-evaluator"))
+    kover(project(":rhino-evaluator"))
+    kover(project(":jackson"))
+}
+
 allprojects {
     apply plugin: "java-library"
     apply plugin: "signing"

diff --git a/core/src/main/kotlin/com/rapatao/projects/ruleset/engine/Evaluator.kt b/core/src/main/kotlin/com/rapatao/projects/ruleset/engine/Evaluator.kt
@@ -3,7 +3,6 @@ package com.rapatao.projects.ruleset.engine
 import com.rapatao.projects.ruleset.engine.context.EvalContext
 import com.rapatao.projects.ruleset.engine.types.Expression
 import com.rapatao.projects.ruleset.engine.types.OnFailure
-import com.rapatao.projects.ruleset.engine.types.errors.UnknownOperator
 import com.rapatao.projects.ruleset.engine.types.operators.Operator
 
 /**
@@ -24,6 +23,8 @@ abstract class Evaluator(
      */
     fun evaluate(expression: Expression, inputData: Any): Boolean {
         return usingFailureWrapper(expression.onFailure) {
+            require(expression.isValid(this)) { "expression $expression is not valid" }
+
             call(inputData) {
                 expression.takeIf { v -> v.parseable() }?.processExpression(it) ?: true &&
                     expression.noneMatch?.processNoneMatch(it) ?: true &&
@@ -96,9 +97,10 @@ abstract class Evaluator(
         return usingFailureWrapper(this.onFailure) {
             requireNotNull(this.operator) { "expression operator must not be null" }
 
-            val operator = operator(this.operator) ?: throw UnknownOperator(this.operator)
+            val operator = operator(this.operator)
+            requireNotNull(operator) { "Unknown operator: $operator" }
 
-            context.process(this.left, operator, this.right)
+            context.process(left = this.left, operator = operator, right = this.right)
         }
     }
 

diff --git a/core/src/main/kotlin/com/rapatao/projects/ruleset/engine/types/errors/UnknownOperator.kt b/core/src/main/kotlin/com/rapatao/projects/ruleset/engine/types/errors/UnknownOperator.kt
diff --git a/graaljs-evaluator/build.gradle b/graaljs-evaluator/build.gradle
@@ -1,38 +1,7 @@
-import kotlinx.kover.gradle.plugin.dsl.MetricType
-
 dependencies {
     api project(":core")
     api("org.graalvm.polyglot:polyglot:24.0.2")
     api("org.graalvm.polyglot:js-community:24.0.2")
 
     testImplementation project(":tests")
 }
-
-koverReport {
-    verify {
-        rule {
-            enabled = true
-            bound {
-                enabled = true
-                metric = MetricType.BRANCH
-                minValue = 80
-            }
-            bound {
-                enabled = true
-                metric = MetricType.LINE
-                minValue = 90
-            }
-            bound {
-                enabled = true
-                metric = MetricType.INSTRUCTION
-                minValue = 90
-            }
-        }
-    }
-
-    defaults {
-        html {
-            onCheck = true
-        }
-    }
-}
diff --git a/...test/kotlin/com/rapatao/projects/ruleset/engine/evaluator/graaljs/GraalJSEvaluatorTest.kt b/...test/kotlin/com/rapatao/projects/ruleset/engine/evaluator/graaljs/GraalJSEvaluatorTest.kt
@@ -1,5 +1,12 @@
 package com.rapatao.projects.ruleset.engine.evaluator.graaljs
 
 import com.rapatao.projects.ruleset.engine.BaseEvaluatorTest
+import com.rapatao.projects.ruleset.engine.helper.ExposeEngineTestOperator
 
-class GraalJSEvaluatorTest : BaseEvaluatorTest(GraalJSEvaluator())
+class GraalJSEvaluatorTest : BaseEvaluatorTest(
+    GraalJSEvaluator(
+        operators = listOf(
+            ExposeEngineTestOperator(),
+        ),
+    ),
+)
diff --git a/gradle.properties b/gradle.properties
@@ -7,6 +7,6 @@ jacocoVersion=0.8.7
 javaVersion=17
 junitVersion=5.10.2
 kotlinVersion=1.9.22
-koverVersion=0.7.6
+koverVersion=0.8.3
 publishPluginVersion=1.3.0
 rhinoVersion=1.7.14
diff --git a/kotlin-evaluator/build.gradle b/kotlin-evaluator/build.gradle
@@ -1,36 +1,5 @@
-import kotlinx.kover.gradle.plugin.dsl.MetricType
-
 dependencies {
     api project(":core")
 
     testImplementation project(":tests")
 }
-
-koverReport {
-    verify {
-        rule {
-            enabled = true
-            bound {
-                enabled = true
-                metric = MetricType.BRANCH
-                minValue = 70
-            }
-            bound {
-                enabled = true
-                metric = MetricType.LINE
-                minValue = 90
-            }
-            bound {
-                enabled = true
-                metric = MetricType.INSTRUCTION
-                minValue = 90
-            }
-        }
-    }
-
-    defaults {
-        html {
-            onCheck = true
-        }
-    }
-}
diff --git a/...tor/src/main/kotlin/com/rapatao/projects/ruleset/engine/evaluator/kotlin/KotlinContext.kt b/...tor/src/main/kotlin/com/rapatao/projects/ruleset/engine/evaluator/kotlin/KotlinContext.kt
@@ -25,6 +25,7 @@ class KotlinContext(
 
     private fun Any?.asValue(): Any? {
         val result = when {
+            this is String && this == "null" -> null
             this is String && !this.trim().matches(Regex("^\".*\"$")) -> rawValue()
             this is String && this.trim().matches(Regex("\".*\"")) -> this.unwrap()
             else -> this

diff --git a/...c/test/kotlin/com/rapatao/projects/ruleset/engine/evaluator/kotlin/KotlinEvaluatorTest.kt b/...c/test/kotlin/com/rapatao/projects/ruleset/engine/evaluator/kotlin/KotlinEvaluatorTest.kt
@@ -1,5 +1,12 @@
 package com.rapatao.projects.ruleset.engine.evaluator.kotlin
 
 import com.rapatao.projects.ruleset.engine.BaseEvaluatorTest
+import com.rapatao.projects.ruleset.engine.helper.ExposeEngineTestOperator
 
-class KotlinEvaluatorTest : BaseEvaluatorTest(KotlinEvaluator())
+class KotlinEvaluatorTest : BaseEvaluatorTest(
+    KotlinEvaluator(
+        operators = listOf(
+            ExposeEngineTestOperator(),
+        ),
+    ),
+)
diff --git a/rhino-evaluator/build.gradle b/rhino-evaluator/build.gradle
@@ -1,37 +1,6 @@
-import kotlinx.kover.gradle.plugin.dsl.MetricType
-
 dependencies {
     api project(":core")
     api("org.mozilla:rhino:${rhinoVersion}")
 
     testImplementation project(":tests")
 }
-
-koverReport {
-    verify {
-        rule {
-            enabled = true
-            bound {
-                enabled = true
-                metric = MetricType.BRANCH
-                minValue = 80
-            }
-            bound {
-                enabled = true
-                metric = MetricType.LINE
-                minValue = 90
-            }
-            bound {
-                enabled = true
-                metric = MetricType.INSTRUCTION
-                minValue = 90
-            }
-        }
-    }
-
-    defaults {
-        html {
-            onCheck = true
-        }
-    }
-}
diff --git a/...src/test/kotlin/com/rapatao/projects/ruleset/engine/evaluator/rhino/RhinoEvaluatorTest.kt b/...src/test/kotlin/com/rapatao/projects/ruleset/engine/evaluator/rhino/RhinoEvaluatorTest.kt
@@ -1,5 +1,12 @@
 package com.rapatao.projects.ruleset.engine.evaluator.rhino
 
 import com.rapatao.projects.ruleset.engine.BaseEvaluatorTest
+import com.rapatao.projects.ruleset.engine.helper.ExposeEngineTestOperator
 
-class RhinoEvaluatorTest : BaseEvaluatorTest(RhinoEvaluator())
+class RhinoEvaluatorTest : BaseEvaluatorTest(
+    RhinoEvaluator(
+        operators = listOf(
+            ExposeEngineTestOperator(),
+        ),
+    ),
+)