crap-analysis

仓库: aaronontheweb/dotnet-skills
安装量: 111
排名: #7693

安装

npx skills add https://github.com/aaronontheweb/dotnet-skills --skill crap-analysis

Use this skill when:

  • Evaluating code quality and test coverage before changes

  • Identifying high-risk code that needs refactoring or testing

  • Setting up coverage collection for a .NET project

  • Prioritizing which code to test based on risk

  • Establishing coverage thresholds for CI/CD pipelines

What is CRAP?

CRAP Score = Complexity x (1 - Coverage)^2

The CRAP (Change Risk Anti-Patterns) score combines cyclomatic complexity with test coverage to identify risky code.

| < 5 | Low | Well-tested, maintainable code

| 5-30 | Medium | Acceptable but watch complexity

| > 30 | High | Needs tests or refactoring

Why CRAP Matters

  • High complexity + low coverage = danger: Code that's hard to understand AND untested is risky to modify

  • Complexity alone isn't enough: A complex method with 100% coverage is safer than a simple method with 0%

  • Focuses effort: Prioritize testing on complex code, not simple getters/setters

CRAP Score Examples

| GetUserId() | 1 | 0% | 1 x (1 - 0)^2 | 1

| ParseToken() | 54 | 52% | 54 x (1 - 0.52)^2 | 12.4

| ValidateForm() | 20 | 0% | 20 x (1 - 0)^2 | 20

| ProcessOrder() | 45 | 20% | 45 x (1 - 0.20)^2 | 28.8

| ImportData() | 80 | 10% | 80 x (1 - 0.10)^2 | 64.8

Coverage Collection Setup

coverage.runsettings

Create a coverage.runsettings file in your repository root. The OpenCover format is required for CRAP score calculation because it includes cyclomatic complexity metrics.

<?xml version="1.0" encoding="utf-8" ?>
<RunSettings>
  <DataCollectionRunSettings>
    <DataCollectors>
      <DataCollector friendlyName="XPlat code coverage">
        <Configuration>
          <!-- OpenCover format includes cyclomatic complexity for CRAP scores -->
          <Format>cobertura,opencover</Format>

          <!-- Exclude test and benchmark assemblies -->
          <Exclude>[*.Tests]*,[*.Benchmark]*,[*.Migrations]*</Exclude>

          <!-- Exclude generated code and obsolete members -->
          <ExcludeByAttribute>Obsolete,GeneratedCodeAttribute,CompilerGeneratedAttribute</ExcludeByAttribute>

          <!-- Exclude source-generated files -->
          <ExcludeByFile>**/obj/**/*,**/*.g.cs,**/*.designer.cs</ExcludeByFile>

          <!-- Exclude test projects -->
          <IncludeTestAssembly>false</IncludeTestAssembly>

          <!-- Optimization flags -->
          <SingleHit>false</SingleHit>
          <UseSourceLink>true</UseSourceLink>
          <SkipAutoProps>true</SkipAutoProps>
        </Configuration>
      </DataCollector>
    </DataCollectors>
  </DataCollectionRunSettings>
</RunSettings>

Key Configuration Options

| Format | Must include opencover for complexity metrics

| Exclude | Exclude test/benchmark assemblies by pattern

| ExcludeByAttribute | Skip generated and obsolete code

| ExcludeByFile | Skip source-generated files

| SkipAutoProps | Don't count auto-properties as branches

ReportGenerator Installation

Install ReportGenerator as a local tool for generating HTML reports with Risk Hotspots.

Add to .config/dotnet-tools.json

{
  "version": 1,
  "isRoot": true,
  "tools": {
    "dotnet-reportgenerator-globaltool": {
      "version": "5.4.5",
      "commands": ["reportgenerator"],
      "rollForward": false
    }
  }
}

Then restore:

dotnet tool restore

Or Install Globally

dotnet tool install --global dotnet-reportgenerator-globaltool

Collecting Coverage

Run Tests with Coverage Collection

# Clean previous results
rm -rf coverage/ TestResults/

# Run unit tests with coverage
dotnet test tests/MyApp.Tests.Unit \
  --settings coverage.runsettings \
  --collect:"XPlat Code Coverage" \
  --results-directory ./TestResults

# Run integration tests (optional, adds to coverage)
dotnet test tests/MyApp.Tests.Integration \
  --settings coverage.runsettings \
  --collect:"XPlat Code Coverage" \
  --results-directory ./TestResults

Generate HTML Report

dotnet reportgenerator \
  -reports:"TestResults/**/coverage.opencover.xml" \
  -targetdir:"coverage" \
  -reporttypes:"Html;TextSummary;MarkdownSummaryGithub"

Report Types

| Html | Full interactive report | coverage/index.html

| TextSummary | Plain text summary | coverage/Summary.txt

| MarkdownSummaryGithub | GitHub-compatible markdown | coverage/SummaryGithub.md

| Badges | SVG badges for README | coverage/badge_*.svg

| Cobertura | Merged Cobertura XML | coverage/Cobertura.xml

Reading the Report

Risk Hotspots Section

The HTML report includes a Risk Hotspots section showing methods sorted by complexity:

  • Cyclomatic Complexity: Number of independent paths through code (if/else, switch cases, loops)

  • NPath Complexity: Number of acyclic execution paths (exponential growth with nesting)

  • Crap Score: Calculated from complexity and coverage

Interpreting Results

Risk Hotspots
─────────────
Method                          Complexity  Coverage  Crap Score
──────────────────────────────────────────────────────────────────
DataImporter.ParseRecord()      54          52%       12.4
AuthService.ValidateToken()     32          0%        32.0   ← HIGH RISK
OrderProcessor.Calculate()      28          85%       1.3
UserService.CreateUser()        15          100%      0.0

Action items:

  • ValidateToken() has CRAP > 30 with 0% coverage - test immediately or refactor

  • ParseRecord() is complex but has decent coverage - acceptable

  • CreateUser() and Calculate() are well-tested - safe to modify

Coverage Thresholds

| Line Coverage | > 80% | Good for most projects

| Branch Coverage | > 60% | Catches conditional logic

| CRAP Score | < 30 | Maximum for new code

Configuring Thresholds

Create coverage.props in your repository:

<Project>
  <PropertyGroup>
    <!-- Coverage thresholds for CI enforcement -->
    <CoverageThresholdLine>80</CoverageThresholdLine>
    <CoverageThresholdBranch>60</CoverageThresholdBranch>
  </PropertyGroup>
</Project>

CI/CD Integration

GitHub Actions

name: Coverage

on:
  pull_request:
    branches: [main, dev]

jobs:
  coverage:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4

      - name: Setup .NET
        uses: actions/setup-dotnet@v4
        with:
          dotnet-version: '9.0.x'

      - name: Restore tools
        run: dotnet tool restore

      - name: Run tests with coverage
        run: |
          dotnet test \
            --settings coverage.runsettings \
            --collect:"XPlat Code Coverage" \
            --results-directory ./TestResults

      - name: Generate report
        run: |
          dotnet reportgenerator \
            -reports:"TestResults/**/coverage.opencover.xml" \
            -targetdir:"coverage" \
            -reporttypes:"Html;MarkdownSummaryGithub;Cobertura"

      - name: Upload coverage report
        uses: actions/upload-artifact@v4
        with:
          name: coverage-report
          path: coverage/

      - name: Add coverage to PR
        uses: marocchino/sticky-pull-request-comment@v2
        with:
          path: coverage/SummaryGithub.md

Azure Pipelines

- task: DotNetCoreCLI@2
  displayName: 'Run tests with coverage'
  inputs:
    command: 'test'
    arguments: '--settings coverage.runsettings --collect:"XPlat Code Coverage" --results-directory $(Build.SourcesDirectory)/TestResults'

- task: DotNetCoreCLI@2
  displayName: 'Generate coverage report'
  inputs:
    command: 'custom'
    custom: 'reportgenerator'
    arguments: '-reports:"$(Build.SourcesDirectory)/TestResults/**/coverage.opencover.xml" -targetdir:"$(Build.SourcesDirectory)/coverage" -reporttypes:"HtmlInline_AzurePipelines;Cobertura"'

- task: PublishCodeCoverageResults@2
  displayName: 'Publish coverage'
  inputs:
    codeCoverageTool: 'Cobertura'
    summaryFileLocation: '$(Build.SourcesDirectory)/coverage/Cobertura.xml'

Quick Reference

One-Liner Commands

# Full analysis workflow
rm -rf coverage/ TestResults/ && \
dotnet test --settings coverage.runsettings \
  --collect:"XPlat Code Coverage" \
  --results-directory ./TestResults && \
dotnet reportgenerator \
  -reports:"TestResults/**/coverage.opencover.xml" \
  -targetdir:"coverage" \
  -reporttypes:"Html;TextSummary"

# View summary
cat coverage/Summary.txt

# Open HTML report (Linux)
xdg-open coverage/index.html

# Open HTML report (macOS)
open coverage/index.html

# Open HTML report (Windows)
start coverage/index.html

Project Standards

| Line Coverage | 80%+ | 60%+ (improve gradually)

| Branch Coverage | 60%+ | 40%+ (improve gradually)

| Maximum CRAP | 30 | Document exceptions

| High-risk methods | Must have tests | Add tests before modifying

What Gets Excluded

The recommended coverage.runsettings excludes:

| [*.Tests]* | Test assemblies aren't production code

| [*.Benchmark]* | Benchmark projects

| [*.Migrations]* | Database migrations (generated)

| GeneratedCodeAttribute | Source generators

| CompilerGeneratedAttribute | Compiler-generated code

| *.g.cs, *.designer.cs | Generated files

| SkipAutoProps | Auto-properties (trivial branches)

When to Update Thresholds

Lower thresholds temporarily for:

  • Legacy codebases being modernized (document in README)

  • Generated code that can't be modified

  • Third-party wrapper code

Never lower thresholds for:

  • "It's too hard to test" - refactor instead

  • "We'll add tests later" - add them now

  • New features - should meet standards from the start

Additional Resources

← 返回排行榜