Added a README.md & test.properties file to the wycheproof docs #2463
Conversation
|
@karianna @smlambert Kindly review my PR. |
external/wycheproof/test.properties
Outdated
| wycheproof) | ||
| github_url="https://github.com/google/wycheproof.git" | ||
| script="wycheproof.sh" | ||
| home_path="\${WORKDIR}" | ||
| test_results="testResults" | ||
| tag_version="master" | ||
| bazel_version="1.2.1" | ||
| debian_packages="git wget unzip zip g++" | ||
| debianslim_packages="${debian_packages}" | ||
| ubuntu_packages="${debian_packages}" | ||
| alpine_packages="bash git wget unzip zip g++ bash" | ||
| centos_packages="git wget unzip zip gcc-c++" | ||
| clefos_packages="${centos_packages}" | ||
| ubi_packages="git wget unzip zip gcc-c++" | ||
| ubi_minimal_packages="${ubi_packages}" |
There was a problem hiding this comment.
We only need this section for the test.properties. Take a look at https://github.com/AdoptOpenJDK/openjdk-tests/pull/2452/files for a similar example.
There was a problem hiding this comment.
Thanks @smlambert for the review, working on the updates requested.
| @@ -0,0 +1,14 @@ | |||
| ## Running External tests locally | |||
There was a problem hiding this comment.
Please add a Heading and paragraph (similar to https://github.com/AdoptOpenJDK/openjdk-tests/pull/2452/files):
External Wycheproof Tests
Wycheproof tests are a part of the external third-party application tests that help verify that the Adoptium binaries are good by running a variety of Java applications inside of Docker containers. AdoptOpenJDK/openjdk-tests/Issue #172 lists the applications that we have initially targeted to best exercise the Adoptium binaries. For each application, we choose to run a selection of their functional tests. Wycheproof test material is pulled from the wycheproof repository.
external/wycheproof/README.md
Outdated
| 4. `cd openjdk-tests` | ||
| 5. `./get.sh` | ||
| 6. `cd TKG` | ||
| 7. export required environment variables, BUILD_LIST and EXTRA_DOCKER_ARGS (example: `export BUILD_LIST=external/jacoco` and `export EXTRA_DOCKER_ARGS="-v $TEST_JDK_HOME:/opt/java/openjdk"` |
There was a problem hiding this comment.
BUILD_LIST=external/wycheproof
| 6. `cd TKG` | ||
| 7. export required environment variables, BUILD_LIST and EXTRA_DOCKER_ARGS (example: `export BUILD_LIST=external/jacoco` and `export EXTRA_DOCKER_ARGS="-v $TEST_JDK_HOME:/opt/java/openjdk"` | ||
| 8. `make wycheproof` (This fetches test material and compiles it, based on build.xml files in the test directories) | ||
| 9. `make wycheproof_test` (When you defined BUILD_LIST to point to a directory in [openjdk-tests/external](https://github.com/AdoptOpenJDK/openjdk-tests/tree/master/external), then this is a testCaseName from the playlist.xml file within the directory you chose) |
There was a problem hiding this comment.
Please add an extra paragraph at the end of the README:
When running these from the command-line, these tests are grouped under a make target called 'external', so 'make external' would run the entire set of tests found in the openjdk-tests/external directory. This is unadvisable! Limit what you compile and run, BUILD_LIST=external/<someSubDirectory>, and TARGET=<testCaseNameFromSubdirPlaylist>
These tests run regularly and results can be found in TRSS Third Party Application view.
|
@smlambert The requested updates has been made, please help review my PR |
external/wycheproof/README.md
Outdated
|
|
||
| 9. `make wycheproof_test` (When you defined BUILD_LIST to point to a directory in [openjdk-tests/external](https://github.com/AdoptOpenJDK/openjdk-tests/tree/master/external), then this is a testCaseName from the playlist.xml file within the directory you chose) | ||
|
|
||
| When [running these from the command-line](https://github.com/AdoptOpenJDK/openjdk-tests/blob/master/doc/userGuide.md#local-testing-via-make-targets-on-the-commandline), these tests are grouped under a make target called 'external', so 'make external' would run the entire set of tests found in the openjdk-tests/external directory. This is unadvisable! Limit what you compile and run, BUILD_LIST=external/<someSubDirectory>, and TARGET=<testCaseNameFromSubdirPlaylist> |
There was a problem hiding this comment.
The last sentence we can use insert the code to make someSubDirectory or testCaseNameFromSubdirPlaylist visible. So BUILD_LIST=external/<someSubDirectory>, and TARGET=<testCaseNameFromSubdirPlaylist>.
And I would suggest to update as BUILD_LIST=external/wycheproof, and TARGET=<testCaseNameFromPlaylistUnderDirwycheproof>
There was a problem hiding this comment.
Thanks @sophia-guo for pointing this out, making the changes ASAP.
There was a problem hiding this comment.
Should the wycheproof in this sentence be in angle brackets as well like you did for "" BUILD_LIST=external/wycheproof, and TARGET=
There was a problem hiding this comment.
As it is a specific subdirectory so i think no need to put the angle brackets.
There was a problem hiding this comment.
Hi @sophia-guo, The required changes has been made, kindly review.
…md file Signed-off-by: Annysah <[email protected]>
|
Yaay! |
No description provided.