gitwebhooks 2.4.1__py3-none-any.whl → 2.4.2__py3-none-any.whl

gitwebhooks/__init__.py

@@ -3,7 +3,7 @@
 Automated deployment server supporting GitHub, Gitee, GitLab, and custom webhooks.
 """
 
-__version__ = '2.4.1'
+__version__ = '2.4.2'
 
 # Export main classes for convenient import paths
 from .server import WebhookServer

gitwebhooks/auth/custom.py

@@ -34,6 +34,12 @@ class CustomTokenVerifier(SignatureVerifier):
         if not self.verify_enabled:
             return SignatureVerificationResult.success()
 
+        # An empty secret means verification is not actually configured.
+        # Without this guard an empty token would match and let an
+        # unauthenticated request through (which would run the deploy command).
+        if not secret:
+            return SignatureVerificationResult.failure('Secret not configured')
+
         if signature == secret:
             return SignatureVerificationResult.success()
         else:

gitwebhooks/auth/factory.py

@@ -4,12 +4,10 @@ Creates corresponding verifier instances based on provider type.
 """
 
 from gitwebhooks.models.provider import Provider
-from gitwebhooks.auth.verifier import SignatureVerifier
 from gitwebhooks.auth.github import GithubSignatureVerifier
 from gitwebhooks.auth.gitee import GiteeSignatureVerifier
 from gitwebhooks.auth.gitlab import GitlabTokenVerifier
 from gitwebhooks.auth.custom import CustomTokenVerifier
-from gitwebhooks.utils.exceptions import UnsupportedProviderError
 
 
 class VerifierFactory:
@@ -25,29 +23,6 @@ class VerifierFactory:
         Provider.CUSTOM: None,  # Custom verifier created dynamically
     }
 
-    @classmethod
-    def get_verifier(cls, provider: Provider,
-                    verify_enabled: bool = True) -> SignatureVerifier:
-        """Get verifier for the specified provider
-
-        Args:
-            provider: Provider type
-            verify_enabled: Whether verification is enabled (CUSTOM only)
-
-        Returns:
-            SignatureVerifier instance
-
-        Raises:
-            UnsupportedProviderError: Unsupported provider
-        """
-        if provider == Provider.CUSTOM:
-            return CustomTokenVerifier(verify_enabled=verify_enabled)
-
-        verifier = cls._verifiers.get(provider)
-        if verifier is None:
-            raise UnsupportedProviderError(f'No verifier for provider: {provider}')
-        return verifier
-
     @classmethod
     def create_github_verifier(cls) -> GithubSignatureVerifier:
         """Create GitHub verifier (convenience method)"""

gitwebhooks/auth/gitee.py

@@ -51,6 +51,12 @@ class GiteeSignatureVerifier(SignatureVerifier):
         if signature is None:
             return SignatureVerificationResult.failure('Missing signature or password')
 
+        # An empty secret means verification is not actually configured.
+        # Without this guard an empty token would match and let an
+        # unauthenticated request through (which would run the deploy command).
+        if not secret:
+            return SignatureVerificationResult.failure('Secret not configured')
+
         # Step 1: Try password validation first (direct comparison)
         if hmac.compare_digest(signature, secret):
             return SignatureVerificationResult.success()

gitwebhooks/auth/gitlab.py

@@ -23,6 +23,12 @@ class GitlabTokenVerifier(SignatureVerifier):
         Returns:
             SignatureVerificationResult instance
         """
+        # An empty secret means verification is not actually configured.
+        # Without this guard an empty token would match and let an
+        # unauthenticated request through (which would run the deploy command).
+        if not secret:
+            return SignatureVerificationResult.failure('Secret not configured')
+
         if signature == secret:
             return SignatureVerificationResult.success()
         else:

gitwebhooks/cli/init_wizard.py

@@ -16,7 +16,7 @@ Validation Functions:
 - _get_platform_default_event: Returns platform-specific default event
 
 TECHNICAL DEBT:
-This module (768 lines) exceeds the Constitution's recommended 400 line limit.
+This module (785 lines) exceeds the Constitution's recommended 400 line limit.
 This is acceptable because the module contains the complete interactive wizard
 logic including platform selection, repository configuration, event configuration,
 and file generation.
@@ -30,9 +30,15 @@ Refactoring Plan (future task):
 import os
 import re
 from dataclasses import dataclass
-from typing import Optional, List, Dict
+from typing import Dict, Optional, Tuple
 import configparser
 
+from gitwebhooks.utils.constants import (
+    CONFIG_PATH_LOCAL,
+    CONFIG_PATH_SYSTEM,
+    CONFIG_PATH_USER,
+)
+
 
 # =============================================================================
 # Module Constants
@@ -40,15 +46,15 @@ import configparser
 
 CONFIG_LEVELS = {
     'system': {
-        'path': '/etc/gitwebhooks.ini',
+        'path': CONFIG_PATH_SYSTEM,
         'requires_root': True
     },
     'local': {
-        'path': '/usr/local/etc/gitwebhooks.ini',
+        'path': CONFIG_PATH_LOCAL,
         'requires_root': True
     },
     'user': {
-        'path': '~/.gitwebhooks.ini',
+        'path': CONFIG_PATH_USER,
         'requires_root': False
     }
 }
@@ -201,7 +207,7 @@ def validate_port(value: str) -> bool:
         return False
 
 
-def validate_event_input(value: str) -> tuple[bool, str]:
+def validate_event_input(value: str) -> Tuple[bool, str]:
     """
     验证事件名称输入。
 

gitwebhooks/cli/prompts.py

@@ -4,143 +4,19 @@ Provides functions for interactive user input and validation.
 """
 
 import sys
-from typing import Any, Callable, Optional, Dict, List, Tuple
 
-from gitwebhooks.utils.constants import ConfigLevel
+from gitwebhooks.utils.constants import (
+    CONFIG_PATH_LOCAL,
+    CONFIG_PATH_SYSTEM,
+    CONFIG_PATH_USER,
+    ConfigLevel,
+)
 
 
 # Question template for configuration initialization
-QUESTIONS = [
-    # Server configuration
-    {
-        'key': 'server_address',
-        'prompt': 'Server listen address [default: 0.0.0.0]: ',
-        'default': '0.0.0.0',
-        'validator': None,
-        'required': True
-    },
-    {
-        'key': 'server_port',
-        'prompt': 'Server port [default: 6789]: ',
-        'default': '6789',
-        'validator': 'validate_port',
-        'required': True
-    },
-    {
-        'key': 'log_file',
-        'prompt': 'Log file path [default: ~/.gitwebhook.log]: ',
-        'default': '~/.gitwebhook.log',
-        'validator': None,
-        'required': False
-    },
-]
 
 
 # Platform-specific questions
-PLATFORM_QUESTIONS = {
-    'github': [
-        {
-            'section': 'github',
-            'key': 'verify',
-            'prompt': '  Enable signature verification? (Y/n) [default: Y]: ',
-            'default': 'true',
-            'validator': None,
-            'required': False
-        },
-        {
-            'section': 'github',
-            'key': 'secret',
-            'prompt': '  Webhook secret (leave empty to skip): ',
-            'default': '',
-            'validator': None,
-            'required': False
-        },
-    ],
-    'gitee': [
-        {
-            'section': 'gitee',
-            'key': 'verify',
-            'prompt': '  Enable signature verification? (Y/n) [default: Y]: ',
-            'default': 'true',
-            'validator': None,
-            'required': False
-        },
-        {
-            'section': 'gitee',
-            'key': 'secret',
-            'prompt': '  Webhook secret (leave empty to skip): ',
-            'default': '',
-            'validator': None,
-            'required': False
-        },
-    ],
-    'gitlab': [
-        {
-            'section': 'gitlab',
-            'key': 'verify',
-            'prompt': '  Enable token verification? (Y/n) [default: Y]: ',
-            'default': 'true',
-            'validator': None,
-            'required': False
-        },
-        {
-            'section': 'gitlab',
-            'key': 'secret',
-            'prompt': '  Webhook token (leave empty to skip): ',
-            'default': '',
-            'validator': None,
-            'required': False
-        },
-    ],
-}
-
-
-def ask_question(prompt: str,
-                 validator: Optional[Callable[[str], Any]] = None,
-                 default: Optional[Any] = None,
-                 required: bool = True) -> Any:
-    """Ask a question with optional validation and default value
-
-    Args:
-        prompt: Question prompt to display
-        validator: Optional validation function that raises ValueError on invalid input
-        default: Optional default value if user provides empty input
-        required: Whether a value is required (defaults to True)
-
-    Returns:
-        Validated user input or default value
-
-    Raises:
-        KeyboardInterrupt: If user confirms exit on Ctrl+C
-    """
-    while True:
-        try:
-            response = input(prompt).strip()
-
-            # Use default if empty input provided
-            if not response and default is not None:
-                return default
-
-            # Validate if validator provided
-            if validator:
-                if isinstance(validator, str):
-                    # Validator is a string name, look up function
-                    validator_func = globals().get(validator)
-                    if validator_func:
-                        return validator_func(response)
-                else:
-                    return validator(response)
-
-            return response
-
-        except KeyboardInterrupt:
-            # Ask for confirmation before exiting
-            if ask_yes_no('Confirm exit? Unsaved changes will be lost (y/N) ', default=False):
-                print('Configuration cancelled')
-                sys.exit(0)
-        except ValueError as e:
-            print(f'Invalid input: {e}')
-            print('Please try again')
 
 
 def ask_yes_no(prompt: str, default: bool = False) -> bool:
@@ -205,78 +81,6 @@ def validate_port(value: str) -> int:
         raise ValueError('Port must be a number')
 
 
-def validate_address(value: str) -> str:
-    """Validate server address
-
-    Args:
-        value: String input to validate
-
-    Returns:
-        Validated address string
-
-    Raises:
-        ValueError: If address is empty
-    """
-    if not value:
-        raise ValueError('Server address cannot be empty')
-    return value
-
-
-def validate_path(value: str) -> str:
-    """Validate file path
-
-    Args:
-        value: String input to validate
-
-    Returns:
-        Validated path string
-
-    Raises:
-        ValueError: If path is empty
-    """
-    if not value:
-        raise ValueError('Path cannot be empty')
-    return value
-
-
-def validate_bool(value: str) -> bool:
-    """Validate boolean input
-
-    Args:
-        value: String input to validate
-
-    Returns:
-        True or False
-
-    Raises:
-        ValueError: If input is not a boolean value
-    """
-    value_lower = value.lower()
-    if value_lower in ('y', 'yes', 'true', '1'):
-        return True
-    elif value_lower in ('n', 'no', 'false', '0'):
-        return False
-    else:
-        raise ValueError('Please enter yes/no or y/n')
-
-
-def validate_text(value: str) -> str:
-    """Validate text input (non-empty)
-
-    Args:
-        value: String input to validate
-
-    Returns:
-        Validated text string
-
-    Raises:
-        ValueError: If text is empty
-    """
-    if not value:
-        raise ValueError('Input cannot be empty')
-    return value
-
-
 def ask_config_level() -> ConfigLevel:
     """Ask user to select configuration file level
 
@@ -290,9 +94,9 @@ def ask_config_level() -> ConfigLevel:
         KeyboardInterrupt: If user confirms exit on Ctrl+C
     """
     print('Select configuration file level for the service:')
-    print('  1. User level (~/.gitwebhooks.ini) - Single user, highest priority')
-    print('  2. Local level (/usr/local/etc/gitwebhooks.ini) - Local system, medium priority')
-    print('  3. System level (/etc/gitwebhooks.ini) - Global system, lowest priority')
+    print(f'  1. User level ({CONFIG_PATH_USER}) - Single user, highest priority')
+    print(f'  2. Local level ({CONFIG_PATH_LOCAL}) - Local system, medium priority')
+    print(f'  3. System level ({CONFIG_PATH_SYSTEM}) - Global system, lowest priority')
     print()
 
     choice_map = {

gitwebhooks/cli/serve.py

@@ -6,7 +6,6 @@ Provides server startup and systemd service management functionality.
 import argparse
 import sys
 from pathlib import Path
-from typing import Optional
 
 from gitwebhooks.server import WebhookServer
 from gitwebhooks.utils.exceptions import ConfigurationError
@@ -72,6 +71,10 @@ def start_server(args: argparse.Namespace) -> int:
     # Get config path from args
     config_file = getattr(args, 'config', None)
 
+    # Import here to avoid circular dependency (see gitwebhooks/cli/help.py).
+    # These live in gitwebhooks.main - do not re-implement them here.
+    from gitwebhooks.main import find_config_file, format_config_error
+
     # Print version
     print(f'gitwebhooks-cli {__version__}')
 
@@ -112,41 +115,3 @@ def start_server(args: argparse.Namespace) -> int:
         print(f'Error: {e}', file=sys.stderr)
         return 1
 
-
-def find_config_file() -> Optional[str]:
-    """Find configuration file by priority order.
-
-    Searches for configuration files in the following order:
-    1. User level: ~/.gitwebhooks.ini
-    2. Local level: /usr/local/etc/gitwebhooks.ini
-    3. System level: /etc/gitwebhooks.ini
-
-    Returns:
-        Path string of the first existing configuration file, or None if not found.
-    """
-    for config_path in CONFIG_SEARCH_PATHS:
-        expanded_path = Path(config_path).expanduser().resolve()
-        if expanded_path.exists():
-            return str(expanded_path)
-    return None
-
-
-def format_config_error(searched_paths: list) -> str:
-    """Format user-friendly error message for missing configuration file.
-
-    Args:
-        searched_paths: List of paths that were searched.
-
-    Returns:
-        Formatted error message string.
-    """
-    lines = [
-        'Error: Configuration file not found.',
-        'Searched paths:'
-    ]
-    for i, path in enumerate(searched_paths, 1):
-        lines.append(f'  {i}. {path}')
-    lines.append('')
-    lines.append('You can create a configuration file using:')
-    lines.append('  gitwebhooks-cli config init')
-    return '\n'.join(lines)

gitwebhooks/cli/service.py

@@ -9,21 +9,23 @@ from pathlib import Path
 from typing import Optional
 
 from gitwebhooks.utils.systemd import (
-    check_systemd,
     check_root_permission,
     generate_service_file,
     get_service_path,
     detect_installation_type,
     InstallationType,
 )
-from gitwebhooks.utils.constants import ConfigLevel
+from gitwebhooks.utils.constants import (
+    CONFIG_PATH_LOCAL,
+    CONFIG_PATH_SYSTEM,
+    CONFIG_PATH_USER,
+    ConfigLevel,
+)
 from gitwebhooks.cli.prompts import ask_yes_no, ask_config_level
 
 
 # Error codes
 E_PERM = 1
-E_SYSTEMD = 1
-E_EXISTS = 1
 
 
 def install_service(
@@ -88,11 +90,11 @@ def install_service(
         config_path = config_path_override
         # Map path to config level for display purposes
         expanded_path = Path(config_path).expanduser()
-        if str(expanded_path) == str(Path('~/.gitwebhooks.ini').expanduser()):
+        if str(expanded_path) == str(Path(CONFIG_PATH_USER).expanduser()):
             config_level = ConfigLevel.USER
-        elif str(expanded_path) == '/usr/local/etc/gitwebhooks.ini':
+        elif str(expanded_path) == CONFIG_PATH_LOCAL:
             config_level = ConfigLevel.LOCAL
-        elif str(expanded_path) == '/etc/gitwebhooks.ini':
+        elif str(expanded_path) == CONFIG_PATH_SYSTEM:
             config_level = ConfigLevel.SYSTEM
         else:
             # Custom path, default to USER for display
@@ -179,15 +181,6 @@ def check_service_exists() -> bool:
     return get_service_path().exists()
 
 
-def confirm_overwrite() -> bool:
-    """Ask user to confirm overwrite
-
-    Returns:
-        True if user confirms, False otherwise
-    """
-    return ask_yes_no('Service already exists, overwrite? (y/N) ', default=False)
-
-
 def enable_and_start_service() -> int:
     """Enable and start the service
 
@@ -338,7 +331,10 @@ def handle_config_cleanup(purge: bool) -> None:
     Returns:
         None
     """
-    config_path = Path('~/.gitwebhook.ini').expanduser()
+    # Single source of truth for the user-level config path (see constants.py).
+    # A hardcoded '~/.gitwebhook.ini' (missing "s") used to make
+    # `serve uninstall --purge` delete the wrong file - or nothing at all.
+    config_path = Path(CONFIG_PATH_USER).expanduser()
 
     if not purge:
         return

gitwebhooks/config/loader.py

@@ -9,6 +9,7 @@ from typing import Dict, Optional
 
 from gitwebhooks.config.models import ProviderConfig, RepositoryConfig
 from gitwebhooks.models.provider import Provider
+from gitwebhooks.utils.constants import RESERVED_SECTIONS
 from gitwebhooks.utils.exceptions import ConfigurationError
 
 
@@ -122,7 +123,7 @@ class ConfigLoader:
         Returns:
             Set of reserved section names
         """
-        return {'server', 'ssl', 'github', 'gitee', 'gitlab', 'custom'}
+        return RESERVED_SECTIONS
 
     def get_server_config(self) -> Dict[str, any]:
         """Get server configuration
@@ -133,9 +134,16 @@ class ConfigLoader:
             - port: Listen port
             - log_file: Log file path
         """
+        try:
+            port = self.parser.getint('server', 'port', fallback=6789)
+        except ValueError as e:
+            raise ConfigurationError(
+                f"Invalid [server] port: {self.parser.get('server', 'port')!r} is not an integer"
+            ) from e
+
         return {
             'address': self.parser.get('server', 'address', fallback='0.0.0.0'),
-            'port': self.parser.getint('server', 'port', fallback=6789),
+            'port': port,
             'log_file': self.parser.get('server', 'log_file', fallback='').strip(),
         }
 
@@ -150,16 +158,26 @@ class ConfigLoader:
             - cert_file: SSL certificate file path
         """
         try:
-            if not self.parser.getboolean('ssl', 'enable'):
-                return None
-        except (configparser.NoSectionError, ValueError):
+            ssl_enabled = self.parser.getboolean('ssl', 'enable')
+        except configparser.NoSectionError:
             return None
+        except ValueError as e:
+            raise ConfigurationError(
+                f"Invalid [ssl] enable: {self.parser.get('ssl', 'enable')!r} is not a boolean"
+            ) from e
 
-        return {
-            'enable': True,
-            'key_file': self.parser.get('ssl', 'key_file'),
-            'cert_file': self.parser.get('ssl', 'cert_file'),
-        }
+        if not ssl_enabled:
+            return None
+
+        ssl_config = {'enable': True}
+        for option in ('key_file', 'cert_file'):
+            value = self.parser.get('ssl', option, fallback='').strip()
+            if not value:
+                raise ConfigurationError(
+                    f"SSL is enabled but '{option}' is missing in the [ssl] section"
+                )
+            ssl_config[option] = value
+        return ssl_config
 
     def validate_repository_configs(self) -> None:
         """Validate all repository configurations

gitwebhooks/config/models.py

@@ -5,7 +5,6 @@ Defines configuration-related dataclasses.
 
 import configparser
 from dataclasses import dataclass
-from pathlib import Path
 from typing import List
 
 from gitwebhooks.models.provider import Provider

gitwebhooks/config/registry.py

@@ -64,41 +64,3 @@ class ConfigurationRegistry:
         if self._repository_configs is None:
             raise ConfigurationError('Repository configs not loaded')
         return self._repository_configs
-
-    def get_provider_config(self, provider: Provider) -> ProviderConfig:
-        """Get configuration for specified provider
-
-        Args:
-            provider: Provider type
-
-        Returns:
-            ProviderConfig instance
-        """
-        return self.provider_configs.get(provider, ProviderConfig(
-            provider=provider,
-            verify=False,
-            secret='',
-            handle_events=[]
-        ))
-
-    def get_repository_config(self, name: str) -> RepositoryConfig:
-        """Get configuration for specified repository
-
-        Args:
-            name: Repository name
-
-        Returns:
-            RepositoryConfig instance, or None if not found
-        """
-        return self.repository_configs.get(name)
-
-    def has_repository(self, name: str) -> bool:
-        """Check if repository exists
-
-        Args:
-            name: Repository name
-
-        Returns:
-            True if exists, False otherwise
-        """
-        return name in self.repository_configs

gitwebhooks/config/server.py

@@ -6,7 +6,7 @@ Defines server-related configuration dataclasses.
 import os
 from dataclasses import dataclass
 from pathlib import Path
-from typing import Dict, Optional
+from typing import Optional
 
 from gitwebhooks.utils.exceptions import ConfigurationError
 

gitwebhooks/handlers/base.py

@@ -6,7 +6,6 @@ Defines the abstract interface for webhook handlers.
 from abc import ABC, abstractmethod
 from typing import Optional
 
-from gitwebhooks.models.provider import Provider
 from gitwebhooks.models.request import WebhookRequest
 from gitwebhooks.models.result import SignatureVerificationResult
 from gitwebhooks.config.models import ProviderConfig
@@ -19,15 +18,6 @@ class WebhookHandler(ABC):
     All platform-specific handlers must inherit from this class and implement all abstract methods.
     """
 
-    @abstractmethod
-    def get_provider(self) -> Provider:
-        """Return the provider type supported by this handler
-
-        Returns:
-            Provider enum value
-        """
-        pass
-
     @abstractmethod
     def verify_signature(self, request: WebhookRequest,
                         config: ProviderConfig) -> SignatureVerificationResult: