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

mcp_dbutils-0.11.0/.github/workflows/test.yml → mcp_dbutils-0.13.0/.github/workflows/quality-assurance.yml

@@ -1,4 +1,4 @@
-name: Tests
+name: Quality Assurance
 
 on:
   push:
@@ -7,7 +7,7 @@ on:
     branches: [ main ]
 
 jobs:
-  test:
+  pytest:
     runs-on: ubuntu-latest
 
     services:
@@ -49,8 +49,15 @@ jobs:
             --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: |
@@ -75,3 +82,29 @@ jobs:
           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

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

@@ -1,3 +1,17 @@
+# [0.13.0](https://github.com/donghao1393/mcp-dbutils/compare/v0.12.0...v0.13.0) (2025-03-14)
+
+
+### Features
+
+* configure SonarCloud quality gates ([#31](https://github.com/donghao1393/mcp-dbutils/issues/31)) ([454c4d3](https://github.com/donghao1393/mcp-dbutils/commit/454c4d384e4ddd8d324fe4292b13436c6b22328c)), closes [#30](https://github.com/donghao1393/mcp-dbutils/issues/30)
+
+# [0.12.0](https://github.com/donghao1393/mcp-dbutils/compare/v0.11.0...v0.12.0) (2025-03-14)
+
+
+### Features
+
+* integrate SonarCloud analysis ([#29](https://github.com/donghao1393/mcp-dbutils/issues/29)) ([67649c5](https://github.com/donghao1393/mcp-dbutils/commit/67649c55cc317c2ee20c69777d1629895863dd86)), closes [#28](https://github.com/donghao1393/mcp-dbutils/issues/28)
+
 # [0.11.0](https://github.com/donghao1393/mcp-dbutils/compare/v0.10.3...v0.11.0) (2025-03-13)
 
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mcp-dbutils
-Version: 0.11.0
+Version: 0.13.0
 Summary: MCP Database Utilities Service
 Author: Dong Hao
 License-Expression: MIT
@@ -65,7 +65,7 @@ uvx mcp-dbutils --config /path/to/config.yaml
 Add to Claude configuration:
 ```json
 "mcpServers": {
-  "mcp-dbutils": {
+  "dbutils": {
     "command": "uvx",
     "args": [
       "mcp-dbutils",
@@ -87,7 +87,7 @@ pip install mcp-dbutils
 Add to Claude configuration:
 ```json
 "mcpServers": {
-  "mcp-dbutils": {
+  "dbutils": {
     "command": "python",
     "args": [
       "-m",
@@ -114,7 +114,7 @@ docker run -i --rm \
 Add to Claude configuration:
 ```json
 "mcpServers": {
-  "mcp-dbutils": {
+  "dbutils": {
     "command": "docker",
     "args": [
       "run",
@@ -460,6 +460,38 @@ Provides MySQL-specific features:
 - SSL/TLS secure connection
 - URL and standard connection methods
 
+## Code Quality
+
+### Quality Gates
+We use SonarCloud to maintain high code quality standards. All pull requests must pass the following quality gates:
+
+- Code Coverage: ≥ 80%
+- Code Quality:
+  * No blocker or critical issues
+  * Less than 10 major issues
+  * Code duplication < 3%
+- Security:
+  * No security vulnerabilities
+  * No security hotspots
+
+### Automated Checks
+Our CI/CD pipeline automatically performs:
+1. Full test suite execution
+2. Code coverage analysis
+3. SonarCloud static code analysis
+4. Quality gate validation
+
+Pull requests that don't meet these standards will be automatically blocked from merging.
+
+### Local Development
+To check code quality locally:
+1. Run tests with coverage:
+   ```bash
+   pytest --cov=src/mcp_dbutils --cov-report=xml:coverage.xml tests/
+   ```
+2. Use SonarLint in your IDE to catch issues early
+3. Review SonarCloud analysis results in PR comments
+
 ## Contributing
 Contributions are welcome! Here's how you can help:
 

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

@@ -42,7 +42,7 @@ uvx mcp-dbutils --config /path/to/config.yaml
 Add to Claude configuration:
 ```json
 "mcpServers": {
-  "mcp-dbutils": {
+  "dbutils": {
     "command": "uvx",
     "args": [
       "mcp-dbutils",
@@ -64,7 +64,7 @@ pip install mcp-dbutils
 Add to Claude configuration:
 ```json
 "mcpServers": {
-  "mcp-dbutils": {
+  "dbutils": {
     "command": "python",
     "args": [
       "-m",
@@ -91,7 +91,7 @@ docker run -i --rm \
 Add to Claude configuration:
 ```json
 "mcpServers": {
-  "mcp-dbutils": {
+  "dbutils": {
     "command": "docker",
     "args": [
       "run",
@@ -437,6 +437,38 @@ Provides MySQL-specific features:
 - SSL/TLS secure connection
 - URL and standard connection methods
 
+## Code Quality
+
+### Quality Gates
+We use SonarCloud to maintain high code quality standards. All pull requests must pass the following quality gates:
+
+- Code Coverage: ≥ 80%
+- Code Quality:
+  * No blocker or critical issues
+  * Less than 10 major issues
+  * Code duplication < 3%
+- Security:
+  * No security vulnerabilities
+  * No security hotspots
+
+### Automated Checks
+Our CI/CD pipeline automatically performs:
+1. Full test suite execution
+2. Code coverage analysis
+3. SonarCloud static code analysis
+4. Quality gate validation
+
+Pull requests that don't meet these standards will be automatically blocked from merging.
+
+### Local Development
+To check code quality locally:
+1. Run tests with coverage:
+   ```bash
+   pytest --cov=src/mcp_dbutils --cov-report=xml:coverage.xml tests/
+   ```
+2. Use SonarLint in your IDE to catch issues early
+3. Review SonarCloud analysis results in PR comments
+
 ## Contributing
 Contributions are welcome! Here's how you can help:
 

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

@@ -26,7 +26,7 @@ uvx mcp-dbutils --config /path/to/config.yaml
 添加到 Claude 配置：
 ```json
 "mcpServers": {
-  "mcp-dbutils": {
+  "dbutils": {
     "command": "uvx",
     "args": [
       "mcp-dbutils",
@@ -48,7 +48,7 @@ pip install mcp-dbutils
 添加到 Claude 配置：
 ```json
 "mcpServers": {
-  "mcp-dbutils": {
+  "dbutils": {
     "command": "python",
     "args": [
       "-m",
@@ -75,7 +75,7 @@ docker run -i --rm \
 添加到 Claude 配置：
 ```json
 "mcpServers": {
-  "mcp-dbutils": {
+  "dbutils": {
     "command": "docker",
     "args": [
       "run",

{mcp_dbutils-0.11.0 → mcp_dbutils-0.13.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mcp-dbutils"
-version = "0.11.0"
+version = "0.13.0"
 description = "MCP Database Utilities Service"
 readme = "README.md"
 license = "MIT"

mcp_dbutils-0.13.0/sonar-project.properties

@@ -0,0 +1,6 @@
+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

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

@@ -9,13 +9,13 @@ import yaml
 from importlib.metadata import metadata
 
 from .log import create_logger
-from .base import ConnectionServer
+from .base import ConnectionServer, LOG_NAME
 
 # 获取包信息
 pkg_meta = metadata("mcp-dbutils")
 
 # 创建全局logger
-log = create_logger(pkg_meta["Name"])
+log = create_logger(LOG_NAME)
 
 async def run_server():
     """服务器运行逻辑"""
@@ -30,7 +30,7 @@ async def run_server():
 
     # 更新logger的debug状态
     global log
-    log = create_logger(pkg_meta["Name"], debug)
+    log = create_logger(LOG_NAME, debug)
 
     log("info", f"MCP Connection Utilities Service v{pkg_meta['Version']}")
     if debug:

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

@@ -31,6 +31,9 @@ from .stats import ResourceStats
 # 获取包信息用于日志命名
 pkg_meta = metadata("mcp-dbutils")
 
+# 日志名称常量
+LOG_NAME = "dbutils"
+
 # MCP日志级别常量
 LOG_LEVEL_DEBUG = "debug"       # 0
 LOG_LEVEL_INFO = "info"        # 1
@@ -56,7 +59,7 @@ class ConnectionHandler(ABC):
         self.connection = connection
         self.debug = debug
         # 创建stderr日志记录器用于本地调试
-        self.log = create_logger(f"{pkg_meta['Name']}.handler.{connection}", debug)
+        self.log = create_logger(f"{LOG_NAME}.handler.{connection}", debug)
         self.stats = ResourceStats()
         self._session = None
 
@@ -246,9 +249,9 @@ class ConnectionServer:
         self.debug = debug
         # 获取包信息用于服务器配置
         pkg_meta = metadata("mcp-dbutils")
-        self.logger = create_logger(f"{pkg_meta['Name']}.server", debug)
+        self.logger = create_logger(f"{LOG_NAME}.server", debug)
         self.server = Server(
-            name=pkg_meta["Name"],
+            name=LOG_NAME,
             version=pkg_meta["Version"]
         )
         self._session = None

{mcp_dbutils-0.11.0 → mcp_dbutils-0.13.0}/src/mcp_dbutils/mysql/server.py

@@ -9,7 +9,7 @@ from ..log import create_logger
 from .config import MySQLConfig
 
 # 获取包信息用于日志命名
-pkg_meta = metadata("mcp-dbutils")
+from ..base import LOG_NAME
 
 class MySQLServer(ConnectionServer):
     def __init__(self, config: MySQLConfig, config_path: Optional[str] = None):
@@ -21,7 +21,7 @@ class MySQLServer(ConnectionServer):
         super().__init__(config_path, config.debug)
         self.config = config
         self.config_path = config_path
-        self.log = create_logger(f"{pkg_meta['Name']}.db.mysql", config.debug)
+        self.log = create_logger(f"{LOG_NAME}.db.mysql", config.debug)
         # 创建连接池
         try:
             conn_params = config.get_connection_params()

{mcp_dbutils-0.11.0 → mcp_dbutils-0.13.0}/src/mcp_dbutils/postgres/server.py

@@ -9,7 +9,8 @@ from ..log import create_logger
 from .config import PostgreSQLConfig
 
 # 获取包信息用于日志命名
-pkg_meta = metadata("mcp-dbutils")
+from ..base import LOG_NAME
+
 class PostgreSQLServer(ConnectionServer):
     def __init__(self, config: PostgreSQLConfig, config_path: Optional[str] = None):
         """初始化PostgreSQL服务器
@@ -20,7 +21,7 @@ class PostgreSQLServer(ConnectionServer):
         super().__init__(config_path, config.debug)
         self.config = config
         self.config_path = config_path
-        self.log = create_logger(f"{pkg_meta['Name']}.db.postgres", config.debug)
+        self.log = create_logger(f"{LOG_NAME}.db.postgres", config.debug)
         # 创建连接池
         try:
             conn_params = config.get_connection_params()

{mcp_dbutils-0.11.0 → mcp_dbutils-0.13.0}/src/mcp_dbutils/sqlite/server.py

@@ -12,7 +12,7 @@ from ..log import create_logger
 from .config import SQLiteConfig
 
 # 获取包信息用于日志命名
-pkg_meta = metadata("mcp-dbutils")
+from ..base import LOG_NAME
 
 class SQLiteServer(ConnectionServer):
     def __init__(self, config: SQLiteConfig, config_path: Optional[str] = None):
@@ -24,7 +24,7 @@ class SQLiteServer(ConnectionServer):
         super().__init__(config_path, config.debug)
         self.config = config
         self.config_path = config_path
-        self.log = create_logger(f"{pkg_meta['Name']}.db.sqlite", config.debug)
+        self.log = create_logger(f"{LOG_NAME}.db.sqlite", config.debug)
 
         # 确保数据库目录存在
         db_file = Path(self.config.absolute_path)