Diğer CI sistemleri

TestDetta, .NET ve git çalıştıran her CI'da çalışır. GitHub Actions dışında iki komut ve bir klasör işi görür.

<maps> sıradan bir klasördür. Onu CI'ınızın pipeline'lar arasında dosya tutabildiği herhangi bir yerde saklayın:

TestDetta'nın kendisi haritalar için hiçbir zaman ağı kullanmaz.

Her kurulumun ihtiyaç duydukları

Kurulum

dotnet tool install --global TestDetta --version 0.5.2
export PATH="$PATH:$HOME/.dotnet/tools"

TestDetta .NET 10 SDK üzerinde çalışır; testlerinizin de bugün kullandıkları SDK ve runtime'lara ihtiyacı vardır. GitHub Action'ın paketini sabitlediği gibi sürümü sabitleyin. Global bir araç ~/.dotnet/tools altına kurulur; barındırılan (hosted) runner'lar ve .NET SDK container imajları bu klasörü PATH'e eklemez, bu yüzden aşağıdaki her örnek onu ekler. Zaten kurulu olan bir sürümü kurmak hiçbir şey yapmaz; kalıcı agent'lar da aynı satırları çalıştırabilir.

GitLab CI

default:
  image: mcr.microsoft.com/dotnet/sdk:10.0   # td runs on .NET 10; use an image that also has your tests' runtimes
  before_script:
    - dotnet tool install --global TestDetta --version 0.5.2
    - export PATH="$PATH:$HOME/.dotnet/tools"

variables:
  GIT_DEPTH: "0"                    # full history
  TESTDETTA_MAPS: /srv/testdetta-maps/$CI_PROJECT_PATH   # a disk the runners share; or sync with object storage

record-coverage:
  stage: test
  rules:
    - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
  script:
    - td record --maps-dir "$TESTDETTA_MAPS"

affected-tests:
  stage: test
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
  script:
    - git fetch --no-tags origin "+refs/heads/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME:refs/remotes/origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME"
    - td test --base "origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME" --maps-dir "$TESTDETTA_MAPS" --summary-file testdetta-summary.md
  artifacts:
    when: always
    paths: [testdetta-summary.md]

Jenkins

Bildirimsel (declarative) bir multibranch pipeline:

pipeline {
  agent any
  environment {
    TESTDETTA_MAPS = "/srv/testdetta-maps/${env.JOB_NAME.split('/')[0]}"
  }
  options { skipDefaultCheckout() }
  stages {
    stage('Checkout') {
      steps {
        checkout scmGit(branches: scm.branches, userRemoteConfigs: scm.userRemoteConfigs,
                        extensions: [cloneOption(shallow: false, depth: 0, noTags: true, reference: '')])
      }
    }
    stage('Record coverage') {
      when { branch 'main' }
      steps {
        sh '''
          dotnet tool install --global TestDetta --version 0.5.2
          export PATH="$PATH:$HOME/.dotnet/tools"
          td record --maps-dir "$TESTDETTA_MAPS"
        '''
      }
    }
    stage('Affected tests') {
      when { changeRequest() }
      steps {
        withCredentials([gitUsernamePassword(credentialsId: 'git-credentials')]) {   // the credential your checkout uses
          sh 'git fetch --no-tags origin "+refs/heads/$CHANGE_TARGET:refs/remotes/origin/$CHANGE_TARGET"'
        }
        sh '''
          dotnet tool install --global TestDetta --version 0.5.2
          export PATH="$PATH:$HOME/.dotnet/tools"
          td test --base "origin/$CHANGE_TARGET" --maps-dir "$TESTDETTA_MAPS"
        '''
      }
    }
  }
}

Agent'ta .NET 10 SDK bulunmalıdır. Checkout'un kimlik bilgileri sonraki adımlar için saklanmaz; bu yüzden özel bir depoda git fetch, Git eklentisinin gitUsernamePassword bağlamasıyla withCredentials içinde çalışır; checkout'unuzun kullandığı kimlik bilgisini belirtin.

Azure DevOps Pipelines

trigger: [main]
pr: [main]

variables:
  TESTDETTA_MAPS: /srv/testdetta-maps/$(Build.Repository.Name)   # a share the agents mount; or sync with object storage

steps:
  - checkout: self
    fetchDepth: 0
    persistCredentials: true            # lets the git fetch below reach a private repository
  - task: UseDotNet@2
    inputs:
      version: 10.0.x                   # td runs on .NET 10; add the SDK your tests use, as in your own pipeline
  - script: |
      dotnet tool install --global TestDetta --version 0.5.2
      echo "##vso[task.prependpath]$HOME/.dotnet/tools"
  - script: td record --maps-dir "$(TESTDETTA_MAPS)"
    condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/main'))
  - script: |
      target="${SYSTEM_PULLREQUEST_TARGETBRANCH#refs/heads/}"
      git fetch --no-tags origin "+refs/heads/$target:refs/remotes/origin/$target"
      td test --base "origin/$target" --maps-dir "$(TESTDETTA_MAPS)" --summary-file "$(Agent.TempDirectory)/testdetta.md"
      echo "##vso[task.uploadsummary]$(Agent.TempDirectory)/testdetta.md"
    condition: and(succeeded(), eq(variables['Build.Reason'], 'PullRequest'))

TESTDETTA_MAPS, self-hosted agent'larda bir paylaşıma işaret eder. Microsoft-hosted agent'larda onu Azure Blob depolamayla senkronize edin (bkz. Nesne depolama).

Windows agent'ları ve PowerShell

Yukarıdaki örnekler POSIX kabuğu kullanır. Windows agent'larında (Azure DevOps, Jenkins, TeamCity ya da kendi pipeline'ınız) dist/ci/testdetta.ps1 betiğini kullanın: reponuza, örneğin build/testdetta.ps1 olarak kopyalayın. Betik sabitlenen sürümü kendi klasörüne kurar, klon sığsa (Azure DevOps varsayılan olarak sığ klonlar) tam geçmişi çeker, pull request'in hedef branch'ini Azure DevOps, Jenkins, GitLab ya da Bitbucket ortamından bulup çeker ve -- sonrasındaki her şeyi dotnet test'e geçirir. Windows PowerShell 5.1 ve PowerShell 7 ile çalışır.

.\build\testdetta.ps1 -Mode record -MapsDir \\fileserver\testdetta-maps\shop -- -c Release   # varsayılan branch
.\build\testdetta.ps1 -Mode shadow -MapsDir \\fileserver\testdetta-maps\shop -- -c Release   # değerlendirirken pull request'ler
.\build\testdetta.ps1 -Mode test   -MapsDir \\fileserver\testdetta-maps\shop -- -c Release   # sonrasında pull request'ler

Hazır pipeline'lar: haritaları pipeline önbelleğinde tutan Microsoft'un Windows agent'ında Azure DevOps ve haritaları bir paylaşımda tutan Windows agent'ında Jenkins multibranch pipeline'ı. İkisi de pull request'leri shadow mode'da başlatır: her test bugünkü gibi çalışır, rapor seçimin neyi dışarıda bırakacağını söyler.

Bitbucket Pipelines

image: mcr.microsoft.com/dotnet/sdk:10.0   # td runs on .NET 10; use an image that also has your tests' runtimes

clone:
  depth: full

pipelines:
  branches:
    main:
      - step:
          script:
            - dotnet tool install --global TestDetta --version 0.5.2
            - export PATH="$PATH:$HOME/.dotnet/tools"
            - td record --maps-dir maps
            - ./sync-maps.sh upload maps        # see "Object storage"
  pull-requests:
    '**':
      - step:
          script:
            - dotnet tool install --global TestDetta --version 0.5.2
            - export PATH="$PATH:$HOME/.dotnet/tools"
            - git fetch --no-tags origin "+refs/heads/$BITBUCKET_PR_DESTINATION_BRANCH:refs/remotes/origin/$BITBUCKET_PR_DESTINATION_BRANCH"
            - ./sync-maps.sh download maps "origin/$BITBUCKET_PR_DESTINATION_BRANCH"
            - td test --base "origin/$BITBUCKET_PR_DESTINATION_BRANCH" --maps-dir maps

sync-maps.sh, adımın imajında kendi depolama aracına, örneğin AWS CLI'a ihtiyaç duyar.

Paylaşılan disk yerine nesne depolama

Barındırılan (hosted) runner'larda paylaşılan bir disk yoktur. Kayıttan sonra yeni klasörü yükleyin. Test etmeden önce yalnızca kullanılabilecek klasörleri indirin: merge base ve ondan önceki en fazla 50 first-parent commit. Onları en yeniden başlayarak indirin ve mevcut olan ilkinde durun. S3 için bir örnek; cp ve ls komutları olan her araç aynı şekilde çalışır:

#!/usr/bin/env bash
# sync-maps.sh upload <maps>          | after td record on the default branch
# sync-maps.sh download <maps> <base> | before td test on a pull request
set -euo pipefail
remote="s3://my-bucket/testdetta-maps/my-repository"
case "$1" in
  upload)
    aws s3 cp --recursive "$2/$(git rev-parse HEAD)" "$remote/$(git rev-parse HEAD)" ;;
  download)
    for sha in $(git rev-list --first-parent -n 51 "$(git merge-base "$3" HEAD)"); do
      if aws s3 ls "$remote/$sha/" > /dev/null 2>&1; then
        aws s3 cp --recursive "$remote/$sha" "$2/$sha"
        break
      fi
    done ;;
esac

Harita olmadığında

Kurulumdan sonraki ilk pull request'ler ya da çok geride kalanlar, erişilebilir mesafede bir harita bulamaz. TestDetta bu durumda yalnızca isimlere göre seçer; bu güvenlidir ama daha fazlasını seçer ve bunu logunda belirtir. td record varsayılan branch'te çalıştıktan sonra seçim isabetli hale gelir. Önce kayıt job'unu kurun: varsayılan branch'teki ilk çalışması ilk haritayı yazar; merge base'i bu haritadan eski olan pull ya da merge request'ler, hedef branch'i merge edene ya da onun üzerine rebase edilene kadar isimlere göre seçer.

Daha eski bir biçimdeki haritalar, örneğin TestDetta 0.1.x'in kaydettikleri, varsayılan branch yeniden kaydedene kadar "record the maps again" uyarısıyla yok sayılır; bkz. Sınırlamalar.