Resources for writing test cases in Jaeger backend

[AnmolxSingh]

Hi Jaeger Community,

I hope this message finds you well. I am currently learning how to write test cases for the Jaeger project, specifically using Bash scripting. I have reviewed some of the existing test scripts in the repository and am eager to understand the best practices and tools used by the community.

Could anyone point me to resources, tutorials, or documentation that would help me get up to speed with Bash testing for Jaeger? Any examples or guidance on writing effective and comprehensive test cases in Bash would be greatly appreciated.

Thank you for your support and for maintaining such a fantastic project!

Best regards,

Anmol

[dosubot[bot]]

Hello @AnmolxSingh,

I'm here to help you with any issues or questions you have regarding the Jaeger project. Whether it's bug fixing, code assistance, or becoming a contributor, I've got you covered. Let me know how I can assist you.

Dosu

For writing test cases in the Jaeger backend using Bash scripting, here are some key points and resources that can help you get started:

1. Custom Bash Scripts: The Jaeger project uses custom Bash scripts for testing. You can find examples of these scripts in the repository, such as check-test-files.sh and check-goleak-files.sh ^[1].

2. Makefile Integration: The Makefile in the Jaeger repository integrates these Bash scripts into the testing process. For example, the test target runs tests using a Bash command:

   .PHONY: test
   test:
       bash -c "set -e; set -o pipefail; $(GOTEST) -tags=memory_storage_integration ./... $(COLORIZE)"

   This ensures that the script exits on errors and handles pipe failures correctly ^[1].

3. CI/CD Pipeline: The Bash test scripts are also integrated into the CI/CD pipeline using GitHub Actions workflows. You can find examples in files like .github/workflows/ci-release-testing.yml and .github/workflows/ci-opensearch.yml ^[2][3].

4. Common Pitfalls and Best Practices:

   • Environment Variable Management: Ensure all necessary environment variables are set correctly.
   • Test Cache Management: Use go clean -testcache to clear the test cache before running tests.
   • Error Handling: Use set -e and set -o pipefail to catch errors early.
   • Race Conditions: Handle race conditions, especially on architectures that do not support the -race flag ^[1].

5. Debugging Tools: Use set -e and set -o pipefail in your Bash scripts to help with debugging by ensuring the script exits immediately on errors and handles pipe failures ^[1].

By following these guidelines and examining the existing scripts and Makefile in the Jaeger repository, you can write effective and comprehensive test cases in Bash for the Jaeger project.

To continue talking to Dosu, mention @dosu.