mcp-dbutils 0.13.0__tar.gz → 0.15.0__tar.gz

mcp_dbutils-0.15.0/.github/workflows/code-style.yml

@@ -0,0 +1,17 @@
+name: Code Style
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
+      - uses: astral-sh/ruff-action@v3.2.1
+        with:
+          version: latest

mcp_dbutils-0.15.0/.github/workflows/quality-assurance.yml

@@ -0,0 +1,266 @@
+name: Quality Assurance
+
+# 添加明确的权限声明
+permissions:
+  contents: read
+  pull-requests: write  # 允许创建PR评论
+  issues: write         # 允许创建issue评论
+  checks: write         # 允许更新检查状态
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  pytest:
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:15-alpine
+        env:
+          POSTGRES_PASSWORD: postgres
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python
+        run: uv python install
+
+      - name: Create and activate venv
+        run: |
+          uv venv
+          . .venv/bin/activate
+
+      - name: Install dependencies
+        run: uv pip install -e ".[test]"
+
+      - name: Run tests with coverage
+        id: tests
+        run: |
+          uv run pytest \
+            -v \
+            --cov=src/mcp_dbutils \
+            --cov-report=html \
+            --cov-report=term-missing \
+            --cov-report=json:coverage.json \
+            --cov-report=xml:coverage.xml \
+            tests/
+            
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: coverage.xml
+            
+      - name: Calculate coverage percentage
+        id: calc_coverage
+        run: |
+          COVERAGE=$(jq -r '.totals.percent_covered' coverage.json)
+          echo "Coverage: $COVERAGE"
+          echo "percentage=${COVERAGE%.*}" >> $GITHUB_OUTPUT
+          if (( $(echo "$COVERAGE >= 90" | bc -l) )); then
+            echo "color=green" >> $GITHUB_OUTPUT
+          elif (( $(echo "$COVERAGE >= 80" | bc -l) )); then
+            echo "color=yellow" >> $GITHUB_OUTPUT
+          else
+            echo "color=red" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Create Coverage Badge
+        uses: schneegans/dynamic-badges-action@v1.7.0
+        with:
+          auth: ${{ secrets.GIST_SECRET }}
+          gistID: bdd0a63ec2a816539ff8c136ceb41e48
+          filename: coverage.json
+          label: "coverage"
+          message: "${{ steps.calc_coverage.outputs.percentage }}%"
+          color: "${{ steps.calc_coverage.outputs.color }}"
+          namedLogo: python
+
+  sonarcloud:
+    name: SonarCloud
+    needs: pytest
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Download coverage report
+        uses: actions/download-artifact@v4
+        with:
+          name: coverage-report
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarqube-scan-action@v5.0.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+      
+      - name: SonarQube Quality Gate Check
+        uses: sonarsource/sonarqube-quality-gate-action@master
+        timeout-minutes: 5
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        with:
+          scanMetadataReportFile: .scannerwork/report-task.txt
+          
+      - name: SonarCloud PR Comment
+        if: github.event_name == 'pull_request'
+        uses: actions/github-script@v6
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_PROJECT_KEY: 'donghao1393_mcp-dbutils'
+        with:
+          script: |
+            const fs = require('fs');
+            
+            // 读取质量门禁结果
+            let qualityGateStatus = 'Unknown';
+            try {
+              const reportTaskContent = fs.readFileSync('.scannerwork/report-task.txt', 'utf8');
+              const ceTaskIdMatch = reportTaskContent.match(/ceTaskId=(.+)/);
+              if (ceTaskIdMatch && ceTaskIdMatch[1]) {
+                const ceTaskId = ceTaskIdMatch[1];
+                
+                // 等待分析完成
+                let analysisComplete = false;
+                let retries = 0;
+                while (!analysisComplete && retries < 10) {
+                  const ceTaskResponse = await fetch(
+                    `https://sonarcloud.io/api/ce/task?id=${ceTaskId}`,
+                    { headers: { Authorization: `Bearer ${process.env.SONAR_TOKEN}` } }
+                  ).then(res => res.json());
+                  
+                  if (ceTaskResponse.task && ceTaskResponse.task.status === 'SUCCESS') {
+                    analysisComplete = true;
+                  } else {
+                    retries++;
+                    await new Promise(resolve => setTimeout(resolve, 5000)); // 等待5秒
+                  }
+                }
+              }
+            } catch (error) {
+              console.error('Error reading report task file:', error);
+            }
+            
+            // 获取SonarCloud分析结果
+            const projectKey = process.env.SONAR_PROJECT_KEY;
+            const sonarResponse = await fetch(
+              `https://sonarcloud.io/api/measures/component?component=${projectKey}&metricKeys=bugs,vulnerabilities,code_smells,coverage,duplicated_lines_density`,
+              { headers: { Authorization: `Bearer ${process.env.SONAR_TOKEN}` } }
+            ).then(res => res.json());
+            
+            // 解析结果
+            let coverage = 'N/A';
+            let bugs = 'N/A';
+            let vulnerabilities = 'N/A';
+            let codeSmells = 'N/A';
+            let duplication = 'N/A';
+            
+            if (sonarResponse && sonarResponse.component && sonarResponse.component.measures) {
+              const measures = sonarResponse.component.measures;
+              
+              for (const measure of measures) {
+                switch (measure.metric) {
+                  case 'coverage':
+                    coverage = `${parseFloat(measure.value).toFixed(2)}%`;
+                    break;
+                  case 'bugs':
+                    bugs = measure.value;
+                    break;
+                  case 'vulnerabilities':
+                    vulnerabilities = measure.value;
+                    break;
+                  case 'code_smells':
+                    codeSmells = measure.value;
+                    break;
+                  case 'duplicated_lines_density':
+                    duplication = `${parseFloat(measure.value).toFixed(2)}%`;
+                    break;
+                }
+              }
+            }
+            
+            // 获取质量门禁状态
+            const qualityGateResponse = await fetch(
+              `https://sonarcloud.io/api/qualitygates/project_status?projectKey=${projectKey}`,
+              { headers: { Authorization: `Bearer ${process.env.SONAR_TOKEN}` } }
+            ).then(res => res.json());
+            
+            if (qualityGateResponse && qualityGateResponse.projectStatus) {
+              qualityGateStatus = qualityGateResponse.projectStatus.status === 'OK' ? '✅ Passed' : '❌ Failed';
+            }
+            
+            // 计算总问题数
+            const totalIssues = parseInt(bugs || 0) + parseInt(vulnerabilities || 0) + parseInt(codeSmells || 0);
+            
+            // 生成评论内容
+            let recommendations = [];
+            if (parseInt(bugs) > 0) recommendations.push('- Fix identified bugs to improve code reliability');
+            if (parseInt(vulnerabilities) > 0) recommendations.push('- Address security vulnerabilities to enhance application security');
+            if (parseInt(codeSmells) > 5) recommendations.push('- Refactor code to reduce code smells and improve maintainability');
+            if (parseFloat(coverage) < 80) recommendations.push('- Increase test coverage to meet the 80% minimum requirement');
+            if (parseFloat(duplication) > 3) recommendations.push('- Reduce code duplication to improve maintainability');
+            
+            const comment = [
+              '## SonarCloud Analysis Results',
+              '',
+              '### Summary',
+              `- **Quality Gate**: ${qualityGateStatus}`,
+              `- **Coverage**: ${coverage}`,
+              `- **Total Issues**: ${totalIssues}`,
+              `- **Code Duplication**: ${duplication}`,
+              '',
+              '### Details',
+              `- **Code Smells**: ${codeSmells}`,
+              `- **Bugs**: ${bugs}`,
+              `- **Security Vulnerabilities**: ${vulnerabilities}`,
+              '',
+              '### Recommendations',
+              ...recommendations,
+              '',
+              `[View full report on SonarCloud](https://sonarcloud.io/dashboard?id=${projectKey})`
+            ].join('\n');
+            
+            // 发布或更新PR评论
+            const { data: comments } = await github.rest.issues.listComments({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.issue.number,
+            });
+            
+            const botComment = comments.find(comment => 
+              comment.user.login === 'github-actions[bot]' && 
+              comment.body.includes('SonarCloud Analysis Results')
+            );
+            
+            if (botComment) {
+              await github.rest.issues.updateComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                comment_id: botComment.id,
+                body: comment,
+              });
+              console.log('Updated existing SonarCloud comment');
+            } else {
+              await github.rest.issues.createComment({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                issue_number: context.issue.number,
+                body: comment,
+              });
+              console.log('Created new SonarCloud comment');
+            }

mcp_dbutils-0.15.0/.pre-commit-config.yaml

@@ -0,0 +1,7 @@
+repos:
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.0
+    hooks:
+    -   id: ruff
+        args: [--fix]
+    -   id: ruff-format

{mcp_dbutils-0.13.0 → mcp_dbutils-0.15.0}/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [0.15.0](https://github.com/donghao1393/mcp-dbutils/compare/v0.14.0...v0.15.0) (2025-03-14)
+
+
+### Features
+
+* integrate Ruff code style automation ([#35](https://github.com/donghao1393/mcp-dbutils/issues/35)) ([6b2bdd7](https://github.com/donghao1393/mcp-dbutils/commit/6b2bdd749cecf2ad9167867c6e41149d1a57746f)), closes [#34](https://github.com/donghao1393/mcp-dbutils/issues/34)
+
+# [0.14.0](https://github.com/donghao1393/mcp-dbutils/compare/v0.13.0...v0.14.0) (2025-03-14)
+
+
+### Features
+
+* implement SonarCloud PR auto-comment system ([#33](https://github.com/donghao1393/mcp-dbutils/issues/33)) ([4e83211](https://github.com/donghao1393/mcp-dbutils/commit/4e83211c4c7a289a6b794cdc5e03caac301d173c)), closes [#32](https://github.com/donghao1393/mcp-dbutils/issues/32)
+
 # [0.13.0](https://github.com/donghao1393/mcp-dbutils/compare/v0.12.0...v0.13.0) (2025-03-14)
 
 

{mcp_dbutils-0.13.0 → mcp_dbutils-0.15.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mcp-dbutils
-Version: 0.13.0
+Version: 0.15.0
 Summary: MCP Database Utilities Service
 Author: Dong Hao
 License-Expression: MIT
@@ -14,10 +14,12 @@ Requires-Dist: pyyaml>=6.0.2
 Provides-Extra: test
 Requires-Dist: aiosqlite>=0.19.0; extra == 'test'
 Requires-Dist: docker>=7.0.0; extra == 'test'
+Requires-Dist: pre-commit>=3.6.0; extra == 'test'
 Requires-Dist: pytest-asyncio>=0.23.0; extra == 'test'
 Requires-Dist: pytest-cov>=4.1.0; extra == 'test'
 Requires-Dist: pytest-docker>=2.0.0; extra == 'test'
 Requires-Dist: pytest>=7.0.0; extra == 'test'
+Requires-Dist: ruff>=0.3.0; extra == 'test'
 Requires-Dist: testcontainers>=3.7.0; extra == 'test'
 Description-Content-Type: text/markdown
 
@@ -483,6 +485,19 @@ Our CI/CD pipeline automatically performs:
 
 Pull requests that don't meet these standards will be automatically blocked from merging.
 
+### Code Style
+We use Ruff for code style checking and formatting:
+
+[![Code Style](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+
+All code must follow our style guide:
+- Line length: 88 characters
+- Indentation: 4 spaces
+- Quotes: Double quotes
+- Naming: PEP8 conventions
+
+For detailed guidelines, see [STYLE_GUIDE.md](docs/STYLE_GUIDE.md).
+
 ### Local Development
 To check code quality locally:
 1. Run tests with coverage:
@@ -491,6 +506,26 @@ To check code quality locally:
    ```
 2. Use SonarLint in your IDE to catch issues early
 3. Review SonarCloud analysis results in PR comments
+4. Run Ruff for code style checking:
+   ```bash
+   # Install Ruff
+   uv pip install ruff
+   
+   # Check code style
+   ruff check .
+   
+   # Format code
+   ruff format .
+   ```
+5. Use pre-commit hooks for automatic checks:
+   ```bash
+   # Install pre-commit
+   uv pip install pre-commit
+   pre-commit install
+   
+   # Run all checks
+   pre-commit run --all-files
+   ```
 
 ## Contributing
 Contributions are welcome! Here's how you can help:

{mcp_dbutils-0.13.0 → mcp_dbutils-0.15.0}/README.md

@@ -460,6 +460,19 @@ Our CI/CD pipeline automatically performs:
 
 Pull requests that don't meet these standards will be automatically blocked from merging.
 
+### Code Style
+We use Ruff for code style checking and formatting:
+
+[![Code Style](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+
+All code must follow our style guide:
+- Line length: 88 characters
+- Indentation: 4 spaces
+- Quotes: Double quotes
+- Naming: PEP8 conventions
+
+For detailed guidelines, see [STYLE_GUIDE.md](docs/STYLE_GUIDE.md).
+
 ### Local Development
 To check code quality locally:
 1. Run tests with coverage:
@@ -468,6 +481,26 @@ To check code quality locally:
    ```
 2. Use SonarLint in your IDE to catch issues early
 3. Review SonarCloud analysis results in PR comments
+4. Run Ruff for code style checking:
+   ```bash
+   # Install Ruff
+   uv pip install ruff
+   
+   # Check code style
+   ruff check .
+   
+   # Format code
+   ruff format .
+   ```
+5. Use pre-commit hooks for automatic checks:
+   ```bash
+   # Install pre-commit
+   uv pip install pre-commit
+   pre-commit install
+   
+   # Run all checks
+   pre-commit run --all-files
+   ```
 
 ## Contributing
 Contributions are welcome! Here's how you can help:

{mcp_dbutils-0.13.0 → mcp_dbutils-0.15.0}/README_CN.md

@@ -419,6 +419,71 @@ except Exception as e:
 - SSL/TLS安全连接
 - URL和标准连接方式
 
+## 代码质量
+
+### 质量门禁
+我们使用SonarCloud维持高代码质量标准。所有的Pull Request必须通过以下质量门禁：
+
+- 代码覆盖率：≥ 80%
+- 代码质量：
+  * 无阻塞级和严重级问题
+  * 主要问题数少于10个
+  * 代码重复率 < 3%
+- 安全性：
+  * 无安全漏洞
+  * 无安全热点问题
+
+### 自动化检查
+我们的CI/CD流程自动执行：
+1. 完整测试套件运行
+2. 代码覆盖率分析
+3. SonarCloud静态代码分析
+4. 质量门禁验证
+
+不符合这些标准的Pull Request将被自动阻止合并。
+
+### 代码风格
+我们使用Ruff进行代码风格检查和格式化：
+
+[![Code Style](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+
+所有代码必须遵循我们的风格指南：
+- 行长度：88个字符
+- 缩进：4个空格
+- 引号：双引号
+- 命名：PEP8约定
+
+详细指南请参见[STYLE_GUIDE.md](docs/STYLE_GUIDE.md)。
+
+### 本地开发
+本地检查代码质量：
+1. 运行带覆盖率的测试：
+   ```bash
+   pytest --cov=src/mcp_dbutils --cov-report=xml:coverage.xml tests/
+   ```
+2. 在IDE中使用SonarLint及早发现问题
+3. 在PR评论中查看SonarCloud分析结果
+4. 运行Ruff进行代码风格检查：
+   ```bash
+   # 安装Ruff
+   uv pip install ruff
+   
+   # 检查代码风格
+   ruff check .
+   
+   # 格式化代码
+   ruff format .
+   ```
+5. 使用pre-commit钩子进行自动检查：
+   ```bash
+   # 安装pre-commit
+   uv pip install pre-commit
+   pre-commit install
+   
+   # 运行所有检查
+   pre-commit run --all-files
+   ```
+
 ## 参与贡献
 欢迎贡献！以下是参与项目的方式：
 

mcp_dbutils-0.15.0/pyproject.toml

@@ -0,0 +1,119 @@
+[project]
+name = "mcp-dbutils"
+version = "0.15.0"
+description = "MCP Database Utilities Service"
+readme = "README.md"
+license = "MIT"
+authors = [
+    {name = "Dong Hao"}
+]
+dependencies = [
+    "mcp>=1.2.1",
+    "psycopg2-binary>=2.9.10",
+    "python-dotenv>=1.0.1",
+    "pyyaml>=6.0.2",
+    "mysql-connector-python>=8.2.0",
+]
+requires-python = ">=3.10"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project.scripts]
+mcp-dbutils = "mcp_dbutils:main"
+
+[tool.semantic_release]
+version_variables = [
+    "pyproject.toml:project.version"
+]
+version_toml = [
+    "pyproject.toml:project.version"
+]
+commit_parser = "conventional"
+major_on_zero = false
+branch = "main"
+changelog_components = "semantic_release.changelog.changelog"
+build_command = "uv build"
+
+[project.optional-dependencies]
+test = [
+    "pytest>=7.0.0",
+    "pytest-asyncio>=0.23.0",
+    "pytest-docker>=2.0.0",
+    "docker>=7.0.0",
+    "aiosqlite>=0.19.0",
+    "testcontainers>=3.7.0",
+    "pytest-cov>=4.1.0",
+    "ruff>=0.3.0",
+    "pre-commit>=3.6.0"
+]
+
+[tool.pytest.ini_options]
+asyncio_mode = "strict"
+asyncio_default_fixture_loop_scope = "function"
+markers = [
+    "no_collect: marks test classes that should not be collected as test cases"
+]
+filterwarnings = [
+    "ignore::pytest.PytestCollectionWarning"
+]
+
+# Ruff配置
+[tool.ruff]
+# 目标Python版本
+target-version = "0.15.0"
+# 行长度限制
+line-length = 88
+# 排除的文件和目录
+exclude = [
+    ".git",
+    ".venv",
+    "__pycache__",
+    "build",
+    "dist",
+]
+
+# Lint配置
+[tool.ruff.lint]
+# 选择的规则集
+select = [
+    "E",   # pycodestyle错误
+    "F",   # pyflakes
+    "I",   # isort
+    "N",   # pep8-naming
+    "UP",  # pyupgrade
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "SIM", # flake8-simplify
+    "T20", # flake8-print
+]
+# 忽略的规则 - 暂时忽略，后续PR中逐步修复
+ignore = [
+    "E501",  # 行太长
+    "B904",  # 在except子句中使用raise ... from err
+    "UP035", # 使用新的typing语法
+    "UP006", # 使用新的类型注解语法
+    "UP007", # 使用X | Y替代Union
+    "F401",  # 未使用的导入
+    "F541",  # f-string没有占位符
+    "UP015", # 不必要的mode参数
+    "UP032", # 使用f-string替代format
+    "B905",  # zip()没有strict参数
+    "SIM105", # 使用contextlib.suppress
+    "UP038",  # 在isinstance调用中使用X | Y
+    "F821",   # 未定义的名称
+    "F841",   # 未使用的局部变量
+    "E402",   # 模块级导入不在文件顶部
+    "T201",   # print语句 - 在日志模块中是必要的
+]
+
+# isort配置
+[tool.ruff.lint.isort]
+known-first-party = ["mcp_dbutils"]
+
+# 格式化配置
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+line-ending = "auto"

mcp_dbutils-0.15.0/sonar-project.properties

@@ -0,0 +1,14 @@
+sonar.organization=donghao1393
+sonar.projectKey=donghao1393_mcp-dbutils
+sonar.sources=src/mcp_dbutils
+sonar.tests=tests
+sonar.python.coverage.reportPaths=coverage.xml
+sonar.python.version=3.10
+
+# PR Analysis Configuration
+sonar.pullrequest.provider=github
+sonar.pullrequest.github.repository=donghao1393/mcp-dbutils
+sonar.pullrequest.github.endpoint=https://api.github.com/
+
+# Quality Gate Settings
+sonar.qualitygate.wait=true

{mcp_dbutils-0.13.0 → mcp_dbutils-0.15.0}/src/mcp_dbutils/__init__.py

@@ -1,15 +1,16 @@
 """MCP Connection Utilities Service"""
 
-import asyncio
 import argparse
+import asyncio
 import os
 import sys
+from importlib.metadata import metadata
 from pathlib import Path
+
 import yaml
-from importlib.metadata import metadata
 
+from .base import LOG_NAME, ConnectionServer
 from .log import create_logger
-from .base import ConnectionServer, LOG_NAME
 
 # 获取包信息
 pkg_meta = metadata("mcp-dbutils")

{mcp_dbutils-0.13.0 → mcp_dbutils-0.15.0}/src/mcp_dbutils/base.py

@@ -12,18 +12,17 @@ class ConnectionError(ConnectionHandlerError):
     """Connection related errors"""
     pass
 
+import json
 from abc import ABC, abstractmethod
-from typing import Any, List, Optional, AsyncContextManager
 from contextlib import asynccontextmanager
-import json
-import yaml
-import time
 from datetime import datetime
 from importlib.metadata import metadata
-from mcp.server import Server, NotificationOptions
+from typing import AsyncContextManager
+
 import mcp.server.stdio
 import mcp.types as types
-from mcp.shared.session import RequestResponder
+import yaml
+from mcp.server import Server
 
 from .log import create_logger
 from .stats import ResourceStats

{mcp_dbutils-0.13.0 → mcp_dbutils-0.15.0}/src/mcp_dbutils/config.py

@@ -1,11 +1,10 @@
 """Common configuration utilities"""
 
 import os
-import yaml
 from abc import ABC, abstractmethod
-from dataclasses import dataclass, field
-from typing import Optional, Dict, Any, Literal
-from pathlib import Path
+from typing import Any, Dict, Literal
+
+import yaml
 
 # Supported connection types
 ConnectionType = Literal['sqlite', 'postgres', 'mysql']