docs: comprehensive update of integration test documentation#214
docs: comprehensive update of integration test documentation#214shawn-hurley wants to merge 1 commit intokonveyor:mainfrom
Conversation
📝 WalkthroughWalkthroughDocumentation updates across test suite files reflecting JDT.LS version bump (1.35.0 → 1.51.0), expanded unit test count (48 → 76), updated test project structure with new Java files and dependencies, revised container build/run instructions distinguishing local and CI workflows, and adjusted integration test examples and expected outputs. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Audit all test documentation against actual code and fix numerous stale references accumulated as tests were added without doc updates. Key corrections: - Unit test count: 48 -> 76 (add 5 undocumented test classes) - Integration sub-test count: 43 -> 47 (account for table-driven tests) - Query count: 40+ -> 47 (precise count from code) - PackageDeclarationSearch queries: 2 -> 8 - test-project file count: 6-8 -> 19 (full listing) - JDT.LS version: fix stale 1.35.0/1.38.0 refs to 1.51.0 - Fix useUIHarness: true -> false (match actual pom.xml) - Fix nonexistent doc path: integration/README.md -> docs/integration-tests.md - Fix go.mod dependency version: v0.4.0-alpha.1 -> v0.8.0 Clarify two-Dockerfile setup: - CI uses default Dockerfile (self-contained, builds JAR from source) - Local dev uses Dockerfile.test (requires pre-built JAR, pre-installs Go) - Add mvn install prerequisite to all local container build instructions - Remove unnecessary runtime golang install from Dockerfile.test commands Other fixes: - Replace stale Phase 1/2/3 planning sections with completed milestones - Fix test assertions API (referenced nonexistent test_utils.go) - Replace fake expected output with actual Go test framework format - Clean up stale 1.18.0 comment in target platform file Signed-off-by: Shawn Hurley <shawn@hurley.page>
395d615 to
8d9acdb
Compare
jmle
left a comment
There was a problem hiding this comment.
Looks good, but do you think we need this level of verbosity for test documentation?
Audit all test documentation against actual code and fix numerous stale references accumulated as tests were added without doc updates.
fixes #193
Key corrections:
Clarify two-Dockerfile setup:
Other fixes:
Summary by CodeRabbit
Documentation
Chores