Başlarken

TestDetta branch'inizi base'iyle karşılaştırır, hangi test projelerinin ve hangi test sınıflarının değişikliği gözlemleyebileceğini belirler ve yalnızca onları çalıştırır. Emin olamadığında daha fazlasını çalıştırır, asla daha azını değil; göremedikleri Sınırlamalar altında listelenir.

Gereksinimler

Hızlı başlangıç

GitHub Actions

GitHub Action, sabitlediği TestDetta paketini nuget.org'dan indirir ve çalıştırmadan önce SHA-512'sini kontrol eder; kurmanız gereken bir şey yok. Bu workflow'u ekleyin, örneğin .github/workflows/tests.yml olarak: varsayılan branch'inize yapılan push'larda bir kapsam haritası kaydeder, pull request'lerde yalnızca etkilenen testleri çalıştırır.

on:
  push:
    branches: [main]
  pull_request:

permissions:
  contents: read
  actions: read # lets pull requests find the newest coverage map in the Actions cache

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7 # pin to a commit SHA
        with:
          fetch-depth: 0 # TestDetta compares with the merge base
          persist-credentials: false

      - uses: actions/setup-dotnet@v6 # pin to a commit SHA
        with:
          global-json-file: global.json # without a global.json: dotnet-version: 10.0.x

      - if: github.event_name == 'push'
        uses: TestDetta/action@8750db18099a2af0436788d20dc591e94b550c07 # v0.5.2
        with:
          mode: record

      - if: github.event_name == 'pull_request'
        uses: TestDetta/action@8750db18099a2af0436788d20dc591e94b550c07 # v0.5.2
        with:
          mode: test

Önce workflow'u merge edin: varsayılan branch'e yapılan ilk push ilk haritayı kaydeder. O zamana kadar ve merge base'i ilk haritadan eski olan pull request'lerde mode: test yalnızca isimlere göre seçer; bu güvenlidir ama daha fazlasını seçer. Böyle bir pull request, varsayılan branch'i merge ettiğinde ya da onun üzerine rebase edildiğinde isabetli hale gelir. İzinler, tüm girdiler ve diğer modlar GitHub Actions sayfasında.

Diğer CI sistemleri

GitLab CI, Jenkins, Azure DevOps, Bitbucket ve şirket içi kurulumlar aynı iki komutu çalıştırır; commit başına kapsam haritalarını içeren bir klasör (--maps-dir) paylaşılan bir diskte ya da nesne depolamada tutulur. TestDetta'yı bir .NET aracı olarak kurun:

dotnet tool install --global TestDetta --version 0.5.2

Her sistem için pipeline'lar Diğer CI sistemleri sayfasında.

Lisans anahtarı yok

TestDetta, Apache License 2.0 ile ücretsiz ve açık kaynaktır; açık ve özel depolarda, her CI'da ve geliştirici makinelerinde. Verilecek bir lisans anahtarı, tanımlanacak bir secret ya da açılacak bir hesap yoktur. Bkz. Lisans; kaynak kod GitHub'da.

İlk komutlar

Bunları deponuzun içinde herhangi bir yerden çalıştırın. --base varsayılan olarak origin/main'dir.

# Branch'lerinizin başladığı commit olan main üzerinde: tüm testleri kapsam ölçümüyle
# çalıştırır ve her test projesi için .testdetta/coverage altına bir harita yazar.
# Feature branch'inizin bir commit'inde kaydedilen harita kullanılmaz.
td record

# Branch'im neleri etkiliyor, neden?
td affected --base origin/main

# Yalnızca etkilenen testleri çalıştırır (dotnet test komutlarını yazdırmak için --dry-run ekleyin)
td test --base origin/main

Kapsam haritası olmadan da td test çalışır: yalnızca isimlere göre karar verir; bu güvenlidir ama daha fazlasını seçer. td record branch'inizin base'inde ya da ondan en fazla 50 commit önce çalıştıktan sonra seçim isabetli hale gelir. TestDetta 0.1.x'in kaydettiği haritalar daha eski bir biçimdedir ve siz yeniden kaydedene kadar "record the maps again" uyarısıyla yok sayılır; bkz. Sınırlamalar.

.testdetta/ klasörünü .gitignore dosyanıza ekleyin. Bu klasör kapsam haritalarını ve önbellekleri tutar; commit edilecek hiçbir şey içermez.

Komutlar

KomutNe yapar
td affected [--format text|json|paths|commands] [--tests-only] [--build]Bir değişikliğin neleri etkilediğini ve nedenini yazdırır. --tests-only yalnızca etkilenen test projelerini listeler; --build, değişen bir source generator'ı kullanan test projelerini, ürettiği kodu karşılaştırmak için derler.
td test [--dry-run] [--summary-file <path>] [-- <dotnet test args>]Yalnızca etkilenen testleri çalıştırır. --summary-file bir Markdown özeti ekler, örneğin $GITHUB_STEP_SUMMARY dosyasına. -- sonrasındaki argümanlar her dotnet test çağrısına iletilir, örneğin -- -c Release.
td test --shadow [--shadow-no-classify] [--shadow-report <path>] [-- <dotnet test args>]Shadow mode: kendi dotnet test argümanlarınızın çalıştırdığı her testi çalıştırır ve seçimin neleri dışarıda bırakacağını raporlar; dışarıda bırakacağı her başarısız sınıfı, bir kaçırmayı kararsız ya da önceden var olan bir başarısızlıktan ayırmak için yeniden çalıştırır. Çıkış kodu tam çalıştırmanınkidir. Testing platform projeleri önce derlenmeli ve --no-build verilmelidir. Bkz. --shadow.
td record [--project <csproj>]... [-c <configuration>] [-f <tfm>] [--parallel <n>] [--no-build] [-- <dotnet test args>]Tüm testleri kapsam ölçümüyle çalıştırır ve her test projesi için .testdetta/coverage altına bir harita yazar. --parallel her projenin test sınıflarını n test sürecine dağıtır; --no-build aynı yapılandırmayla yapılmış önceki bir derlemenin çıktısını kaydeder. -- sonrasındaki argümanlar (filtreniz, ayarlarınız) kayıt sırasında korunur; bkz. Test yapılandırmanız.
td audit [--target-broken <n>] [--max-mutants <n>] [--budget <time>] [--parallel <n>] [--member <Type.Member>]... [-- <dotnet test args>]Seçimi kendi kodunuzda kontrol eder: çalışma ağacının bir kopyasında üyeleri birer birer bozar, her değişikliği görebilen her testi çalıştırır ve seçimin dışarıda bıraktığı her başarısız sınıfı raporlar. Bkz. td audit.

Ortak seçenekler

SeçenekAnlamı
--base <ref>Karşılaştırılacak git ref'i. Varsayılan: origin/main.
--repo <path>Depo içindeki herhangi bir yol. Varsayılan: geçerli dizin.
--max-map-age <n>Merge base'den en fazla n commit önce kaydedilmiş kapsam haritalarını kullanır ve aradaki değişiklikleri köprüler. Varsayılan: 50; 0 yalnızca tam eşleşen haritaları kullanır. Bkz. Nasıl karar verir.
--maps-dir <dir>Depo dışında, commit başına bir klasör olarak tutulan kapsam haritaları: record oraya kaydeder, affected, test ve audit ise --max-map-age sınırı içindeki en yenisini geri yükler. GitHub Actions dışındaki CI sistemleri için.
--drift-fallback <all|name>Daha eski bir haritadan bu yana yapılan değişiklikler bir derleme dosyası, yapılandırma ya da global using içerdiğinde: etkilenen test projelerini tamamen çalıştırır (all, varsayılan) ya da isimlere göre karar verir (name).
--non-code-files <readers|project>Bir proje klasöründe kod olmayan değişen bir dosyanın (README.md, bir JSON dosyası) neyi çalıştıracağı: readers (varsayılan), derleme dosyayı kullanmıyorsa yalnızca kapsam haritasının onu okuduğunu gördüğü test sınıflarını çalıştırır; project dosyanın projesini ve ona bağlı her projeyi tamamen çalıştırır. Bkz. --non-code-files.
--not-build-inputs <patterns>Derlemenizin kullanmadığı kod olmayan dosyalar (docs/**;*.yaml): doküman dosyaları gibi, yalnızca kesin bir işaretle derleme girdisi sayılır, tahminle asla. Bkz. --not-build-inputs.
-v, --verboseDebug loglarını stderr'e yazar: kullanıcının sorgulayabileceği her karar, gerekçesiyle birlikte.
--log-level <level>trace, debug, information, warning (varsayılan), error ya da none.
--color <when>auto (varsayılan: terminal ya da GitHub Actions logu; NO_COLOR kapatır), always ya da never. JSON hiçbir zaman renklenmez.
--theme <name>default, colorblind (yeşil ve kırmızı yerine mavi ve sarı) ya da mono. TESTDETTA_THEME ile de seçilir.

Loglar stderr'e gider; stdout komutun çıktısını taşır ve makine tarafından okunabilir kalır.

Çıkış kodları

KodAnlamı
0Başarılı.
1Analiz başarısız oldu (td audit: çalışamadı ya da iptal edildi; td test --shadow: testler çalışmadan önce iptal edildi).
2Geçersiz komut satırı.
3Testler başarısız oldu (td test, td test --shadow'un tam çalıştırması, td record); bir kaçırma (td audit).