Documenting options; was Re: RFR: JDK-8220639 Need a way to augment JTREG_LAUNCHER_OPTIONS from command-line

[Magnus Ihse Bursie]

On 2020-06-16 14:31, Lance Andersen wrote:
> Hi Magnus,
>
> Can we update this page to include an example of how to run a JTREG 
> manual test via the make infrastructure?
For the record: After some off-list discussion, Lance opened 
https://bugs.openjdk.java.net/browse/JDK-8247690 for supporting manual 
test runs.

/Magnus

>
> Best
> Lance
>
>> On Jun 16, 2020, at 8:26 AM, Magnus Ihse Bursie 
>> <magnus.ihse.bursie at oracle.com 
>> <mailto:magnus.ihse.bursie at oracle.com>> wrote:
>>
>> On 2020-06-16 04:33, Jonathan Gibbons wrote:
>>> Thanks; I'll link to that page from the jtreg FAQ.
>> ... but please use the tip URL: 
>> https://hg.openjdk.java.net/jdk/jdk/raw-file/tip/doc/testing.html
>>
>> Actually, that link is going to get stale in just a few months time. 
>> Probably better to link here directly:
>>
>> https://github.com/openjdk/jdk/blob/master/doc/testing.md
>>
>> /Magnus
>>
>>>
>>> -- Jon
>>>
>>> On 6/15/20 2:23 PM, Erik Joelsson wrote:
>>>> The makefile test documentation is in the repo, so you could link 
>>>> directly to it:
>>>>
>>>> https://hg.openjdk.java.net/jdk/jdk/raw-file/87828d2e32fe/doc/testing.html 
>>>>
>>>>
>>>> Which reminds me that Magnus should update that documentation with 
>>>> these new options.
>>>>
>>>> /Erik
>>>>
>>>> On 2020-06-15 14:19, Jonathan Gibbons wrote:
>>>>> Magnus,
>>>>>
>>>>> Would it be worth while adding something to the jtreg 
>>>>> documentation, such as a new page describing these options for the 
>>>>> JDK makefile support, giving due deference to the makefile (like 
>>>>> "If in doubt, consult `make test JTREG=help`")
>>>>>
>>>>> I can write the page, with your help, if you think this would be a 
>>>>> good idea.
>>>>>
>>>>> -- Jon
>>>>>
>>>>> On 6/15/20 8:56 AM, Magnus Ihse Bursie wrote:
>>>>>> It turned out that it was not possible to send arguments directly 
>>>>>> to the java that launches jtreg, something that was needed, 
>>>>>> especially to change the output limit using Djavatest.maxOutputSize.
>>>>>>
>>>>>> This patch adds JTREG=LAUNCHER_OPTIONS=xxx to pass generic 
>>>>>> options to the launcher. Also, for the specific case of changing 
>>>>>> the max output size, it adds JTREG=MAX_OUTPUT=nnn.
>>>>>>
>>>>>> All these new options made me realize there's no way apart from 
>>>>>> reading the code to know what options are available, so I added a 
>>>>>> help system, and documented this in "make help". Now you can get:
>>>>>>
>>>>>> $ make test JTREG=help
>>>>>> Building target 'test' in configuration 'linux-x64'
>>>>>> Valid keywords for JTREG:
>>>>>> JOBS TIMEOUT_FACTOR FAILURE_HANDLER_TIMEOUT TEST_MODE ASSERT 
>>>>>> VERBOSE RETAIN MAX_MEM RUN_PROBLEM_LISTS RETRY_COUNT MAX_OUTPUT 
>>>>>> OPTIONS JAVA_OPTIONS VM_OPTIONS KEYWORDS EXTRA_PROBLEM_LISTS 
>>>>>> AOT_MODULES LAUNCHER_OPTIONS.
>>>>>> RunTests.gmk:292: *** Re-run without 'help' to continue. Stop.
>>>>>>
>>>>>> Finally, I fixed some broken comments regarding AOT that I 
>>>>>> noticed while fixing this.
>>>>>>
>>>>>> Bug: https://bugs.openjdk.java.net/browse/JDK-8220639
>>>>>> WebRev: 
>>>>>> http://cr.openjdk.java.net/~ihse/JDK-8220639-add-jtreg-launcher-options/webrev.01
>>>>>>
>>>>>> /Magnus
>>
>
> <http://oracle.com/us/design/oracle-email-sig-198324.gif>
> <http://oracle.com/us/design/oracle-email-sig-198324.gif><http://oracle.com/us/design/oracle-email-sig-198324.gif>
> <http://oracle.com/us/design/oracle-email-sig-198324.gif>Lance 
> Andersen| Principal Member of Technical Staff | +1.781.442.2037
> Oracle Java Engineering
> 1 Network Drive
> Burlington, MA 01803
> Lance.Andersen at oracle.com <mailto:Lance.Andersen at oracle.com>
>
>
>