-
Notifications
You must be signed in to change notification settings - Fork 0
284 lines (231 loc) · 8.36 KB
/
code_quality.yml
File metadata and controls
284 lines (231 loc) · 8.36 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
name: Code Quality
on:
push:
branches: [ main, develop ]
pull_request:
branches: [ main, develop ]
env:
FLUTTER_VERSION: '3.32.5'
jobs:
analyze:
name: Code Analysis
runs-on: ubuntu-22.04
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup Flutter
uses: subosito/flutter-action@v2
with:
flutter-version: ${{ env.FLUTTER_VERSION }}
channel: 'stable'
cache: true
- name: Get dependencies
run: flutter pub get
- name: Verify formatting
run: |
echo "Checking code formatting..."
if ! dart format --output=none --set-exit-if-changed .; then
echo "⚠️ Code formatting issues found"
echo "Files that need formatting:"
dart format --output=none --show=changed .
echo "❌ Please run 'dart format .' to fix formatting issues"
exit 1
else
echo "✅ Code formatting is correct"
fi
- name: Analyze project source
run: |
dart analyze --fatal-infos
if [ $? -ne 0 ]; then
echo "❌ Code analysis issues found"
exit 1
fi
echo "✅ Code analysis passed"
- name: Check for unused dependencies
run: |
flutter pub deps --json > deps.json
echo "✅ Dependencies checked"
- name: Check for outdated dependencies
run: |
flutter pub outdated --json > outdated.json || true
echo "✅ Outdated dependencies checked"
test_coverage:
name: Test Coverage
runs-on: ubuntu-22.04
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup Flutter
uses: subosito/flutter-action@v2
with:
flutter-version: ${{ env.FLUTTER_VERSION }}
channel: 'stable'
cache: true
- name: Get dependencies
run: flutter pub get
- name: Run tests with coverage
run: |
flutter test --coverage
if [ $? -ne 0 ]; then
echo "❌ Tests failed"
exit 1
fi
echo "✅ All tests passed"
- name: Generate coverage report
run: |
if [ -f "coverage/lcov.info" ]; then
# 计算覆盖率
COVERAGE=$(lcov --summary coverage/lcov.info 2>&1 | grep "lines" | awk '{print $2}' | sed 's/%//')
echo "Test coverage: $COVERAGE%"
# 检查覆盖率阈值
THRESHOLD=80
if (( $(echo "$COVERAGE < $THRESHOLD" | bc -l) )); then
echo "❌ Test coverage ($COVERAGE%) is below threshold ($THRESHOLD%)"
exit 1
fi
echo "✅ Test coverage ($COVERAGE%) meets threshold ($THRESHOLD%)"
else
echo "⚠️ No coverage data found"
fi
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v4
with:
file: ./coverage/lcov.info
flags: unittests
name: codecov-umbrella
fail_ci_if_error: false
security_check:
name: Security Check
runs-on: ubuntu-22.04
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup Flutter
uses: subosito/flutter-action@v2
with:
flutter-version: ${{ env.FLUTTER_VERSION }}
channel: 'stable'
cache: true
- name: Get dependencies
run: flutter pub get
- name: Check for known vulnerabilities
run: |
# 检查 pubspec.yaml 中的依赖
echo "Checking for known vulnerabilities..."
# 检查是否有已知的不安全依赖
flutter pub deps --json > deps.json
# 这里可以添加更多的安全检查
echo "✅ Security check completed"
- name: Check for sensitive data
run: |
echo "Checking for sensitive data in code..."
# 检查是否有硬编码的密钥、密码等
if grep -r -i "password\|secret\|key\|token" lib/ --include="*.dart" | grep -v "// TODO\|// FIXME"; then
echo "⚠️ Potential sensitive data found in code"
echo "Please review the above matches"
else
echo "✅ No obvious sensitive data found"
fi
- name: Check file permissions
run: |
echo "Checking file permissions..."
# 检查是否有不当的文件权限
find . -type f -perm /o+w -exec echo "World-writable file: {}" \;
echo "✅ File permissions checked"
performance_check:
name: Performance Check
runs-on: ubuntu-22.04
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup Flutter
uses: subosito/flutter-action@v2
with:
flutter-version: ${{ env.FLUTTER_VERSION }}
channel: 'stable'
cache: true
- name: Get dependencies
run: flutter pub get
- name: Check app size
run: |
echo "Analyzing app size..."
# 构建 APK 并检查大小
flutter build apk --analyze-size --target-platform android-arm64
# 检查 APK 大小
if [ -f "build/app/outputs/flutter-apk/app-release.apk" ]; then
APK_SIZE=$(du -h build/app/outputs/flutter-apk/app-release.apk | cut -f1)
echo "APK size: $APK_SIZE"
# 检查大小是否超过阈值(例如 50MB)
APK_SIZE_BYTES=$(du -b build/app/outputs/flutter-apk/app-release.apk | cut -f1)
THRESHOLD_BYTES=$((50 * 1024 * 1024)) # 50MB
if [ $APK_SIZE_BYTES -gt $THRESHOLD_BYTES ]; then
echo "⚠️ APK size ($APK_SIZE) exceeds threshold (50MB)"
else
echo "✅ APK size ($APK_SIZE) is within acceptable range"
fi
fi
- name: Check for performance anti-patterns
run: |
echo "Checking for performance anti-patterns..."
# 检查常见的性能问题
if grep -r "print(" lib/ --include="*.dart"; then
echo "⚠️ Found print() statements that should be removed in production"
fi
if grep -r "debugPrint(" lib/ --include="*.dart"; then
echo "ℹ️ Found debugPrint() statements (OK for debug builds)"
fi
echo "✅ Performance check completed"
documentation_check:
name: Documentation Check
runs-on: ubuntu-22.04
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Check README
run: |
if [ ! -f "README.md" ]; then
echo "❌ README.md not found"
exit 1
fi
echo "✅ README.md exists"
- name: Check CHANGELOG
run: |
if [ ! -f "CHANGELOG.md" ]; then
echo "⚠️ CHANGELOG.md not found"
else
echo "✅ CHANGELOG.md exists"
fi
- name: Check documentation coverage
run: |
echo "Checking documentation coverage..."
# 检查公共 API 是否有文档注释
dart doc --dry-run --quiet
echo "✅ Documentation check completed"
summary:
name: Quality Summary
runs-on: ubuntu-22.04
needs: [analyze, test_coverage, security_check, performance_check, documentation_check]
if: always()
steps:
- name: Quality Summary
run: |
echo "=========================================="
echo " Code Quality Summary"
echo "=========================================="
echo "Analysis: ${{ needs.analyze.result }}"
echo "Test Coverage: ${{ needs.test_coverage.result }}"
echo "Security Check: ${{ needs.security_check.result }}"
echo "Performance Check: ${{ needs.performance_check.result }}"
echo "Documentation Check: ${{ needs.documentation_check.result }}"
echo "=========================================="
# 检查是否有失败的检查
if [ "${{ needs.analyze.result }}" = "failure" ] ||
[ "${{ needs.test_coverage.result }}" = "failure" ] ||
[ "${{ needs.security_check.result }}" = "failure" ] ||
[ "${{ needs.performance_check.result }}" = "failure" ] ||
[ "${{ needs.documentation_check.result }}" = "failure" ]; then
echo "❌ Some quality checks failed"
exit 1
else
echo "✅ All quality checks passed"
fi