RFR: Initial section on testing [v6]

[Lance Andersen]

On Thu, 22 Oct 2020 16:31:01 GMT, Igor Ignatyev <iignatyev at openjdk.org> wrote:

>> I think the addition of some conceptual testing information is sufficient for now, with the possibility of adding more discussion later.
>
>> _Mailing list message from [Lance Andersen](mailto:LANCE.ANDERSEN at ORACLE.COM) on [guide-dev](mailto:guide-dev at openjdk.java.net):_
>> 
>> Understand, and I guess my point was should the use of TEST.properties be covered in the dev guide of just left to the JTREG pages. It would be nice to have best practices flushed out.
>> 
>> Best
>> Lance
> 
> Hi Lance,
> 
> I agree that we need to write down the best practices and have them easily available and discoverable, but I don't think that the Guide is the right place for them. I see the Guide as a QuickStart or How To Start Hacking OpenJDK In 5 Minutes (as opposed to The Comprehension OpenJDK Guide: How To Do All Possible Things Right And What Things Not To Do).  if we start to add all best practices to the guide, inevitably they will either be superficially covered or we end up with lots of information and overwhelm readers, both cases will result in poor comprehension and I'd argue would undermine the purpose of this document and will cause more confusion.
> 
> so I'd prefer not to cover `TEST.properties` here, instead, I suggest creating a ticket to document common best practices in `/doc/jtreg-tests.md` in the jdk repo, and list `TEST.properties` as one of the things we need to document.
> 
> Cheers,
> -- Igor

Hi Igor,

> On Oct 22, 2020, at 12:31 PM, Igor Ignatev <notifications at github.com> wrote:
> 
> 
> Mailing list message from Lance Andersen <mailto:LANCE.ANDERSEN at ORACLE.COM> on guide-dev <mailto:guide-dev at openjdk.java.net>:
> 
> Understand, and I guess my point was should the use of TEST.properties be covered in the dev guide of just left to the JTREG pages. It would be nice to have best practices flushed out.
> 
> Best
> Lance
> 
> Hi Lance,
> 
> I agree that we need to write down the best practices and have them easily available and discoverable, but I don't think that the Guide is the right place for them. I see the Guide as a QuickStart or How To Start Hacking OpenJDK In 5 Minutes (as opposed to The Comprehension OpenJDK Guide: How To Do All Possible Things Right And What Things Not To Do). if we start to add all best practices to the guide, inevitably they will either be superficially covered or we end up with lots of information and overwhelm readers, both cases will result in poor comprehension and I'd argue would undermine the purpose of this document and will cause more confusion.
> 
> so I'd prefer not to cover TEST.properties here, instead, I suggest creating a ticket to document common best practices in /doc/jtreg-tests.md in the jdk repo, and list TEST.properties as one of the things we need to document.
> 
> 
Having an additional best practices document would be fine also and perhaps the dev guide just points to it.  I do think we need this as this will help with bringing new developers up to speed quicker as we all have a lot of information that we have learned over the years but it is not written down :-)


Best
Lance
> Cheers,
> -- Igor
> 
> —
> You are receiving this because you commented.
> Reply to this email directly, view it on GitHub <https://github.com/openjdk/guide/pull/30#issuecomment-714612515>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ABQPFO2XCJGC6AZF7SRDK2TSMBM5PANCNFSM4STQRI7A>.
> 


Best
Lance
------------------




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

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

PR: https://git.openjdk.java.net/guide/pull/30