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

Docs: 'Running the Tests' section is out of date #51136

Closed
stevewritescode opened this issue Jan 10, 2019 · 10 comments
Closed

Docs: 'Running the Tests' section is out of date #51136

stevewritescode opened this issue Jan 10, 2019 · 10 comments
Assignees
Labels
Bug broken, incorrect, or confusing behavior Documentation Relates to Salt documentation Phosphorus v3005.0 Release code name and version severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around

Comments

@stevewritescode
Copy link

Description of Issue/Question

It looks like this docs section about setting up and running the Salt test suite is out-of-date: https://github.com/saltstack/salt/blob/develop/doc/topics/tutorials/writing_tests.rst

Quote from @gtmanfred from https://github.com/saltstack/salt/pull/51082/files#r246492565:

The docs should really have instructions about using test-kitchen to run the test suite.

There are some examples here https://kitchen.saltstack.com/docs/file/docs/gettingstarted.md

but nothing specific to the salt test suite, which uses just bundle exec kitchen verify and can be configured with the runtests verifier to only run specific tests.

https://kitchen.saltstack.com/docs/file/docs/runtests.md#tests

@garethgreenaway garethgreenaway added this to the Approved milestone Jan 11, 2019
@garethgreenaway garethgreenaway added Documentation Relates to Salt documentation Bug broken, incorrect, or confusing behavior P2 Priority 2 severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around labels Jan 11, 2019
@dwoz dwoz added the fixed-pls-verify fix is linked, bug author to confirm fix label Jan 15, 2019
@Ch3LL Ch3LL self-assigned this Jun 6, 2019
@Ch3LL
Copy link
Contributor

Ch3LL commented Jun 14, 2019

I will need to bump this to next week

@Ch3LL
Copy link
Contributor

Ch3LL commented Dec 11, 2019

as an update here. Since our tests have continued to change over the last 6 months we are going to wait until the migration to pytest is complete so we can ensure when we update the test documentation it is all accurate. I will be working with the test working group when that migration is complete to ensure we update all of the required documentation. Juts wanted to update the issue here.

@Ch3LL Ch3LL removed the fixed-pls-verify fix is linked, bug author to confirm fix label Dec 11, 2019
@Ch3LL
Copy link
Contributor

Ch3LL commented Dec 11, 2019

also to add to the information that we want to add:

  • running tests with nox
  • setting up kitchen-salt
  • running tests with pytest

@Ch3LL
Copy link
Contributor

Ch3LL commented Jan 27, 2020

Updated in ##55995

Cannot merge until #55745 is merged as well.

Also, I still need to update the kitchen-salt jenkins docs here: https://kitchen.saltstack.com/docs/file/docs/jenkins.md before we can close this.

@Ch3LL
Copy link
Contributor

Ch3LL commented Jan 28, 2020

@Ch3LL Ch3LL added the fixed-pls-verify fix is linked, bug author to confirm fix label Jan 28, 2020
@Ch3LL
Copy link
Contributor

Ch3LL commented Jan 28, 2020

@stevewritescode any chance you can give both those PRs a review?

@sagetherage sagetherage added the Magnesium Mg release after Na prior to Al label May 29, 2020
@sagetherage sagetherage assigned cmcmarrow and unassigned Ch3LL May 29, 2020
@sagetherage sagetherage removed the P2 Priority 2 label Jun 3, 2020
@s0undt3ch
Copy link
Collaborator

The doc in question got a minor update slated for the Sodium release.
Issue is still valid though since all test related documentation needs to be updated.

@sagetherage sagetherage modified the milestones: Approved, Magnesium Jul 14, 2020
@sagetherage sagetherage removed the fixed-pls-verify fix is linked, bug author to confirm fix label Sep 29, 2020
@sagetherage
Copy link
Contributor

@s0undt3ch is there another PR to address the Documentation?

@sagetherage sagetherage removed the Magnesium Mg release after Na prior to Al label Oct 5, 2020
@sagetherage sagetherage modified the milestones: Magnesium, Aluminium Oct 5, 2020
@sagetherage sagetherage added the Aluminium Release Post Mg and Pre Si label Oct 5, 2020
@sagetherage sagetherage added Silicon v3004.0 Release code name and removed Aluminium Release Post Mg and Pre Si labels Mar 24, 2021
@sagetherage sagetherage modified the milestones: Aluminium, Silicon Mar 24, 2021
@sagetherage sagetherage modified the milestones: Silicon, Approved Aug 19, 2021
@anilsil anilsil removed the Silicon v3004.0 Release code name label Oct 26, 2021
@anilsil anilsil modified the milestones: Approved, Phosphorus v3005.0 Oct 26, 2021
@MKLeb MKLeb self-assigned this Oct 26, 2021
@MKLeb MKLeb added the Phosphorus v3005.0 Release code name and version label Jan 18, 2022
@Ch3LL
Copy link
Contributor

Ch3LL commented Feb 1, 2022

I believe this issue can be closed since we updated the Kitchen-Salt and Main Salt Documentation with the new nox and pytest approach for testing. Do you agree @s0undt3ch can we close this one out?

@s0undt3ch
Copy link
Collaborator

Yes, we can.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug broken, incorrect, or confusing behavior Documentation Relates to Salt documentation Phosphorus v3005.0 Release code name and version severity-medium 3rd level, incorrect or bad functionality, confusing and lacks a work around
Projects
None yet
Development

Successfully merging a pull request may close this issue.

9 participants