diff --git a/python/docs/source/development/index.rst b/python/docs/source/development/index.rst index 246822613800..ca628f73d21f 100644 --- a/python/docs/source/development/index.rst +++ b/python/docs/source/development/index.rst @@ -23,4 +23,4 @@ Development :maxdepth: 2 contributing - + testing diff --git a/python/docs/source/development/testing.rst b/python/docs/source/development/testing.rst new file mode 100644 index 000000000000..08fd730a19f4 --- /dev/null +++ b/python/docs/source/development/testing.rst @@ -0,0 +1,57 @@ +.. 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. + +=============== +Testing PySpark +=============== + +In order to run PySpark tests, you should build Spark itself first via Maven or SBT. For example, + +.. code-block:: bash + + build/mvn -DskipTests clean package + +After that, the PySpark test cases can be run via using ``python/run-tests``. For example, + +.. code-block:: bash + + python/run-tests --python-executable=python3 + +Note that you may set ``OBJC_DISABLE_INITIALIZE_FORK_SAFETY`` environment variable to ``YES`` if you are running tests on Mac OS. + +Please see the guidance on how to `build Spark `_, +`run tests for a module, or individual tests `_. + + +Running Individual PySpark Tests +-------------------------------- + +You can run a specific test via using ``python/run-tests``, for example, as below: + +.. code-block:: bash + + python/run-tests --testnames pyspark.sql.tests.test_arrow + +Please refer to `Testing PySpark `_ for more details. + + +Running tests using GitHub Actions +---------------------------------- + +You can run the full PySpark tests by using GitHub Actions in your own forked GitHub +repositry with a few clicks. Please refer to +`Running tests in your forked repository using GitHub Actions `_ for more details.