Tests

chore: use confluent kafka image for tests #275

Workflow file for this run

.github/workflows/validate.yml at c906451

	name: Tests
	on:
	pull_request:
	branches: ['**']
	merge_group:
	branches: [main]
	push:
	branches: [main]
	concurrency:
	group: ${{ github.workflow }}-${{ github.event.number \|\| github.ref }}
	cancel-in-progress: true

	permissions: read-all

	env:
	# Make sure we're actually testing with the intended Go release (i.e, ensure
	# no automatic toolchain download happens).
	GOTOOLCHAIN: local

	jobs:
	##############################################################################
	# Run all the code generators; and refresh the LICENSES-3rdparty.csv file
	generate:
	needs: coverage-preflight
	runs-on: ubuntu-latest
	name: Run all generators
	outputs:
	has-patch: ${{ steps.is-tree-dirty.outputs.result }}
	steps:
	- name: Checkout
	uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
	- name: Setup go
	id: setup-go
	uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # v5
	with:
	go-version: stable
	cache-dependency-path: '**/go.mod'

	- name: Run 'go generate ./...'
	run: \|-
	mkdir -p ${GOCOVERDIR}
	go generate ./...
	go -C _integration-tests generate -tags=integration ./...
	env:
	GOFLAGS: -cover -covermode=atomic -coverpkg=github.com/DataDog/orchestrion/...,./...
	GOCOVERDIR: ${{ github.workspace }}/coverage
	- name: Consolidate coverage report
	if: github.event_name != 'merge_group'
	run: go tool covdata textfmt -i ./coverage -o ./coverage/generator.out
	- name: Determine simple go version
	if: github.event_name != 'merge_group'
	id: go
	run: \|-
	set -euo pipefail
	echo "version=$(echo '${{ steps.setup-go.outputs.go-version }}' \| cut -d'.' -f1,2)" >> "${GITHUB_OUTPUT}"
	- name: Upload coverage report
	if: github.event_name != 'merge_group'
	uses: ./.github/actions/codecov-upload
	with:
	name: Generators
	files: ./coverage/generator.out
	flags: \|-
	generator
	go${{ steps.go.outputs.version }}
	${{ runner.os }}
	${{ runner.arch }}
	token: ${{ secrets.CODECOV_TOKEN }}
	- name: Run 'go mod tidy'
	# Don't run for push, it's not necessary
	if: github.event_name != 'push'
	run: find . -iname go.mod -execdir go mod tidy \;

	- name: Refresh LICENSE-3rdparty.csv
	run: ./tools/make-licenses.sh
	env:
	TMPDIR: ${{ runner.temp }}

	- name: Check if working tree is dirty
	# Don't run for push, it's not necessary
	if: github.event_name != 'push'
	id: is-tree-dirty
	run: \|-
	set -euxo pipefail
	git add .
	git status
	git diff --staged --patch --exit-code > .repo.patch \|\| echo 'result=true' >> "${GITHUB_OUTPUT}"
	- name: Upload patch
	if: github.event_name != 'push' && steps.is-tree-dirty.outputs.result == 'true'
	uses: actions/upload-artifact@50769540e7f4bd5e21e526ee35c689e35e0d6874 # v4
	with:
	if-no-files-found: error
	include-hidden-files: true
	name: repo.patch
	path: .repo.patch
	- name: Fail build if working tree is dirty
	if: github.event_name == 'push' && steps.is-tree-dirty.outputs.result == 'true'
	run: \|-
	echo "::error::Files have been modified by 'go generate ./...' (see logs)."
	cat .repo.patch
	exit 1
	##############################################################################
	# If the generators changed anything, and we can update the PR, then we'll
	# proactively do it with the mutator token.
	self-mutation:
	needs: generate
	runs-on: ubuntu-latest
	name: Update PR with generated files
	if: always() && needs.generate.outputs.has-patch == 'true' && github.event_name == 'pull_request' && (github.event.pull_request.head.repo.full_name == github.repository \|\| github.event.pull_request.maintainer_can_modify)
	steps:
	- name: Checkout
	uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
	with:
	ref: ${{ github.event.pull_request.head.ref }}
	repository: ${{ github.event.pull_request.head.repo.full_name }}
	- name: Download patch
	uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4
	with:
	name: repo.patch
	path: ${{ runner.temp }}
	- name: Apply patch
	run: \|-
	[ -s '${{ runner.temp }}/.repo.patch' ] && git apply '${{ runner.temp }}/.repo.patch' \|\| echo 'Empty patch. Skipping.'
	# We use ghcommit to create signed commits directly using the GitHub API
	- name: Push changes
	uses: planetscale/ghcommit-action@88c53665a0c85bc370b410610f2bcf1979204651 # v0.1.45
	with:
	commit_message: "chore: update generated files"
	repo: ${{ github.event.pull_request.head.repo.full_name }}
	branch: ${{ github.event.pull_request.head.ref }}
	env:
	GITHUB_TOKEN: ${{ secrets.MUTATOR_GITHUB_TOKEN }}

	##############################################################################
	# Run the various linters we have set up...
	lint:
	needs: generate
	runs-on: ubuntu-latest
	name: Go Linters
	steps:
	- name: Checkout
	uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
	- name: Setup go
	uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # v5
	with:
	go-version: stable
	cache-dependency-path: "**/go.mod"
	- name: Lint main module
	uses: golangci/golangci-lint-action@aaa42aa0628b4ae2578232a66b541047968fac86 # v6
	with:
	version: v1.60.3
	- name: Lint integration tests
	uses: golangci/golangci-lint-action@aaa42aa0628b4ae2578232a66b541047968fac86 # v6
	with:
	version: v1.60.3
	working-directory: _integration-tests
	- name: Verify license headers
	run: go run tools/headercheck/header_check.go
	- name: vet
	run: go vet ./...

	##############################################################################
	# Verify all GitHub workflows have hash-pinned actions
	lint-workflows:
	runs-on: ubuntu-latest
	name: GitHub Workflow Linters
	steps:
	- name: Checkout
	uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
	- name: Ensure SHA pinned actions
	uses: zgosalvez/github-actions-ensure-sha-pinned-actions@0901cf7b71c7ea6261ec69a3dc2bd3f9264f893e # v3

	##############################################################################
	# Run all unit tests with coverage enabled
	unit-tests:
	needs: generate
	runs-on: ubuntu-latest
	strategy:
	fail-fast: false
	matrix:
	go-version: [oldstable, stable]
	name: Unit tests (go ${{ matrix.go-version }})
	steps:
	- name: Checkout
	uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
	- name: Setup Go
	id: setup-go
	uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # v5
	with:
	go-version: ${{ matrix.go-version }}
	cache-dependency-path: "**/go.mod"
	- name: Run unit tests
	shell: bash
	run: \|-
	mkdir -p coverage
	test_args=("-shuffle=on" "-race" "-v")
	if [ "${{ github.event_name }}" != "merge_group" ]; then
	test_args+=("-cover" "-covermode=atomic" "-coverpkg=./...,github.com/DataDog/orchestrion/..." "-coverprofile=${{ github.workspace }}/coverage/unit.out")
	fi
	go test "${test_args[@]}" ./...
	- name: Run integraton suite unit tests
	shell: bash
	run: \|-
	mkdir -p coverage
	test_args=("-shuffle=on" "-race" "-v")
	if [ "${{ github.event_name }}" != "merge_group" ]; then
	test_args+=("-cover" "-covermode=atomic" "-coverpkg=./...,github.com/DataDog/orchestrion/..." "-coverprofile=${{ github.workspace }}/coverage/integration.out")
	fi
	go -C _integration-tests test "${test_args[@]}" ./...
	- name: Determine simple go version
	if: github.event_name != 'merge_group'
	id: go
	shell: bash
	run: \|-
	set -euo pipefail
	echo "version=$(echo '${{ steps.setup-go.outputs.go-version }}' \| cut -d'.' -f1,2)" >> "${GITHUB_OUTPUT}"
	- name: Upload coverage report
	if: github.event_name != 'merge_group'
	uses: ./.github/actions/codecov-upload
	with:
	name: Unit Tests (go${{ steps.go.outputs.version }}, ${{ runner.os }}, ${{ runner.arch }})
	files: \|-
	./coverage/unit.out
	./coverage/integration.out
	flags: \|-
	unit
	go${{ steps.go.outputs.version }}
	${{ runner.os }}
	${{ runner.arch }}
	token: ${{ secrets.CODECOV_TOKEN }}

	##############################################################################
	# Run all integration tests and gather extensive coverage
	integration-tests:
	needs: generate
	strategy:
	fail-fast: false
	matrix:
	runs-on: [macos, ubuntu, windows]
	go-version: [oldstable, stable]
	build-mode: [DRIVER]
	include:
	# Alternate build modes (only on ubuntu, latest go; to save CI time)
	- runs-on: ubuntu
	go-version: oldstable
	build-mode: TOOLEXEC
	- runs-on: ubuntu
	go-version: oldstable
	build-mode: GOFLAGS
	runs-on: ${{ matrix.runs-on }}-latest
	name: Integration tests (go ${{ matrix.go-version }}, ${{ matrix.runs-on }}, ${{ matrix.build-mode }})
	steps:
	- name: Checkout
	uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
	- name: Setup go
	id: setup-go
	uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # v5
	with:
	go-version: ${{ matrix.go-version }}
	cache-dependency-path: "**/go.mod"
	- name: Setup python
	uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5
	with:
	python-version: 3.x
	cache: pip
	cache-dependency-path: _integration-tests/utils/agent/requirements.txt
	- name: Install python dependencies
	run: pip install -r _integration-tests/utils/agent/requirements.txt
	- name: Build orchestrion binary
	shell: bash
	run: \|-
	build_args=()
	if [ "${{ github.event_name }}" != "merge_group" ]; then
	build_args+=("-cover" "-covermode=atomic" "-coverpkg=./...")
	fi
	go build ${build_args[@]+"${build_args[@]}"} -o="bin/orchestrion.exe" .
	- name: Run Integration Tests
	shell: bash
	run: \|-
	mkdir -p "${GOCOVERDIR}"
	test_args=("-shuffle=on" "-v")
	if [ "${{ github.event_name }}" != "merge_group" ]; then
	test_args+=("-coverpkg=./...,github.com/DataDog/orchestrion/..." "-covermode=atomic" "-cover" "-coverprofile=${{ github.workspace }}/coverage/integration.run.out")
	fi

	case "${{ matrix.build-mode }}" in
	"DRIVER")
	bin/orchestrion.exe go -C=_integration-tests test "${test_args[@]}" -a ./...
	;;
	"TOOLEXEC")
	go -C=_integration-tests test "${test_args[@]}" -toolexec="${{ github.workspace }}/bin/orchestrion.exe toolexec" ./...
	;;
	"GOFLAGS")
	export GOFLAGS="'-toolexec=${{ github.workspace }}/bin/orchestrion.exe toolexec' ${GOFLAGS}"
	go -C=_integration-tests test "${test_args[@]}" ./...
	;;
	*)
	echo "Unknown build mode: ${{ matrix.build-mode }}"
	exit 1
	;;
	esac
	env:
	GOCOVERDIR: ${{ github.workspace }}/coverage/raw
	GOFLAGS: -tags=integration,buildtag # Globally set build tags (buildtag is used by the dd-span test)
	- name: Consolidate coverage report
	if: github.event_name != 'merge_group'
	run: go tool covdata textfmt -i ./coverage/raw -o ./coverage/integration.out
	- name: Determine go minor version
	id: go
	if: github.event_name != 'merge_group'
	shell: bash
	run: \|-
	set -euo pipefail
	echo "version=$(echo '${{ steps.setup-go.outputs.go-version }}' \| cut -d'.' -f1,2)" >> "${GITHUB_OUTPUT}"
	- name: Upload coverage report
	if: github.event_name != 'merge_group'
	uses: ./.github/actions/codecov-upload
	with:
	name: Integration Tests (${{ matrix.build-mode }}, go${{ steps.go.outputs.version }}, ${{ runner.os }}, ${{ runner.arch }})
	files: \|-
	./coverage/integration.out
	./coverage/integration.run.out
	flags: \|-
	integration
	${{ matrix.build-mode }}
	go${{ steps.go.outputs.version }}
	${{ runner.os }}
	${{ runner.arch }}
	token: ${{ secrets.CODECOV_TOKEN }}

	##############################################################################
	# Assert everything is complete. This simplifies branch protection settings
	# and allows us to have one single trigger for CodeCov reporting.
	complete:
	runs-on: ubuntu-latest
	name: Complete
	needs:
	- generate
	- lint
	- lint-workflows
	- unit-tests
	- integration-tests
	if: '!cancelled()'
	steps:
	- name: Success
	if: needs.generate.result != 'failure' && needs.lint.result != 'failure' && needs.lint-workflows.result != 'failure' && needs.unit-tests.result != 'failure' && needs.integration-tests.result != 'failure'
	run: echo "OK"
	- name: Failed
	if: needs.generate.result == 'failure' \|\| needs.lint.result == 'failure' \|\| needs.lint-workflows.result == 'failure' \|\| needs.unit-tests.result == 'failure' \|\| needs.integration-tests.result == 'failure'
	run: \|-
	echo "Failed!"
	exit 1

	##############################################################################
	# Produce a CodeCov coverage report with all uploaded code coverage data.
	coverage-preflight:
	runs-on: ubuntu-latest
	name: CodeCov pre-flight
	if: github.event_name != 'merge_group'
	steps:
	- name: Checkout
	uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
	- name: Download codecov CLI
	id: codecov-cli
	uses: ./.github/actions/codecov-cli
	- name: Register commit with CodeCov
	shell: bash
	env:
	CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
	run: \|-
	set -euo pipefail

	pr=()
	sha="${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha \|\| github.sha }}"
	parentsha="${{ github.event_name == 'pull_request' && github.event.pull_request.base.sha \|\| github.event.before }}"
	if [ "${{ github.event_name }}" == "pull_request" ]; then
	pr+=("--pr=${{ github.event.number }}")
	fi

	echo "::group::Register commit metadata with CodeCov"
	${{ steps.codecov-cli.outputs.codecov }} \
	--auto-load-params-from=GithubActions \
	--verbose \
	create-commit \
	--parent-sha="${parentsha}" \
	${pr[@]+"${pr[@]}"} \
	--sha="${sha}" \
	--fail-on-error \
	--git-service=github \
	--token="${CODECOV_TOKEN}" \
	--slug="${{ github.repository }}"
	echo "::endgroup::"

	echo "::group::Create a new blank CodeCov report"
	${{ steps.codecov-cli.outputs.codecov }} \
	--auto-load-params-from=GithubActions \
	--verbose \
	create-report \
	${pr[@]+"${pr[@]}"} \
	--sha="${sha}" \
	--fail-on-error \
	--git-service=github \
	--token="${CODECOV_TOKEN}" \
	--slug="${{ github.repository }}"
	echo "::endgroup::"
	coverage-finalize:
	runs-on: ubuntu-latest
	name: Create CodeCov report
	needs:
	- coverage-preflight
	- unit-tests
	- integration-tests
	if: github.event_name != 'merge_group'
	steps:
	- name: Checkout
	uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4
	- name: Download codecov CLI
	id: codecov-cli
	uses: ./.github/actions/codecov-cli
	- name: Create CodeCov report
	shell: bash
	env:
	CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
	run: \|-
	set -euo pipefail
	sha="${{ github.event_name == 'pull_request' && github.event.pull_request.head.sha \|\| github.sha }}"

	echo "::group::Create CodeCov report results"
	${{ steps.codecov-cli.outputs.codecov }} \
	--auto-load-params-from=GithubActions \
	--verbose \
	create-report-results \
	--sha="${sha}" \
	--fail-on-error \
	--git-service=github \
	--token="${CODECOV_TOKEN}" \
	--slug="${{ github.repository }}"
	echo "::endgroup::"

	echo "::group::Issue GitHub notifications"
	${{ steps.codecov-cli.outputs.codecov }} \
	--auto-load-params-from=GithubActions \
	--verbose \
	send-notifications \
	--sha="${sha}" \
	--fail-on-error \
	--git-service=github \
	--token="${CODECOV_TOKEN}" \
	--slug=${{ github.repository }}
	echo "::endgroup::"

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: use confluent kafka image for tests #275

Workflow file

chore: use confluent kafka image for tests #275

Jobs

Run details

Workflow file for this run