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

[TECH DEBT] Need tests for existing modules #9

Open
nicholasmhughes opened this issue Jan 13, 2024 · 6 comments
Open

[TECH DEBT] Need tests for existing modules #9

nicholasmhughes opened this issue Jan 13, 2024 · 6 comments
Assignees
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@nicholasmhughes
Copy link
Member

Description of the tech debt to be addressed, include links and screenshots

It seems these modules were created back in 2016 before there were stricter requirements for tests. The test framework is in place with some boilerplate, but we need to get some actual test code to cover the existing functionality.

@nicholasmhughes nicholasmhughes added good first issue Good for newcomers help wanted Extra attention is needed labels Jan 13, 2024
@vipermark7
Copy link

vipermark7 commented Feb 7, 2024

Interested in taking this on! I'll start with the utils/ folder

@vipermark7
Copy link

vipermark7 commented Feb 7, 2024

Would we want to use PyTest for this?

I'm unsure what the wider Python community uses. I think it would be a good option since in seems to come with handy mocking features :)

@nicholasmhughes
Copy link
Member Author

Hello @vipermark7 ! Yes, the Salt Extensions expect to use nox to call pytest so the tests should be written in that fashion. You can look at some of the other Extensions which have tests for examples on how to structure them. If you have any additional questions, feel free to ask!

@vipermark7
Copy link

I got a new unit test to pass locally! I thinkk I'll need write access to push it to my new branch though

@nicholasmhughes
Copy link
Member Author

Great! Regarding contribution workflow, we use the Fork-and-Branch Workflow that is prevalent in OSS. So, you should be able to fork the repo, create a branch in your fork to hold and changes, and then open a PR to merge your branch into main back in this repository.

@vipermark7
Copy link

vipermark7 commented Feb 7, 2024 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants