On Fri, 15 Sep 2023 07:09:13 GMT, Ajit Ghaisas <aghai...@openjdk.org> wrote:

> - Removed README file
> - Added README.md file with details
> 
> For formatted output of README.md - See : 
> https://github.com/aghaisas/jfx-tests/tree/update_readme

I was able to run the tests following the instructions. I left a few minor 
wording comment.

README.md line 3:

> 1: # JFX-Tests
> 2: 
> 3: This repository contains the tests and tools for Java FX.

JavaFX is one word.

README.md line 21:

> 19: 5) Jtreg - We need a jtreg that contains lib/junit.jar file. e.g. version 
> jtreg-6.2.1. See [Jtreg](https://openjdk.org/jtreg)
> 20: 6) Jemmy-v3 library
> 21:    - git clone https://github.com/openjdk/jemmy-v3

That should be: https://github.com/openjdk/jemmy-v3.git

README.md line 52:

> 50: 7) **Generating golden images**
> 51: 
> 52: A golden image is a manually verified image of the expected graphical 
> output of a test. Many of the javafx functional tests depend upon golden 
> images for image comparison and assert.

I recommend to either remove the "and assert" or else change it to "and 
assertion testing".

README.md line 53:

> 51: 
> 52: A golden image is a manually verified image of the expected graphical 
> output of a test. Many of the javafx functional tests depend upon golden 
> images for image comparison and assert.
> 53: In the absence of a centrally hosted directory of golden images, it is 
> imperative that one needs to generate these golden images once and then 
> subsequently run the tests. Here are the steps to generate golden images

the "needs to" is redundant. I would change "it is imperative that one needs to 
generate these golden images" to "you must generate these golden images".

README.md line 55:

> 53: In the absence of a centrally hosted directory of golden images, it is 
> imperative that one needs to generate these golden images once and then 
> subsequently run the tests. Here are the steps to generate golden images
> 54: 
> 55: a) Run the required tests (e.g. functional/SceneGraphTests) as described 
> in step (6) above. This test run results in multiple test failures, but 
> generates screenshots of test window in `build/images` directory. If 
> satisfied with the expected graphical output, these images can be used as 
> golden images by copying them to `build/golden/SceneGraphTests/prism/mac` 
> directory (for a test run on MacOS). Note - this directory structure needs to 
> be created if not present.

Minor: "MacOS" --> "macOs"

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

PR Review: 
https://git.openjdk.org/jfx-tests/pull/11#pullrequestreview-1628899061
PR Review Comment: 
https://git.openjdk.org/jfx-tests/pull/11#discussion_r1327252095
PR Review Comment: 
https://git.openjdk.org/jfx-tests/pull/11#discussion_r1327252797
PR Review Comment: 
https://git.openjdk.org/jfx-tests/pull/11#discussion_r1327307580
PR Review Comment: 
https://git.openjdk.org/jfx-tests/pull/11#discussion_r1327310673
PR Review Comment: 
https://git.openjdk.org/jfx-tests/pull/11#discussion_r1327270450

Reply via email to