Gradle Integration and Improvements

[jckreg]

As new Issues with the build system are found or identified please add comments to this Issues to bring to the attention of the Admin and DevOps team

[jckreg]

IDE Integration

Problem

In part due to the practice of sharing things like the classpath file with hard-coded paths as well as the use of the lib folder and its usage in the classpath, IDE syntax highlighting and auto completion is breaking for some users. The addition of Gradle to the project for resolving dependencies has increased the number of users experiencing this issue. Currently to fix the IDEs that are no longer handling syntax highlighting and dependencies correctly, users are manually creating and editing custom configurations and classpaths files. This works but, is not ideal for getting new devs spun up quickly or handling an increasing number of dependencies for all devs.

Goal

Simplify the issue for the user or automate the process to improve developer quality of life.

Try to make as many IDE's as possible readily usable out of the box to help all current and future Devs

TODOs

• remove existing machine specific files from the github
• remove existing IDE specific code/configuration from the github
• automate the generation of a config/classpath folder to help with IDE integration
  • try to make OS, IDE and machine agnostic
• Get help to identify most common IDEs used by team (and in general) and test auto-generated file
  • Eclipse
  • IntelliJ
  • NeoVim

Triage Info for IDE Integration Specifically

• Priority: Low
• Impact: Low - Moderate
• Due Date: NA

[jckreg]

Java Version

Problem

Project requires that the code is compatible with Java 8. Currently the runners use java 8 but users use what ever is set locally

Goal

Gradle should use Java 8 if available to build, run and test the program

TODO

• Have gradle check for and use java 8 if available
• verify github runners are using 8
• Find out if the java version can be or should be updated to a later version

Triage Info for: Java Version

• Priority: Moderate?
• Impact: Moderate?
• Due Date: ?

[jckreg]

Testing

Problem

Testing is not a part of gradle despite some existing Regression tests and Unit tests

Goal

Set up gradle automated testing

TODO

• Targets for existing tests
• plan for extending tests in future

Triage Info

• Priority: Moderate
• Impact: ?
• Due Date: ?

[jckreg]

Umbrella TODO:
[X] #18 IDE Integration
[] #19 Gradle Java Version
[] #20 Gradle Testing Targets