Chore: Refactor Swan Extension to cryptoadvance.specterext (#1955)

* Refactor Swan service, delete bitcoinreserve

fix tests for services move to specterext and complete

* complete refactoring of swan extension

* added a test

* feedback manolis

Co-authored-by: Manolis Mandrapilias <[email protected]>

Author: k9ert

src/cryptoadvance/specter/config.py

@@ -173,9 +173,8 @@ class BaseConfig(object):
 
     # List of extensions (services) to potentially load
     EXTENSION_LIST = [
-        "cryptoadvance.specter.services.swan.service",
+        "cryptoadvance.specterext.swan.service",
         "cryptoadvance.specterext.liquidissuer.service",
-        "cryptoadvance.specter.services.bitcoinreserve.service",
         "cryptoadvance.specterext.devhelp.service",
         "cryptoadvance.specterext.exfund.service",
         "cryptoadvance.specterext.faucet.service",

src/cryptoadvance/specter/managers/service_manager/__init__.py

@@ -0,0 +1 @@
+from .service_manager import *

src/cryptoadvance/specter/managers/service_manager.py renamed to src/cryptoadvance/specter/managers/service_manager/service_manager.py

@@ -17,16 +17,16 @@
 from flask import url_for
 from flask.blueprints import Blueprint
 
-from ..services.service import Service
-from ..services import callbacks, ExtensionException
-from ..util.reflection import (
+from ...services.service import Service
+from ...services import callbacks, ExtensionException
+from ...util.reflection import (
     _get_module_from_class,
     get_classlist_of_type_clazz_from_modulelist,
     get_package_dir_for_subclasses_of,
     get_subclasses_for_clazz,
     get_subclasses_for_clazz_in_cwd,
 )
-from ..util.reflection_fs import search_dirs_in_path
+from ...util.reflection_fs import search_dirs_in_path
 
 logger = logging.getLogger(__name__)
 
@@ -44,7 +44,7 @@ def __init__(self, specter, devstatus_threshold):
         logger.info("----> starting service discovery Static")
         # How do we discover services? Two configs are relevant:
         # * SERVICES_LOAD_FROM_CWD (boolean, CWD is current working directory)
-        # * EXTENSION_LIST (array of Fully Qualified module strings like ["cryptoadvance.specter.services.swan.service"])
+        # * EXTENSION_LIST (array of Fully Qualified module strings like ["cryptoadvance.specterext.swan.service"])
         # Ensuring security (especially for the CWD) is NOT done here but
         # in the corresponding (Production)Config
         logger.debug(f"EXTENSION_LIST = {app.config.get('EXTENSION_LIST')}")

src/cryptoadvance/specter/services/bitcoinreserve/controller.py

@@ -62,10 +62,13 @@ def get_package_dir_for_subclasses_of(clazz):
             ).resolve()
         )
     elif clazz.__name__ == "Service":
+        # here, we'd like to know the Path of the namespace module cryptoadvance.specterext
+        # but that fails because you cannot import namespace-modules.
+        # So we take a module that we know exists and take its parent.
         return str(
             Path(
-                import_module("cryptoadvance.specter.services").__file__
-            ).parent.resolve()
+                import_module("cryptoadvance.specterext.devhelp").__file__
+            ).parent.parent.resolve()
         )
     # This is mainly for testing purposes for now
     elif clazz.__name__ == "Device":
@@ -176,53 +179,44 @@ def get_subclasses_for_clazz(clazz, package_dirs: List[str] = None):
             f"Iterating on importer={importer} , module_name={module_name} is_pkg={is_pkg}"
         )
         if clazz.__name__ == "Service":
+            # Ignore the stuff lying around in cryptoadvance/specter/services
+            if importer.path.endswith(
+                os.path.sep.join(["cryptoadvance", "specter", "services"])
+            ):
+                continue
             try:
-
-                module = import_module(
-                    f"cryptoadvance.specter.services.{module_name}.service"
-                )
-                logger.debug(
-                    f"  Imported cryptoadvance.specter.services.{module_name}.service"
-                )
-            except ModuleNotFoundError:
-                # Ignore the stuff lying around in cryptoadvance/specter/services
-                if importer.path.endswith(
-                    os.path.sep.join(["cryptoadvance", "specter", "services"])
-                ):
-                    continue
+                module = import_module(f"{module_name}.service")
+                logger.debug(f"  Imported {module_name}.service")
+            except ModuleNotFoundError as e:
                 try:
-                    module = import_module(f"{module_name}.service")
-                    logger.debug(f"  Imported {module_name}.service")
+                    # Another style is orgname.specterext.extensionid, for that we have to guess the orgname:
+                    orgname = str(importer).split(os.path.sep)[-2]
+                    logger.debug(f"guessing orgname: {orgname}")
+                    module = import_module(
+                        f"{orgname}.specterext.{module_name}.service"
+                    )
+                    logger.debug(
+                        f"  Imported {orgname}.specterext.{module_name}.service"
+                    )
                 except ModuleNotFoundError as e:
-                    try:
-                        # Another style is orgname.specterext.extensionid, for that we have to guess the orgname:
-                        orgname = str(importer).split(os.path.sep)[-2]
-                        logger.debug(f"guessing orgname: {orgname}")
-                        module = import_module(
-                            f"{orgname}.specterext.{module_name}.service"
-                        )
-                        logger.debug(
-                            f"  Imported {orgname}.specterext.{module_name}.service"
+                    if module_name in str(e.name) or orgname in str(e.name):
+                        raise Exception(
+                            f"""
+                    While iterating over {importer} for module {module_name}, 
+                    a Service implementation could not be found in this places:
+                    * cryptoadvance.specter.services.{module_name}.service
+                    * {module_name}.service
+                    * {orgname}.specterext.{module_name}.service
+                    Maybe you did forget to do this:
+                    $ pip3 install -e .
+
+                    OR The Module has been found, but had issues finding Modules itself
+
+                    {e}
+                    """
                         )
-                    except ModuleNotFoundError as e:
-                        if module_name in str(e.name) or orgname in str(e.name):
-                            raise Exception(
-                                f"""
-                        While iterating over {importer} for module {module_name}, 
-                        a Service implementation could not be found in this places:
-                        * cryptoadvance.specter.services.{module_name}.service
-                        * {module_name}.service
-                        * {orgname}.specterext.{module_name}.service
-                        Maybe you did forget to do this:
-                        $ pip3 install -e .
-
-                        OR The Module has been found, but had issues finding Modules itself
-
-                        {e}
-                        """
-                            )
-                        else:
-                            raise e
+                    else:
+                        raise e
         elif clazz.__name__ == "SpecterMigration":
             module = import_module(
                 f"cryptoadvance.specter.util.migrations.{module_name}"