gitwebhooks 2.4.0__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.0'
+__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__.py

@@ -7,6 +7,22 @@ from gitwebhooks.cli.config import cmd_init, cmd_view
 from gitwebhooks.cli.help import cmd_help
 from gitwebhooks.cli.serve import cmd_serve
 
+# Top-level subparsers keyed by name, so the `help` subcommand can render
+# exactly the same text argparse prints for `<subcommand> --help`.
+_SUBPARSERS = {}
+
+
+def get_subparser(topic):
+    """Get a registered top-level subparser by name.
+
+    Args:
+        topic: Subcommand name ('serve' or 'config')
+
+    Returns:
+        The ArgumentParser for that subcommand, or None if unknown
+    """
+    return _SUBPARSERS.get(topic)
+
 
 def register_subparsers(subparsers):
     """Register all CLI subparsers
@@ -38,9 +54,9 @@ def register_serve_subparser(subparsers):
     """
     serve_parser = subparsers.add_parser(
         'serve',
-        add_help=False,
         help='Start webhook server or manage systemd service'
     )
+    _SUBPARSERS['serve'] = serve_parser
     serve_parser.add_argument(
         '-c', '--config',
         dest='config',
@@ -49,7 +65,10 @@ def register_serve_subparser(subparsers):
     serve_subparsers = serve_parser.add_subparsers(dest='serve_action')
 
     # install action
-    install_parser = serve_subparsers.add_parser('install', add_help=False)
+    install_parser = serve_subparsers.add_parser(
+        'install',
+        help='Install systemd service'
+    )
     install_parser.add_argument(
         '--force',
         action='store_true',
@@ -74,7 +93,10 @@ def register_serve_subparser(subparsers):
     install_parser.set_defaults(func=cmd_serve)
 
     # uninstall action
-    uninstall_parser = serve_subparsers.add_parser('uninstall', add_help=False)
+    uninstall_parser = serve_subparsers.add_parser(
+        'uninstall',
+        help='Uninstall systemd service'
+    )
     uninstall_parser.add_argument(
         '--purge',
         action='store_true',
@@ -97,7 +119,7 @@ def register_help_subparser(subparsers):
     """
     help_parser = subparsers.add_parser(
         'help',
-        add_help=False
+        help='Show help information'
     )
     help_parser.add_argument(
         'topic',
@@ -118,15 +140,14 @@ def register_config_subparser(subparsers):
     """
     config_parser = subparsers.add_parser(
         'config',
-        add_help=False,
         help='Manage gitwebhooks configuration'
     )
+    _SUBPARSERS['config'] = config_parser
     config_subparsers = config_parser.add_subparsers(dest='config_action')
 
     # init action
     init_parser = config_subparsers.add_parser(
         'init',
-        add_help=False,
         help='Initialize configuration file using interactive wizard'
     )
     init_parser.add_argument(
@@ -138,7 +159,10 @@ def register_config_subparser(subparsers):
     init_parser.set_defaults(func=cmd_init)
 
     # view action
-    view_parser = config_subparsers.add_parser('view', add_help=False)
+    view_parser = config_subparsers.add_parser(
+        'view',
+        help='View configuration file content'
+    )
     view_parser.add_argument(
         '-c',
         '--config',

gitwebhooks/cli/help.py

@@ -1,6 +1,10 @@
 """Help command module
 
 Provides help information display functionality for gitwebhooks-cli.
+
+All help output is generated by argparse from the parser definitions, so
+``<command> -h``/``--help`` and ``gitwebhooks-cli help <command>`` always
+show exactly the same text.
 """
 
 import argparse
@@ -17,7 +21,7 @@ def cmd_help(args: argparse.Namespace) -> int:
             - topic: Optional subcommand name to show help for
 
     Returns:
-        Exit code (0 = success)
+        Exit code (0 = success, 1 = unknown topic)
 
     Examples:
         >>> args = argparse.Namespace(topic=None)
@@ -29,16 +33,23 @@ def cmd_help(args: argparse.Namespace) -> int:
     """
     # Import here to avoid circular dependency
     from gitwebhooks.main import get_parser
+    from gitwebhooks.cli import get_subparser
 
     parser = get_parser()
+    topic = getattr(args, 'topic', None)
 
-    if hasattr(args, 'topic') and args.topic:
-        # Show subcommand help
-        show_subcommand_help(parser, args.topic)
-    else:
-        # Show main help
+    if not topic:
         show_main_help(parser)
+        return 0
+
+    if get_subparser(topic) is None:
+        print(f"Error: Unknown command '{topic}'", file=sys.stderr)
+        print("Available commands: serve, config", file=sys.stderr)
+        print()
+        print("Use 'gitwebhooks-cli help' to see main help", file=sys.stderr)
+        return 1
 
+    show_subcommand_help(parser, topic)
     return 0
 
 
@@ -51,105 +62,25 @@ def show_main_help(parser: argparse.ArgumentParser) -> None:
     Returns:
         None
     """
-    # Custom help output
-    help_text = """Git Webhooks Server - Automated deployment webhook handler
-
-Usage:
-  gitwebhooks-cli [-v] [-c CONFIG] <command> [<args>]
-
-Commands:
-  serve       Start webhook server or manage systemd service
-  config      Manage configuration file
-  help        Show help information
-
-Options:
-  -v, --version  Show version information
-  -c, --config   Path to configuration file (default: auto-discover)
-
-Examples:
-  gitwebhooks-cli serve                    # Start server
-  gitwebhooks-cli serve install            # Install systemd service
-  gitwebhooks-cli config init              # Initialize configuration
-  gitwebhooks-cli help serve               # Show serve command help
-
-For more information on a specific command:
-  gitwebhooks-cli help <command>
-"""
-    print(help_text)
+    print(parser.format_help(), end='')
 
 
 def show_subcommand_help(parser: argparse.ArgumentParser, topic: str) -> None:
     """Display help for a specific subcommand.
 
     Args:
-        parser: The main argument parser
+        parser: The main argument parser (unused, kept for call compatibility)
         topic: Subcommand name
 
     Returns:
         None
     """
-    # Map topic to help text
-    help_texts = {
-        'serve': """Command: serve
-Start webhook server or manage systemd service
-
-Usage:
-  gitwebhooks-cli serve [-c CONFIG]
-  gitwebhooks-cli serve install [--force] [--dry-run] [--verbose]
-  gitwebhooks-cli serve uninstall [--purge]
-
-Subcommands:
-  (none)        Start the webhook server
-  install       Install systemd service
-  uninstall     Uninstall systemd service
-
-Options:
-  -c, --config   Path to configuration file
-
-Install options:
-  --force        Force overwrite existing service
-  --dry-run      Preview mode, don't make changes
-  --verbose      Increase verbosity
-
-Uninstall options:
-  --purge        Also remove configuration file
-
-Examples:
-  gitwebhooks-cli serve                         # Start server
-  gitwebhooks-cli serve -c /etc/webhooks.ini    # Start with custom config
-  gitwebhooks-cli serve install                 # Install service
-  gitwebhooks-cli serve install --force         # Force overwrite
-  gitwebhooks-cli serve uninstall               # Uninstall service
-""",
-        'config': """Command: config
-Manage configuration file
-
-Usage:
-  gitwebhooks-cli config init [level]
-  gitwebhooks-cli config view [-c CONFIG]
-
-Subcommands:
-  init          Initialize configuration file
-  view          View configuration file
-
-Init arguments:
-  level         Configuration level (system, local, user)
-
-View options:
-  -c, --config  Path to configuration file
-
-Examples:
-  gitwebhooks-cli config init              # Interactive init
-  gitwebhooks-cli config init user         # User-level config
-  gitwebhooks-cli config init system       # System-level config (requires sudo)
-  gitwebhooks-cli config view              # View current config
-""",
-    }
-
-    if topic in help_texts:
-        print(help_texts[topic])
-    else:
+    # Import here to avoid circular dependency
+    from gitwebhooks.cli import get_subparser
+
+    subparser = get_subparser(topic)
+    if subparser is None:
         print(f"Error: Unknown command '{topic}'", file=sys.stderr)
-        print("Available commands: serve, config", file=sys.stderr)
-        print()
-        print("Use 'gitwebhooks-cli help' to see main help", file=sys.stderr)
+        return
+
+    print(subparser.format_help(), end='')

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]:
     """
     验证事件名称输入。
 
@@ -760,7 +766,7 @@ class Wizard:
         print("后续步骤:")
         print(f"  1. 检查配置文件内容: gitwebhooks-cli config view {path}")
         print(f"  2. 启动服务器: gitwebhooks-cli -c {path}")
-        print("  3. 或安装为服务: sudo gitwebhooks-cli service install")
+        print("  3. 或安装为服务: sudo gitwebhooks-cli serve install")
 
     def _cleanup(self) -> None:
         """

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 = {