Merge pull request #1495 from finos/1488-custom-generator-constraint

feat(#1488): allow Custom generators to be used in constraints

docs/GettingStarted.md

@@ -40,7 +40,7 @@ We'll start by generating data for a trivial schema. Using your favourite text e
 
 ```json
 {
-    "schemaVersion": "0.7",
+    "schemaVersion": "0.16",
     "fields": [{ "name": "firstName", "type": "string" }],
     "rules": []
 }
@@ -111,7 +111,7 @@ Update the JSON profile as follows:
 
 ```json
 {
-    "schemaVersion": "0.7",
+    "schemaVersion": "0.16",
     "fields": [{ "name": "firstName", "type": "string" }],
     "rules": [
         {
@@ -181,7 +181,7 @@ We'll expand the example profile to add a new `age` field, a not-null integer in
 
 ```json
 {
-    "schemaVersion": "0.7",
+    "schemaVersion": "0.16",
     "fields": [
         { "name": "firstName", "type": "string" }, 
         { "name": "age", "type": "integer"  }
@@ -228,7 +228,7 @@ Finally, we'll add a field for National Insurance number. In this case, the cons
 
 ```json
 {
-    "schemaVersion": "0.7",
+    "schemaVersion": "0.16",
     "fields": [
         { "name": "firstName", "type": "string" }, 
         { "name": "age", "type": "integer"  },

docs/UserGuide.md

@@ -56,6 +56,7 @@
 7. [Custom Generators](#custom-generator)
     1. [adding](#adding-custom-generator)
     2. [using](#using-custom-generator)
+    3. [using as constraint](#using-custom-generator-as-constraint)
 
 8. [Running a Profile](#Running-a-Profile)
     1. [Command Line Arguments](#Command-Line-Arguments)
@@ -87,9 +88,9 @@ This section will walk you through creating basic profiles with which you can ge
 Profiles are JSON documents consisting of three sections, the schema version, the list of fields and the rules.
 
 - **Schema Version** - Dictates the method of serialisation of the profile in order for the generator to
-interpret the profile fields and rules. The latest version is 0.7.
+interpret the profile fields and rules. The latest version is 
 ```
-    "schemaVersion": "0.7",
+    "schemaVersion": "0.16",
 ```
 - **List of Fields** - An array of column headings is defined with unique "name" keys.
 ```
@@ -140,7 +141,7 @@ These three sections are combined to form the [complete profile](#Example-Profil
 ## Example Profile
 
     {
-    "schemaVersion": "0.7",
+    "schemaVersion": "0.16",
     "fields": [
         {
             "name": "Column 1",
@@ -668,7 +669,6 @@ While it's not prohibited, wrapping conditional constraints in any other kind of
 
 
 
-
 # Custom Generators
 <div id="custom-generator"></div>
 
@@ -704,6 +704,22 @@ This will use the "lorem ipsum" example custom generator.
 
 To use your own, put the name of your generator instead of "lorem ipsum"
 
+## using Custom Generators as Constraint
+<div id="using-custom-generator-as-constraint"></div>
+
+You can also use custom generators as constraints 
+
+
+```javascript
+{ "field": "field1", "generator": "lorem ipsum" }
+```
+
+Custom generators can be used in "anyOf" grammatical constraints, as well as in the "then" and "else" parts of conditional constraints
+
+To combine generators with sets and equalTo, you will need to create a 'matchingFunction' when building the custom generator. Which should be a function that returns true if a value is one the custom generator could produce. 
+
+To be able negate the custom generator, or use in the 'if' section of an if then statement, you must define the 'negated Generator' when building the custom generator. Which should return values that the custom generator should not produce. 
+
 # Running a Profile
 <div id="Running-a-Profile"></div>
 

docs/user/Schema.md

@@ -3,7 +3,7 @@
 ## Sample file
 ```javascript
 {
-	"schemaVersion": "0.7",
+	"schemaVersion": "0.16",
 	"description": "A dataset about financial products",
 	"fields":
 	[

examples/a-valid-isin/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "isin",

examples/actor-names/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "forename",

examples/anyOf/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "rules": [
     {
       "rule": "rule 1",

examples/date-after/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "date",

examples/datetime-after-dynamic/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "field1",

examples/datetime-after/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "date",

examples/datetime-equal-to-dynamic-offset/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "first",

examples/datetime-equal-to-dynamic/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "first",

examples/datetime-equal-to/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "date",

examples/datetime-offset-working-days/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "foo",

examples/demo-trades-smaller/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "tradeId",

examples/demo-trades/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "tradeId",

examples/duplicates/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "a",

examples/formatting/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "decimal",

examples/from-file-weighted/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "name",

examples/from-file/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "name",

examples/hard-contradiction-null-validation/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "Column 1",

examples/hard-contradiction-range-and-granular/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "Column 1",

examples/integer-range-with-blacklist/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "an_integer",

examples/integer-range/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "an_integer",

examples/multiple-fields/profile.json

@@ -1,5 +1,5 @@
 {
-    "schemaVersion": "0.15",
+    "schemaVersion": "0.16",
     "fields": [
         {
             "name": "field1",

examples/names/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "forename",

examples/partial-contradictions/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "Column 1",

examples/partitioning/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "p1f1",

examples/real-number-range/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "a_number",

examples/regex-contains/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "first_name",

examples/regex-intersect-with-blacklist/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "first_name",

examples/regex-intersect/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "first_name",

examples/regex/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "first_name",

examples/setwise-combination/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "a",

examples/shorter-than/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "first_name",

examples/string/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "rules": [],
   "fields": [
     {

examples/unique/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "id",

examples/user-account/profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "user_id",

orchestrator/src/test/java/com/scottlogic/deg/orchestrator/cucumber/features/CustomGenerator.feature

@@ -0,0 +1,8 @@
+Feature: Generator use custom generators.
+
+  Scenario: custom lorem ipsum generator can output rows
+    Given the generation strategy is Random
+    And the generator can generate at most 1 rows
+    And there is a non nullable field foo
+    And foo uses custom generator "lorem ipsum"
+    Then the generator can generate at most 1 rows

orchestrator/src/test/java/com/scottlogic/deg/orchestrator/cucumber/testframework/steps/StringValueStep.java

@@ -123,6 +123,11 @@ public void producedDataShouldContainStringValuesOutOfRangeForField(String field
             value -> !isLengthBetweenInclusively(min, max).apply(value));
     }
 
+    @When("^([A-z0-9]+) uses custom generator \"(.*)\"$")
+    public void customGenerator(String fieldName, String value) {
+        state.addConstraint(fieldName, ConstraintType.EQUAL_TO, value);
+    }
+
     private Function<String, Boolean> isLengthBetweenInclusively(int minInclusive, int maxInclusive) {
         return value -> isLongerThanOrEqual(value, minInclusive) && isShorterThanOrEqual(value, maxInclusive);
     }

orchestrator/src/test/java/com/scottlogic/deg/orchestrator/cucumber/testframework/utils/CucumberTestState.java

@@ -225,6 +225,12 @@ private ConstraintDTO createConstraint(String fieldName, ConstraintType type, Ob
                     field = fieldName;
                     value = (String) _value;
                 }};
+            case GENERATOR:
+                return new GeneratorConstraintDTO()
+                {{
+                    field = fieldName;
+                    generator = (String) _value;
+                }};
             default:
                 return null;
         }

orchestrator/src/test/java/com/scottlogic/deg/orchestrator/endtoend/loadfiletest.profile.json

@@ -1,5 +1,5 @@
 {
-  "schemaVersion": "0.15",
+  "schemaVersion": "0.16",
   "fields": [
     {
       "name": "foo",

orchestrator/src/test/java/com/scottlogic/deg/orchestrator/endtoend/testprofile.profile.json

@@ -1,5 +1,5 @@
 {
-    "schemaVersion": "0.15",
+    "schemaVersion": "0.16",
     "description": "Testing Profile",
     "fields": [
         {