Skip to content

Commit 5d0da21

Browse files
authored
A short gradle command to run Polaris (#880)
1 parent db3b3b8 commit 5d0da21

File tree

3 files changed

+4
-23
lines changed

3 files changed

+4
-23
lines changed

README.md

+2-21
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,8 @@ Apache Polaris is built using Gradle with Java 21+ and Docker 27+.
6161
- `./gradlew build` - To build and run tests. Make sure Docker is running, as the integration tests depend on it.
6262
- `./gradlew assemble` - To skip tests.
6363
- `./gradlew test` - To run unit tests and integration tests.
64-
- `./gradlew polarisServerRun` - To run the Polaris server locally; the server is reachable at
64+
- `./gradlew run` - To run the Polaris server locally; the server is reachable at
6565
localhost:8181. This is also suitable for running regression tests, or for connecting with Spark.
66-
See below for more information on regression tests.
67-
6866
- `./regtests/run_spark_sql.sh` - To connect from Spark SQL. Here are some example commands to run in the Spark SQL shell:
6967
```sql
7068
create database db1;
@@ -73,7 +71,7 @@ create table db1.table1 (id int, name string);
7371
insert into db1.table1 values (1, 'a');
7472
select * from db1.table1;
7573
```
76-
74+
- `env POLARIS_HOST=localhost ./regtests/run.sh` - To run regression tests locally, see more options [here](./regtests/README.md).
7775
### More build and run options
7876

7977
#### Running in Docker
@@ -95,23 +93,6 @@ select * from db1.table1;
9593
- `kubectl get deployment -n polaris` - To check the status of the deployment.
9694
- `kubectl describe deployment polaris-deployment -n polaris` - To troubleshoot if things aren't working as expected.
9795

98-
#### Running regression tests
99-
100-
Regression tests can be run in a local environment or in a Docker environment.
101-
102-
To run regression tests locally, you first need to start Polaris, then run the tests:
103-
104-
```shell
105-
./gradlew polarisServerRun
106-
env POLARIS_HOST=localhost ./regtests/run.sh
107-
```
108-
109-
To run regression tests in a Docker environment, you can use the following command:
110-
111-
```shell
112-
docker compose -f regtests/docker-compose.yml up --build --exit-code-from regtest
113-
```
114-
11596
#### Building docs
11697

11798
- Docs are generated using [Hugo](https://gohugo.io/) using the [Docsy](https://www.docsy.dev/docs/) theme.

quarkus/server/build.gradle.kts

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ tasks.named("distTar") { dependsOn("quarkusBuild") }
7070

7171
tasks.withType<Javadoc> { isFailOnError = false }
7272

73-
tasks.register("polarisServerRun") { dependsOn("quarkusRun") }
73+
tasks.register("run") { dependsOn("quarkusRun") }
7474

7575
tasks.named<QuarkusRun>("quarkusRun") {
7676
jvmArgs = listOf("-Dpolaris.bootstrap.credentials=POLARIS,root,secret")

regtests/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ In this setup, a Polaris server must be running on localhost:8181 before running
6767
way to do this is to run the Polaris server in a separate terminal window:
6868

6969
```shell
70-
./gradlew polarisServerRun
70+
./gradlew run
7171
```
7272

7373
Note: the regression tests expect Polaris to run with certain options, e.g. with support for `FILE`

0 commit comments

Comments
 (0)