arkindex_worker/worker/__init__.py

@@ -137,6 +137,8 @@ class ElementsWorker(
 
     def configure(self):
         super().configure()
+        super().configure_cache()
+
         # Add report concerning elements
         self.report = Reporter(
             **self.worker_details, version=getattr(self, "worker_version_id", None)

arkindex_worker/worker/base.py

@@ -118,6 +118,7 @@ class BaseWorker(object):
         self.parser.add_argument(
             "-v",
             "--verbose",
+            "--debug",
             help="Display more information on events and errors",
             action="store_true",
             default=False,
@@ -138,8 +139,8 @@ class BaseWorker(object):
         # CLI args are stored on the instance so that implementations can access them
         self.args = self.parser.parse_args()
 
-        # Setup logging level
-        if self.args.verbose:
+        # Setup logging level if verbose or if ARKINDEX_DEBUG is set to true
+        if self.args.verbose or os.environ.get("ARKINDEX_DEBUG"):
             logger.setLevel(logging.DEBUG)
             logger.debug("Debug output enabled")
 
@@ -147,11 +148,6 @@ class BaseWorker(object):
         self.api_client = ArkindexClient(**options_from_env())
         logger.debug(f"Setup Arkindex API client on {self.api_client.document.url}")
 
-        # Load features available on backend, and check authentication
-        user = self.request("RetrieveUser")
-        logger.debug(f"Connected as {user['display_name']} - {user['email']}")
-        self.features = user["features"]
-
         # Load process information except in developer mode
         if not self.args.dev:
             assert os.environ.get(
@@ -210,6 +206,12 @@ class BaseWorker(object):
                 if self.user_configuration:
                     logger.info("Loaded user configuration from WorkerRun")
 
+        # if debug mode is set to true activate debug mode in logger
+        if self.user_configuration and self.user_configuration.get("debug"):
+            logger.setLevel(logging.DEBUG)
+            logger.debug("Debug output enabled")
+
+    def configure_cache(self):
         task_id = os.environ.get("PONOS_TASK")
         paths = None
         if self.support_cache and self.args.database is not None:

tests/conftest.py

@@ -109,7 +109,7 @@ def give_env_variable(request, monkeypatch):
 
 
 @pytest.fixture
-def mock_config_api(mock_worker_version_api, mock_process_api, mock_user_api):
+def mock_config_api(mock_worker_version_api, mock_process_api):
     """Mock all API endpoints required to configure a worker"""
     pass
 
@@ -223,29 +223,6 @@ def mock_process_api(responses):
     )
 
 
-@pytest.fixture
-def mock_user_api(responses):
-    """
-    Provide a mock API response to retrieve user details
-    Signup is disabled in this mock
-    """
-    payload = {
-        "id": 1,
-        "email": "bot@teklia.com",
-        "display_name": "Bender",
-        "features": {
-            "signup": False,
-        },
-    }
-    responses.add(
-        responses.GET,
-        "http://testserver/api/v1/user/",
-        status=200,
-        body=json.dumps(payload),
-        content_type="application/json",
-    )
-
-
 @pytest.fixture
 def mock_activity_calls(responses):
     """
@@ -309,6 +286,7 @@ def mock_elements_worker_with_cache(monkeypatch, mock_config_api, tmp_path):
 
     worker = ElementsWorker(support_cache=True)
     worker.configure()
+    worker.configure_cache()
     return worker
 
 

tests/test_base_worker.py

@@ -45,9 +45,7 @@ def test_init_var_ponos_data_given(monkeypatch):
     assert worker.worker_version_id == "12341234-1234-1234-1234-123412341234"
 
 
-def test_init_var_worker_version_id_missing(
-    monkeypatch, mock_user_api, mock_process_api
-):
+def test_init_var_worker_version_id_missing(monkeypatch, mock_process_api):
     monkeypatch.setattr(sys, "argv", ["worker"])
     monkeypatch.delenv("WORKER_VERSION_ID")
     worker = BaseWorker()
@@ -57,9 +55,7 @@ def test_init_var_worker_version_id_missing(
     assert worker.config == {}  # default empty case
 
 
-def test_init_var_worker_local_file(
-    monkeypatch, tmp_path, mock_user_api, mock_process_api
-):
+def test_init_var_worker_local_file(monkeypatch, tmp_path, mock_process_api):
     # Build a dummy yaml config file
     config = tmp_path / "config.yml"
     config.write_text("---\nlocalKey: abcdef123")
@@ -119,9 +115,25 @@ def test_cli_arg_verbose_given(mocker, mock_config_api):
     logger.setLevel(logging.NOTSET)
 
 
-def test_configure_dev_mode(
-    mocker, monkeypatch, mock_user_api, mock_worker_version_api
-):
+def test_cli_envvar_debug_given(mocker, monkeypatch, mock_config_api):
+    worker = BaseWorker()
+
+    assert logger.level == logging.NOTSET
+    assert not hasattr(worker, "api_client")
+    mocker.patch.object(sys, "argv", ["worker"])
+    monkeypatch.setenv("ARKINDEX_DEBUG", True)
+
+    worker.configure()
+    assert logger.level == logging.DEBUG
+    assert worker.api_client
+    assert worker.worker_version_id == "12341234-1234-1234-1234-123412341234"
+    assert worker.is_read_only is False
+    assert worker.config == {"someKey": "someValue"}  # from API
+
+    logger.setLevel(logging.NOTSET)
+
+
+def test_configure_dev_mode(mocker, monkeypatch, mock_worker_version_api):
     """
     Configuring a worker in developer mode avoid retrieving process information
     """
@@ -164,7 +176,6 @@ def test_configure_user_configuration_defaults(
     mocker,
     monkeypatch,
     mock_worker_version_user_configuration_api,
-    mock_user_api,
     mock_process_api,
     responses,
 ):
@@ -186,6 +197,34 @@ def test_configure_user_configuration_defaults(
     }
 
 
+@pytest.mark.parametrize("debug_dict", [{"debug": True}, {"debug": False}])
+def test_configure_user_config_debug(
+    mocker, monkeypatch, responses, mock_config_api, debug_dict
+):
+    worker = BaseWorker()
+    mocker.patch.object(sys, "argv", ["worker"])
+    run_id = "aaaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
+    configuration_id = "bbbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
+    monkeypatch.setenv("ARKINDEX_WORKER_RUN_ID", run_id)
+    assert logger.level == logging.NOTSET
+    responses.add(
+        responses.GET,
+        f"http://testserver/api/v1/imports/workers/{run_id}/",
+        json={"id": run_id, "configuration_id": configuration_id},
+    )
+    responses.add(
+        responses.GET,
+        f"http://testserver/api/v1/workers/configurations/{configuration_id}/",
+        json={"id": configuration_id, "name": "BBB", "configuration": debug_dict},
+    )
+    worker.configure()
+
+    assert worker.user_configuration == debug_dict
+    expected_log_level = logging.DEBUG if debug_dict["debug"] else logging.NOTSET
+    assert logger.level == expected_log_level
+    logger.setLevel(logging.NOTSET)
+
+
 def test_configure_worker_run_missing_conf(
     mocker, monkeypatch, responses, mock_config_api
 ):

tests/test_elements_worker/__init__.py

 # -*- coding: utf-8 -*-
 # API calls during worker configuration
 BASE_API_CALLS = [
-    ("GET", "http://testserver/api/v1/user/"),
     ("GET", "http://testserver/api/v1/imports/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeffff/"),
     (
         "GET",

tests/test_elements_worker/test_worker.py

@@ -79,9 +79,7 @@ def test_readonly(responses, mock_elements_worker):
     ] == BASE_API_CALLS
 
 
-def test_activities_disabled(
-    responses, monkeypatch, mock_worker_version_api, mock_user_api
-):
+def test_activities_disabled(responses, monkeypatch, mock_worker_version_api):
     """Test worker process elements without updating activities when they are disabled for the process"""
     responses.add(
         responses.GET,
@@ -101,7 +99,7 @@ def test_activities_disabled(
     ] == BASE_API_CALLS
 
 
-def test_activities_dev_mode(mocker, mock_user_api, mock_worker_version_api):
+def test_activities_dev_mode(mocker, mock_worker_version_api):
     """
     Worker activities are not stored in dev mode
     """

tests/test_merge.py

@@ -182,6 +182,7 @@ def test_merge_from_worker(
     # Create the task's output dir, so that it can create its own database
     (tmpdir / "my_task").mkdir()
     mock_base_worker_with_cache.configure()
+    mock_base_worker_with_cache.configure_cache()
 
     # Then we have 2 elements and a transcription
     assert CachedImage.select().count() == 0