[Rev 02] RFR: 8244297: memory leak test utility

[Kevin Rushforth]

On Tue, 5 May 2020 11:55:41 GMT, Florian Kirmaier <fkirmaier at openjdk.org> wrote:

>> modules/javafx.base/src/test/java/de/sandec/jmemorybuddy/JMemoryBuddy.java line 145:
>> 
>>> 144:
>>> 145:     public static void createHeapDump() {
>>> 146:         try {
>> 
>> I don't think we want automatic creation of heap dumps by our unit test suite. That would need a larger discussion. I
>> recommend to either comment this out, or else to qualify it with a system property that could be passed in via a
>> `gradle` property (e.g., as is done for `UNSTABLE_TEST`), with a default of `false`.
>
> I've made it configurable in the Library with system-parameters and I've changed the default not create a heap dump.
> Is that ok?

Yes, that seems fine.

>> modules/javafx.base/src/test/java/de/sandec/jmemorybuddy/JMemoryBuddy.java line 15:
>> 
>>> 14:
>>> 15: public class JMemoryBuddy {
>>> 16:
>> 
>> Since this is a utility intended to be used by various tests, it would be very helpful to add some documentation about
>> how to use it.
>
> Where/How should I add the documentation? Ideally, I would reference the documentation of the project itself.

A javadoc comment right before the class declaration is fine. It can be short.

-------------

PR: https://git.openjdk.java.net/jfx/pull/204