Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Replace Defaults module with JSON schema #499

Merged
merged 57 commits into from
Dec 22, 2021
Merged

Replace Defaults module with JSON schema #499

merged 57 commits into from
Dec 22, 2021

Conversation

sim642
Copy link
Member

@sim642 sim642 commented Dec 15, 2021 •
edited
Loading

Closes #476.

Changes

  1. Add JSON schema validation based on json-data-encoding library. This also validates incoming --conf files.
  2. Convert (programmatically) the existing Defaults to a JSON schema. All option names, descriptions and default values are specified by the schema.
  3. Construct initial JSON conf object by extracting all the default values from the generated schema.
  4. Document VSCode settings for using the schema. This makes conf file editing a pleasure: autocomplete option names and their defaults, see type errors and documentation right inside a conf file.

TODO

  • Remove old JsonSchema module.
  • Rename new JsonSchema2 module.
  • Remove old Defaults module after final conversion to schema.
  • Remove Defaults to schema conversion code.
  • Add allowed string value enumerations to schema manually for options that have a fixed set of allowed values.
  • Remove static phases mechanism? Remove unmaintained features #460

@sim642
Add ocplib-json-typed dependency
ad9a900
@sim642
Add JSON validation attempt
1105641
@sim642
Add recursive validation of JSON schema objects
bcc82b4
@sim642
Try JSON schema generation from defaults
6db73d6
@sim642
Rewrite defaults JSON schema generation properly
5141f32
@sim642
Switch from ocplib-json-typed to json-data-encoding
4a282a1
@sim642
Add default values to generated schema
67bf73e
@sim642
Add schema for array elements
efa5ee0
@sim642
Add element schema to phases
1764488
@sim642
Remove broken old-style phases
0fd4ddb
@sim642
Remove special case for old-style ana.activated from JSON schema
233360d
@sim642
Add category descriptions to generated JSON schema
bc6b2ee
@sim642
Add defaults object generation from JSON schema
c74b4bc
@sim642
Change GobConfig.set_value to preserve order
0db5c60
@sim642
Remove unused GobConfig json path copy from JsonSchema2
75f886b
@sim642
Fix integer JSON schema generation
02fba60
@sim642
Add schema conversion to all required fields
def40ab
@sim642
Remove category description from JSON schema root
3ee612a
@sim642
Add missing cases to encoding_of_schema_element
bdb317d
@sim642
Add new JSON schema validation to options, including --conf
282751e
@sim642
Reverse Defaults and GobConfig dependency
79f39d5
@sim642
Create Options module
60c368e
@sim642
Move defaults to schema conversion to Options
22bc7f5
@sim642
Remove unused schema string from JsonSchema2
077ce0c
@sim642
Refactor element_category_of_defaults_json
8067e0a
@sim642
Refactor schema_of_defaults_json
ea5fded
@sim642
Refactor schema_require_all
51e0ca7
@sim642
Reverse defaults to fix schema order
836bb7e
@sim642
Refactor schema_defaults
a4ed797
@sim642
Refactor schema generation
8d142d2
@sim642 sim642 added cleanup Refactoring, clean-up feature usability documentation Documentation, comments labels Dec 15, 2021
@sim642 sim642 self-assigned this Dec 21, 2021
@sim642 sim642 merged commit 628a9fe into master Dec 22, 2021
@sim642 sim642 deleted the json-schema branch December 22, 2021 10:59
sim642 added a commit that referenced this pull request Jan 7, 2022
@sim642
Add pkg-config system dependency (PR #499)
2f1f67c 
json-data-encoding indirectly depends on it and the Docker builds have been failing ever since.
@sim642 sim642 added this to the v2.0.0 milestone Aug 12, 2022
sim642 added a commit to sim642/opam-repository that referenced this pull request Aug 18, 2022
@sim642
[new release] goblint (2.0.0)
6efdfdf 
CHANGES:

Goblint "lean" release after a lot of cleanup.

* Remove unmaintained analyses: OSEK, ARINC, shapes, containment, deadlocksByRaces (goblint/analyzer#460, goblint/analyzer#736, goblint/analyzer#812, goblint/analyzer#474).
* Add interactive analysis (goblint/analyzer#391).
* Add server mode (goblint/analyzer#522).
* Add Compilation Database support (goblint/analyzer#406, goblint/analyzer#448).
* Add floating point domain, unrolled array domain and improved struct domains (goblint/analyzer#734, goblint/analyzer#761, goblint/analyzer#577, goblint/analyzer#419).
* Add static loop unrolling and heap variable unrolling (goblint/analyzer#563, goblint/analyzer#722).
* Improve race detection with may-happen-in-parallel analysis (goblint/analyzer#529, goblint/analyzer#518, goblint/analyzer#595).
* Reimplement lockset and deadlock analyses (goblint/analyzer#659, goblint/analyzer#662, goblint/analyzer#650, goblint/analyzer#655).
* Add pthread extraction to Promela (goblint/analyzer#220).
* Add location spans to output (goblint/analyzer#428, goblint/analyzer#449).
* Improve race reporting (goblint/analyzer#550, goblint/analyzer#551).
* Improve dead code reporting (goblint/analyzer#94, goblint/analyzer#353, goblint/analyzer#785).
* Refactor warnings (goblint/analyzer#55, goblint/analyzer#783).
* Add JSON schema for configuration (goblint/analyzer#476, goblint/analyzer#499).
* Refactor option names (goblint/analyzer#28, goblint/analyzer#192, goblint/analyzer#516, goblint/analyzer#675).
* Add bash completion (goblint/analyzer#669).
* Add OCaml 4.13 and 4.14 support, remove OCaml 4.09 support (goblint/analyzer#503, goblint/analyzer#672).
@sim642 sim642 mentioned this pull request Aug 18, 2022
Merged
sim642 added a commit to sim642/opam-repository that referenced this pull request Aug 18, 2022
@sim642
[new release] goblint (2.0.0)
1c281d5 
CHANGES:

Goblint "lean" release after a lot of cleanup.

* Remove unmaintained analyses: OSEK, ARINC, shapes, containment, deadlocksByRaces (goblint/analyzer#460, goblint/analyzer#736, goblint/analyzer#812, goblint/analyzer#474).
* Add interactive analysis (goblint/analyzer#391).
* Add server mode (goblint/analyzer#522).
* Add Compilation Database support (goblint/analyzer#406, goblint/analyzer#448).
* Add floating point domain, unrolled array domain and improved struct domains (goblint/analyzer#734, goblint/analyzer#761, goblint/analyzer#577, goblint/analyzer#419).
* Add static loop unrolling and heap variable unrolling (goblint/analyzer#563, goblint/analyzer#722).
* Improve race detection with may-happen-in-parallel analysis (goblint/analyzer#529, goblint/analyzer#518, goblint/analyzer#595).
* Reimplement lockset and deadlock analyses (goblint/analyzer#659, goblint/analyzer#662, goblint/analyzer#650, goblint/analyzer#655).
* Add pthread extraction to Promela (goblint/analyzer#220).
* Add location spans to output (goblint/analyzer#428, goblint/analyzer#449).
* Improve race reporting (goblint/analyzer#550, goblint/analyzer#551).
* Improve dead code reporting (goblint/analyzer#94, goblint/analyzer#353, goblint/analyzer#785).
* Refactor warnings (goblint/analyzer#55, goblint/analyzer#783).
* Add JSON schema for configuration (goblint/analyzer#476, goblint/analyzer#499).
* Refactor option names (goblint/analyzer#28, goblint/analyzer#192, goblint/analyzer#516, goblint/analyzer#675).
* Add bash completion (goblint/analyzer#669).
* Add OCaml 4.13 and 4.14 support, remove OCaml 4.09 support (goblint/analyzer#503, goblint/analyzer#672).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@sim642 sim642

Labels
cleanup Refactoring, clean-up documentation Documentation, comments feature usability
Projects
None yet
Milestone
v2.0.0
Development

Successfully merging this pull request may close these issues.

Replace JSON schema validation and add full options schema
1 participant
@sim642