This is an automated email from the ASF dual-hosted git repository.
yufei pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/polaris.git
The following commit(s) were added to refs/heads/main by this push:
new 5d0da219 A short gradle command to run Polaris (#880)
5d0da219 is described below
commit 5d0da2198edc439b38a6ce50079eb13f57c5b75c
Author: Yufei Gu <[email protected]>
AuthorDate: Sat Jan 25 17:41:41 2025 -0800
A short gradle command to run Polaris (#880)
---
README.md | 23 ++---------------------
quarkus/server/build.gradle.kts | 2 +-
regtests/README.md | 2 +-
3 files changed, 4 insertions(+), 23 deletions(-)
diff --git a/README.md b/README.md
index 22dc61d8..d706d990 100644
--- a/README.md
+++ b/README.md
@@ -61,10 +61,8 @@ Apache Polaris is built using Gradle with Java 21+ and
Docker 27+.
- `./gradlew build` - To build and run tests. Make sure Docker is running, as
the integration tests depend on it.
- `./gradlew assemble` - To skip tests.
- `./gradlew test` - To run unit tests and integration tests.
-- `./gradlew polarisServerRun` - To run the Polaris server locally; the server
is reachable at
+- `./gradlew run` - To run the Polaris server locally; the server is reachable
at
localhost:8181. This is also suitable for running regression tests, or for
connecting with Spark.
- See below for more information on regression tests.
-
- `./regtests/run_spark_sql.sh` - To connect from Spark SQL. Here are some
example commands to run in the Spark SQL shell:
```sql
create database db1;
@@ -73,7 +71,7 @@ create table db1.table1 (id int, name string);
insert into db1.table1 values (1, 'a');
select * from db1.table1;
```
-
+- `env POLARIS_HOST=localhost ./regtests/run.sh` - To run regression tests
locally, see more options [here](./regtests/README.md).
### More build and run options
#### Running in Docker
@@ -95,23 +93,6 @@ select * from db1.table1;
- `kubectl get deployment -n polaris` - To check the status of the deployment.
- `kubectl describe deployment polaris-deployment -n polaris` - To
troubleshoot if things aren't working as expected.
-#### Running regression tests
-
-Regression tests can be run in a local environment or in a Docker environment.
-
-To run regression tests locally, you first need to start Polaris, then run the
tests:
-
-```shell
-./gradlew polarisServerRun
-env POLARIS_HOST=localhost ./regtests/run.sh
-```
-
-To run regression tests in a Docker environment, you can use the following
command:
-
-```shell
-docker compose -f regtests/docker-compose.yml up --build --exit-code-from
regtest
-```
-
#### Building docs
- Docs are generated using [Hugo](https://gohugo.io/) using the
[Docsy](https://www.docsy.dev/docs/) theme.
diff --git a/quarkus/server/build.gradle.kts b/quarkus/server/build.gradle.kts
index 61354040..de67f323 100644
--- a/quarkus/server/build.gradle.kts
+++ b/quarkus/server/build.gradle.kts
@@ -70,7 +70,7 @@ tasks.named("distTar") { dependsOn("quarkusBuild") }
tasks.withType<Javadoc> { isFailOnError = false }
-tasks.register("polarisServerRun") { dependsOn("quarkusRun") }
+tasks.register("run") { dependsOn("quarkusRun") }
tasks.named<QuarkusRun>("quarkusRun") {
jvmArgs = listOf("-Dpolaris.bootstrap.credentials=POLARIS,root,secret")
diff --git a/regtests/README.md b/regtests/README.md
index 5e40471c..648255d4 100644
--- a/regtests/README.md
+++ b/regtests/README.md
@@ -67,7 +67,7 @@ In this setup, a Polaris server must be running on
localhost:8181 before running
way to do this is to run the Polaris server in a separate terminal window:
```shell
-./gradlew polarisServerRun
+./gradlew run
```
Note: the regression tests expect Polaris to run with certain options, e.g.
with support for `FILE`
