Added JSON schema correctness check. (#38)

* Added JSON schema correctness check
* Added pre-commit

Author: tyomo4ka

.github/workflows/ci.yml

@@ -51,6 +51,13 @@ jobs:
       - run: PGPASSWORD=postgres psql -c 'create database tests;' -U postgres -h localhost -p 5432
       - run: poetry run ./bin/test
 
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-python@v3
+    - uses: pre-commit/[email protected]
+
   publish:
     if: startsWith(github.event.ref, 'refs/tags')
     name: publish

.pre-commit-config.yaml

@@ -0,0 +1,15 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: debug-statements
+    -   id: double-quote-string-fixer
+
+-   repo: https://github.com/asottile/pyupgrade
+    rev: v3.3.1
+    hooks:
+    -   id: pyupgrade
+        args: [--py38-plus]

bin/wait_for_it.py

@@ -19,16 +19,16 @@ def log(self, loginfo):
     def build_log(self, type, app, time=0):
         # 1=enable_timeout,2=disable_timeout,3=success_msg,4=unavailable,5=timeout_msg
         loginfo = {
-            1: "%s: waiting %d seconds for %s" % (sys.argv[0], time, app),
-            2: "%s: waiting for %s without a timeout" % (sys.argv[0], app),
-            3: "%s: %s is available after %d seconds" % (sys.argv[0], app, time),
-            4: "%s: %s is unavailable" % (sys.argv[0], app),
-            5: "%s: timeout occurred after waiting %d seconds for %s" % (sys.argv[0], time, app),
+            1: '%s: waiting %d seconds for %s' % (sys.argv[0], time, app),
+            2: f'{sys.argv[0]}: waiting for {app} without a timeout',
+            3: '%s: %s is available after %d seconds' % (sys.argv[0], app, time),
+            4: f'{sys.argv[0]}: {app} is unavailable',
+            5: '%s: timeout occurred after waiting %d seconds for %s' % (sys.argv[0], time, app),
         }.get(type)
         return loginfo
 
     def wait_for(self, host, port, timeout):
-        self.app = ("%s:%d") % (host, port)
+        self.app = ('%s:%d') % (host, port)
         sk = socket.socket()
         logmsg = self.build_log(2, self.app, timeout)
         if timeout != 0:
@@ -44,21 +44,21 @@ def wait_for(self, host, port, timeout):
 
     def get_parser(self):
         parser = OptionParser()
-        parser.add_option("-a", "--address", dest="address", help="Host or IP under test")
-        parser.add_option("-p", "--port", dest="port", help="TCP port under test")
+        parser.add_option('-a', '--address', dest='address', help='Host or IP under test')
+        parser.add_option('-p', '--port', dest='port', help='TCP port under test')
         parser.add_option(
-            "-t", "--timeout", dest="timeout", default="15", help="Timeout in seconds, zero for no timeout"
+            '-t', '--timeout', dest='timeout', default='15', help='Timeout in seconds, zero for no timeout'
         )
-        parser.add_option("-q", "--quiet", dest="quiet", action="store_false", help="Don't output any status messages")
+        parser.add_option('-q', '--quiet', dest='quiet', action='store_false', help="Don't output any status messages")
         return parser
 
     def verify_options(self):
         if self.options.address is None:
-            raise OptionException("The address must be set!")
+            raise OptionException('The address must be set!')
         elif self.options.port is None:
-            raise OptionException("The port must be set!")
+            raise OptionException('The port must be set!')
         elif str(self.options.port).isnumeric() is False:
-            raise OptionException("The value of port must be number!")
+            raise OptionException('The value of port must be number!')
 
     def start_up(self):
         try:
@@ -77,6 +77,6 @@ def start_up(self):
             self.log(logmsg)
 
 
-if __name__ == "__main__":
+if __name__ == '__main__':
     w = wait_for_app()
     w.start_up()

django_reactive/__init__.py

@@ -1 +1 @@
-default_app_config = "django_reactive.apps.DjangoReactJsonSchemaFormConfig"
+default_app_config = 'django_reactive.apps.DjangoReactJsonSchemaFormConfig'

django_reactive/apps.py

@@ -1,6 +1,5 @@
-# -*- coding: utf-8
 from django.apps import AppConfig
 
 
 class DjangoReactJsonSchemaFormConfig(AppConfig):
-    name = "django_reactive"
+    name = 'django_reactive'

django_reactive/fields.py

@@ -1,8 +1,10 @@
 from django.core.exceptions import ValidationError
+from django.core import checks
 from jsonschema import validate, ValidationError as JSONSchemaValidationError
 
 from .widget.fields import ReactJSONSchemaFormField
 from .widget.widgets import ReactJSONSchemaFormWidget
+from .schema_validator import validate_json_schema
 
 try:
     # DJANGO 3.1
@@ -13,8 +15,8 @@
 
 class ReactJSONSchemaField(BaseJSONField):
     def __init__(self, schema=None, ui_schema=None, on_render=None, extra_css=None, extra_js=None, **kwargs):
-        kwargs.setdefault("default", dict)
-        super(ReactJSONSchemaField, self).__init__(**kwargs)
+        kwargs.setdefault('default', dict)
+        super().__init__(**kwargs)
         self.schema = schema
         self.ui_schema = ui_schema
         self.on_render = on_render
@@ -23,7 +25,7 @@ def __init__(self, schema=None, ui_schema=None, on_render=None, extra_css=None,
 
     def formfield(self, **kwargs):
         defaults = {
-            "required": not self.blank,
+            'required': not self.blank,
         }
         defaults.update(**kwargs)
         return ReactJSONSchemaFormField(
@@ -38,8 +40,23 @@ def formfield(self, **kwargs):
         )
 
     def validate(self, value, model_instance):
-        super(ReactJSONSchemaField, self).validate(value, model_instance)
+        super().validate(value, model_instance)
         try:
             validate(value, self.schema)
         except JSONSchemaValidationError:
-            raise ValidationError("This field has errors.")
+            raise ValidationError('This field has errors.')
+
+    def check(self, **kwargs):
+        errors = super().check(**kwargs)
+        res, schema_errors = validate_json_schema(self.schema)
+        if not res:
+            msg = ','.join(schema_errors)
+            errors = [
+                checks.Error(
+                    f'JSON schema is not valid: {msg}',
+                    obj=self.model,
+                    id='fields.JSON_SCHEMA_ERROR',
+                )
+            ]
+
+        return errors

django_reactive/forms.py

@@ -9,7 +9,7 @@ class ReactJSONSchemaModelForm(ModelForm):
     """
 
     def __init__(self, *args, **kwargs):
-        on_render_object = kwargs.get("instance", None)
+        on_render_object = kwargs.get('instance', None)
         super().__init__(*args, **kwargs)
         for field_name, field_value in self.fields.items():
             if isinstance(field_value, ReactJSONSchemaFormField):

django_reactive/schema_validator.py

@@ -0,0 +1,15 @@
+from jsonschema import Draft7Validator
+from typing import List, Tuple
+
+
+def validate_json_schema(schema: dict) -> Tuple[bool, List[str]]:
+    """
+    Validate a JSON schema using the Draft 7 validator.
+    """
+    validator = Draft7Validator(
+        schema=Draft7Validator.META_SCHEMA,
+        format_checker=Draft7Validator.FORMAT_CHECKER,
+    )
+    errors = [f"{'.'.join(e.path)}: {e.message}" for e in validator.iter_errors(schema)]
+
+    return not bool(errors), errors

django_reactive/static/css/django_reactive.css

@@ -126,4 +126,3 @@
 .form-row .rjsf .list-inline li {
   display: inline;
 }
-