RFR: 8340818: Add a new jtreg test root to test the generated documentation

[Nizar Benalla]

On Tue, 1 Oct 2024 13:04:15 GMT, Erik Joelsson <erikj at openjdk.org> wrote:

>> Please review this change that adds a new test root `docs` dedicated to testing the documentation, which has been a work in progress for a while. Tests for links, encoding, HTML, accessibility will be later added in following PRs. 
>> 
>> We also define a new make target `test-docs` meant for local use and depends on the docs.
>> This also adds the necessary configurations needed at Oracle.
>> 
>> This patch includes a test `TestDocs` which serves to show developers how they are meant to resolve the docs to test them, I want to include it temporarily until better tests are added later.
>> 
>> TIA
>
> test/docs/jdk/javadoc/TestDocs.java line 59:
> 
>> 57:             throw new SkippedException("docs folder not found in either location");
>> 58:         }
>> 59:     }
> 
> This shouldn't be needed. We should define an environment variable that is expected to point to the docs image that RunTests.gmk sets up. Perhaps there could be java code to automatically fallback to looking in the first candidate location here, as that's the layout of the build itself. Some people prefer to bypass the makefiles and run jtreg standalone, and that would help support that usecase. I would put that java code in a common library class for the whole test root.

Understood
> Some people prefer to bypass the makefiles and run jtreg standalone, and that would help support that usecase

I tend to do that most of the time if I only made changes to the test.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/21272#discussion_r1782829470