components and service build (#282)

* components and service build

* tests

* remove rdm model

* test fix

* service kwargs

* Update run-tests.sh

* Update run-tests.sh

---------

Co-authored-by: Alzbeta Pokorna <[email protected]>
Co-authored-by: Alzbeta Pokorna <[email protected]>
Co-authored-by: Mirek Simek <[email protected]>

Author: 4 people

oarepo_model_builder/datatypes/components/model/ext_resource.py

@@ -32,6 +32,6 @@ def before_model_prepare(self, datatype, *, context, **kwargs):
         if not datatype.profile == "record":
             return
         ext = set_default(datatype, "ext-resource", {})
-
+        ext.setdefault("service-kwargs", {})
         ext.setdefault("generate", True)
         ext.setdefault("skip", False)

oarepo_model_builder/invenio/templates/ext.py.jinja2

@@ -13,6 +13,7 @@ class {{ vars.ext|class_header }}:
 
     def init_app(self, app):
         """Flask application initialization."""
+        self.app = app
         {% if vars.ext.base_classes %}
         super().init_app(app=app)
         {% endif %}

oarepo_model_builder/invenio/templates/ext_resource.py.jinja2

@@ -5,11 +5,15 @@ class {{ vars.ext|class_header }}:
     {% if not vars.service.skip %}
     @cached_property
     def {{ ext.ext_service_name }}(self):
+        service_config = config.{{ vars.service_config.config_key }}
+        service_kwargs = {{ ext.service_kwargs }}
+        if hasattr(service_config, "build"):
+            config_class = service_config.build(self.app)
+        else:
+            config_class = service_config()
+        service_kwargs["config"] = config_class
         return config.{{ vars.service.config_key }}(
-            config=config.{{ vars.service_config.config_key }}(
-            {% if vars.service_config.additional_args %}
-                {{ vars.service_config.additional_args|generate_list }}
-            {% endif %}),
+            **service_kwargs,
             {% if vars.service.additional_args %}
                 {{ vars.service.additional_args|generate_list }}
             {% endif %}

oarepo_model_builder/invenio/templates/service_config.py.jinja2

@@ -10,6 +10,7 @@
 {% for c in vars.service_config.components %}
 {{ c|code_imports }}
 {% endfor %}
+from oarepo_runtime.services.components import process_service_configs
 
 class {{ vars.service_config|class_header }}:
     """{{ vars.record.class|base_name }} service config."""
@@ -41,7 +42,13 @@ class {{ vars.service_config|class_header }}:
     search_item_links_template = {{ vars.service_config.search_item_links_template_cls|base_name }}
     {% endif %}
 
-    components = [ {% for b in vars.service_config.base_classes %}*{{ b|base_name }}.components{% if not loop.last %}, {% endif %}{% endfor %}{% for c in vars.service_config.components %}, {{ c|extra_code }} {% endfor %}]
+    @property
+    def components(self):
+        components_list = []
+        components_list.extend(process_service_configs(type(self).mro()[2:]))
+        additional_components = [{% for c in vars.service_config.components %}{{ c|extra_code }}{% if not loop.last %}, {% endif %}{% endfor %}]
+        components_list.extend(additional_components)
+        return components_list
 
     model = "{{ vars.module.qualified }}"
 

run-tests.sh

@@ -9,6 +9,7 @@ cd "$(dirname "$0")"
 export BUILDER_VENV=.venv
 export TEST_VENV=.venv-tests
 export SERVER_VENV=.venv-server
+export PYTHON_VERSION=${PYTHON_VERSION:-python3}
 
 OAREPO_VERSION=${OAREPO_VERSION:-12}
 
@@ -19,12 +20,13 @@ initialize_server_venv() {
     rm -rf $SERVER_VENV
   fi
 
-  python3 -m venv $SERVER_VENV
+  $PYTHON_VERSION -m venv $SERVER_VENV
   source $SERVER_VENV/bin/activate
 
-  $SERVER_VENV/bin/pip install -U setuptools pip wheel
-  $SERVER_VENV/bin/pip install "oarepo[tests]==${OAREPO_VERSION}.*"
-  $SERVER_VENV/bin/pip install -e complex-model
+  $SERVER_VENV/bin/pip install -U setuptools pip wheel nrp-devtools
+  $SERVER_VENV/bin/nrp-devtools proxy 120 &
+  $SERVER_VENV/bin/pip install "oarepo[tests, rdm]==${OAREPO_VERSION}.*" --index-url "http://127.0.0.1:4549/simple" --extra-index-url https://pypi.org/simple
+  $SERVER_VENV/bin/pip install -e complex-model --index-url "http://127.0.0.1:4549/simple" --extra-index-url https://pypi.org/simple
 }
 
 initialize_builder_venv() {
@@ -33,7 +35,7 @@ initialize_builder_venv() {
     rm -rf $BUILDER_VENV
   fi
 
-  python3 -m venv $BUILDER_VENV
+  $PYTHON_VERSION -m venv $BUILDER_VENV
   . $BUILDER_VENV/bin/activate
   $BUILDER_VENV/bin/pip install -U setuptools pip wheel
   $BUILDER_VENV/bin/pip install -e '.[tests]'
@@ -45,7 +47,7 @@ initialize_client_test_venv() {
     rm -rf $TEST_VENV
   fi
 
-  python3 -m venv $TEST_VENV
+  $PYTHON_VERSION -m venv $TEST_VENV
 
   $TEST_VENV/bin/pip install -U setuptools pip wheel
   $TEST_VENV/bin/pip install requests PyYAML pytest
@@ -159,4 +161,4 @@ cat complex-model/data/sample_data.yaml
 $TEST_VENV/bin/pytest tests-model
 
 
-echo "All tests succeeded"
+echo "All tests succeeded"

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = oarepo-model-builder
-version = 4.0.96
+version = 4.0.97
 description = A utility library that generates OARepo required data model files from a JSON specification file
 authors = Miroslav Bauer <[email protected]>, Miroslav Simek <[email protected]>
 readme = README.md
@@ -9,7 +9,7 @@ long_description_content_type = text/markdown
 
 
 [options]
-python = >=3.9
+python = >=3.12
 install_requires =
     ConfigUpdater>=3.1.1,<4.0.0
     Faker>11.3.0

tests/test_datatype_prepare.py

@@ -66,7 +66,7 @@ def test_prepare_datatype():
             "suffix-snake": "test",
         },
         "sample": {"file": "data/sample_data.yaml"},
-        "ext-resource": {"generate": True, "skip": False},
+        "ext-resource": {"generate": True, 'service-kwargs': {}, "skip": False},
         "search-options": {
             "generate": True,
             "module": "my.test.services.records.search",

tests/test_include_components.py

@@ -47,8 +47,7 @@ def test_include_invenio():
     data = builder.filesystem.open(
         os.path.join("test", "services", "records", "config.py")
     ).read()
-    data = str(data)
-    assert (
-        "components=[*PermissionsPresetsConfigMixin.components,*InvenioRecordServiceConfig.components,DoiComponent,OaiSectionComponent]"
-        in re.sub(r"\s", "", data)
-    )
+    data = re.sub(r"\s", "", str(data))
+    additional_components = "additional_components=[DoiComponent,OaiSectionComponent]"  # Remove whitespace from expected substring
+
+    assert additional_components in data

tests/test_model_saver.py

@@ -40,6 +40,7 @@ def test_model_saver():
             }
         },
     )
+    print(data[0]["model"])
     assert data[0]["model"] == {
         "type": "model",
         "searchable": True,
@@ -60,7 +61,7 @@ def test_model_saver():
         },
         "sample": {"file": "data/sample_data.yaml"},
         "model-name": "Test",
-        "ext-resource": {"generate": True, "skip": False},
+        "ext-resource": {"generate": True, 'service-kwargs': {} , "skip": False},
         "search-options": {
             "generate": True,
             "module": "test.services.records.search",
@@ -433,7 +434,7 @@ def test_model_saver_invenio():
         },
         "sample": {"file": "data/sample_data.yaml"},
         "model-name": "Test",
-        "ext-resource": {"generate": True, "skip": False},
+        "ext-resource": {"generate": True, 'service-kwargs': {}, "skip": False},
         "search-options": {
             "generate": True,
             "module": "test.services.records.search",

tests/test_simple_builders.py

@@ -193,6 +193,7 @@ def __init__(self, app=None):
 
     def init_app(self, app):
         """Flask application initialization."""
+        self.app = app
         
         self.init_config(app)
         if not self.is_inherited():
@@ -392,6 +393,7 @@ def test_service_config():
 from test.services.records.results import TestRecordList
 from invenio_records_resources.services import LinksTemplate
 
+from oarepo_runtime.services.components import process_service_configs
 
 class TestServiceConfig(PermissionsPresetsConfigMixin, InvenioRecordServiceConfig):
     """TestRecord service config."""
@@ -418,12 +420,19 @@ class TestServiceConfig(PermissionsPresetsConfigMixin, InvenioRecordServiceConfi
     
     
     service_id = "test"
-    
-    
+
+
     search_item_links_template = LinksTemplate
-    
 
-    components = [ *PermissionsPresetsConfigMixin.components, *InvenioRecordServiceConfig.components]
+
+    @property
+    def components(self):
+        components_list = []
+        components_list.extend(process_service_configs(type(self).mro()[2:]))
+        additional_components = []
+        components_list.extend(additional_components)
+        return components_list
+    
 
     model = "test"