godfreyhe commented on a change in pull request #13283:
URL: https://github.com/apache/flink/pull/13283#discussion_r485486141
##########
File path: flink-end-to-end-tests/flink-tpcds-test/tpcds-tool/README.md
##########
@@ -11,13 +11,28 @@ Scripts to download the TPC-DS data generator and generate
test data, the suppor
* generator_dir: directory to save TPC-DS data generator.
* scale_factor: scale factor indicates raw data size in GB, we use the
validation scale factor 1 (1G) by default.
* data_dir: directory to save TPC-DS test data.
-* common_scripts_dir: directory which contains some common scripts for end-to
end tests, the retry scripts will be used when download the TPC-DS data
generator.
+* common_scripts_dir: directory which contains some common scripts for Flink
end to end tests, the retry scripts `retry_times_with_backoff_and_cleanup()`
will be used when download the TPC-DS data generator from the Internet.
+
+The scripts is internally used in Flink end to end tests, give an example to
specific how the scripts works:
+```
+$ cd /Users/demo/flink
# go to the fFink project
Review comment:
typo: `fFink`
##########
File path: flink-end-to-end-tests/flink-tpcds-test/README.md
##########
@@ -0,0 +1,12 @@
+# Flink [TPC-DS]( http://www.tpc.org/tpcds) test
+
+You can run the Flink TPC-DS test in your local environment as following
commands:
+
+```
+$ cd /Users/demo/flink
# go to the Flink project
Review comment:
nit: use `<your_workspace_dir>` instead of `/Users/demo` ?
##########
File path: flink-end-to-end-tests/flink-tpcds-test/tpcds-tool/README.md
##########
@@ -11,13 +11,28 @@ Scripts to download the TPC-DS data generator and generate
test data, the suppor
* generator_dir: directory to save TPC-DS data generator.
* scale_factor: scale factor indicates raw data size in GB, we use the
validation scale factor 1 (1G) by default.
* data_dir: directory to save TPC-DS test data.
-* common_scripts_dir: directory which contains some common scripts for end-to
end tests, the retry scripts will be used when download the TPC-DS data
generator.
+* common_scripts_dir: directory which contains some common scripts for Flink
end to end tests, the retry scripts `retry_times_with_backoff_and_cleanup()`
will be used when download the TPC-DS data generator from the Internet.
+
+The scripts is internally used in Flink end to end tests, give an example to
specific how the scripts works:
+```
+$ cd /Users/demo/flink
# go to the fFink project
+$ mvn compile -DskipTests=true
# compile the Flink source code
+$ export
FLINK_DIR=/Users/demo/flink/flink-dist/target/flink-${flink-version}-bin/flink-${flink-version}
# set Flink distribution directory, the ${flink-version} is the compiled
Flink version
+$ export END_TO_END_DIR=/Users/demo/flink/flink-end-to-end-tests
# set end to end tests directory
+$ mkdir -p /Users/demo/dir_to_save_genarator
+$ mkdir -p /Users/demo/dir_to_save_data
+$ cd /Users/demo/flink/flink-end-to-end-tests/tpcds-tool
+$ sh data_generator.sh /Users/demo/dir_to_save_genarator 1
/Users/demo/dir_to_save_data
/Users/demo/flink/flink-end-to-end-tests/test-scripts
+```
+The downloaded generator will be saved to `/Users/demo/dir_to_save_genarator`,
the generated data will be saved to `Users/demo/dir_to_save_data`.
Review comment:
typo: `Users/demo`
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
