chore: Test cases for annotations and annotation layers incorrect creation through API (#17246)

* Add/Refactor tests

* Add return type

* Update api tests

tests/unit_tests/annotation_layers/fixtures.py

@@ -0,0 +1,24 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+# isort:skip_file
+import dateutil.parser
+
+
+START_STR = "2019-01-02T03:04:05.678900"
+END_STR = "2020-01-02T03:04:05.678900"
+START_DTTM = dateutil.parser.parse(START_STR)
+END_DTTM = dateutil.parser.parse(END_STR)

tests/unit_tests/annotation_layers/schema_tests.py

@@ -0,0 +1,157 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+import pytest
+from marshmallow.exceptions import ValidationError
+
+from superset.annotation_layers.annotations.schemas import (
+    AnnotationPostSchema,
+    AnnotationPutSchema,
+)
+from superset.annotation_layers.schemas import (
+    AnnotationLayerPostSchema,
+    AnnotationLayerPutSchema,
+)
+from tests.unit_tests.annotation_layers.fixtures import (
+    END_DTTM,
+    END_STR,
+    START_DTTM,
+    START_STR,
+)
+
+
+def test_annotation_layer_post_schema_with_name() -> None:
+    result = AnnotationLayerPostSchema().load({"name": "foo"})
+    assert result["name"] == "foo"
+    assert "descr" not in result
+
+
+def test_annotation_layer_post_schema_with_name_and_descr() -> None:
+    result = AnnotationLayerPostSchema().load({"name": "foo", "descr": "bar"})
+    assert result["name"] == "foo"
+    assert result["descr"] == "bar"
+
+
+def test_annotation_layer_post_schema_with_null_name() -> None:
+    with pytest.raises(ValidationError):
+        AnnotationLayerPostSchema().load({"name": None})
+
+
+def test_annotation_layer_post_schema_empty() -> None:
+    with pytest.raises(ValidationError):
+        AnnotationLayerPostSchema().load({})
+
+
+def test_annotation_layer_put_schema_empty() -> None:
+    result = AnnotationLayerPutSchema().load({})
+    assert result == {}
+
+
+def test_annotation_layer_put_schema_with_null_name() -> None:
+    with pytest.raises(ValidationError):
+        AnnotationLayerPutSchema().load({"name": None})
+
+
+def test_annotation_layer_put_schema_with_null_descr() -> None:
+    with pytest.raises(ValidationError):
+        AnnotationLayerPutSchema().load({"descr": None})
+
+
+def test_annotation_post_schema_basic() -> None:
+    result = AnnotationPostSchema().load(
+        {"short_descr": "foo", "start_dttm": START_STR, "end_dttm": END_STR}
+    )
+    assert result["short_descr"] == "foo"
+    assert result["start_dttm"] == START_DTTM
+    assert result["end_dttm"] == END_DTTM
+
+
+def test_annotation_post_schema_full() -> None:
+    result = AnnotationPostSchema().load(
+        {
+            "short_descr": "foo",
+            "long_descr": "bar",
+            "start_dttm": START_STR,
+            "end_dttm": END_STR,
+            "json_metadata": '{"abc": 123}',
+        }
+    )
+    assert result["short_descr"] == "foo"
+    assert result["long_descr"] == "bar"
+    assert result["start_dttm"] == START_DTTM
+    assert result["end_dttm"] == END_DTTM
+    assert result["json_metadata"] == '{"abc": 123}'
+
+
+def test_annotation_post_schema_short_descr_null() -> None:
+    with pytest.raises(ValidationError):
+        AnnotationPostSchema().load(
+            {"short_descr": None, "start_dttm": START_STR, "end_dttm": END_STR}
+        )
+
+
+def test_annotation_post_schema_start_dttm_null() -> None:
+    with pytest.raises(ValidationError):
+        result = AnnotationPostSchema().load(
+            {"short_descr": "foo", "start_dttm": None, "end_dttm": END_STR}
+        )
+
+
+def test_annotation_post_schema_end_dttm_null() -> None:
+    with pytest.raises(ValidationError):
+        AnnotationPostSchema().load(
+            {"short_descr": "foo", "start_dttm": START_STR, "end_dttm": None}
+        )
+
+
+def test_annotation_put_schema_empty() -> None:
+    result = AnnotationPutSchema().load({})
+    assert result == {}
+
+
+def test_annotation_put_schema_short_descr_null() -> None:
+    with pytest.raises(ValidationError):
+        AnnotationPutSchema().load({"short_descr": None})
+
+
+def test_annotation_put_schema_start_dttm_null() -> None:
+    with pytest.raises(ValidationError):
+        AnnotationPutSchema().load({"start_dttm": None})
+
+
+def test_annotation_put_schema_end_dttm_null() -> None:
+    with pytest.raises(ValidationError):
+        AnnotationPutSchema().load({"end_dttm": None})
+
+
+def test_annotation_put_schema_json_metadata() -> None:
+    result = AnnotationPutSchema().load({"json_metadata": '{"abc": 123}'})
+    assert result["json_metadata"] == '{"abc": 123}'
+
+
+def test_annotation_put_schema_json_metadata_null() -> None:
+    result = AnnotationPutSchema().load({"json_metadata": None})
+    assert result["json_metadata"] is None
+
+
+def test_annotation_put_schema_json_metadata_empty() -> None:
+    result = AnnotationPutSchema().load({"json_metadata": ""})
+    assert result["json_metadata"] == ""
+
+
+def test_annotation_put_schema_json_metadata_invalid() -> None:
+    with pytest.raises(ValidationError):
+        AnnotationPutSchema().load({"json_metadata": "foo bar"})