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

{mcp_dbutils-0.15.0 → mcp_dbutils-0.15.1}/.github/workflows/quality-assurance.yml

@@ -103,13 +103,17 @@ jobs:
         with:
           name: coverage-report
       - name: SonarCloud Scan
+        id: sonar_scan
         uses: SonarSource/sonarqube-scan-action@v5.0.0
+        continue-on-error: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
       
       - name: SonarQube Quality Gate Check
+        id: sonar_qg
         uses: sonarsource/sonarqube-quality-gate-action@master
+        continue-on-error: true
         timeout-minutes: 5
         env:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
@@ -264,3 +268,163 @@ jobs:
               });
               console.log('Created new SonarCloud comment');
             }
+            
+      - name: Extract SonarCloud Issues
+        if: always()
+        uses: actions/github-script@v6
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+          SONAR_PROJECT_KEY: 'donghao1393_mcp-dbutils'
+        with:
+          script: |
+            const fs = require('fs');
+            
+            // 获取SonarCloud问题
+            const projectKey = process.env.SONAR_PROJECT_KEY;
+            console.log(`获取项目 ${projectKey} 的SonarCloud问题...`);
+            
+            // 获取未解决的问题
+            const issuesResponse = await fetch(
+              `https://sonarcloud.io/api/issues/search?componentKeys=${projectKey}&resolved=false&ps=500`,
+              { headers: { Authorization: `Bearer ${process.env.SONAR_TOKEN}` } }
+            ).then(res => res.json());
+            
+            console.log(`找到 ${issuesResponse.issues ? issuesResponse.issues.length : 0} 个未解决的问题`);
+            
+            // 保存原始JSON
+            fs.writeFileSync('sonar_issues.json', JSON.stringify(issuesResponse, null, 2));
+            
+            // 格式化为AI友好的Markdown
+            let markdownContent = '# SonarCloud分析问题报告\n\n';
+            markdownContent += `[在SonarCloud中查看完整报告](https://sonarcloud.io/project/issues?id=${projectKey})\n\n`;
+            
+            // 添加问题摘要
+            if (issuesResponse.issues && issuesResponse.issues.length > 0) {
+              // 按严重性统计
+              const severityCounts = {};
+              // 按类型统计
+              const typeCounts = {};
+              
+              issuesResponse.issues.forEach(issue => {
+                severityCounts[issue.severity] = (severityCounts[issue.severity] || 0) + 1;
+                typeCounts[issue.type] = (typeCounts[issue.type] || 0) + 1;
+              });
+              
+              markdownContent += '## 问题摘要\n\n';
+              
+              markdownContent += '### 按严重性\n\n';
+              for (const [severity, count] of Object.entries(severityCounts)) {
+                let severityText = '';
+                switch (severity) {
+                  case 'BLOCKER': severityText = '阻断级'; break;
+                  case 'CRITICAL': severityText = '严重级'; break;
+                  case 'MAJOR': severityText = '主要级'; break;
+                  case 'MINOR': severityText = '次要级'; break;
+                  case 'INFO': severityText = '提示级'; break;
+                  default: severityText = severity;
+                }
+                markdownContent += `- ${severityText}: ${count}个问题\n`;
+              }
+              
+              markdownContent += '\n### 按类型\n\n';
+              for (const [type, count] of Object.entries(typeCounts)) {
+                let typeText = '';
+                switch (type) {
+                  case 'BUG': typeText = 'Bug'; break;
+                  case 'VULNERABILITY': typeText = '安全漏洞'; break;
+                  case 'CODE_SMELL': typeText = '代码异味'; break;
+                  default: typeText = type;
+                }
+                markdownContent += `- ${typeText}: ${count}个问题\n`;
+              }
+              
+              // 按文件分组问题
+              const issuesByFile = {};
+              issuesResponse.issues.forEach(issue => {
+                const component = issue.component.split(':').pop();
+                if (!issuesByFile[component]) {
+                  issuesByFile[component] = [];
+                }
+                issuesByFile[component].push(issue);
+              });
+              
+              markdownContent += '\n## 详细问题列表\n\n';
+              
+              for (const [file, issues] of Object.entries(issuesByFile)) {
+                markdownContent += `### 文件: ${file}\n\n`;
+                
+                issues.forEach(issue => {
+                  let severityText = '';
+                  switch (issue.severity) {
+                    case 'BLOCKER': severityText = '阻断级'; break;
+                    case 'CRITICAL': severityText = '严重级'; break;
+                    case 'MAJOR': severityText = '主要级'; break;
+                    case 'MINOR': severityText = '次要级'; break;
+                    case 'INFO': severityText = '提示级'; break;
+                    default: severityText = issue.severity;
+                  }
+                  
+                  let typeText = '';
+                  switch (issue.type) {
+                    case 'BUG': typeText = 'Bug'; break;
+                    case 'VULNERABILITY': typeText = '安全漏洞'; break;
+                    case 'CODE_SMELL': typeText = '代码异味'; break;
+                    default: typeText = issue.type;
+                  }
+                  
+                  markdownContent += `- 文件: ${file}\n`;
+                  markdownContent += `  行号: ${issue.line || 'N/A'}\n`;
+                  markdownContent += `  问题: ${issue.message}\n`;
+                  markdownContent += `  严重性: ${severityText}\n`;
+                  markdownContent += `  类型: ${typeText}\n`;
+                  markdownContent += `  [在SonarCloud中查看](https://sonarcloud.io/project/issues?id=${projectKey}&open=${issue.key})\n\n`;
+                });
+              }
+              
+              // 添加常见问题修复建议
+              markdownContent += '## 常见问题修复建议\n\n';
+              
+              // 检查是否存在特定规则的问题
+              const hasRule = rule => issuesResponse.issues.some(issue => issue.rule === rule);
+              
+              if (hasRule('python:S1481')) {
+                markdownContent += '- **未使用的变量**: 删除未使用的变量声明，或者在变量名前添加下划线（例如 `_unused`）\n';
+              }
+              
+              if (hasRule('python:S5754')) {
+                markdownContent += '- **类型检查**: 使用 `isinstance()` 替代 `type()` 进行类型检查\n';
+              }
+              
+              if (hasRule('python:S1066')) {
+                markdownContent += '- **合并嵌套if语句**: 将嵌套的if语句合并为一个使用 `and` 运算符的条件\n';
+              }
+              
+              if (hasRule('python:S1172')) {
+                markdownContent += '- **未使用的参数**: 删除未使用的函数参数，或者在参数名前添加下划线\n';
+              }
+              
+              if (hasRule('python:S5806')) {
+                markdownContent += '- **不必要的lambda**: 使用函数引用替代只调用另一个函数的lambda\n';
+              }
+              
+              // 添加通用建议
+              markdownContent += '- **代码重复**: 提取重复代码为共享函数或类\n';
+              markdownContent += '- **复杂函数**: 将大型函数拆分为更小的函数，每个函数只做一件事\n';
+              markdownContent += '- **注释**: 为复杂逻辑添加清晰的注释，解释"为什么"而不仅仅是"做什么"\n';
+            } else {
+              markdownContent += '## 没有发现问题\n\n恭喜！SonarCloud没有检测到任何问题。';
+            }
+            
+            // 保存Markdown文件
+            fs.writeFileSync('sonar_report.md', markdownContent);
+            
+            console.log('已生成SonarCloud问题报告');
+            
+      - name: Upload SonarCloud Issues Report
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: sonarcloud-issues
+          path: |
+            sonar_issues.json
+            sonar_report.md

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

@@ -1,3 +1,10 @@
+## [0.15.1](https://github.com/donghao1393/mcp-dbutils/compare/v0.15.0...v0.15.1) (2025-03-14)
+
+
+### Bug Fixes
+
+* ensure SonarCloud reports are generated even when analysis fails ([#40](https://github.com/donghao1393/mcp-dbutils/issues/40)) ([01d8a43](https://github.com/donghao1393/mcp-dbutils/commit/01d8a431f22079e621cc4160c210f3e8ce68a754)), closes [#39](https://github.com/donghao1393/mcp-dbutils/issues/39)
+
 # [0.15.0](https://github.com/donghao1393/mcp-dbutils/compare/v0.14.0...v0.15.0) (2025-03-14)
 
 

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mcp-dbutils
-Version: 0.15.0
+Version: 0.15.1
 Summary: MCP Database Utilities Service
 Author: Dong Hao
 License-Expression: MIT
@@ -527,6 +527,24 @@ To check code quality locally:
    pre-commit run --all-files
    ```
 
+### SonarCloud AI Integration
+We've implemented an AI-assisted workflow for fixing SonarCloud issues:
+
+1. Our CI/CD pipeline automatically extracts SonarCloud analysis results
+2. Results are formatted into both JSON and Markdown formats
+3. These reports can be downloaded using the provided Fish function
+4. The reports can then be provided to AI tools for analysis and fix suggestions
+
+For detailed instructions, see [SonarCloud AI Integration Guide](docs/sonarcloud-ai-integration.md).
+
+```bash
+# Load the function
+source scripts/sonar-ai-fix.fish
+
+# Download the latest SonarCloud analysis reports
+sonar-ai-fix
+```
+
 ## Contributing
 Contributions are welcome! Here's how you can help:
 

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

@@ -502,6 +502,24 @@ To check code quality locally:
    pre-commit run --all-files
    ```
 
+### SonarCloud AI Integration
+We've implemented an AI-assisted workflow for fixing SonarCloud issues:
+
+1. Our CI/CD pipeline automatically extracts SonarCloud analysis results
+2. Results are formatted into both JSON and Markdown formats
+3. These reports can be downloaded using the provided Fish function
+4. The reports can then be provided to AI tools for analysis and fix suggestions
+
+For detailed instructions, see [SonarCloud AI Integration Guide](docs/sonarcloud-ai-integration.md).
+
+```bash
+# Load the function
+source scripts/sonar-ai-fix.fish
+
+# Download the latest SonarCloud analysis reports
+sonar-ai-fix
+```
+
 ## Contributing
 Contributions are welcome! Here's how you can help:
 

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

@@ -484,6 +484,24 @@ except Exception as e:
    pre-commit run --all-files
    ```
 
+### SonarCloud AI 集成
+我们实现了一个AI辅助的SonarCloud问题修复工作流：
+
+1. 我们的CI/CD流程自动提取SonarCloud分析结果
+2. 结果被格式化为JSON和Markdown两种格式
+3. 这些报告可以使用提供的Fish函数下载
+4. 然后可以将报告提供给AI工具进行分析和修复建议
+
+详细说明请参见[SonarCloud AI集成指南](docs/sonarcloud-ai-integration.md)。
+
+```bash
+# 加载函数
+source scripts/sonar-ai-fix.fish
+
+# 下载最新的SonarCloud分析报告
+sonar-ai-fix
+```
+
 ## 参与贡献
 欢迎贡献！以下是参与项目的方式：
 

{mcp_dbutils-0.15.0 → mcp_dbutils-0.15.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mcp-dbutils"
-version = "0.15.0"
+version = "0.15.1"
 description = "MCP Database Utilities Service"
 readme = "README.md"
 license = "MIT"
@@ -62,7 +62,7 @@ filterwarnings = [
 # Ruff配置
 [tool.ruff]
 # 目标Python版本
-target-version = "0.15.0"
+target-version = "0.15.1"
 # 行长度限制
 line-length = 88
 # 排除的文件和目录

mcp_dbutils-0.15.1/scripts/sonar-ai-fix.fish

@@ -0,0 +1,62 @@
+#!/usr/bin/env fish
+
+function sonar-ai-fix
+    # 检查当前目录是否是项目目录
+    if not test -f "pyproject.toml"; or not test -d "src/mcp_dbutils"
+        echo "错误: 请在项目根目录运行此命令"
+        echo "当前目录不是mcp-dbutils项目目录"
+        return 1
+    end
+    
+    # 下载最新的构件
+    echo "正在下载 SonarCloud 分析报告..."
+    
+    # 获取最新的工作流运行ID
+    set RUN_ID (gh run list --workflow "Quality Assurance" --limit 1 --json databaseId --jq '.[0].databaseId')
+    
+    if test -z "$RUN_ID"
+        echo "错误: 无法获取最新的工作流运行ID"
+        return 1
+    end
+    
+    # 创建临时目录存放下载的文件
+    set TEMP_DIR (mktemp -d)
+    
+    # 下载构件
+    gh run download $RUN_ID --name sonarcloud-issues --dir $TEMP_DIR
+    
+    if test $status -ne 0
+        echo "错误: 下载构件失败"
+        rm -rf $TEMP_DIR
+        return 1
+    end
+    
+    # 检查文件是否存在
+    if not test -f "$TEMP_DIR/sonar_report.md"
+        echo "错误: 未找到 sonar_report.md 文件"
+        rm -rf $TEMP_DIR
+        return 1
+    end
+    
+    if not test -f "$TEMP_DIR/sonar_issues.json"
+        echo "错误: 未找到 sonar_issues.json 文件"
+        rm -rf $TEMP_DIR
+        return 1
+    end
+    
+    # 复制文件到当前目录
+    cp "$TEMP_DIR/sonar_report.md" ./sonar_report.md
+    cp "$TEMP_DIR/sonar_issues.json" ./sonar_issues.json
+    
+    # 清理临时目录
+    rm -rf $TEMP_DIR
+    
+    echo "已下载 SonarCloud 分析报告:"
+    echo "- sonar_report.md: Markdown格式的报告，适合人类阅读"
+    echo "- sonar_issues.json: JSON格式的原始数据，适合AI处理"
+    echo ""
+    echo "使用方法:"
+    echo "1. 查看报告: cat sonar_report.md"
+    echo "2. 提供给AI: 将sonar_report.md的内容复制给AI，请求修复建议"
+    echo "3. 高级分析: 将sonar_issues.json提供给AI进行更深入的分析"
+end