gitwebhooks 2.1.1__tar.gz → 2.1.3__tar.gz

{gitwebhooks-2.1.1 → gitwebhooks-2.1.3}/CLAUDE.md

@@ -290,6 +290,8 @@ git-webhooks-server/
 - INI 配置文件生成（读写） (001-config-init-wizard)
 - Python 3.7+ + Python 标准库（sys, shutil, os, pathlib, argparse） (001-install-method-guidance)
 - INI 配置文件，systemd 服务单元文件 (001-install-method-guidance)
+- Python 3.7+ (项目要求) + Python 标准库仅（无外部依赖） (001-fix-config-init-bug)
+- INI 配置文件 (configparser) (001-fix-config-init-bug)
 
 ## Recent Changes
 - 001-config-init-wizard: 添加 `config init` 交互式向导，支持配置级别选择、平台配置和仓库配置

{gitwebhooks-2.1.1 → gitwebhooks-2.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitwebhooks
-Version: 2.1.1
+Version: 2.1.3
 Summary: A lightweight Git webhook server for automated deployment supporting GitHub, Gitee, GitLab, and custom webhooks
 Author-email: Troy Tse <troy@holyhi.net>
 Maintainer-email: Troy Tse <troy@holyhi.net>
@@ -489,6 +489,30 @@ python3 -m pytest tests/
 python3 -m unittest discover tests/
 ```
 
+### Releasing to PyPI
+
+**IMPORTANT**: Before releasing to PyPI, you MUST run the pre-release validation script:
+
+```bash
+./scripts/pre-release-check.sh
+```
+
+This script validates:
+- Package builds successfully
+- CLI entry point works (`gitwebhooks-cli`)
+- All subcommands work (`service`, `config`)
+- Module imports work correctly
+
+Only after all checks pass, proceed with publishing:
+
+```bash
+# Build the package
+python3 -m build
+
+# Upload to PyPI
+python3 -m twine upload dist/*
+```
+
 ## License
 
 MIT License

{gitwebhooks-2.1.1 → gitwebhooks-2.1.3}/README.md

@@ -449,6 +449,30 @@ python3 -m pytest tests/
 python3 -m unittest discover tests/
 ```
 
+### Releasing to PyPI
+
+**IMPORTANT**: Before releasing to PyPI, you MUST run the pre-release validation script:
+
+```bash
+./scripts/pre-release-check.sh
+```
+
+This script validates:
+- Package builds successfully
+- CLI entry point works (`gitwebhooks-cli`)
+- All subcommands work (`service`, `config`)
+- Module imports work correctly
+
+Only after all checks pass, proceed with publishing:
+
+```bash
+# Build the package
+python3 -m build
+
+# Upload to PyPI
+python3 -m twine upload dist/*
+```
+
 ## License
 
 MIT License

{gitwebhooks-2.1.1 → gitwebhooks-2.1.3}/README.zh.md

@@ -449,6 +449,30 @@ python3 -m pytest tests/
 python3 -m unittest discover tests/
 ```
 
+### 发布到 PyPI
+
+**重要提示**：发布到 PyPI 前，必须运行发布前验证脚本：
+
+```bash
+./scripts/pre-release-check.sh
+```
+
+此脚本会验证：
+- 包能成功构建
+- CLI 入口点正常工作（`gitwebhooks-cli`）
+- 所有子命令正常工作（`service`、`config`）
+- 模块导入正常工作
+
+只有在所有检查通过后，才能进行发布：
+
+```bash
+# 构建包
+python3 -m build
+
+# 上传到 PyPI
+python3 -m twine upload dist/*
+```
+
 ## 许可证
 
 MIT License

{gitwebhooks-2.1.1 → gitwebhooks-2.1.3}/gitwebhooks/cli/init_wizard.py

@@ -3,6 +3,28 @@ Interactive configuration initialization wizard.
 
 This module provides a user-friendly wizard for creating git-webhooks-server
 configuration files through an interactive command-line interface.
+
+Features:
+- Support for GitHub, Gitee, GitLab, and custom webhook platforms
+- Automatic validation of repository names (supports dots, hyphens, underscores)
+- Direct text input for event names with platform-specific defaults
+- Secure file generation with proper permissions (0600)
+
+Validation Functions:
+- validate_repo_name: Validates repository name format
+- validate_event_input: Validates event name input (rejects newlines and digits)
+- _get_platform_default_event: Returns platform-specific default event
+
+TECHNICAL DEBT:
+This module (768 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.
+
+Refactoring Plan (future task):
+- Extract validation functions to gitwebhooks/cli/wizard_validators.py
+- Consider splitting Wizard class into smaller focused classes
+- Evaluate separating platform-specific logic into dedicated handlers
 """
 
 import os
@@ -51,6 +73,19 @@ PLATFORMS = {
     }
 }
 
+# 平台默认事件值
+# 每个平台使用不同的默认事件格式：
+# - GitHub: 'push' (小写单数)
+# - Gitee: 'Push Hook' (大写带空格)
+# - GitLab: 'Push Hooks' (大写空格复数)
+# - Custom: 'webhook' (通用自定义事件)
+PLATFORM_DEFAULT_EVENTS = {
+    'github': 'push',
+    'gitee': 'Push Hook',
+    'gitlab': 'Push Hooks',
+    'custom': 'webhook',
+}
+
 
 # =============================================================================
 # Data Classes
@@ -76,7 +111,7 @@ class ServerConfig:
 class PlatformConfig:
     """Platform configuration parameters."""
     platform: str
-    handle_events: List[str]
+    handle_events: str  # Changed from List[str] to str - comma-separated event names
     verify: bool
     secret: Optional[str] = None
     custom_params: Optional[Dict[str, str]] = None
@@ -96,19 +131,31 @@ class RepositoryConfig:
 
 def validate_repo_name(value: str) -> bool:
     """
-    Validate repository name format.
+    验证仓库名称格式。
+
+    支持的格式：
+    - Two-level: owner/repo (GitHub/Gitee)
+    - Multi-level: group/subgroup/project (GitLab)
+    - 特殊字符: 支持点号、连字符、下划线
+
+    有效示例：
+    - owner/repo
+    - my-org/my-repo
+    - user.repo/project
+    - group/sub_group/project.name
 
-    Supports:
-    - Two-level format: owner/repo (GitHub/Gitee)
-    - Multi-level format: group/subgroup/project (GitLab)
+    无效示例：
+    - owner repo (包含空格)
+    - owner/repo/ (尾部斜杠)
+    - owner@org/repo (包含不支持的字符)
 
     Args:
-        value: Repository name string
+        value: 仓库名称字符串
 
     Returns:
         True if valid, False otherwise
     """
-    return bool(re.match(r'^[^/]+(/[^/]+)+$', value))
+    return bool(re.match(r'^[\w.-]+(/[\w.-]+)*$', value))
 
 
 def validate_existing_path(value: str) -> bool:
@@ -154,6 +201,50 @@ def validate_port(value: str) -> bool:
         return False
 
 
+def validate_event_input(value: str) -> tuple[bool, str]:
+    """
+    验证事件名称输入。
+
+    验证规则：
+    1. 不能为空字符串
+    2. 不能包含换行符（会破坏 INI 文件格式）
+    3. 不能包含数字（拒绝旧的数字选择格式）
+
+    Args:
+        value: 用户输入的事件名称
+
+    Returns:
+        (is_valid, error_message) - 验证结果和错误消息（如果验证失败）
+    """
+    # 空输入检查（由调用方处理默认值，这里只做非空检查）
+    if not value or not value.strip():
+        return False, "事件名称不能为空"
+
+    # 换行符检查
+    if '\n' in value or '\r' in value:
+        return False, "事件名称不能包含换行符"
+
+    # 数字检查：去除逗号和空格后检查是否包含数字
+    cleaned = value.replace(',', '').replace(' ', '')
+    if any(c.isdigit() for c in cleaned):
+        return False, "请直接输入事件名称，不支持数字选择"
+
+    return True, ""
+
+
+def _get_platform_default_event(platform: str) -> str:
+    """
+    获取平台默认事件值。
+
+    Args:
+        platform: 平台名称 (github/gitee/gitlab/custom)
+
+    Returns:
+        默认事件字符串，如果平台未找到则返回 'webhook'
+    """
+    return PLATFORM_DEFAULT_EVENTS.get(platform.lower(), 'webhook')
+
+
 # =============================================================================
 # INI Generation Functions
 # =============================================================================
@@ -186,7 +277,7 @@ def _generate_config(
     # Platform section
     platform_section = platform.platform
     platform_config = {
-        'handle_events': ', '.join(platform.handle_events),
+        'handle_events': platform.handle_events,  # Direct string value
         'verify': 'true' if platform.verify else 'false'
     }
 
@@ -202,7 +293,7 @@ def _generate_config(
     config[platform_section] = platform_config
 
     # Repository section
-    repo_section = f'repo/{repo.name}'
+    repo_section = repo.name
     config[repo_section] = {
         'cwd': repo.cwd,
         'cmd': repo.cmd
@@ -489,51 +580,38 @@ class Wizard:
             custom_params=custom_params
         )
 
-    def _collect_events(self, platform: str) -> List[str]:
+    def _collect_events(self, platform: str) -> str:
         """
-        Collect webhook events to handle.
+        收集平台要处理的事件名称。
+
+        改为直接文本输入方式，支持逗号分隔多个事件。
+        空输入时使用平台默认值。
 
         Args:
-            platform: Platform name
+            platform: Platform name (github/gitee/gitlab/custom)
 
         Returns:
-            List of event names
+            逗号分隔的事件名称字符串
         """
-        platform_info = PLATFORMS[platform]
-
-        if platform == 'custom':
-            # Custom platform: ask for event name
-            print("自定义平台事件处理")
-            print("输入要处理的事件名称（直接回车跳过）:")
-            events_str = input().strip()
-            return [e.strip() for e in events_str.split(',') if e.strip()] if events_str else ['webhook']
-
-        # Standard platforms: show event list
-        events = platform_info['events']
-        print("选择要处理的 webhook 事件（多个用逗号分隔，直接回车默认选 1）:")
-        for idx, event in enumerate(events, 1):
-            print(f"  {idx}. {event}")
+        default_event = _get_platform_default_event(platform)
+        prompt = f"输入要处理的事件名称（多个用逗号分隔，直接回车默认: {default_event}）: "
 
         while True:
-            try:
-                choice = input("输入选择: ").strip()
-                if not choice:
-                    # Default to first event (push)
-                    return [events[0]]
+            value = input(prompt).strip()
 
-                # Parse comma-separated indices
-                indices = [int(x.strip()) - 1 for x in choice.split(',')]
+            # 空输入使用默认值
+            if not value:
+                return default_event
 
-                # Validate indices
-                if all(0 <= i < len(events) for i in indices):
-                    return [events[i] for i in indices]
-                else:
-                    print(f"无效选择，请输入 1-{len(events)} 之间的数字，多个用逗号分隔")
+            # 验证输入
+            is_valid, error_msg = validate_event_input(value)
+            if not is_valid:
+                print(f"错误: {error_msg}")
+                continue
 
-            except ValueError:
-                print("请输入有效的数字，多个用逗号分隔")
-            except KeyboardInterrupt:
-                raise
+            # 去除逗号前后的空格
+            cleaned = ','.join(part.strip() for part in value.split(','))
+            return cleaned
 
     def _collect_custom_params(self) -> Dict[str, str]:
         """
@@ -585,7 +663,7 @@ class Wizard:
             repo_name = input("输入仓库名称 (格式: owner/repo): ").strip()
             if validate_repo_name(repo_name):
                 break
-            print("仓库名称格式不正确，应为 owner/repo 格式")
+            print("仓库名称只能包含字母、数字、斜杠、点号、连字符和下划线")
 
         # Working directory
         while True:

{gitwebhooks-2.1.1 → gitwebhooks-2.1.3}/gitwebhooks.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitwebhooks
-Version: 2.1.1
+Version: 2.1.3
 Summary: A lightweight Git webhook server for automated deployment supporting GitHub, Gitee, GitLab, and custom webhooks
 Author-email: Troy Tse <troy@holyhi.net>
 Maintainer-email: Troy Tse <troy@holyhi.net>
@@ -489,6 +489,30 @@ python3 -m pytest tests/
 python3 -m unittest discover tests/
 ```
 
+### Releasing to PyPI
+
+**IMPORTANT**: Before releasing to PyPI, you MUST run the pre-release validation script:
+
+```bash
+./scripts/pre-release-check.sh
+```
+
+This script validates:
+- Package builds successfully
+- CLI entry point works (`gitwebhooks-cli`)
+- All subcommands work (`service`, `config`)
+- Module imports work correctly
+
+Only after all checks pass, proceed with publishing:
+
+```bash
+# Build the package
+python3 -m build
+
+# Upload to PyPI
+python3 -m twine upload dist/*
+```
+
 ## License
 
 MIT License

gitwebhooks-2.1.3/gitwebhooks.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+gitwebhooks-cli = gitwebhooks.main:main

{gitwebhooks-2.1.1 → gitwebhooks-2.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "gitwebhooks"
-version = "2.1.1"
+version = "2.1.3"
 description = "A lightweight Git webhook server for automated deployment supporting GitHub, Gitee, GitLab, and custom webhooks"
 readme = "README.md"
 license = "MIT"
@@ -64,7 +64,7 @@ Repository = "https://github.com/troytse/git-webhooks-server.git"
 Issues = "https://github.com/troytse/git-webhooks-server/issues"
 
 [project.scripts]
-gitwebhooks-cli = "gitwebhooks.cli:main"
+gitwebhooks-cli = "gitwebhooks.main:main"
 
 [tool.setuptools]
 package-dir = {"" = "."}

{gitwebhooks-2.1.1 → gitwebhooks-2.1.3}/tests/unit/cli/test_init_wizard.py

@@ -76,16 +76,20 @@ class TestInputValidation:
         assert validate_repo_name('org/team/sub-project') is True
         assert validate_repo_name('group/subgroup/project') is True
 
+        # Single-level format (now supported per spec)
+        assert validate_repo_name('owner') is True
+        assert validate_repo_name('myrepo') is True
+
     def test_validate_repo_name_invalid(self):
         """Test validate_repo_name rejects invalid formats."""
         from gitwebhooks.cli.init_wizard import validate_repo_name
 
-        assert validate_repo_name('owner') is False
         assert validate_repo_name('owner/') is False
         assert validate_repo_name('/repo') is False
         assert validate_repo_name('') is False
         assert validate_repo_name('https://github.com/owner/repo') is False
         assert validate_repo_name('owner//repo') is False
+        assert validate_repo_name('owner repo') is False  # spaces not allowed
 
     def test_validate_existing_path_valid(self):
         """Test validate_existing_path accepts existing directories."""
@@ -209,7 +213,7 @@ class TestINIGeneration:
         server = MagicMock()
         platform = PlatformConfig(
             platform='github',
-            handle_events=['push', 'release'],
+            handle_events='push,release',  # Changed from list to string
             verify=True,
             secret='test-secret',
             custom_params=None
@@ -219,7 +223,7 @@ class TestINIGeneration:
         config = _generate_config(server, platform, repo)
 
         assert config.has_section('github')
-        assert config.get('github', 'handle_events') == 'push, release'
+        assert config.get('github', 'handle_events') == 'push,release'  # No spaces
         assert config.get('github', 'verify') == 'true'
         assert config.get('github', 'secret') == 'test-secret'
 
@@ -237,9 +241,10 @@ class TestINIGeneration:
 
         config = _generate_config(server, platform, repo)
 
-        assert config.has_section('repo/owner/repo')
-        assert config.get('repo/owner/repo', 'cwd') == '/path/to/repo'
-        assert config.get('repo/owner/repo', 'cmd') == 'git pull && ./deploy.sh'
+        # Section name no longer has 'repo/' prefix
+        assert config.has_section('owner/repo')
+        assert config.get('owner/repo', 'cwd') == '/path/to/repo'
+        assert config.get('owner/repo', 'cmd') == 'git pull && ./deploy.sh'
 
     def test_generate_custom_platform_section(self):
         """Test generating [custom] section with custom parameters."""
@@ -248,7 +253,7 @@ class TestINIGeneration:
         server = MagicMock()
         platform = PlatformConfig(
             platform='custom',
-            handle_events=['push'],
+            handle_events='webhook',  # Changed from list to string
             verify=False,
             secret=None,
             custom_params={
@@ -291,12 +296,12 @@ class TestDataClasses:
 
         platform = PlatformConfig(
             platform='github',
-            handle_events=['push', 'release'],
+            handle_events='push,release',  # Changed from list to string
             verify=True,
             secret='my-secret'
         )
         assert platform.platform == 'github'
-        assert platform.handle_events == ['push', 'release']
+        assert platform.handle_events == 'push,release'
         assert platform.verify is True
         assert platform.secret == 'my-secret'
 

gitwebhooks-2.1.1/gitwebhooks.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-gitwebhooks-cli = gitwebhooks.cli:main