mirror of
https://github.com/ChuckBuilds/LEDMatrix.git
synced 2026-08-21 10:29:06 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0a7d14d75e |
@@ -195,18 +195,36 @@ class PluginManager:
|
|||||||
continue
|
continue
|
||||||
|
|
||||||
manifest_path = item / "manifest.json"
|
manifest_path = item / "manifest.json"
|
||||||
if manifest_path.exists():
|
if not manifest_path.exists():
|
||||||
try:
|
# A directory here that carries no manifest is not a
|
||||||
with open(manifest_path, 'r', encoding='utf-8') as f:
|
# plugin. Said once, because the alternative is a plugin
|
||||||
manifest = json.load(f)
|
# that is enabled in config, enabled in plugin state,
|
||||||
plugin_id = manifest.get('id')
|
# present on disk, and simply absent from the running
|
||||||
if plugin_id:
|
# process with nothing anywhere to say why. Working that
|
||||||
plugin_ids.append(plugin_id)
|
# out afterwards means reading cache-file mtimes.
|
||||||
new_manifests[plugin_id] = manifest
|
self.logger.warning(
|
||||||
new_directories[plugin_id] = item
|
"Skipping %s: no manifest.json, so it cannot be loaded "
|
||||||
except (json.JSONDecodeError, PermissionError, OSError) as e:
|
"as a plugin", item.name)
|
||||||
self.logger.warning("Error reading manifest from %s: %s", manifest_path, e, exc_info=True)
|
continue
|
||||||
continue
|
try:
|
||||||
|
with open(manifest_path, 'r', encoding='utf-8') as f:
|
||||||
|
manifest = json.load(f)
|
||||||
|
except (json.JSONDecodeError, PermissionError, OSError) as e:
|
||||||
|
self.logger.warning("Error reading manifest from %s: %s", manifest_path, e, exc_info=True)
|
||||||
|
continue
|
||||||
|
|
||||||
|
plugin_id = manifest.get('id')
|
||||||
|
if not plugin_id:
|
||||||
|
# Parsed but unusable. This was the quietest path of all:
|
||||||
|
# the manifest is read successfully and then dropped.
|
||||||
|
self.logger.warning(
|
||||||
|
"Skipping %s: its manifest.json has no \"id\", so there "
|
||||||
|
"is nothing to register it under", item.name)
|
||||||
|
continue
|
||||||
|
|
||||||
|
plugin_ids.append(plugin_id)
|
||||||
|
new_manifests[plugin_id] = manifest
|
||||||
|
new_directories[plugin_id] = item
|
||||||
except (OSError, PermissionError) as e:
|
except (OSError, PermissionError) as e:
|
||||||
self.logger.error("Error scanning directory %s: %s", directory, e, exc_info=True)
|
self.logger.error("Error scanning directory %s: %s", directory, e, exc_info=True)
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,64 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Discovery must say when it skips a directory.
|
||||||
|
|
||||||
|
A plugin can be enabled in config, enabled in plugin state, present on disk
|
||||||
|
with a valid entry point -- and simply absent from the running process, with
|
||||||
|
nothing in the journal to say why. Working that out afterwards meant comparing
|
||||||
|
cache-file mtimes to find when it had last run.
|
||||||
|
|
||||||
|
Two paths were silent. A directory with no manifest.json was ignored, and --
|
||||||
|
quieter still -- a manifest that parsed but carried no "id" was read
|
||||||
|
successfully and then dropped on the floor.
|
||||||
|
"""
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
from unittest.mock import MagicMock
|
||||||
|
|
||||||
|
sys.path.insert(0, str(Path(__file__).resolve().parent.parent))
|
||||||
|
|
||||||
|
from src.plugin_system.plugin_manager import PluginManager # noqa: E402
|
||||||
|
|
||||||
|
|
||||||
|
def _manager(tmp_path):
|
||||||
|
pm = PluginManager.__new__(PluginManager)
|
||||||
|
pm.plugins_dir = tmp_path
|
||||||
|
pm.logger = logging.getLogger("test.discovery")
|
||||||
|
pm.plugin_manifests = {}
|
||||||
|
pm.plugin_directories = {}
|
||||||
|
pm._discovery_lock = __import__("threading").RLock()
|
||||||
|
pm.schema_manager = MagicMock()
|
||||||
|
return pm
|
||||||
|
|
||||||
|
|
||||||
|
def test_a_directory_without_a_manifest_is_reported(tmp_path, caplog):
|
||||||
|
(tmp_path / "not-a-plugin").mkdir()
|
||||||
|
pm = _manager(tmp_path)
|
||||||
|
with caplog.at_level(logging.WARNING, logger="test.discovery"):
|
||||||
|
pm._scan_directory_for_plugins(tmp_path)
|
||||||
|
joined = " ".join(r.message for r in caplog.records)
|
||||||
|
assert "not-a-plugin" in joined and "manifest" in joined, (
|
||||||
|
f"skip was silent; log said: {joined!r}")
|
||||||
|
|
||||||
|
|
||||||
|
def test_a_manifest_without_an_id_is_reported(tmp_path, caplog):
|
||||||
|
d = tmp_path / "idless"
|
||||||
|
d.mkdir()
|
||||||
|
(d / "manifest.json").write_text(json.dumps({"name": "No Id", "version": "1.0.0"}))
|
||||||
|
pm = _manager(tmp_path)
|
||||||
|
with caplog.at_level(logging.WARNING, logger="test.discovery"):
|
||||||
|
pm._scan_directory_for_plugins(tmp_path)
|
||||||
|
joined = " ".join(r.message for r in caplog.records)
|
||||||
|
assert "idless" in joined and "id" in joined, (
|
||||||
|
f"a parsed-but-unusable manifest vanished silently; log said: {joined!r}")
|
||||||
|
|
||||||
|
|
||||||
|
def test_a_good_plugin_still_registers(tmp_path, caplog):
|
||||||
|
d = tmp_path / "real-plugin"
|
||||||
|
d.mkdir()
|
||||||
|
(d / "manifest.json").write_text(json.dumps(
|
||||||
|
{"id": "real-plugin", "name": "Real", "version": "1.0.0"}))
|
||||||
|
pm = _manager(tmp_path)
|
||||||
|
pm._scan_directory_for_plugins(tmp_path)
|
||||||
|
assert "real-plugin" in pm.plugin_manifests, "a valid plugin was not registered"
|
||||||
@@ -194,46 +194,15 @@ class TestSavePluginConfig:
|
|||||||
|
|
||||||
def test_secret_count_message_counts_top_level_keys(self, env):
|
def test_secret_count_message_counts_top_level_keys(self, env):
|
||||||
# Pinned: the "(N secret field(s))" message counts TOP-LEVEL keys of
|
# Pinned: the "(N secret field(s))" message counts TOP-LEVEL keys of
|
||||||
# the separated secrets dict. Here that is 1: the posted accounts
|
# the separated secrets dict. Here that is 2: the posted accounts
|
||||||
# array, whose item tokens all count as ONE key.
|
# array (all its item tokens count as ONE key) plus the schema's
|
||||||
#
|
# api_key default ("") that merge_with_defaults adds before
|
||||||
# It was 2 before blank secrets were dropped, the second being the
|
# separation.
|
||||||
# schema's api_key default (""), which merge_with_defaults adds to
|
|
||||||
# every save. Counting it was the visible edge of a real bug: that
|
|
||||||
# injected blank was merged over the stored api_key, so saving any
|
|
||||||
# unrelated field destroyed the credential. See
|
|
||||||
# test_an_unrelated_edit_does_not_erase_a_stored_secret.
|
|
||||||
resp = self._save(env, {
|
resp = self._save(env, {
|
||||||
"accounts": [{"name": "a", "token": "t"}],
|
"accounts": [{"name": "a", "token": "t"}],
|
||||||
})
|
})
|
||||||
message = resp.get_json()["message"]
|
message = resp.get_json()["message"]
|
||||||
assert "(1 secret field(s) saved to config_secrets.json)" in message
|
assert "(2 secret field(s) saved to config_secrets.json)" in message
|
||||||
|
|
||||||
def test_an_unrelated_edit_does_not_erase_a_stored_secret(self, env):
|
|
||||||
"""Editing one field must not wipe the plugin's API key.
|
|
||||||
|
|
||||||
The config form renders secrets masked, so the browser posts them
|
|
||||||
back blank; merge_with_defaults injects a blank api_key even when
|
|
||||||
the client omits it entirely. Either way a "" reached the secrets
|
|
||||||
file and deep_merge wrote it over the stored credential.
|
|
||||||
"""
|
|
||||||
assert self._save(env, {"api_key": "REAL-KEY-0123456789",
|
|
||||||
"city": "Austin"}).status_code == 200
|
|
||||||
assert _on_disk(env.secrets_file)[PLUGIN_ID]["api_key"] == \
|
|
||||||
"REAL-KEY-0123456789"
|
|
||||||
|
|
||||||
# the user changes the city; the masked api_key rides along blank
|
|
||||||
assert self._save(env, {"api_key": "", "city": "Dallas"}).status_code == 200
|
|
||||||
|
|
||||||
assert _on_disk(env.secrets_file)[PLUGIN_ID]["api_key"] == \
|
|
||||||
"REAL-KEY-0123456789", "an unrelated edit destroyed the API key"
|
|
||||||
assert env.fresh_load()[PLUGIN_ID]["city"] == "Dallas"
|
|
||||||
|
|
||||||
def test_a_secret_can_still_be_changed(self, env):
|
|
||||||
"""Dropping blanks must not stop a real new value from being saved."""
|
|
||||||
self._save(env, {"api_key": "first-key"})
|
|
||||||
self._save(env, {"api_key": "second-key"})
|
|
||||||
assert _on_disk(env.secrets_file)[PLUGIN_ID]["api_key"] == "second-key"
|
|
||||||
|
|
||||||
def test_resave_replaces_stored_secrets_list_wholesale(self, env):
|
def test_resave_replaces_stored_secrets_list_wholesale(self, env):
|
||||||
# Characterized: api_v3's deep_merge intentionally replaces lists,
|
# Characterized: api_v3's deep_merge intentionally replaces lists,
|
||||||
|
|||||||
@@ -21,8 +21,7 @@ logger = logging.getLogger(__name__)
|
|||||||
# Import new infrastructure
|
# Import new infrastructure
|
||||||
from src.web_interface.api_helpers import success_response, error_response, validate_request_json
|
from src.web_interface.api_helpers import success_response, error_response, validate_request_json
|
||||||
from src.web_interface.errors import ErrorCode
|
from src.web_interface.errors import ErrorCode
|
||||||
from src.web_interface.secret_helpers import (find_secret_fields, remove_empty_secrets,
|
from src.web_interface.secret_helpers import find_secret_fields, separate_secrets
|
||||||
separate_secrets)
|
|
||||||
from src.web_interface.error_handler import describe_exception, redact_text
|
from src.web_interface.error_handler import describe_exception, redact_text
|
||||||
from src.plugin_system.operation_types import OperationType
|
from src.plugin_system.operation_types import OperationType
|
||||||
from src.web_interface.validators import (
|
from src.web_interface.validators import (
|
||||||
@@ -1217,11 +1216,6 @@ def save_main_config():
|
|||||||
|
|
||||||
# Separate secrets from regular config (same logic as save_plugin_config)
|
# Separate secrets from regular config (same logic as save_plugin_config)
|
||||||
regular_config, secrets_config = separate_secrets(plugin_config, secret_fields)
|
regular_config, secrets_config = separate_secrets(plugin_config, secret_fields)
|
||||||
# The config form renders secrets masked, so every save posts
|
|
||||||
# them back blank. Without this the blank is merged over the
|
|
||||||
# stored value and the credential is destroyed by the act of
|
|
||||||
# changing an unrelated setting. A blank means "unchanged".
|
|
||||||
secrets_config = remove_empty_secrets(secrets_config)
|
|
||||||
|
|
||||||
# PRE-PROCESSING: Preserve 'enabled' state if not in regular_config
|
# PRE-PROCESSING: Preserve 'enabled' state if not in regular_config
|
||||||
# This prevents overwriting the enabled state when saving config from a form that doesn't include the toggle
|
# This prevents overwriting the enabled state when saving config from a form that doesn't include the toggle
|
||||||
@@ -5605,11 +5599,6 @@ def save_plugin_config():
|
|||||||
# Separate secrets from regular config (handles nested configs and
|
# Separate secrets from regular config (handles nested configs and
|
||||||
# array-item secrets — see src/web_interface/secret_helpers.py)
|
# array-item secrets — see src/web_interface/secret_helpers.py)
|
||||||
regular_config, secrets_config = separate_secrets(plugin_config, secret_fields)
|
regular_config, secrets_config = separate_secrets(plugin_config, secret_fields)
|
||||||
# The config form renders secrets masked, so every save posts
|
|
||||||
# them back blank. Without this the blank is merged over the
|
|
||||||
# stored value and the credential is destroyed by the act of
|
|
||||||
# changing an unrelated setting. A blank means "unchanged".
|
|
||||||
secrets_config = remove_empty_secrets(secrets_config)
|
|
||||||
|
|
||||||
# Get current configs
|
# Get current configs
|
||||||
current_config = api_v3.config_manager.load_config()
|
current_config = api_v3.config_manager.load_config()
|
||||||
|
|||||||
Reference in New Issue
Block a user