This is an automated email from the ASF dual-hosted git repository.
jiayu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sedona.git
The following commit(s) were added to refs/heads/master by this push:
new 9fba4b60 [DOCS] Update to community/develop (#858)
9fba4b60 is described below
commit 9fba4b6064c2102ef3e1a9083cfeb9b8db495cde
Author: Nilesh Gajwani <[email protected]>
AuthorDate: Mon Jun 12 15:07:12 2023 -0700
[DOCS] Update to community/develop (#858)
---
docs/community/develop.md | 20 ++++++++++++++++++--
1 file changed, 18 insertions(+), 2 deletions(-)
diff --git a/docs/community/develop.md b/docs/community/develop.md
index dd8c47d2..94833223 100644
--- a/docs/community/develop.md
+++ b/docs/community/develop.md
@@ -4,7 +4,7 @@
### IDE
-We recommend Intellij IDEA with Scala plugin installed.
+We recommend Intellij IDEA with Scala plugin installed. Please make sure that
the IDE has JDK 1.8 set as project default.
### Import the project
@@ -51,6 +51,10 @@ Make sure you reload the POM.xml or reload the maven
project. The IDE will ask y
#### Run all unit tests
In a terminal, go to the Sedona root folder. Run `mvn clean install`. All
tests will take more than 15 minutes. To only build the project jars, run `mvn
clean install -DskipTests`.
+!!!Note
+ `mvn clean install` will compile Sedona with Spark 3.0 and Scala 2.12. If
you have a different version of Spark in $SPARK_HOME, make sure to specify that
using -Dspark command line arg.
+ For example, to compile sedona with Spark 3.4 and Scala 2.12, use: `mvn
clean install -Dspark=3.4 -Dscala=2.12`
+
More details can be found on [Compile Sedona](../../setup/compile/)
@@ -78,7 +82,19 @@ Re-run the test case. Do NOT right click the test case to
re-run. Instead, click
## Python developers
-More details to come.
+#### Run all python tests
+
+To run all Python test cases, follow steps mentioned
[here](../../setup/compile/#run-python-test).
+
+#### Run all python tests in a single test file
+To run a particular python test file, specify the path of the .py file to
pipenv.
+
+For example, to run all tests in `test_function.py` located in
`python/tests/sql/`, use: `pipenv run pytest tests/sql/test_function.py`.
+
+#### Run a single test
+To run a particular test in a particular .py test file, specify
`file_name::class_name::test_name` to the pytest command.
+
+For example, to run the test on ST_Contains function located in
sql/test_predicate.py, use: `pipenv run pytest
tests/sql/test_predicate.py::TestPredicate::test_st_contains`
### IDE
