Skip to content

Commit 4b13775

Browse files
committed
chore: update testgen readme
1 parent 8b6f923 commit 4b13775

File tree

1 file changed

+17
-20
lines changed

1 file changed

+17
-20
lines changed

testgen/README.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -70,28 +70,25 @@ At this time, ValidGen already has two generators:
7070

7171
But these generators do not have a common configuration, do not implement all tests for all cases, and keeping the distinct configuration files in sync is painful.
7272

73-
Beyond that, some new generators could be created:
74-
- Unit tests to validate operations
75-
- Unit tests to validate operation x type
76-
- Unit tests to validate the "buildValidationCode" function
77-
- Unit tests to validate the "condition table"
78-
- Parser tests
79-
- Almost all existing end-to-end tests could be generated
80-
- Examples (in _examples/) could be generated
81-
82-
And, for all cases, valid scenarios and invalid scenarios must be generated.
83-
8473
## What TestGen does
8574

86-
TestGen generates the following tests:
87-
- Benchmark tests between ValidGen and GoValidator
88-
- End-to-end tests with all possible use cases (all validations vs all types vs valid and invalid inputs)
89-
- Unit tests to validate operations
90-
- Unit tests to validate operation vs type
91-
- Unit tests to validate the "buildValidationCode" function
92-
- Unit tests to validate "condition table" result
93-
- Parser tests (parser_tests.go)
94-
- Examples (in _examples/)
75+
TestGen generates the following tests (without field operations):
76+
- [x] Benchmark tests between ValidGen and GoValidator
77+
- [x] End-to-end tests with all possible use cases (all validations vs all types vs valid and invalid inputs)
78+
- [x] Unit tests to validate the "buildValidationCode" function
79+
80+
High priority generators:
81+
- [ ] Unit tests to validate the "condition table" (get_test_elements_*_test.go)
82+
- [ ] Benchmark tests between ValidGen and GoValidator with field operations
83+
- [ ] End-to-end tests with all possible use cases (all validations vs all types vs valid and invalid inputs) with field operations
84+
- [ ] Unit tests to validate the "buildValidationCode" function with field operations
85+
86+
Low priority generators (already exist, but they could be generated):
87+
- [ ] Unit tests to validate operations (func TestOperationsIsValid)
88+
- [ ] Unit tests to validate operation vs type (func TestOperationsIsValidByType)
89+
- [ ] Unit tests to validate if is field operation (func TestOperationsIsFieldOperation)
90+
- [ ] Unit tests to validate arguments count by operation (func TestOperationsArgsCount)
91+
- [ ] Examples (in _examples/) could be generated
9592

9693
In some cases, valid scenarios and invalid scenarios must be generated.
9794

0 commit comments

Comments
 (0)