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

Documentation outdated with regards to setup_suite? #715

Open
paravoid opened this issue Mar 22, 2023 · 1 comment
Open

Documentation outdated with regards to setup_suite? #715

paravoid opened this issue Mar 22, 2023 · 1 comment
Labels
Component: Docs Priority: Medium Wrong or misleading documentation, broken behavior with workaround Size: Medium Changes in the same file Status: Confirmed The reproducer worked as described Type: Bug

Comments

@paravoid
Copy link

The FAQ page says:

Is there a mechanism to add file/test specific functionality to a common setup function?
[...] There is no suite wide setup functionality yet [...]

How can I setup/cleanup before/after all tests?
Currently, this is not supported. Please contribute your usecase to issue #39

That bug is closed, and the "Writing tests" section of the documentation does mention a setup_suite() however, so I guess that's not the case anymore and it's just a matter of outdated documentation?

On a similar note, the "Let's do some setup" of the Tutorial, does not mention setup_suite() either. That's both in the "Avoiding costly repeated setups" section, as well as in the "Setting up a multifile test suite" section. The latter even includes a test_helper/common-setup helper and _common_setup function, which seems to me like a way that was recommended to handle this use case before setup_suite() existed.

I'm pretty new to bats and I'm not sure if I've got it right -- apologies if this was a misunderstanding on my end!

@paravoid paravoid added Priority: NeedsTriage Issue has not been vetted yet Type: Bug labels Mar 22, 2023
@martin-schulze-vireso martin-schulze-vireso added Component: Docs Priority: High Broken behavior in specific environments like in parallel mode or only on some operating systems Status: Confirmed The reproducer worked as described Size: Medium Changes in the same file and removed Priority: NeedsTriage Issue has not been vetted yet labels Mar 22, 2023
@martin-schulze-vireso
Copy link
Member

Yes thats outdated documentation, thanks for reporting it.

@martin-schulze-vireso martin-schulze-vireso added Priority: Medium Wrong or misleading documentation, broken behavior with workaround and removed Priority: High Broken behavior in specific environments like in parallel mode or only on some operating systems labels Jan 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Docs Priority: Medium Wrong or misleading documentation, broken behavior with workaround Size: Medium Changes in the same file Status: Confirmed The reproducer worked as described Type: Bug
Projects
None yet
Development

No branches or pull requests

2 participants