dissect.target 3.20.2.dev52__tar.gz → 3.20.2.dev53__tar.gz

{dissect_target-3.20.2.dev52/dissect.target.egg-info → dissect_target-3.20.2.dev53}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: dissect.target
-Version: 3.20.2.dev52
+Version: 3.20.2.dev53
 Summary: This module ties all other Dissect modules together, it provides a programming API and command line tools which allow easy access to various data sources inside disk images or file collections (a.k.a. targets)
 Author-email: Dissect Team <dissect@fox-it.com>
 License: Affero General Public License v3

{dissect_target-3.20.2.dev52 → dissect_target-3.20.2.dev53}/dissect/target/plugin.py

@@ -93,6 +93,7 @@ class FunctionDescriptor:
         "exported",
         "internal",
         "findable",
+        "alias",
         "output",
         "method_name",
         "module",
@@ -105,6 +106,7 @@ class FunctionDescriptor:
     exported: bool
     internal: bool
     findable: bool
+    alias: bool
     output: str | None
     method_name: str
     module: str
@@ -358,6 +360,7 @@ class Plugin:
     Finally. :func:`args` decorator sets the ``__args__`` attribute.
 
     The :func:`alias` decorator populates the ``__aliases__`` private attribute of :class:`Plugin` methods.
+    Resulting clones of the :class:`Plugin` are populated with the boolean ``__alias__`` attribute set to ``True``.
 
     Args:
         target: The :class:`~dissect.target.target.Target` object to load the plugin for.
@@ -528,6 +531,7 @@ def register(plugincls: type[Plugin]) -> None:
                         exported=exported,
                         internal=internal,
                         findable=plugincls.__findable__,
+                        alias=name in getattr(attr, "__aliases__", []),
                         output=getattr(attr, "__output__", None),
                         method_name=attr.__name__,
                         module=plugincls.__module__,
@@ -552,6 +556,7 @@ def register(plugincls: type[Plugin]) -> None:
                 exported=bool(len(exports)),
                 internal=bool(len(functions)) and not bool(len(exports)),
                 findable=plugincls.__findable__,
+                alias=False,
                 output=getattr(plugincls.__call__, "__output__", None),
                 method_name="__call__",
                 module=plugincls.__module__,

{dissect_target-3.20.2.dev52 → dissect_target-3.20.2.dev53}/dissect/target/plugins/general/plugins.py

@@ -67,6 +67,7 @@ def generate_functions_json(functions: list[plugin.FunctionDescriptor] | None =
                 "type": getattr(arg.get("type"), "__name__", None),
                 "help": arg.get("help"),
                 "default": arg.get("default"),
+                "required": arg.get("required", False),
             }
             for name, arg in getattr(func, "__args__", [])
         ]
@@ -78,6 +79,7 @@ def generate_functions_json(functions: list[plugin.FunctionDescriptor] | None =
                 "description": docstring,
                 "arguments": arguments,
                 "path": desc.path,
+                "alias": desc.alias,
             }
         )
 

{dissect_target-3.20.2.dev52 → dissect_target-3.20.2.dev53/dissect.target.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: dissect.target
-Version: 3.20.2.dev52
+Version: 3.20.2.dev53
 Summary: This module ties all other Dissect modules together, it provides a programming API and command line tools which allow easy access to various data sources inside disk images or file collections (a.k.a. targets)
 Author-email: Dissect Team <dissect@fox-it.com>
 License: Affero General Public License v3

{dissect_target-3.20.2.dev52 → dissect_target-3.20.2.dev53}/tests/plugins/general/test_plugins.py

@@ -49,6 +49,7 @@ def test_categorize_plugins(mocked_plugins: MagicMock, mocked_load: MagicMock) -
             exported=True,
             internal=False,
             findable=True,
+            alias=False,
             output=None,
             method_name="data",
             module="other.root.something.data",

{dissect_target-3.20.2.dev52 → dissect_target-3.20.2.dev53}/tests/test_plugin.py

@@ -112,6 +112,7 @@ def test_plugin_directory(mock_plugins: PluginRegistry, tmp_path: Path) -> None:
                 exported=True,
                 internal=False,
                 findable=True,
+                alias=False,
                 output="default",
                 method_name="my_function",
                 module="myplugin._plugin",
@@ -126,6 +127,7 @@ def test_plugin_directory(mock_plugins: PluginRegistry, tmp_path: Path) -> None:
                 exported=True,
                 internal=False,
                 findable=True,
+                alias=False,
                 output=None,
                 method_name="__call__",
                 module="mypluginns._plugin",
@@ -140,6 +142,7 @@ def test_plugin_directory(mock_plugins: PluginRegistry, tmp_path: Path) -> None:
                 exported=True,
                 internal=False,
                 findable=True,
+                alias=False,
                 output="default",
                 method_name="my_function",
                 module="mypluginns._plugin",
@@ -198,6 +201,7 @@ class MockOSWarpPlugin(OSPlugin):
                         exported=True,
                         internal=False,
                         findable=True,
+                        alias=False,
                         output="record",
                         method_name="f3",
                         module="test.x13",
@@ -212,6 +216,7 @@ class MockOSWarpPlugin(OSPlugin):
                         exported=True,
                         internal=False,
                         findable=True,
+                        alias=False,
                         output="record",
                         method_name="f3",
                         module="os",
@@ -226,6 +231,7 @@ class MockOSWarpPlugin(OSPlugin):
                         exported=True,
                         internal=False,
                         findable=False,
+                        alias=False,
                         output="record",
                         method_name="f22",
                         module="test.x69",
@@ -242,6 +248,7 @@ class MockOSWarpPlugin(OSPlugin):
                         exported=True,
                         internal=False,
                         findable=True,
+                        alias=False,
                         output="record",
                         method_name="f6",
                         module="os.warp._os",
@@ -503,6 +510,7 @@ MOCK_PLUGINS = PluginRegistry(
                     exported=True,
                     internal=False,
                     findable=True,
+                    alias=False,
                     output="record",
                     method_name="mail",
                     module="apps.mail",
@@ -517,6 +525,7 @@ MOCK_PLUGINS = PluginRegistry(
                     exported=True,
                     internal=False,
                     findable=True,
+                    alias=False,
                     output="record",
                     method_name="app1",
                     module="os.apps.app1",
@@ -531,6 +540,7 @@ MOCK_PLUGINS = PluginRegistry(
                     exported=True,
                     internal=False,
                     findable=True,
+                    alias=False,
                     output="record",
                     method_name="app2",
                     module="os.apps.app2",
@@ -543,6 +553,7 @@ MOCK_PLUGINS = PluginRegistry(
                     exported=True,
                     internal=False,
                     findable=True,
+                    alias=False,
                     output="record",
                     method_name="app2",
                     module="os.fooos.apps.app2",
@@ -557,6 +568,7 @@ MOCK_PLUGINS = PluginRegistry(
                     exported=True,
                     internal=False,
                     findable=True,
+                    alias=False,
                     output="record",
                     method_name="foo_app",
                     module="os.foos.apps.foo_app",
@@ -571,6 +583,7 @@ MOCK_PLUGINS = PluginRegistry(
                     exported=True,
                     internal=False,
                     findable=True,
+                    alias=False,
                     output="record",
                     method_name="bar_app",
                     module="os.foos.apps.bar_app",
@@ -585,6 +598,7 @@ MOCK_PLUGINS = PluginRegistry(
                     exported=True,
                     internal=False,
                     findable=True,
+                    alias=False,
                     output="record",
                     method_name="foobar",
                     module="os.foos.foobar",
@@ -601,6 +615,7 @@ MOCK_PLUGINS = PluginRegistry(
                     exported=True,
                     internal=False,
                     findable=True,
+                    alias=False,
                     output="record",
                     method_name="generic_os",
                     module="os._os",
@@ -615,6 +630,7 @@ MOCK_PLUGINS = PluginRegistry(
                     exported=True,
                     internal=False,
                     findable=True,
+                    alias=False,
                     output="record",
                     method_name="foo_os",
                     module="os.fooos._os",
@@ -811,6 +827,60 @@ def test_plugins_default_plugin(target_default: Target) -> None:
     assert len(list(default_os_plugin_desc)) == 1
 
 
+def test_function_aliases(target_default: Target) -> None:
+    """test if alias functions are tagged as such correctly."""
+
+    # function that is an alias should have an alias property set to True
+    syslog_fd = find_functions("syslog", target_default)[0][0]
+    assert syslog_fd
+    assert syslog_fd.path == "os.unix.log.messages.syslog"
+    assert syslog_fd.exported
+    assert syslog_fd.alias
+
+    # function that is not an alias should have an alias property set to False
+    messages_fd = find_functions("messages", target_default)[0][0]
+    assert messages_fd
+    assert messages_fd.path == "os.unix.log.messages.messages"
+    assert not messages_fd.alias
+
+
+def test_function_required_arguments(target_default: Target) -> None:
+    """test if functions with required arguments are tagged as such correctly."""
+
+    # function without any arguments should have an args property with an empty list
+    syslog_fd = find_functions("syslog", target_default)[0][0]
+    assert syslog_fd
+
+    # args property does not exist until https://github.com/fox-it/dissect.target/pull/1007 is merged
+    func = getattr(load(syslog_fd), syslog_fd.method_name)
+    assert not hasattr(func, "__args__")
+
+    # function with an argument should have an args property filled
+    envfile_fd = find_functions("envfile", target_default)[0][0]
+    assert envfile_fd
+
+    # args property does not exist until https://github.com/fox-it/dissect.target/pull/1007 is merged
+    func = getattr(load(envfile_fd), envfile_fd.method_name)
+    assert hasattr(func, "__args__")
+
+    assert func.__args__ == [
+        (
+            ("--env-path",),
+            {
+                "help": "path to scan environment files in",
+                "required": True,
+            },
+        ),
+        (
+            ("--extension",),
+            {
+                "default": "env",
+                "help": "extension of files to scan",
+            },
+        ),
+    ]
+
+
 @pytest.mark.parametrize(
     "method_name",
     [

{dissect_target-3.20.2.dev52 → dissect_target-3.20.2.dev53}/tests/test_report.py

@@ -263,6 +263,7 @@ def test_execution_report_log_incompatible_plugin_plugin_desc(
         exported=True,
         internal=False,
         findable=True,
+        alias=False,
         output=None,
         method_name="plugin1",
         module="test_module",

{dissect_target-3.20.2.dev52 → dissect_target-3.20.2.dev53}/tests/tools/test_query.py

@@ -162,6 +162,7 @@ def mock_find_functions(patterns: str, *args, **kwargs) -> tuple[list[FunctionDe
                 exported=True,
                 internal=False,
                 findable=True,
+                alias=False,
                 output="record",
                 method_name=pattern,
                 module=pattern,
@@ -275,6 +276,7 @@ def test_target_query_list_json(capsys: pytest.CaptureFixture, monkeypatch: pyte
         "description": "Return the users available in the target.",
         "output": "record",
         "arguments": [],
+        "alias": False,
         "path": "os.default._os.users",
     }
 
@@ -285,6 +287,7 @@ def test_target_query_list_json(capsys: pytest.CaptureFixture, monkeypatch: pyte
         "description": "Yield file and directory names from the plocate.db.",
         "output": "record",
         "arguments": [],
+        "alias": False,
         "path": "os.unix.locate.plocate.locate",
     }
 
@@ -295,5 +298,6 @@ def test_target_query_list_json(capsys: pytest.CaptureFixture, monkeypatch: pyte
         "description": "Dump SAM entries",
         "output": "record",
         "arguments": [],
+        "alias": False,
         "path": "os.windows.credential.sam.sam",
     }