Skip to content

Migrate Ginkgo from v1 to v2#109111

Merged
k8s-ci-robot merged 19 commits into
kubernetes:masterfrom
chendave:ginkgo_upstream
Jul 8, 2022
Merged

Migrate Ginkgo from v1 to v2#109111
k8s-ci-robot merged 19 commits into
kubernetes:masterfrom
chendave:ginkgo_upstream

Conversation

@chendave

@chendave chendave commented Mar 29, 2022 •
edited
Loading

Copy link
Copy Markdown
Member

With the GA of v2, v1 has been formally deprecated

see #109744 for some umbrella issues.

Signed-off-by: Dave Chen dave.chen@arm.com

What type of PR is this?

/kind feature

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #107936

Special notes for your reviewer:

Verified as below,

# export ACK_GINKGO_DEPRECATIONS=2.1.3
/usr/bin/e2e.test -ginkgo.focus="\[sig-network\] ClusterDns \[Feature:Example\] should create pod that uses dns" -report-dir=/var/log/kubernetes/e2e
Mar 29 22:54:28.913: INFO: The --provider flag is not set. Continuing as if --provider=skeleton had been used.
I0329 22:54:28.914153   16360 e2e.go:128] Starting e2e run "7e89c927-22d8-4e2e-9bde-e0bd1ab289a5" on Ginkgo node 0
Running Suite: Kubernetes e2e suite - /go/src/k8s.io/kubernetes
===============================================================
Random Seed: 1648565668

Will run 1 of 7371 specs
SSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSSS
------------------------------
• [SLOW TEST] [13.539 seconds]
[sig-network] ClusterDns [Feature:Example] should create pod that uses dns
test/e2e/network/example_cluster_dns.go:74
------------------------------
...
Ran 1 of 7371 Specs in 13.747 seconds
SUCCESS! -- 1 Passed | 0 Failed | 0 Pending | 7370 Skipped
PASS

Does this PR introduce a user-facing change?

End-to-end testing has been migrated from Ginkgo v1 to v2.

ACTION REQUIRED: When running test/e2e via the Ginkgo CLI, the v2 CLI must be used and `-timeout=24h` (or some other, suitable value) must be passed because the default timeout was reduced from 24h to 1h. When running it via `go test`, the corresponding `-args` parameter is `-ginkgo.timeout=24h`. To build the CLI in the Kubernetes repo, use `make all WHAT=github.com/onsi/ginkgo/v2/ginkgo`.
ACTION REQUIRED: Ginkgo V2 doesn't accept go test's `-parallel` flags to parallelize Ginkgo specs, please switch to use `ginkgo -p` or `ginkgo -procs=N` instead.

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

@k8s-ci-robot k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. area/apiserver area/cloudprovider area/code-generation labels Mar 29, 2022
@k8s-ci-robot k8s-ci-robot requested review from a team, alculquicondor and andrewsykim March 29, 2022 15:16
@k8s-ci-robot k8s-ci-robot added area/conformance Issues or PRs related to kubernetes conformance tests area/dependency Issues or PRs related to dependency changes area/e2e-test-framework Issues or PRs related to refactoring the kubernetes e2e test framework area/kubeadm area/kubectl area/network-policy Issues or PRs related to Network Policy subproject area/test sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/apps Categorizes an issue or PR as relevant to SIG Apps. sig/architecture Categorizes an issue or PR as relevant to SIG Architecture. sig/auth Categorizes an issue or PR as relevant to SIG Auth. sig/autoscaling Categorizes an issue or PR as relevant to SIG Autoscaling. sig/cli Categorizes an issue or PR as relevant to SIG CLI. sig/cloud-provider Categorizes an issue or PR as relevant to SIG Cloud Provider. sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels Mar 29, 2022
chendave and others added 5 commits July 8, 2022 10:46
@chendave @pohly
Custom reporter of Junit report is no longer needed
82ac6be 
Ginkgo is now writing the JUnit file itself. The -report-dir parameter is used
as fallback for enabling JUnit output in case that users haven't migrated to
the new -junit-report parameter.

Co-authored-by: Patrick Ohly <patrick.ohly@intel.com>
Signed-off-by: Dave Chen <dave.chen@arm.com>
@chendave @pohly
Redirect klog out to GinkgoWriter
3833695 
Co-authored-by: Patrick Ohly <patrick.ohly@intel.com>
Signed-off-by: Dave Chen <dave.chen@arm.com>
@chendave
ginkgo.By can only be used inside a runnable node
05c513d 
Signed-off-by: Dave Chen <dave.chen@arm.com>
@pohly @chendave
build: add ginkgo aliases for WHAT
f7427d0 
The alias for vendor/github.com/onsi/ginkgo/ginkgo ensures that code like
https://github.com/chendave/test-infra/blob/30e99cb2a97fdee7bb41316881cfbca91bb600db/experiment/kind-conformance-image-e2e.sh#L110
continues to work. The one without "vendor/" is there just in case that it
was used because it also worked.

Long term, "ginkgo" is a nicer, version independent alias. It gets used
internally to avoid future churn and gets documented also publicly in the
Makefile help.

The caveat is that there's no guarantee that a future v3 CLI will be compatible
with current invocations. But the most common usage is through
hack/ginkgo-e2e.sh, which can deal with such differences.
@chendave
Add Ginkgo v1 to the list of unwanted dependencies
50d1b6c 
Ginkgo has been migrated to V2, add this to unwanted dependencies
so that it won't be shown up as a dep again in the future.

Signed-off-by: Dave Chen <dave.chen@arm.com>
@chendave

chendave commented Jul 8, 2022

Copy link
Copy Markdown
Member Author

Due to latest update on master: https://github.com/kubernetes/kubernetes/pull/110805/files and https://github.com/kubernetes/kubernetes/pull/110122/files

We must rebase to master and fix the import path again, see here and there

Nothing else was updated in this push.

@dims @pohly Might you label this again?

@chendave

chendave commented Jul 8, 2022

Copy link
Copy Markdown
Member Author

/retest

@chendave

chendave commented Jul 8, 2022

Copy link
Copy Markdown
Member Author

/hold cancel

@k8s-ci-robot

k8s-ci-robot commented Jul 8, 2022

Copy link
Copy Markdown
Contributor

@chendave: The following tests failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-kubernetes-e2e-aks-engine-windows-containerd 62d38dfa2bec1fd939fbdb9c7bcfb5d5da0c6d83 link false /test pull-kubernetes-e2e-aks-engine-windows-containerd
pull-kubernetes-e2e-gci-gce-ipvs 50d1b6c link false /test pull-kubernetes-e2e-gci-gce-ipvs
pull-kubernetes-e2e-gce-storage-snapshot 50d1b6c link false /test pull-kubernetes-e2e-gce-storage-snapshot

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Details

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. I understand the commands that are listed here.

@pohly

pohly commented Jul 8, 2022

Copy link
Copy Markdown
Contributor

/lgtm

@nilo19 nilo19 mentioned this pull request Jul 9, 2022
Closed
@aojea

aojea commented Jul 10, 2022

Copy link
Copy Markdown
Member

sorry for missing the pings, I was out on vacation, glad to see this has merged 👏

@chendave

chendave commented Jul 11, 2022

Copy link
Copy Markdown
Member Author

Added one action item,

ACTION REQUIRED: Ginkgo V2 doesn't accept go test's `-parallel` flags to parallelize Ginkgo specs, please switch to use `ginkgo -p` or `ginkgo -procs=N` instead.

based on what we observed here: #111040

@aojea aojea mentioned this pull request Jul 12, 2022
Closed
@CecileRobertMichon CecileRobertMichon mentioned this pull request Jul 12, 2022
Closed
3 tasks
@sedefsavas sedefsavas mentioned this pull request Jul 12, 2022
Merged
4 tasks
@CecileRobertMichon CecileRobertMichon mentioned this pull request Jul 12, 2022
Merged
3 tasks
@mboersma mboersma mentioned this pull request Jul 12, 2022
Merged
@mkumatag mkumatag mentioned this pull request Jul 13, 2022
Closed
@shuheiktgw shuheiktgw mentioned this pull request Jul 14, 2022
Closed
@tyuchn tyuchn mentioned this pull request Jul 15, 2022
Merged
@jsturtevant jsturtevant mentioned this pull request Jul 22, 2022
Merged
@mborsz mborsz mentioned this pull request Jul 29, 2022
Closed
@schrej schrej mentioned this pull request Aug 11, 2022
Merged
@jakobmoellerdev jakobmoellerdev mentioned this pull request Aug 15, 2022
Closed
@camilamacedo86 camilamacedo86 mentioned this pull request Aug 16, 2022
Closed
@ambiknai ambiknai mentioned this pull request Oct 12, 2022
Merged
@hh hh mentioned this pull request Dec 12, 2022
Closed
This was referenced Feb 16, 2023
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@BenTheElder BenTheElder BenTheElder left review comments

@liggitt liggitt liggitt left review comments

@alculquicondor alculquicondor Awaiting requested review from alculquicondor

@andrewsykim andrewsykim Awaiting requested review from andrewsykim

+4 more reviewers

@pohly pohly pohly approved these changes

@onsi onsi onsi left review comments

@endocrimes endocrimes endocrimes left review comments

@aojea aojea aojea left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@pohly pohly

@dims dims

@liggitt liggitt

@aojea aojea

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. area/apiserver area/cloudprovider area/code-generation area/conformance Issues or PRs related to kubernetes conformance tests area/dependency Issues or PRs related to dependency changes area/e2e-test-framework Issues or PRs related to refactoring the kubernetes e2e test framework area/kubeadm area/kubectl area/network-policy Issues or PRs related to Network Policy subproject area/test cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. release-note-action-required Denotes a PR that introduces potentially breaking changes that require user action. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/apps Categorizes an issue or PR as relevant to SIG Apps. sig/architecture Categorizes an issue or PR as relevant to SIG Architecture. sig/auth Categorizes an issue or PR as relevant to SIG Auth. sig/autoscaling Categorizes an issue or PR as relevant to SIG Autoscaling. sig/cli Categorizes an issue or PR as relevant to SIG CLI. sig/cloud-provider Categorizes an issue or PR as relevant to SIG Cloud Provider. sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. sig/network Categorizes an issue or PR as relevant to SIG Network. sig/node Categorizes an issue or PR as relevant to SIG Node. sig/release Categorizes an issue or PR as relevant to SIG Release. sig/scheduling Categorizes an issue or PR as relevant to SIG Scheduling. sig/storage Categorizes an issue or PR as relevant to SIG Storage. sig/testing Categorizes an issue or PR as relevant to SIG Testing. sig/windows Categorizes an issue or PR as relevant to SIG Windows. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Projects

SIG Auth
Archived in project
SIG Node CI/Test Board
Archived in project
SIG Node: code and documentation PRs
Archived in project

Milestone

v1.25

Development

Successfully merging this pull request may close these issues.

Updating the test framework to ginkgo 2.0