Skip to content

Latest commit

 

History

History
46 lines (41 loc) · 1.63 KB

DEVELOPER_GUIDE.md

File metadata and controls

46 lines (41 loc) · 1.63 KB

Developer Guide

Package

If you want to package the single jar for, you can do so by running the following command:

sbt assembly

Integration Test

The integration test is defined in the integ-test directory of the project. If you want to run the integration test for the project, you can do so by running the following command:

sbt integtest/test

AWS Integration Test

The integration folder contains tests for cloud server providers. For instance, test against AWS OpenSearch domain, configure the following settings. The client will use the default credential provider to access the AWS OpenSearch domain.

export AWS_OPENSEARCH_HOST=search-xxx.aos.us-west-2.on.aws
export AWS_REGION=us-west-2

And run the

sbt integtest/integration

[info] AWSOpenSearchAccessTestSuite:
[info] - should Create Pit on AWS OpenSearch
[info] Run completed in 3 seconds, 116 milliseconds.
[info] Total number of tests run: 1
[info] Suites: completed 1, aborted 0
[info] Tests: succeeded 1, failed 0, canceled 0, ignored 0, pending 0
[info] All tests passed.

Scala Formatting Guidelines

For Scala code, flint use spark scalastyle. Before submitting the PR, make sure to use "scalafmtAll" to format the code. read more in scalafmt sbt

sbt scalafmtAll

The code style is automatically checked, but users can also manually check it.

sbt scalastyle

For IntelliJ user, read more in scalafmt IntelliJ to integrate scalafmt with IntelliJ