0.12.0 release

Author: adamw

README.md

@@ -5,7 +5,7 @@ tl;dr
 -----
 
 * message queue system
-* runs stand-alone ([download](https://s3-eu-west-1.amazonaws.com/softwaremill-public/elasticmq-server-0.11.1.jar)) or embedded
+* runs stand-alone ([download](https://s3-eu-west-1.amazonaws.com/softwaremill-public/elasticmq-server-0.12.0.jar)) or embedded
 * [Amazon SQS](http://aws.amazon.com/sqs/)-compatible interface
 * fully asynchronous implementation, no blocking calls
 
@@ -43,18 +43,18 @@ Installation: stand-alone
 -------------------------
 
 You can download the stand-alone distribution here:
-[https://s3/.../elasticmq-server-0.11.1.jar](https://s3-eu-west-1.amazonaws.com/softwaremill-public/elasticmq-server-0.11.1.jar)
+[https://s3/.../elasticmq-server-0.12.0.jar](https://s3-eu-west-1.amazonaws.com/softwaremill-public/elasticmq-server-0.12.0.jar)
 
 Java 6 or above is required for running the server.
 
 Simply run the jar and you should get a working server, which binds to `localhost:9324`:
 
-    java -jar elasticmq-server-0.11.1.jar
+    java -jar elasticmq-server-0.12.0.jar
 
 ElasticMQ uses [Typesafe Config](https://github.com/typesafehub/config) for configuration. To specify custom
 configuration values, create a file (e.g. `custom.conf`), fill it in with the desired values, and pass it to the server:
 
-    java -Dconfig.file=custom.conf -jar elasticmq-server-0.11.1.jar
+    java -Dconfig.file=custom.conf -jar elasticmq-server-0.12.0.jar
 
 The config file may contain any configuration for Akka and ElasticMQ. Current ElasticMQ configuration values are:
 
@@ -78,6 +78,10 @@ rest-sqs {
     sqs-limits = strict
 }
 
+// Should the node-address be generated from the bind port/hostname
+// Set this to true e.g. when assigning port automatically by using port 0.
+generate-node-address = false
+
 queues {
     // See next section
 }
@@ -87,7 +91,7 @@ You can also provide an alternative [Logback](http://logback.qos.ch/) configurat
 [default](server/src/main/resources/logback.xml) is configured to
 log INFO logs and above to the console):
 
-    java -Dlogback.configurationFile=my_logback.xml -jar elasticmq-server-0.11.1.jar
+    java -Dlogback.configurationFile=my_logback.xml -jar elasticmq-server-0.12.0.jar
 
 How are queue URLs created
 --------------------------
@@ -98,12 +102,14 @@ To customize, you should properly set the protocol/host/port/context in the `nod
 You can also set `node-address.host` to a special value, `"*"`, which will cause any queue URLs created during a request
 to use the path of the incoming request. This might be useful e.g. in containerized (Docker) deployments.
 
-Note that changing the `bind-port` and `bind-hostname` settings does not affect the queue URLs in any way.
-
+Note that changing the `bind-port` and `bind-hostname` settings does not affect the queue URLs in any way unless
+`generate-node-address` is `true`. In that case, the bind host/port are used to create the node address. This is
+useful when the port should be automatically assigned (use port `0` in such case, the selected port will be
+visible in the logs).
 Automatically creating queues on startup
 ----------------------------------------
 
-Queues can be automatically created on startup by providing appropriate configuration (since 0.9.3):
+Queues can be automatically created on startup by providing appropriate configuration:
 
 The queues are specified in a custom configuration file. For example, create a `custom.conf` file with the following:
 
@@ -182,15 +188,15 @@ ElasticMQ dependencies in SBT
 -----------------------------
 
     // Scala 2.11
-    val elasticmqSqs        = "org.elasticmq" %% "elasticmq-rest-sqs"         % "0.11.1"
+    val elasticmqSqs        = "org.elasticmq" %% "elasticmq-rest-sqs"         % "0.12.0"
 
     // Scala 2.10
     val elasticmqSqs        = "org.elasticmq" %% "elasticmq-rest-sqs"         % "0.7.1"
 
 If you don't want the SQS interface, but just use the actors directly, you can add a dependency only to the `core`
 module:
 
-    val elasticmqCore       = "org.elasticmq" %% "elasticmq-core"             % "0.11.1"
+    val elasticmqCore       = "org.elasticmq" %% "elasticmq-core"             % "0.12.0"
 
 If you want to use a snapshot version, you will need to add the [https://oss.sonatype.org/content/repositories/snapshots/](https://oss.sonatype.org/content/repositories/snapshots/) repository to your configuration.
 
@@ -202,7 +208,7 @@ Dependencies:
     <dependency>
         <groupId>org.elasticmq</groupId>
         <artifactId>elasticmq-rest-sqs_2.11</artifactId>
-        <version>0.11.1</version>
+        <version>0.12.0</version>
     </dependency>
 
 If you want to use a snapshot version, you will need to add the [https://oss.sonatype.org/content/repositories/snapshots/](https://oss.sonatype.org/content/repositories/snapshots/) repository to your configuration.
@@ -216,9 +222,9 @@ have been discontinued.
 Current versions
 ----------------
 
-*Stable*: 0.11.1, 0.8.12
+*Stable*: 0.12.0, 0.8.12
 
-*Development*: 0.11.1-SNAPSHOT
+*Development*: 0.12.0-SNAPSHOT
 
 Logging
 -------
@@ -284,6 +290,11 @@ Technology
 Change log
 ----------
 
+#### Version 0.12.0 (7 Dec 2016)
+
+* support for dynamic port allocation
+* node address is generated from bind address if not specified
+
 #### Version 0.11.1 (30 Nov 2016)
 
 * bug fix

project/Build.scala

@@ -5,7 +5,7 @@ import sbtassembly.AssemblyKeys._
 object BuildSettings {
   val buildSettings = Defaults.coreDefaultSettings ++ Seq (
     organization  := "org.elasticmq",
-    version       := "0.11.1",
+    version       := "0.12.0",
     scalaVersion  := "2.11.8",
     crossScalaVersions := Seq(scalaVersion.value, "2.12.0"),
 

rest/rest-sqs/src/main/scala/org/elasticmq/rest/sqs/SQSRestServerBuilder.scala

@@ -4,6 +4,7 @@ import java.io.ByteArrayOutputStream
 import java.nio.ByteBuffer
 import java.security.MessageDigest
 import java.util.concurrent.TimeUnit
+import java.util.concurrent.atomic.AtomicReference
 
 import akka.actor.{ActorRef, ActorSystem, Props}
 import akka.http.scaladsl.Http
@@ -22,6 +23,7 @@ import scala.collection.mutable.ArrayBuffer
 import scala.concurrent.duration._
 import scala.concurrent.{Await, Future}
 import scala.util.control.Exception._
+import scala.util.control.NonFatal
 import scala.xml.{EntityRef, _}
 
 /**
@@ -32,13 +34,14 @@ import scala.xml.{EntityRef, _}
  *  <ul>for `sqsLimits`: relaxed
  * </li>
  */
-object SQSRestServerBuilder extends TheSQSRestServerBuilder(None, None, "", 9324, NodeAddress(), SQSLimits.Strict)
+object SQSRestServerBuilder extends TheSQSRestServerBuilder(None, None, "", 9324, NodeAddress(), true, SQSLimits.Strict)
 
 case class TheSQSRestServerBuilder(providedActorSystem: Option[ActorSystem],
                                    providedQueueManagerActor: Option[ActorRef],
                                    interface: String,
                                    port: Int,
                                    serverAddress: NodeAddress,
+                                   generateServerAddress: Boolean,
                                    sqsLimits: SQSLimits.Value) extends Logging {
 
   /**
@@ -65,15 +68,15 @@ case class TheSQSRestServerBuilder(providedActorSystem: Option[ActorSystem],
   def withPort(_port: Int) = this.copy(port = _port)
 
   /**
-   * Will use port zero for automatic assignment.
+   * Will assign port automatically (uses port 0). The port to which the socket binds will be logged on successful startup.
    */
   def withDynamicPort() = withPort(0)
 
   /**
    * @param _serverAddress Address which will be returned as the queue address. Requests to this address
    *                       should be routed to this server.
    */
-  def withServerAddress(_serverAddress: NodeAddress) = this.copy(serverAddress = _serverAddress)
+  def withServerAddress(_serverAddress: NodeAddress) = this.copy(serverAddress = _serverAddress, generateServerAddress = false)
 
   /**
    * @param _sqsLimits Should "real" SQS limits be used (strict), or should they be relaxed where possible (regarding
@@ -84,12 +87,14 @@ case class TheSQSRestServerBuilder(providedActorSystem: Option[ActorSystem],
   def start(): SQSRestServer = {
     val (theActorSystem, stopActorSystem) = getOrCreateActorSystem
     val theQueueManagerActor = getOrCreateQueueManagerActor(theActorSystem)
-    val theServerAddress = serverAddress
+    val theServerAddress = if (generateServerAddress) NodeAddress(host = if (interface.isEmpty) "localhost" else interface, port = port) else serverAddress
     val theLimits = sqsLimits
 
     implicit val implicitActorSystem = theActorSystem
     implicit val implicitMaterializer = ActorMaterializer()
 
+    val currentServerAddress = new AtomicReference[NodeAddress](theServerAddress)
+
     val env = new QueueManagerActorModule
       with QueueURLModule
       with SQSLimitsModule
@@ -110,7 +115,7 @@ case class TheSQSRestServerBuilder(providedActorSystem: Option[ActorSystem],
       with PurgeQueueDirectives
       with AttributesModule {
 
-      var serverAddress = theServerAddress
+      def serverAddress = currentServerAddress.get()
       lazy val actorSystem = theActorSystem
       lazy val materializer = implicitMaterializer
       lazy val queueManagerActor = theQueueManagerActor
@@ -159,17 +164,19 @@ case class TheSQSRestServerBuilder(providedActorSystem: Option[ActorSystem],
 
     appStartFuture.onSuccess {
       case sb: Http.ServerBinding =>
-        env.serverAddress = NodeAddress(
-          env.serverAddress.protocol,
-          env.serverAddress.host,
-          sb.localAddress.getPort,
-          env.serverAddress.contextPath
-        )
+        if (generateServerAddress && port != sb.localAddress.getPort) {
+          currentServerAddress.set(theServerAddress.copy(port = sb.localAddress.getPort))
+        }
 
         TheSQSRestServerBuilder.this.logger.info("Started SQS rest server, bind address %s:%d, visible server address %s"
                 .format(interface, sb.localAddress.getPort, if (env.serverAddress.isWildcard) "* (depends on incoming request path) " else env.serverAddress.fullAddress))
     }
 
+    appStartFuture.onFailure {
+      case NonFatal(e) =>
+        TheSQSRestServerBuilder.this.logger.error("Cannot start SQS rest server, bind address %s:%d".format(interface, port), e)
+    }
+
     SQSRestServer(appStartFuture, () => {
       appStartFuture.flatMap { sb =>
         stopActorSystem()

server/src/main/resources/reference.conf

@@ -21,6 +21,10 @@ rest-sqs {
     sqs-limits = strict
 }
 
+// Should the node-address be generated from the bind port/hostname
+// Set this to true e.g. when assigning port automatically by using port 0.
+generate-node-address = false
+
 queues {
     // queueName1 = {
     //   // all optional

server/src/main/scala/org/elasticmq/server/ElasticMQServer.scala

@@ -30,9 +30,8 @@ class ElasticMQServer(config: ElasticMQServerConfig) extends Logging {
 
   private def createBase(): ActorRef = {
     config.storage match {
-      case config.InMemoryStorage => {
+      case config.InMemoryStorage =>
         actorSystem.actorOf(Props(new QueueManagerActor(new NowProvider())))
-      }
     }
   }
 
@@ -44,6 +43,7 @@ class ElasticMQServer(config: ElasticMQServerConfig) extends Logging {
         config.restSqs.bindHostname,
         config.restSqs.bindPort,
         config.nodeAddress,
+        config.generateNodeAddress,
         config.restSqs.sqsLimits).start()
 
       server.waitUntilStarted()

server/src/main/scala/org/elasticmq/server/ElasticMQServerConfig.scala

@@ -31,6 +31,8 @@ class ElasticMQServerConfig(config: Config) {
       subConfig.getString("context-path"))
   }
 
+  val generateNodeAddress = config.getBoolean("generate-node-address")
+
   // Optionally expose the REST SQS interface
 
   class RestSqsConfiguration {