HPCC Java Projects Bug Write up Guidelines

Users are encouraged to disclose suspected bugs and are asked to adhere to the following guidelines in order to effectively and accurately triage and resolve issues.

• Confirm the issue is indeed a bug before reaching out to the developers or opening a bug ticket.
  • Please review the (HPCC Java Projects common issues) wiki entry
  • Review existing (open/closed) Jiras to avoid duplicates and to find accepted solutions
• Confirm the issue is directly related to HPCC logic
  • Reproduce issue with as little 3rd party logic as possible
  • DFSClient users can use the (DfsClient FileUtility) to reproduce file stream issues.
    • Sample usage: (FileUtility JUnit tests)
  • DFSClient users encountering read failures on specific file parts can use the FileUtility to test reading of specific file parts.
• If the issue is confirmed to be an HPCC bug create a Jira with all information needed to reproduce the issue
  • Provide clear and descriptive title and summary of the issue
  • Include Java JRE/JDE provider/version
  • Include HPCC Java library build version
  • Include target HPCC build version
  • Provide all relevant environment details
  • Provide detailed reproduction steps
  • Include expected results and actual results
  • Provide all supporting logs
    • Java library reports logs to hpcc4j logger
    • ESP logs are very informative and should be included (might need to request from ops team)
    • For file stream issues, DAFILESRV logs should also be included (might need to request from ops team)