mirror of
https://github.com/kubeshark/kubeshark.git
synced 2025-06-14 18:48:54 +00:00
1.5 KiB
1.5 KiB
Testing guidelines
Generic guidelines
- Use "testing" package
- Write Table-driven tests using subtests
- Use cleanup in test/subtest in order to clean up resources
- Name the test func "Test<tested_func_name><tested_case>"
Unit tests
- Position the test file inside the folder of the tested package
- In case of internal func testing
- Name the test file "<tested_file_name>_internal_test.go"
- Name the test package same as the package being tested
- Example - Config
- In case of exported func testing
- Name the test file "<tested_file_name>_test.go"
- Name the test package "<tested_package>_test"
- Example - Slice Utils
- Make sure to run test coverage to make sure you covered all the cases and lines in the func
Acceptance tests
- Position the test file inside the acceptance tests folder
- Name the file "<tested_command>_test.go"
- Name the package "acceptanceTests"
- Do not run as part of the short tests
- Use/Create generic test utils func in acceptanceTests/testsUtils
- Don't use sleep inside the tests - active check
- Running acceptance tests locally
- Switch to the branch that is being tested
- Run acceptanceTests/setup.sh
- Run tests (make acceptance-test)
- Example - Tap