jsonschema: Add additionalProperties option

[bact]

Add optional --use-additional-properties flag to command line, to use additionalProperties instead of unevaluatedProperties (which has a known performance regression issue with networknt json-schema-validator 2.0.0)

Note that the size of the generated schema will grow with this option, as we have to repeat the inherited property list for every classes (see snippets in #117 (comment)).

To fix #60 as reported by @goneall

[github-actions]

Coverage report

Click to see where and how coverage changed

File	Statements	Missing	Coverage	Coverage (new stmts)	Lines missing
src/shacl2code/lang
common.py
jsonschema.py
Project Total

This report was generated by python-coverage-comment-action

[bact]

Size comparison for the generated JSON Schema, using SPDX models as example:

Model	Mode	Size (KB)	Lines	Generated file
SPDX 3.0	default	253	6,807	spdx-3.0-schema.json
SPDX 3.0	--use-additional-properties	336	8,786	spdx-3.0-schema-additional-properties.json
SPDX 3.1-dev	default	452	12,128	spdx-3.1-dev-schema.json
SPDX 3.1-dev	--use-additional-properties	712	18,620	spdx-3.1-dev-schema-additional-properties.json

@goneall you may use the generated schema (additionalProperties version) to test your SPDX document if it improves the performance of case in networknt/json-schema-validator#1216.

[bact]

Generated JSON Schema snippets for comparison (from SPDX 3.0 model):

Default (without --use-additional-properties):

        "software_File": {
            "if": {
                "type": "object",
                "properties": {
                    "type": {
                        "const": "software_File"
                    }
                },
                "required": ["type"]
            },
            "then": {
                "allOf": [
                    {
                        "type": "object",
                        "properties": {
                            "spdxId": { "$ref": "#/$defs/IRI" },
                            "type": { "type": "string" }
                        },
                        "required": ["spdxId"]
                    },
                    { "$ref": "#/$defs/software_File_props" }
                ]
            },
            "else": {
                "const": "Not a software_File"
            }
        },
        "software_File_props": {
            "allOf": [
                { "$ref": "#/$defs/software_SoftwareArtifact_props" },
                {
                    "type": "object",
                    "properties": {
                        "contentType": {
                            "$ref": "#/$defs/prop_software_File_contentType"
                        },
                        "software_fileKind": {
                            "$ref": "#/$defs/prop_software_File_software_fileKind"
                        }
                    }
                }
            ]
        },

With --use-additional-properties, all properties have to be repeated:

        "software_File": {
            "if": {
                "type": "object",
                "properties": {
                    "type": {
                        "const": "software_File"
                    }
                },
                "required": ["type"]
            },
            "then": {
                "type": "object",
                "properties": {
                    "spdxId": { "$ref": "#/$defs/IRI" },
                    "type": { "type": "string" },
                    "@context": {},
                    "comment": {
                        "$ref": "#/$defs/prop_Element_comment"
                    },
                    "creationInfo": {
                        "$ref": "#/$defs/prop_Element_creationInfo"
                    },
                    "description": {
                        "$ref": "#/$defs/prop_Element_description"
                    },
                    "extension": {
                        "anyOf": [
                            {
                                "type": "array",
                                "items": {
                                    "$ref": "#/$defs/prop_Element_extension"
                                }
                            }
                        ]
                    },
                    "externalIdentifier": {
                        "anyOf": [
                            {
                                "type": "array",
                                "items": {
                                    "$ref": "#/$defs/prop_Element_externalIdentifier"
                                }
                            }
                        ]
                    },
                    "externalRef": {
                        "anyOf": [
                            {
                                "type": "array",
                                "items": {
                                    "$ref": "#/$defs/prop_Element_externalRef"
                                }
                            }
                        ]
                    },
                    "name": {
                        "$ref": "#/$defs/prop_Element_name"
                    },
                    "summary": {
                        "$ref": "#/$defs/prop_Element_summary"
                    },
                    "verifiedUsing": {
                        "anyOf": [
                            {
                                "type": "array",
                                "items": {
                                    "$ref": "#/$defs/prop_Element_verifiedUsing"
                                }
                            }
                        ]
                    },
                    "builtTime": {
                        "$ref": "#/$defs/prop_Artifact_builtTime"
                    },
                    "originatedBy": {
                        "anyOf": [
                            {
                                "type": "array",
                                "items": {
                                    "$ref": "#/$defs/prop_Artifact_originatedBy"
                                }
                            }
                        ]
                    },
                    "releaseTime": {
                        "$ref": "#/$defs/prop_Artifact_releaseTime"
                    },
                    "standardName": {
                        "anyOf": [
                            {
                                "type": "array",
                                "items": {
                                    "$ref": "#/$defs/prop_Artifact_standardName"
                                }
                            }
                        ]
                    },
                    "suppliedBy": {
                        "$ref": "#/$defs/prop_Artifact_suppliedBy"
                    },
                    "supportLevel": {
                        "anyOf": [
                            {
                                "type": "array",
                                "items": {
                                    "$ref": "#/$defs/prop_Artifact_supportLevel"
                                }
                            }
                        ]
                    },
                    "validUntilTime": {
                        "$ref": "#/$defs/prop_Artifact_validUntilTime"
                    },
                    "software_additionalPurpose": {
                        "anyOf": [
                            {
                                "type": "array",
                                "items": {
                                    "$ref": "#/$defs/prop_software_SoftwareArtifact_software_additionalPurpose"
                                }
                            }
                        ]
                    },
                    "software_attributionText": {
                        "anyOf": [
                            {
                                "type": "array",
                                "items": {
                                    "$ref": "#/$defs/prop_software_SoftwareArtifact_software_attributionText"
                                }
                            }
                        ]
                    },
                    "software_contentIdentifier": {
                        "anyOf": [
                            {
                                "type": "array",
                                "items": {
                                    "$ref": "#/$defs/prop_software_SoftwareArtifact_software_contentIdentifier"
                                }
                            }
                        ]
                    },
                    "software_copyrightText": {
                        "$ref": "#/$defs/prop_software_SoftwareArtifact_software_copyrightText"
                    },
                    "software_primaryPurpose": {
                        "$ref": "#/$defs/prop_software_SoftwareArtifact_software_primaryPurpose"
                    },
                    "contentType": {
                        "$ref": "#/$defs/prop_software_File_contentType"
                    },
                    "software_fileKind": {
                        "$ref": "#/$defs/prop_software_File_software_fileKind"
                    }
                },
                "required": [
                    "spdxId",
                    "creationInfo"
                ],
                "additionalProperties": false
            },
            "else": {
                "const": "Not a software_File"
            }
        },

[bact]

After the merge of test_ajv_compile, the test is broken.
Put to draft to fix first.
Also will reduce the changeset by undoing the code deduplication (_run helper class, etc), to make it easier to review.

[JPEWdev]

FYI, I did see this, but I want to have a good think about it. It's a lot of extra complexity

[bact]

FYI, I did see this, but I want to have a good think about it. It's a lot of extra complexity

Thanks. No hurries. It does add extra complexity.

Also I think the performance issue on json-schema-validator is probably fixed/mitigated by networknt/json-schema-validator#1217 - need to be confirmed.