End point unit tests (Closes #34 through #44 and #46) (#54)

* Initial pass endpoint test framework

* Refactor to use test runners, more bug fixes

* Add runner tests to remaining objects, improve translations and add tests

* Add rules parm checks

* Refactor tests to use temporary GRAMPSHOME

* Emit Gramps types using xml_str()

Author: cdhorn

gramps_webapi/api/__init__.py

@@ -70,7 +70,7 @@ def register_endpt(resource: Type[Resource], url: str, name: str):
 # Filter
 register_endpt(FilterResource, "/filters/<string:namespace>", "filter")
 # Translate
-register_endpt(TranslationResource, "/translations/<string:code>", "translation")
+register_endpt(TranslationResource, "/translations/<string:isocode>", "translation")
 register_endpt(TranslationsResource, "/translations/", "translations")
 # Relation
 register_endpt(

gramps_webapi/api/resources/base.py

@@ -57,8 +57,10 @@ class GrampsObjectResource(GrampsObjectResourceHelper, Resource):
     @use_args(
         {
             "strip": fields.Str(validate=validate.Length(equal=0)),
-            "keys": fields.DelimitedList(fields.Str(), missing=[]),
-            "skipkeys": fields.DelimitedList(fields.Str(), missing=[]),
+            "keys": fields.DelimitedList(fields.Str(validate=validate.Length(min=1))),
+            "skipkeys": fields.DelimitedList(
+                fields.Str(validate=validate.Length(min=1))
+            ),
             "profile": fields.Str(validate=validate.Length(equal=0)),
             "extend": fields.DelimitedList(fields.Str(validate=validate.Length(min=1))),
         },
@@ -80,8 +82,10 @@ class GrampsObjectsResource(GrampsObjectResourceHelper, Resource):
         {
             "gramps_id": fields.Str(validate=validate.Length(min=1)),
             "strip": fields.Str(validate=validate.Length(equal=0)),
-            "keys": fields.DelimitedList(fields.Str(), missing=[]),
-            "skipkeys": fields.DelimitedList(fields.Str(), missing=[]),
+            "keys": fields.DelimitedList(fields.Str(validate=validate.Length(min=1))),
+            "skipkeys": fields.DelimitedList(
+                fields.Str(validate=validate.Length(min=1))
+            ),
             "profile": fields.Str(validate=validate.Length(equal=0)),
             "extend": fields.DelimitedList(fields.Str(validate=validate.Length(min=1))),
             "filter": fields.Str(validate=validate.Length(min=1)),

gramps_webapi/api/resources/citation.py

@@ -22,7 +22,7 @@ def object_extend(self, obj: Citation, args: Dict) -> Citation:
         if "extend" in args:
             db_handle = self.db_handle
             obj.extended = get_extended_attributes(db_handle, obj, args)
-            if "all" in args["extend"] or "source" in args["extend"]:
+            if "all" in args["extend"] or "source_handle" in args["extend"]:
                 obj.extended["source"] = get_source_by_handle(
                     db_handle, obj.source_handle, args
                 )

gramps_webapi/api/resources/emit.py

@@ -76,29 +76,41 @@ def is_null(value: Any) -> bool:
         ):
             apply_filter = True
         for key, value in obj.__class__.__dict__.items():
+            if key.startswith("_"):
+                key = key[2 + key.find("__") :]
             if apply_filter:
                 if self.filter_only_keys and key not in self.filter_only_keys:
                     continue
                 if self.filter_skip_keys and key in self.filter_skip_keys:
                     continue
             if isinstance(value, property):
-                data[key] = getattr(obj, key)
+                value = getattr(obj, key)
+                if not self.strip_empty_keys or not is_null(value):
+                    data[key] = value
         for key, value in obj.__dict__.items():
+            if key.startswith("_"):
+                key = key[2 + key.find("__") :]
+            # Values we always filter out, data presented through different endpoint
+            if key in ["thumb"]:
+                continue
             if apply_filter:
                 if self.filter_only_keys and key not in self.filter_only_keys:
                     continue
                 if self.filter_skip_keys and key in self.filter_skip_keys:
                     continue
-            if key.startswith("_"):
-                key = key[2 + key.find("__") :]
+            # Values we normalize for schema consistency
+            if key == "rect" and value is None:
+                value = []
+            if key in ["mother_handle", "father_handle", "famc"] and value is None:
+                value = ""
             if not self.strip_empty_keys or not is_null(value):
                 data[key] = value
         return data
 
     def default(self, obj: Any):
         """Our default handler."""
         if isinstance(obj, lib.GrampsType):
-            return str(obj)
+            return obj.xml_str()
 
         for gramps_class in self.gramps_classes:
             if isinstance(obj, gramps_class):

gramps_webapi/api/resources/family.py

@@ -30,11 +30,11 @@ def object_extend(self, obj: Family, args: Dict) -> Family:
             )
         if "extend" in args:
             obj.extended = get_extended_attributes(db_handle, obj, args)
-            if "all" in args["extend"] or "father" in args["extend"]:
+            if "all" in args["extend"] or "father_handle" in args["extend"]:
                 obj.extended["father"] = get_person_by_handle(
                     db_handle, obj.father_handle
                 )
-            if "all" in args["extend"] or "mother" in args["extend"]:
+            if "all" in args["extend"] or "mother_handle" in args["extend"]:
                 obj.extended["mother"] = get_person_by_handle(
                     db_handle, obj.mother_handle
                 )

gramps_webapi/api/resources/filters.py

@@ -95,7 +95,7 @@ def build_filter(filter_parms: Dict, namespace: str) -> GenericFilter:
                 rule_instance = rule_class
                 break
         if rule_instance is None:
-            abort(400)
+            abort(404)
         filter_args = []
         if "values" in filter_rule:
             filter_args = filter_rule["values"]
@@ -120,7 +120,7 @@ def apply_filter(db_handle: DbReadBase, args: Dict, namespace: str) -> List[Hand
     except json.JSONDecodeError:
         abort(400)
     except ValidationError:
-        abort(400)
+        abort(422)
 
     filter_object = build_filter(filter_parms, namespace)
     return filter_object.apply(db_handle)
@@ -165,7 +165,7 @@ def get(self, args: Dict[str, str], namespace: str) -> Response:
         try:
             namespace = GRAMPS_NAMESPACES[namespace]
         except KeyError:
-            abort(400)
+            abort(404)
 
         rule_list = get_filter_rules(args, namespace)
         if args.get("rule") and not args.get("filter"):

gramps_webapi/api/resources/metadata.py

@@ -48,7 +48,7 @@ def get(self, args: Dict, datatype: str) -> Response:
                 elif args["type"] == "family_attribute":
                     result = db_handle.get_family_attribute_types()
                 elif args["type"] == "media_attribute":
-                    result = db_handle.get_person_attribute_types()
+                    result = db_handle.get_media_attribute_types()
                 elif args["type"] == "family_relation":
                     result = db_handle.get_family_relation_types()
                 elif args["type"] == "child_reference":

gramps_webapi/api/resources/translate.py

@@ -20,14 +20,23 @@ class TranslationResource(ProtectedResource, GrampsJSONEncoder):
         {"strings": fields.Str(required=True)},
         location="query",
     )
-    def get(self, args: Dict, code: str) -> Response:
+    def get(self, args: Dict, isocode: str) -> Response:
         """Get translation."""
         try:
             strings = json.loads(args["strings"])
         except json.JSONDecodeError:
             abort(400)
 
-        gramps_locale = GrampsLocale(lang=code)
+        language_code = isocode.replace("-", "_")
+        catalog = GRAMPS_LOCALE.get_language_dict()
+        found = False
+        for language in catalog:
+            if catalog[language] == language_code:
+                found = True
+        if not found:
+            abort(404)
+
+        gramps_locale = GrampsLocale(lang=language_code)
         return self.response(
             200,
             [
@@ -45,5 +54,8 @@ def get(self) -> Response:
         catalog = GRAMPS_LOCALE.get_language_dict()
         return self.response(
             200,
-            [{"language": language, "code": catalog[language]} for language in catalog],
+            [
+                {"language": language, "isocode": catalog[language].replace("_", "-")}
+                for language in catalog
+            ],
         )

gramps_webapi/api/resources/util.py

@@ -1,6 +1,6 @@
 """Gramps utility functions."""
 
-from typing import Dict, Optional
+from typing import Dict, Optional, Union
 
 from gramps.gen.const import GRAMPS_LOCALE
 from gramps.gen.db.base import DbReadBase
@@ -24,30 +24,30 @@
 dd = GRAMPS_LOCALE.date_displayer
 
 
-def get_person_by_handle(db_handle: DbReadBase, handle: Handle) -> Optional[Person]:
+def get_person_by_handle(db_handle: DbReadBase, handle: Handle) -> Union[Person, Dict]:
     """Safe get person by handle."""
     try:
         return db_handle.get_person_from_handle(handle)
     except HandleError:
-        return None
+        return {}
 
 
-def get_place_by_handle(db_handle: DbReadBase, handle: Handle) -> Optional[Place]:
+def get_place_by_handle(db_handle: DbReadBase, handle: Handle) -> Union[Place, Dict]:
     """Safe get place by handle."""
     try:
         return db_handle.get_place_from_handle(handle)
     except HandleError:
-        return None
+        return {}
 
 
 def get_family_by_handle(
     db_handle: DbReadBase, handle: Handle, args: Optional[Dict] = None
-) -> Optional[Family]:
+) -> Union[Family, Dict]:
     """Get a family and optional extended attributes."""
     try:
         obj = db_handle.get_family_from_handle(handle)
     except HandleError:
-        return None
+        return {}
     args = args or {}
     if "extend" in args:
         obj.extended = get_extended_attributes(db_handle, obj, args)
@@ -81,20 +81,18 @@ def get_sex_profile(person: Person) -> str:
 def get_event_profile_for_object(db_handle: DbReadBase, event: Event) -> Dict:
     """Get event profile given an Event."""
     return {
-        "type": str(event.type),
+        "type": event.type.xml_str(),
         "date": dd.display(event.date),
         "place": pd.display_event(db_handle, event),
     }
 
 
-def get_event_profile_for_handle(
-    db_handle: DbReadBase, handle: Handle
-) -> Optional[Dict]:
+def get_event_profile_for_handle(db_handle: DbReadBase, handle: Handle) -> Dict:
     """Get event profile given a handle."""
     try:
         obj = db_handle.get_event_from_handle(handle)
     except HandleError:
-        return None
+        return {}
     return get_event_profile_for_object(db_handle, obj)
 
 
@@ -173,12 +171,12 @@ def get_person_profile_for_handle(
     handle: Handle,
     with_family: bool = True,
     with_events: bool = True,
-) -> Optional[Person]:
+) -> Union[Person, Dict]:
     """Get person profile given a handle."""
     try:
         obj = db_handle.get_person_from_handle(handle)
     except HandleError:
-        return None
+        return {}
     return get_person_profile_for_object(db_handle, obj, with_family, with_events)
 
 
@@ -214,12 +212,12 @@ def get_family_profile_for_object(
 
 def get_family_profile_for_handle(
     db_handle: DbReadBase, handle: Handle, with_events: bool = True
-) -> Optional[Family]:
+) -> Union[Family, Dict]:
     """Get family profile given a handle."""
     try:
         obj = db_handle.get_family_from_handle(handle)
     except HandleError:
-        return None
+        return {}
     return get_family_profile_for_object(db_handle, obj, with_events)
 
 

gramps_webapi/app.py

@@ -15,7 +15,7 @@
 from .dbmanager import WebDbManager
 
 
-def create_app():
+def create_app(db_manager=None):
     """Flask application factory."""
     app = Flask(__name__)
     app.logger.setLevel(logging.INFO)
@@ -27,7 +27,10 @@ def create_app():
     app.config.from_envvar(ENV_CONFIG_FILE)
 
     # instantiate DB manager
-    app.config["DB_MANAGER"] = WebDbManager(name=app.config["TREE"])
+    if db_manager is None:
+        app.config["DB_MANAGER"] = WebDbManager(name=app.config["TREE"])
+    else:
+        app.config["DB_MANAGER"] = db_manager
 
     if app.config.get("DISABLE_AUTH"):
         pass