feat: add CONTRIBUTING, LICENSE, SECURITY, tests, requirements

CONTRIBUTING.md

@@ -0,0 +1,21 @@
+# Contributing to pwnsorter
+
+Thank you for your interest in contributing to pwnsorter!
+
+## How to Contribute
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## Code Style
+
+- Follow PEP 8
+- Add docstrings to all functions
+- Write tests for new features
+
+## Reporting Issues
+
+Please use the GitHub issue tracker to report bugs or request features.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 itsdarklikehell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

SECURITY.md

@@ -0,0 +1,13 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| latest  | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+Please report security vulnerabilities by opening a security advisory on GitHub.
+
+Do NOT open a public issue for security vulnerabilities.

tests/test_pwnsorter.py

@@ -0,0 +1,190 @@
+"""
+Tests for pwnsorter plugin.
+"""
+
+import ast
+import sys
+import types
+import importlib
+import importlib.util
+from pathlib import Path
+from unittest.mock import MagicMock, patch
+
+import pytest
+
+REPO_ROOT = Path(__file__).resolve().parent.parent
+
+
+def _ensure_pwnagotchi_mocks():
+    """Install mock pwnagotchi modules if not already present."""
+    if "pwnagotchi" in sys.modules:
+        return
+
+    pwnagotchi = types.ModuleType("pwnagotchi")
+    pwnagotchi.__path__ = []
+    sys.modules["pwnagotchi"] = pwnagotchi
+
+    plugins_mod = types.ModuleType("pwnagotchi.plugins")
+    plugins_mod.Plugin = type("Plugin", (), {})
+    plugins_mod.BasePlugin = type("BasePlugin", (), {})
+    plugins_mod.toggle_plugin = MagicMock()
+    sys.modules["pwnagotchi.plugins"] = plugins_mod
+    pwnagotchi.plugins = plugins_mod
+
+    ui_mod = types.ModuleType("pwnagotchi.ui")
+    ui_mod.__path__ = []
+    sys.modules["pwnagotchi.ui"] = ui_mod
+    pwnagotchi.ui = ui_mod
+
+    components_mod = types.ModuleType("pwnagotchi.ui.components")
+    components_mod.LabeledValue = MagicMock
+    components_mod.Text = MagicMock
+    components_mod.Line = MagicMock
+    components_mod.Rect = MagicMock
+    components_mod.FilledRect = MagicMock
+    components_mod.Widget = MagicMock
+    sys.modules["pwnagotchi.ui.components"] = components_mod
+    ui_mod.components = components_mod
+
+    view_mod = types.ModuleType("pwnagotchi.ui.view")
+    view_mod.BLACK = 0
+    view_mod.WHITE = 1
+    view_mod.__dict__["__getattr__"] = lambda name: MagicMock()
+    sys.modules["pwnagotchi.ui.view"] = view_mod
+    ui_mod.view = view_mod
+
+    fonts_mod = types.ModuleType("pwnagotchi.ui.fonts")
+    fonts_mod.Bold = MagicMock()
+    fonts_mod.Medium = MagicMock()
+    fonts_mod.Size = MagicMock()
+    sys.modules["pwnagotchi.ui.fonts"] = fonts_mod
+    ui_mod.fonts = fonts_mod
+
+
+def _load_plugin_module(plugin_file):
+    """Load a plugin module from file."""
+    _ensure_pwnagotchi_mocks()
+    spec = importlib.util.spec_from_file_location(plugin_file.stem, plugin_file)
+    if spec is None:
+        return None
+    module = importlib.util.module_from_spec(spec)
+    try:
+        spec.loader.exec_module(module)
+        return module
+    except Exception:
+        return None
+
+
+def _find_plugin_class(module):
+    """Find the plugin class in a module."""
+    for attr_name in dir(module):
+        attr = getattr(module, attr_name)
+        if isinstance(attr, type) and hasattr(attr, "__version__"):
+            return attr
+    return None
+
+
+class TestPwnsorterSyntax:
+    """Test that pwnsorter files have valid Python syntax."""
+
+    def test_potfilesorter_parses(self):
+        """potfilesorter.py can be parsed by ast."""
+        source = (REPO_ROOT / "potfilesorter.py").read_text(encoding="utf-8")
+        try:
+            ast.parse(source)
+        except SyntaxError as e:
+            pytest.fail(f"Syntax error in potfilesorter.py: {e}")
+
+    def test_potfilesorter_compiles(self):
+        """potfilesorter.py compiles to bytecode."""
+        source = (REPO_ROOT / "potfilesorter.py").read_text(encoding="utf-8")
+        try:
+            compile(source, "potfilesorter.py", "exec")
+        except (SyntaxError, ValueError) as e:
+            pytest.fail(f"Compile error in potfilesorter.py: {e}")
+
+
+class TestPwnsorterStructure:
+    """Test that pwnsorter plugin class has required attributes."""
+
+    def test_potfilesorter_has_version(self):
+        """PotfileSorter class has __version__ attribute."""
+        module = _load_plugin_module(REPO_ROOT / "potfilesorter.py")
+        if module is None:
+            pytest.skip("potfilesorter.py could not be loaded")
+        plugin_class = _find_plugin_class(module)
+        if plugin_class is None:
+            pytest.skip("No plugin class found in potfilesorter.py")
+        assert hasattr(plugin_class, "__version__"), "PotfileSorter missing __version__"
+
+    def test_potfilesorter_has_license(self):
+        """PotfileSorter class has __license__ attribute."""
+        module = _load_plugin_module(REPO_ROOT / "potfilesorter.py")
+        if module is None:
+            pytest.skip("potfilesorter.py could not be loaded")
+        plugin_class = _find_plugin_class(module)
+        if plugin_class is None:
+            pytest.skip("No plugin class found in potfilesorter.py")
+        assert hasattr(plugin_class, "__license__"), "PotfileSorter missing __license__"
+
+    def test_potfilesorter_has_name(self):
+        """PotfileSorter class has __name__ attribute."""
+        module = _load_plugin_module(REPO_ROOT / "potfilesorter.py")
+        if module is None:
+            pytest.skip("potfilesorter.py could not be loaded")
+        plugin_class = _find_plugin_class(module)
+        if plugin_class is None:
+            pytest.skip("No plugin class found in potfilesorter.py")
+        assert hasattr(plugin_class, "__name__"), "PotfileSorter missing __name__"
+
+    def test_potfilesorter_has_description(self):
+        """PotfileSorter class has __description__ attribute."""
+        module = _load_plugin_module(REPO_ROOT / "potfilesorter.py")
+        if module is None:
+            pytest.skip("potfilesorter.py could not be loaded")
+        plugin_class = _find_plugin_class(module)
+        if plugin_class is None:
+            pytest.skip("No plugin class found in potfilesorter.py")
+        assert hasattr(plugin_class, "__description__"), "PotfileSorter missing __description__"
+
+    def test_potfilesorter_has_author(self):
+        """PotfileSorter class has __author__ attribute."""
+        module = _load_plugin_module(REPO_ROOT / "potfilesorter.py")
+        if module is None:
+            pytest.skip("potfilesorter.py could not be loaded")
+        plugin_class = _find_plugin_class(module)
+        if plugin_class is None:
+            pytest.skip("No plugin class found in potfilesorter.py")
+        assert hasattr(plugin_class, "__author__"), "PotfileSorter missing __author__"
+
+    def test_potfilesorter_has_init(self):
+        """PotfileSorter class has __init__ method."""
+        module = _load_plugin_module(REPO_ROOT / "potfilesorter.py")
+        if module is None:
+            pytest.skip("potfilesorter.py could not be loaded")
+        plugin_class = _find_plugin_class(module)
+        if plugin_class is None:
+            pytest.skip("No plugin class found in potfilesorter.py")
+        assert hasattr(plugin_class, "__init__"), "PotfileSorter missing __init__"
+
+    def test_potfilesorter_has_on_loaded(self):
+        """PotfileSorter class has on_loaded method."""
+        module = _load_plugin_module(REPO_ROOT / "potfilesorter.py")
+        if module is None:
+            pytest.skip("potfilesorter.py could not be loaded")
+        plugin_class = _find_plugin_class(module)
+        if plugin_class is None:
+            pytest.skip("No plugin class found in potfilesorter.py")
+        assert hasattr(plugin_class, "on_loaded"), "PotfileSorter missing on_loaded"
+
+
+class TestPwnsorterConfig:
+    """Test that pwnsorter config files are valid."""
+
+    def test_requirements_exists(self):
+        """requirements.txt exists."""
+        assert (REPO_ROOT / "requirements.txt").exists(), "requirements.txt missing"
+
+    def test_potfilesorter_script_exists(self):
+        """potfilesorter script exists."""
+        assert (REPO_ROOT / "potfilesorter").exists(), "potfilesorter script missing"