Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Setup/Teardown run as subtest using provided name #333

Open
phisco opened this issue Oct 13, 2023 · 14 comments
Open

Setup/Teardown run as subtest using provided name #333

phisco opened this issue Oct 13, 2023 · 14 comments
Labels
kind/feature Categorizes issue or PR as related to a new feature. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed.

Comments

@phisco
Copy link
Contributor

phisco commented Oct 13, 2023

What do you want to see?

At present, when multiple Setup or Teardown steps are defined, it can be challenging to identify which specific step has failed if the proper logs were not configured initially. This results from the fact that while Assessment steps are executed in dedicated subtests, Setup and Teardown steps are not. Actually, names for the Setup and Teardown steps are totally ignored, which I don't think was the desired behaviour.

I think it could be useful to execute all steps in dedicated subtests.

Extra Labels

No response

@phisco phisco added the kind/feature Categorizes issue or PR as related to a new feature. label Oct 13, 2023
@phisco
Copy link
Contributor Author

phisco commented Oct 27, 2023

Ping @vladimirvivien @harshanarayana given that I had your attention for the other issue 😬

@harshanarayana
Copy link
Contributor

+1 to this. This will be a very useful change.

@harshanarayana
Copy link
Contributor

@phisco Do you happen to have a possible format for these setup/teardowns in mind in terms of naming them ? If so, please share that here ?

@phisco
Copy link
Contributor Author

phisco commented Dec 12, 2023

@harshanarayana, do you mean for the names in the features? Teardown and Setup steps can already define a name, which in the case of the Assess steps are used as name for their dedicated sub-test, while here they are just ignored. See here for an example of how we use it.

I would expect each of these steps to be executed in its own sub-test and to be shown as .../Teardown/<NAME_OF_THE_STEP> for example here:

--- PASS: TestEnvironmentConfigDefault (30.30s)
    --- PASS: TestEnvironmentConfigDefault/TestEnvironmentConfigDefault (30.30s)
        --- PASS: TestEnvironmentConfigDefault/TestEnvironmentConfigDefault/CreateClaim (13.51s)
        --- PASS: TestEnvironmentConfigDefault/TestEnvironmentConfigDefault/MRHasAnnotation (0.51s)
        --- PASS: TestEnvironmentConfigDefault/TestEnvironmentConfigDefault/Teardown/DisableAlphaEnvironmentConfig (X.Ys)

or wthout the Teardown part:

        --- PASS: TestEnvironmentConfigDefault/TestEnvironmentConfigDefault/DisableAlphaEnvironmentConfig (X.Ys)

I'd have to check how this would play out with the current way setup teardown steps are handled.

@vladimirvivien
Copy link
Contributor

@phisco I think it's a good idea to take a closer look how setup and teardown are put together. I don't see any harm in running them as subtests similar to other steps like "Assess".

@phisco
Copy link
Contributor Author

phisco commented Dec 19, 2023

Cool @vladimirvivien, I can give it a look over the holidays and try opening a PR for it!

@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle stale
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 18, 2024
@phisco
Copy link
Contributor Author

phisco commented Mar 19, 2024

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 19, 2024
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle stale
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 17, 2024
@cpanato
Copy link
Member

cpanato commented Jun 17, 2024

/remove-lifecycle stale

@k8s-ci-robot k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 17, 2024
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle stale
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Sep 15, 2024
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle rotten
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Oct 15, 2024
@phisco
Copy link
Contributor Author

phisco commented Oct 15, 2024

I really need to find the time to work on this 😩 if anyone else wants to jump in, please do!

@vladimirvivien
Copy link
Contributor

This is still relevant and needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed.
Projects
None yet
Development

No branches or pull requests

6 participants