You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@beam.apache.org by GitBox <gi...@apache.org> on 2020/12/08 05:29:04 UTC
[GitHub] [beam] youngoli opened a new pull request #13503: [BEAM-11415] In-progress Go ValidatesRunner framework.
youngoli opened a new pull request #13503:
URL: https://github.com/apache/beam/pull/13503
This PR includes everything I've worked on in the Go ValidatesRunner framework so far, for initial review. Note that it includes the contents of PR #13502 as the first commit since it's a required for this code to work, but that should be reviewed in its own PR. This PR only covers the second commit.
This PR creates a new subdirectory, test/validatesrunner, that is intended to just contain a bunch of tests that run and validate lightweight pipelines. It also contains a script that handles starting job servers and expansion services, similar to run_integration_tests.sh, and one initially tested gradle build rule for running it with Flink. Running with the direct runner also works fine, with the command "go test validatesrunner/... --runner=direct". Currently, the script has only been confirmed to work with Flink and the direct runner, but it should theoretically work with the Portable runner and Spark as well, once appropriate gradle build rules are figured out.
Most of the contents here are likely to be transient, chances are this will be merged to be an update to the existing integration directory rather than a whole new directory, and will just replace the existing driver approach to the tests. However, this is still valuable to commit as a starting point to the work.
------------------------
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
- [x] [**Choose reviewer(s)**](https://beam.apache.org/contribute/#make-your-change) and mention them in a comment (`R: @username`).
- [x] Format the pull request title like `[BEAM-XXX] Fixes bug in ApproximateQuantiles`, where you replace `BEAM-XXX` with the appropriate JIRA issue, if applicable. This will automatically link the pull request to the issue.
- [ ] Update `CHANGES.md` with noteworthy changes.
- [x] If this contribution is large, please file an Apache [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
See the [Contributor Guide](https://beam.apache.org/contribute) for more tips on [how to make review process smoother](https://beam.apache.org/contribute/#make-reviewers-job-easier).
Post-Commit Tests Status (on master branch)
------------------------------------------------------------------------------------------------
Lang | SDK | Dataflow | Flink | Samza | Spark | Twister2
--- | --- | --- | --- | --- | --- | ---
Go | [](https://ci-beam.apache.org/job/beam_PostCommit_Go/lastCompletedBuild/) | --- | [](https://ci-beam.apache.org/job/beam_PostCommit_Go_VR_Flink/lastCompletedBuild/) | --- | [](https://ci-beam.apache.org/job/beam_PostCommit_Go_VR_Spark/lastCompletedBuild/) | ---
Java | [](https://ci-beam.apache.org/job/beam_PostCommit_Java/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Dataflow/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_VR_Dataflow_V2/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Dataflow_Java11/lastCompletedBuild/) | [](https://ci-beam
.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Flink/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Flink_Java11/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_PVR_Flink_Batch/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_PVR_Flink_Streaming/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Samza/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Spark/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_PVR_Spark_Batch/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_SparkStructuredStreaming/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_Java_ValidatesRunner_Twister2/lastCompletedBuild/)
Python | [](https://ci-beam.apache.org/job/beam_PostCommit_Python36/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Python37/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Python38/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_Py_VR_Dataflow/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Py_VR_Dataflow_V2/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Py_ValCont/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Python_PVR_Flink_Cron/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PostCommit_Python_VR_Flink/lastCompletedBuild/) | --- | [](https://ci-beam.apache.org/job/beam_PostCommit_Python_VR_Spark/lastCompletedBuild/) | ---
XLang | [](https://ci-beam.apache.org/job/beam_PostCommit_XVR_Direct/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_XVR_Dataflow/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PostCommit_XVR_Flink/lastCompletedBuild/) | --- | [](https://ci-beam.apache.org/job/beam_PostCommit_XVR_Spark/lastCompletedBuild/) | ---
Pre-Commit Tests Status (on master branch)
------------------------------------------------------------------------------------------------
--- |Java | Python | Go | Website | Whitespace | Typescript
--- | --- | --- | --- | --- | --- | ---
Non-portable | [](https://ci-beam.apache.org/job/beam_PreCommit_Java_Cron/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Python_Cron/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PreCommit_PythonLint_Cron/lastCompletedBuild/)<br>[](https://ci-beam.apache.org/job/beam_PreCommit_PythonDocker_Cron/lastCompletedBuild/) <br>[](https://ci-beam.apache.org/job/beam_PreCommit_PythonDocs_Cron/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Go_Cron/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Website_Cron/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Whitespace_Cron/lastCompletedBuild/) | [](https://ci-beam.apache.org/job/beam_PreCommit_Typescript_Cron/lastCompletedBuild/)
Portable | --- | [](https://ci-beam.apache.org/job/beam_PreCommit_Portable_Python_Cron/lastCompletedBuild/) | --- | --- | --- | ---
See [.test-infra/jenkins/README](https://github.com/apache/beam/blob/master/.test-infra/jenkins/README.md) for trigger phrase, status and link of all Jenkins jobs.
GitHub Actions Tests Status (on master branch)
------------------------------------------------------------------------------------------------
[](https://github.com/apache/beam/actions?query=workflow%3A%22Build+python+source+distribution+and+wheels%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Python+Tests%22+branch%3Amaster+event%3Aschedule)
[](https://github.com/apache/beam/actions?query=workflow%3A%22Java+Tests%22+branch%3Amaster+event%3Aschedule)
See [CI.md](https://github.com/apache/beam/blob/master/CI.md) for more information about GitHub Actions CI.
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [beam] youngoli commented on pull request #13503: [BEAM-11415] In-progress Go ValidatesRunner framework.
Posted by GitBox <gi...@apache.org>.
youngoli commented on pull request #13503:
URL: https://github.com/apache/beam/pull/13503#issuecomment-740386922
R: @lostluck
To reiterate, the first commit has its own PR already #13502, it's just included here because I didn't want to wait until that was submitted before submitting this PR. For this PR, just review the second commit.
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [beam] lostluck commented on a change in pull request #13503: [BEAM-11415] In-progress Go ValidatesRunner framework.
Posted by GitBox <gi...@apache.org>.
lostluck commented on a change in pull request #13503:
URL: https://github.com/apache/beam/pull/13503#discussion_r539030427
##########
File path: sdks/go/test/build.gradle
##########
@@ -50,6 +50,25 @@ golang {
}
}
+// A temporary build rule using the newer, under-construction ValidatesRunner
+// framework rather than the existing one in the integration directory.
+// TODO(BEAM-11415): Merge this into existing ValidatesRunner gradle rules.
+task flinkNewValidatesRunner {
Review comment:
For now, could we use flinkXlangValidatesRunner which at least covers what is in particularly new coverage about this set up. This comment driven by seeing too many vestigial "new" implementations that don't get fully migrated.
Tangent, it's generally preferable to rename older implementations to "old" than new ones to "new" when possible.
Feel free to disregard if you've already gotten far enough in the consolidation in later commits.
##########
File path: sdks/go/test/run_validatesrunner_tests.sh
##########
@@ -0,0 +1,174 @@
+#!/bin/bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This script executes ValidatesRunner tests including launching any additional
+# services needed, such as job services or expansion services. The following
+# runners are supported, and selected via a flag:
+#
+# --runner {portable|direct|flink} (default: portable)
+# Select which runner to execute tests on. This flag also determines which
+# services to start up and which tests may be skipped.
+# direct - Go SDK Direct Runner
+# portable - (default) Python Portable Runner (aka. Reference Runner or FnAPI Runner)
+# flink - Java Flink Runner (local mode)
+# spark - Java Spark Runner (local mode)
+#
+# --flink_job_server_jar -> Filepath to jar, used if runner is Flink.
+# --spark_job_server_jar -> Filepath to jar, used if runner is Spark.
+# --endpoint -> Replaces jar filepath with existing job server endpoint.
+#
+# --expansion_service_jar -> Filepath to jar for expansion service.
+# --expansion_addr -> Replaces jar filepath with existing expansion service endpoint.
+#
+# Execute from the root of the repository. This script requires that necessary
+# services can be built from the repository.
+
+set -e
+set -v
+
+RUNNER=portable
+
+exit_background_processes () {
+ if [[ -n "$JOBSERVER_PID" ]]; then
+ kill -s SIGKILL $JOBSERVER_PID
+ fi
+ if [[ -n "$EXPANSION_PID" ]]; then
+ kill -s SIGKILL $EXPANSION_PID
+ fi
+}
+trap exit_background_processes SIGINT SIGTERM EXIT
+
+while [[ $# -gt 0 ]]
+do
+key="$1"
+case $key in
+ --runner)
+ RUNNER="$2"
+ shift # past argument
+ shift # past value
+ ;;
+ --flink_job_server_jar)
+ FLINK_JOB_SERVER_JAR="$2"
+ shift # past argument
+ shift # past value
+ ;;
+ --spark_job_server_jar)
+ SPARK_JOB_SERVER_JAR="$2"
+ shift # past argument
+ shift # past value
+ ;;
+ --endpoint)
+ ENDPOINT="$2"
+ shift # past argument
+ shift # past value
+ ;;
+ --expansion_service_jar)
+ EXPANSION_SERVICE_JAR="$2"
+ shift # past argument
+ shift # past value
+ ;;
+ --expansion_addr)
+ EXPANSION_ADDR="$2"
+ shift # past argument
+ shift # past value
+ ;;
+ *) # unknown option
+ echo "Unknown option: $1"
+ exit 1
+ ;;
+esac
+done
+
+# Go to the root of the repository
+cd $(git rev-parse --show-toplevel)
+
+# Verify in the root of the repository
+test -d sdks/go/test
+
+# Set up environment based on runner.
+ARGS=--runner=$RUNNER
+if [[ "$RUNNER" == "flink" || "$RUNNER" == "spark" || "$RUNNER" == "portable" ]]; then
+ if [[ -z "$ENDPOINT" ]]; then
+ # Hacky python script to find a free port. Note there is a small chance the chosen port could
+ # get taken before being claimed by the job server.
+ SOCKET_SCRIPT="
+import socket
+s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+s.bind(('localhost', 0))
+print(s.getsockname()[1])
+s.close()
+ "
+ JOB_PORT=$(python -c "$SOCKET_SCRIPT")
+ ENDPOINT="localhost:$JOB_PORT"
+ echo "No endpoint specified; starting a new $RUNNER job server on $ENDPOINT"
+ if [[ "$RUNNER" == "flink" ]]; then
+ java \
+ -jar $FLINK_JOB_SERVER_JAR \
+ --flink-master [local] \
+ --job-port $JOB_PORT \
+ --expansion-port 0 \
+ --artifact-port 0 &
+ elif [[ "$RUNNER" == "spark" ]]; then
+ java \
+ -jar $SPARK_JOB_SERVER_JAR \
+ --spark-master-url local \
+ --job-port $JOB_PORT \
+ --expansion-port 0 \
+ --artifact-port 0 &
+ elif [[ "$RUNNER" == "portable" ]]; then
+ python \
+ -m apache_beam.runners.portability.local_job_service_main \
+ --port $JOB_PORT &
+ else
+ echo "Unknown runner: $RUNNER"
+ exit 1;
+ fi
+ JOBSERVER_PID=$!
+ fi
+
+ if [[ -z "$EXPANSION_ADDR" ]]; then
+ SOCKET_SCRIPT="
+import socket
+s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+s.bind(('localhost', 0))
+print(s.getsockname()[1])
+s.close()
+ "
Review comment:
Deduplicate w/the socket script higher up please.
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [beam] youngoli commented on a change in pull request #13503: [BEAM-11415] In-progress Go ValidatesRunner framework.
Posted by GitBox <gi...@apache.org>.
youngoli commented on a change in pull request #13503:
URL: https://github.com/apache/beam/pull/13503#discussion_r539748748
##########
File path: sdks/go/test/build.gradle
##########
@@ -50,6 +50,25 @@ golang {
}
}
+// A temporary build rule using the newer, under-construction ValidatesRunner
+// framework rather than the existing one in the integration directory.
+// TODO(BEAM-11415): Merge this into existing ValidatesRunner gradle rules.
+task flinkNewValidatesRunner {
Review comment:
I'm alright with that, done.
##########
File path: sdks/go/test/run_validatesrunner_tests.sh
##########
@@ -0,0 +1,174 @@
+#!/bin/bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This script executes ValidatesRunner tests including launching any additional
+# services needed, such as job services or expansion services. The following
+# runners are supported, and selected via a flag:
+#
+# --runner {portable|direct|flink} (default: portable)
+# Select which runner to execute tests on. This flag also determines which
+# services to start up and which tests may be skipped.
+# direct - Go SDK Direct Runner
+# portable - (default) Python Portable Runner (aka. Reference Runner or FnAPI Runner)
+# flink - Java Flink Runner (local mode)
+# spark - Java Spark Runner (local mode)
+#
+# --flink_job_server_jar -> Filepath to jar, used if runner is Flink.
+# --spark_job_server_jar -> Filepath to jar, used if runner is Spark.
+# --endpoint -> Replaces jar filepath with existing job server endpoint.
+#
+# --expansion_service_jar -> Filepath to jar for expansion service.
+# --expansion_addr -> Replaces jar filepath with existing expansion service endpoint.
+#
+# Execute from the root of the repository. This script requires that necessary
+# services can be built from the repository.
+
+set -e
+set -v
+
+RUNNER=portable
+
+exit_background_processes () {
+ if [[ -n "$JOBSERVER_PID" ]]; then
+ kill -s SIGKILL $JOBSERVER_PID
+ fi
+ if [[ -n "$EXPANSION_PID" ]]; then
+ kill -s SIGKILL $EXPANSION_PID
+ fi
+}
+trap exit_background_processes SIGINT SIGTERM EXIT
+
+while [[ $# -gt 0 ]]
+do
+key="$1"
+case $key in
+ --runner)
+ RUNNER="$2"
+ shift # past argument
+ shift # past value
+ ;;
+ --flink_job_server_jar)
+ FLINK_JOB_SERVER_JAR="$2"
+ shift # past argument
+ shift # past value
+ ;;
+ --spark_job_server_jar)
+ SPARK_JOB_SERVER_JAR="$2"
+ shift # past argument
+ shift # past value
+ ;;
+ --endpoint)
+ ENDPOINT="$2"
+ shift # past argument
+ shift # past value
+ ;;
+ --expansion_service_jar)
+ EXPANSION_SERVICE_JAR="$2"
+ shift # past argument
+ shift # past value
+ ;;
+ --expansion_addr)
+ EXPANSION_ADDR="$2"
+ shift # past argument
+ shift # past value
+ ;;
+ *) # unknown option
+ echo "Unknown option: $1"
+ exit 1
+ ;;
+esac
+done
+
+# Go to the root of the repository
+cd $(git rev-parse --show-toplevel)
+
+# Verify in the root of the repository
+test -d sdks/go/test
+
+# Set up environment based on runner.
+ARGS=--runner=$RUNNER
+if [[ "$RUNNER" == "flink" || "$RUNNER" == "spark" || "$RUNNER" == "portable" ]]; then
+ if [[ -z "$ENDPOINT" ]]; then
+ # Hacky python script to find a free port. Note there is a small chance the chosen port could
+ # get taken before being claimed by the job server.
+ SOCKET_SCRIPT="
+import socket
+s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+s.bind(('localhost', 0))
+print(s.getsockname()[1])
+s.close()
+ "
+ JOB_PORT=$(python -c "$SOCKET_SCRIPT")
+ ENDPOINT="localhost:$JOB_PORT"
+ echo "No endpoint specified; starting a new $RUNNER job server on $ENDPOINT"
+ if [[ "$RUNNER" == "flink" ]]; then
+ java \
+ -jar $FLINK_JOB_SERVER_JAR \
+ --flink-master [local] \
+ --job-port $JOB_PORT \
+ --expansion-port 0 \
+ --artifact-port 0 &
+ elif [[ "$RUNNER" == "spark" ]]; then
+ java \
+ -jar $SPARK_JOB_SERVER_JAR \
+ --spark-master-url local \
+ --job-port $JOB_PORT \
+ --expansion-port 0 \
+ --artifact-port 0 &
+ elif [[ "$RUNNER" == "portable" ]]; then
+ python \
+ -m apache_beam.runners.portability.local_job_service_main \
+ --port $JOB_PORT &
+ else
+ echo "Unknown runner: $RUNNER"
+ exit 1;
+ fi
+ JOBSERVER_PID=$!
+ fi
+
+ if [[ -z "$EXPANSION_ADDR" ]]; then
+ SOCKET_SCRIPT="
+import socket
+s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+s.bind(('localhost', 0))
+print(s.getsockname()[1])
+s.close()
+ "
Review comment:
Done.
----------------------------------------------------------------
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:
users@infra.apache.org
[GitHub] [beam] youngoli merged pull request #13503: [BEAM-11415] In-progress Go ValidatesRunner framework.
Posted by GitBox <gi...@apache.org>.
youngoli merged pull request #13503:
URL: https://github.com/apache/beam/pull/13503
----------------------------------------------------------------
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:
users@infra.apache.org