S3Proxy SBT Plugin
Scala
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
project
src
.gitignore
CHANGELOG.md
CONTRIBUTING.md
LICENSE
README.md
build.sbt
version.sbt

README.md

sbt-s3

Support for running S3Proxy in tests.

MIT license Download

Installation

For sbt 1.0+, use version 1.0.0 in your project/plugins.sbt file:

addSbtPlugin("com.localytics" % "sbt-s3" % "1.0.0")

For sbt 0.13.6+, use version 0.7.2:

addSbtPlugin("com.localytics" % "sbt-s3" % "0.7.2")

Version 0.7.2 should also work with sbt 0.13.5 with the right bintray resolvers

Usage

To use S3Proxy in your project you can call start-s3-proxy and stop-s3-proxy directly in sbt.

Configuration

To have S3Proxy automatically start and stop around your tests

startS3Proxy := startS3Proxy.dependsOn(compile in Test).value
test in Test := (test in Test).dependsOn(startS3Proxy).value
testOnly in Test := (testOnly in Test).dependsOn(startS3Proxy).evaluated
testOptions in Test += s3ProxyTestCleanup.value

To set the version of the S3Proxy jar to download ("1.5.3" is the default)

s3ProxyVersion := "1.5.3"

To download the S3Proxy jar to a specific location ("s3-proxy" is the default)

s3ProxyDownloadDir := file("my-dir")

To specify a port other than the default 8001

s3ProxyPort := 8081

To override the default JVM heap size (specified in MB)

s3ProxyHeapSize := Some(1024)

To change the directory for the S3Proxy data ("s3-proxy" is the default)

s3ProxyDataDir := "some/directory/here"

The default on stop is to cleanup any data directory if specified. This can be changed using

s3ProxyCleanAfterStop := false

The authorization type can either be set to none in which case all requests are accepted or aws-v2 in which case requests must include a key/secret pair matching s3ProxyIdentity/s3ProxyCredential. none is the default.

s3ProxyAuthorization := "none"

The identity is the AWS key allowed to access the S3Proxy when s3ProxyAuthorization is set to aws-v2. Defaults to identity.

s3ProxyIdentity := "identity"

The credential is the AWS secret key allowed to access the S3Proxy when s3ProxyAuthorization is set to aws-v2. Defaults to credential.

s3ProxyCredential := "credential"

Scopes

By default this plugin lives entirely in the Global scope. However, different settings for different scopes is possible. For instance, you can add the plugin to the Test scope using

inConfig(Test)(baseS3ProxySettings)

You can then adjust the settings within the Test scope using

(s3ProxyDownloadDir in Test) := file("in-test/s3-proxy")

and you can execute the plugin tasks within the Test scope using

sbt test:start-s3-proxy

Similarly, you can have the plugin automatically start and stop around your tests using

startS3Proxy in Test := (startS3Proxy in Test).dependsOn(compile in Test).value
test in Test := (test in Test).dependsOn(startS3Proxy in Test).value
testOnly in Test := (testOnly in Test).dependsOn(startS3Proxy in Test).evaluated
testOptions in Test += (s3ProxyTestCleanup in Test).value

Thanks

Thanks to Andrew Gaul for the excellent S3Proxy library.