Add property-based tests: schema roundtripping (DSL and JSON forms)

Author: mx00s

.cargo/config.toml

@@ -1,3 +1,6 @@
 [alias]
+ft = "test --features fast-test"
+lt = "test"
+cov = "tarpaulin --ignore-tests --out Lcov --features fast-test"
 ir = "insta review"
-w = "watch -c -x ir -x test -x clippy -x doc"
+w = "watch -c -x ir -x ft -x clippy -x doc"

.github/workflows/ci.yml

@@ -8,6 +8,11 @@ jobs:
   test:
     name: Test Suite
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        rust:
+          - stable
+          - 1.40.0   # TODO: document MSRV
     steps:
       - name: Checkout repository
         uses: actions/checkout@v2
@@ -77,12 +82,11 @@ jobs:
       - name: Run cargo-tarpaulin
         uses: actions-rs/tarpaulin@v0.1
         with:
-          args: '--ignore-tests --out Lcov'
+          args: '--ignore-tests --out Lcov --features fast-test'
       - name: Upload to Coveralls
         # upload only if push
         if: ${{ github.event_name == 'push' }}
         uses: coverallsapp/github-action@master
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           path-to-lcov: './lcov.info'
-

Cargo.toml

@@ -7,11 +7,16 @@ description = "ipld-schema mandatory description"
 repository = "https://github.com/mx00s/ipld-schema"
 license = "MIT OR Apache-2.0"
 
+[features]
+fast-test = []
+
 [dependencies]
 peg = "0.6.3"
 serde = "1.0.118"
 
 [dev-dependencies]
 insta = "1.3.0"
 pretty_assertions = "0.6.1"
+proptest = "0.10.1"
 serde_json = "1.0.61"
+test-strategy = "0.1.1"

README.md

@@ -15,6 +15,7 @@
   - [ ] Generate arbitrary IPLD schemas in reified form from the parsed schema-schema
   - [ ] Validate IPLD schema in reified form against the schema-schema and additional constraints (e.g. "rules around valid characters for type names")
   - [ ] Generate Rust types from a valid IPLD schema
+  - [ ] Test generated IPLD schemas against implementations in other languages
   - [ ] Parse IPLD values into Rust types generated from a compatible schema  
   - [ ] Generate arbitrary IPLD values from the reified form of some IPLD schema
   - [ ] Verify generated IPLD values roundtrip through parsing to Rust types which were generated from the IPLD schema

cobertura.xml

@@ -0,0 +1 @@
+<?xml version="1.0"?><coverage lines-covered="245" lines-valid="341" line-rate="0.718475073313783" branches-covered="0" branches-valid="0" branch-rate="0" complexity="0" version="1.9" timestamp="1609360835"><sources><source>/home/sage/w/ipld-schema/proptest</source></sources><packages><package name="src" line-rate="0.718475073313783" branch-rate="0" complexity="0"><classes><class name="schema" filename="src/schema.rs" line-rate="0.718475073313783" branch-rate="0" complexity="0"><methods/><lines><line number="159" hits="1"/><line number="160" hits="1"/><line number="172" hits="4"/><line number="173" hits="8"/><line number="227" hits="3"/><line number="228" hits="1"/><line number="262" hits="1"/><line number="263" hits="1"/><line number="276" hits="0"/><line number="278" hits="0"/><line number="479" hits="0"/><line number="480" hits="0"/><line number="531" hits="1"/><line number="532" hits="3"/><line number="574" hits="1"/><line number="575" hits="1"/><line number="580" hits="1"/><line number="581" hits="2"/><line number="582" hits="1"/><line number="584" hits="1"/><line number="589" hits="1"/><line number="591" hits="1"/><line number="596" hits="1"/><line number="597" hits="12"/><line number="598" hits="2"/><line number="599" hits="1"/><line number="600" hits="1"/><line number="601" hits="1"/><line number="602" hits="1"/><line number="603" hits="1"/><line number="604" hits="1"/><line number="605" hits="1"/><line number="606" hits="1"/><line number="607" hits="1"/><line number="608" hits="1"/><line number="609" hits="2"/><line number="635" hits="1"/><line number="636" hits="8"/><line number="637" hits="2"/><line number="638" hits="1"/><line number="639" hits="1"/><line number="640" hits="1"/><line number="641" hits="1"/><line number="642" hits="1"/><line number="643" hits="1"/><line number="644" hits="2"/><line number="650" hits="1"/><line number="651" hits="2"/><line number="652" hits="2"/><line number="653" hits="1"/><line number="655" hits="0"/><line number="656" hits="0"/><line number="662" hits="1"/><line number="663" hits="1"/><line number="668" hits="1"/><line number="669" hits="1"/><line number="674" hits="1"/><line number="675" hits="1"/><line number="680" hits="1"/><line number="681" hits="0"/><line number="682" hits="2"/><line number="689" hits="1"/><line number="690" hits="1"/><line number="695" hits="1"/><line number="696" hits="1"/><line number="701" hits="1"/><line number="702" hits="1"/><line number="707" hits="1"/><line number="708" hits="4"/><line number="709" hits="1"/><line number="710" hits="2"/><line number="711" hits="1"/><line number="713" hits="1"/><line number="715" hits="1"/><line number="716" hits="2"/><line number="717" hits="1"/><line number="719" hits="1"/><line number="720" hits="0"/><line number="722" hits="1"/><line number="724" hits="2"/><line number="725" hits="2"/><line number="726" hits="2"/><line number="728" hits="0"/><line number="729" hits="1"/><line number="730" hits="0"/><line number="732" hits="1"/><line number="733" hits="0"/><line number="735" hits="1"/><line number="744" hits="1"/><line number="745" hits="2"/><line number="746" hits="1"/><line number="748" hits="1"/><line number="755" hits="1"/><line number="756" hits="1"/><line number="761" hits="1"/><line number="762" hits="1"/><line number="767" hits="1"/><line number="768" hits="4"/><line number="769" hits="2"/><line number="770" hits="1"/><line number="771" hits="0"/><line number="772" hits="1"/><line number="773" hits="2"/><line number="779" hits="1"/><line number="780" hits="1"/><line number="781" hits="3"/><line number="782" hits="1"/><line number="784" hits="3"/><line number="785" hits="1"/><line number="787" hits="1"/><line number="792" hits="1"/><line number="793" hits="1"/><line number="794" hits="3"/><line number="795" hits="1"/><line number="797" hits="3"/><line number="798" hits="1"/><line number="800" hits="1"/><line number="805" hits="0"/><line number="806" hits="0"/><line number="807" hits="0"/><line number="808" hits="0"/><line number="810" hits="0"/><line number="811" hits="0"/><line number="813" hits="0"/><line number="814" hits="0"/><line number="815" hits="0"/><line number="816" hits="0"/><line number="821" hits="1"/><line number="822" hits="1"/><line number="823" hits="3"/><line number="824" hits="1"/><line number="826" hits="3"/><line number="827" hits="1"/><line number="829" hits="1"/><line number="830" hits="0"/><line number="832" hits="0"/><line number="838" hits="1"/><line number="839" hits="1"/><line number="840" hits="3"/><line number="841" hits="1"/><line number="843" hits="3"/><line number="844" hits="1"/><line number="846" hits="1"/><line number="851" hits="1"/><line number="852" hits="2"/><line number="853" hits="2"/><line number="854" hits="1"/><line number="855" hits="3"/><line number="856" hits="1"/><line number="857" hits="3"/><line number="858" hits="1"/><line number="859" hits="2"/><line number="860" hits="1"/><line number="862" hits="1"/><line number="865" hits="3"/><line number="866" hits="1"/><line number="868" hits="1"/><line number="870" hits="0"/><line number="871" hits="0"/><line number="872" hits="0"/><line number="873" hits="0"/><line number="875" hits="0"/><line number="876" hits="0"/><line number="878" hits="0"/><line number="879" hits="0"/><line number="880" hits="0"/><line number="881" hits="0"/><line number="882" hits="0"/><line number="884" hits="0"/><line number="885" hits="0"/><line number="886" hits="0"/><line number="887" hits="0"/><line number="888" hits="0"/><line number="890" hits="0"/><line number="892" hits="0"/><line number="894" hits="0"/><line number="895" hits="0"/><line number="896" hits="0"/><line number="897" hits="0"/><line number="899" hits="0"/><line number="900" hits="0"/><line number="902" hits="0"/><line number="903" hits="0"/><line number="904" hits="0"/><line number="905" hits="0"/><line number="907" hits="0"/><line number="908" hits="0"/><line number="909" hits="0"/><line number="910" hits="0"/><line number="912" hits="0"/><line number="913" hits="0"/><line number="915" hits="0"/><line number="916" hits="0"/><line number="917" hits="0"/><line number="919" hits="0"/><line number="920" hits="0"/><line number="921" hits="0"/><line number="922" hits="0"/><line number="924" hits="0"/><line number="925" hits="0"/><line number="927" hits="0"/><line number="934" hits="1"/><line number="935" hits="1"/><line number="940" hits="1"/><line number="941" hits="2"/><line number="942" hits="1"/><line number="944" hits="1"/><line number="945" hits="0"/><line number="947" hits="1"/><line number="952" hits="1"/><line number="953" hits="2"/><line number="954" hits="2"/><line number="955" hits="2"/><line number="961" hits="1"/><line number="962" hits="2"/><line number="963" hits="2"/><line number="964" hits="2"/><line number="970" hits="1"/><line number="971" hits="1"/><line number="973" hits="3"/><line number="974" hits="1"/><line number="976" hits="3"/><line number="977" hits="1"/><line number="979" hits="1"/><line number="986" hits="1"/><line number="987" hits="1"/><line number="992" hits="1"/><line number="993" hits="1"/><line number="997" hits="814"/><line number="1003" hits="2"/><line number="1007" hits="11"/><line number="1009" hits="2"/><line number="1012" hits="1"/><line number="1015" hits="5"/><line number="1017" hits="3"/><line number="1018" hits="3"/><line number="1019" hits="1"/><line number="1020" hits="3"/><line number="1021" hits="1"/><line number="1025" hits="5"/><line number="1027" hits="2"/><line number="1029" hits="1"/><line number="1030" hits="1"/><line number="1031" hits="1"/><line number="1032" hits="1"/><line number="1033" hits="1"/><line number="1037" hits="5"/><line number="1039" hits="1"/><line number="1040" hits="1"/><line number="1041" hits="1"/><line number="1042" hits="1"/><line number="1043" hits="1"/><line number="1053" hits="4"/><line number="1055" hits="1"/><line number="1056" hits="3"/><line number="1057" hits="1"/><line number="1058" hits="1"/><line number="1059" hits="1"/><line number="1060" hits="3"/><line number="1061" hits="1"/><line number="1062" hits="1"/><line number="1063" hits="1"/><line number="1064" hits="4"/><line number="1065" hits="10"/><line number="1066" hits="1"/><line number="1067" hits="3"/><line number="1080" hits="1"/><line number="1081" hits="0"/><line number="1084" hits="3"/><line number="1090" hits="1"/><line number="1091" hits="8"/><line number="1092" hits="8"/><line number="1093" hits="1"/><line number="1094" hits="11"/><line number="1095" hits="2"/><line number="1097" hits="5"/><line number="1098" hits="2"/><line number="1100" hits="4"/><line number="1102" hits="3"/><line number="1103" hits="1"/><line number="1104" hits="1"/><line number="1105" hits="1"/><line number="1106" hits="1"/><line number="1107" hits="1"/><line number="1108" hits="3"/><line number="1109" hits="1"/><line number="1110" hits="1"/><line number="1111" hits="1"/><line number="1122" hits="3"/><line number="1123" hits="0"/><line number="1124" hits="3"/><line number="1125" hits="0"/><line number="1126" hits="0"/><line number="1127" hits="0"/><line number="1128" hits="3"/><line number="1135" hits="1"/><line number="1138" hits="7"/><line number="1139" hits="0"/><line number="1141" hits="5"/><line number="1143" hits="3"/><line number="1144" hits="3"/><line number="1145" hits="1"/><line number="1146" hits="2"/><line number="1147" hits="3"/><line number="1149" hits="1"/><line number="1150" hits="9"/><line number="1151" hits="1"/><line number="1152" hits="14"/><line number="1155" hits="4"/><line number="1157" hits="6"/><line number="1158" hits="4"/><line number="1161" hits="1"/><line number="1162" hits="0"/><line number="1164" hits="0"/><line number="1165" hits="0"/><line number="1166" hits="0"/><line number="1169" hits="0"/><line number="1171" hits="0"/><line number="1174" hits="3"/><line number="1176" hits="0"/><line number="1178" hits="0"/><line number="1179" hits="0"/><line number="1180" hits="0"/><line number="1181" hits="0"/><line number="1182" hits="0"/><line number="1188" hits="1"/><line number="1190" hits="0"/><line number="1192" hits="0"/><line number="1193" hits="0"/><line number="1194" hits="0"/><line number="1195" hits="0"/><line number="1196" hits="0"/><line number="1202" hits="1"/><line number="1204" hits="0"/><line number="1205" hits="0"/><line number="1206" hits="0"/><line number="1210" hits="1"/><line number="1216" hits="4"/><line number="1219" hits="4"/><line number="1220" hits="4"/><line number="1222" hits="6"/></lines></class></classes></package></packages></coverage>