⚠️ Migrate scaffolding of v3 / v4-alpha to ginkgo v2

[jakobmoellerdev]

This PR is updating the v3 and v4-alpha plugins to use ginkgo v2. It purposefully does not introduce ginkgo cli as most options can be added onto go test instead. It is a follow up for #2532

Currently it does not use the NewLineReporter from the old scaffolding, but it can be manually added back (it is not recommended to do so by Ginkgo but possible with a custom hook into the rpeorting lifecycle). If this is wanted we can add docs on how to do that.

Currently the scaffolding does not automatically do this and people can manually add it.

[k8s-ci-robot]

Hi @jakobmoellersap. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[camilamacedo86]

/ok-to-test

[jakobmoellerdev]

@camilamacedo86

In the upstream controller-runtime PR, there is also a junit-aggregation logic in https://github.com/kubernetes-sigs/controller-runtime/pull/1977/files#diff-ab3c2c731b5083def78d27378838304f494f0ae5dec7bcf2339e1da30a9bf6d0R28 . we could achieve the same with a script that aggregates all junit-report.xml files generated with the -ginkgo.junit-report=junit-report.xml flag into a folder called artifacts. I was not sure if we want to include a script for this into the scaffolding for this purpose:

In Makefile we would need to modify the test target:

.PHONY: test
test: manifests generate fmt vet envtest ## Run tests.
	KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./... -coverprofile cover.out -ginkgo.junit-report=junit-report.xml
	ARTIFACTS="./artifacts" hack/aggregate-junit-reports.sh

Then in hack/aggregate-junit-reports.sh we would create a small script for the aggregation:

#!/usr/bin/env bash

set -e

if [[ -n ${ARTIFACTS:-} ]]; then
  mkdir -p "${ARTIFACTS}"
fi

find . -name '*junit-report.xml' -print0 | while IFS= read -r -d '' file
do
  ((count++))
  new_file=${file#./}
  new_file=${new_file%/junit-report.xml}
  new_file=${new_file//"/"/"-"}
  mv "$file" "$ARTIFACTS/junit_${new_file}.xml"
  echo "aggregated $file to $ARTIFACTS/junit_${new_file}.xml"
done

[camilamacedo86]

The changes show fine.
Great work 🥇

I am looking on your comments.

[camilamacedo86]

Hi @jakobmoellersap,

Regaads #2939 (comment) it seems out of the scope right? I think we do not need this aggregation by default either.

Also, I am not sure about we add another sh hack/aggregate-junit-reports.sh scaffolded for that.
we might could doc this option as helper for those that would like to have that. WDYT?
What about we add the steps/options in : https://book.kubebuilder.io/reference/makefile-helpers.html ?

Regards the changes on this PR all show fine for we move forward.

/approved

[everettraven]

Just a minor typo in the docs. Other than that looks great! Once the typo is fixed I'll approve and LGTM.

[everettraven]

/label tide/merge-method-squash

[everettraven]

/lgtm

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: camilamacedo86, everettraven, jakobmoellersap

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [camilamacedo86]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment