Play Framework/Scala example source code file (NettyHandlingSpec.scala)

This example Play Framework source code file (NettyHandlingSpec.scala) is included in my "Source Code Warehouse" project. The intent of this project is to help you more easily find Play Framework (and Scala) source code examples by using tags.

All credit for the original source code belongs to Play Framework; I'm just trying to make examples easier to find. (For my Scala work, see my Scala examples and tutorials.)

Play Framework tags/keywords

api, close, connection, dummy, exception, keep-alive, must, mvc, netty, nettyhandlingspec, ok, play, play framework, play's

The NettyHandlingSpec.scala Play Framework example source code

/*
 * Copyright (C) 2009-2013 Typesafe Inc. <http://www.typesafe.com>
 */
package play.it.http

import org.jboss.netty.handler.codec.http._
import play.api.mvc._

/**
 * Tests for Play's interactions with Netty. Allows observation and control of
 * individual Netty events, e.g. can simulate failure sending a response and
 * observe whether the connection is closed properly.
 */
object NettyHandlingSpec extends NettySpecification {

  "Play's Netty handling" should {

    "handle HTTP/1.1 requests without Connection headers" in withQueuingChannel(Action(Results.Ok)) { qc =>
      val request = new DefaultHttpRequest(HttpVersion.HTTP_1_1, HttpMethod.GET, "/")
      qc.sendOrderedMessage(request)

      val responseMessage = qc.receive.asInstanceOf[Message]
      val httpResponse = responseMessage.msg.asInstanceOf[DefaultHttpResponse]
      httpResponse.getStatus.getCode must_== OK
      httpResponse.headers().get(HttpHeaders.Names.CONTENT_LENGTH) must_== "0"

      qc.succeed

      qc.dontReceive // Must not close connection
    }

    "handle HTTP/1.1 requests with 'Connection: Keep-Alive' headers" in withQueuingChannel(Action(Results.Ok)) { qc =>
      val request = new DefaultHttpRequest(HttpVersion.HTTP_1_1, HttpMethod.GET, "/")
      request.headers().add(CONNECTION, "Keep-Alive")
      qc.sendOrderedMessage(request)

      val responseMessage = qc.receive.asInstanceOf[Message]
      val httpResponse = responseMessage.msg.asInstanceOf[DefaultHttpResponse]
      httpResponse.getStatus.getCode must_== OK
      httpResponse.headers().get(HttpHeaders.Names.CONTENT_LENGTH) must_== "0"
      qc.succeed

      qc.dontReceive // Must not close connection
    }

    "handle HTTP/1.1 requests with 'Connection: Close' headers" in withQueuingChannel(Action(Results.Ok)) { qc =>
      val request = new DefaultHttpRequest(HttpVersion.HTTP_1_1, HttpMethod.GET, "/")
      request.headers().add(CONNECTION, "Close")
      qc.sendOrderedMessage(request)

      val responseMessage = qc.receive.asInstanceOf[Message]
      val httpResponse = responseMessage.msg.asInstanceOf[DefaultHttpResponse]
      httpResponse.getStatus.getCode must_== OK
      httpResponse.headers().get(HttpHeaders.Names.CONTENT_LENGTH) must_== "0"
      qc.succeed

      qc.receive.asInstanceOf[Close.type]
      qc.dontReceive // Must not close connection twice
    }

    "handle HTTP/1.1 requests with 'Connection: Close' headers when an error occurs sending a response" in withQueuingChannel(Action(Results.Ok)) { qc =>
      val request = new DefaultHttpRequest(HttpVersion.HTTP_1_1, HttpMethod.GET, "/")
      request.headers().add(CONNECTION, "Close")
      qc.sendOrderedMessage(request)

      val responseMessage = qc.receive.asInstanceOf[Message]
      val httpResponse = responseMessage.msg.asInstanceOf[DefaultHttpResponse]
      httpResponse.getStatus.getCode must_== OK
      httpResponse.headers().get(HttpHeaders.Names.CONTENT_LENGTH) must_== "0"
      qc.fail(new Exception("Dummy exception sending"))

      qc.receive.asInstanceOf[Close.type]
      qc.dontReceive // Must not close connection twice
    }

    "handle HTTP/1.0 requests without Connection headers" in withQueuingChannel(Action(Results.Ok)) { qc =>
      val request = new DefaultHttpRequest(HttpVersion.HTTP_1_0, HttpMethod.GET, "/")
      qc.sendOrderedMessage(request)

      val responseMessage = qc.receive.asInstanceOf[Message]
      val httpResponse = responseMessage.msg.asInstanceOf[DefaultHttpResponse]
      httpResponse.getStatus.getCode must_== OK
      httpResponse.headers().get(HttpHeaders.Names.CONTENT_LENGTH) must_== "0"
      qc.succeed

      qc.receive.asInstanceOf[Close.type]
      qc.dontReceive // Must not close connection twice
    }

    "handle HTTP/1.0 requests with 'Connection: Keep-Alive' headers" in withQueuingChannel(Action(Results.Ok)) { qc =>
      val request = new DefaultHttpRequest(HttpVersion.HTTP_1_0, HttpMethod.GET, "/")
      request.headers().add(CONNECTION, "Keep-Alive")
      qc.sendOrderedMessage(request)

      val responseMessage = qc.receive.asInstanceOf[Message]
      val httpResponse = responseMessage.msg.asInstanceOf[DefaultHttpResponse]
      httpResponse.getStatus.getCode must_== OK
      httpResponse.headers().get(HttpHeaders.Names.CONTENT_LENGTH) must_== "0"
      qc.succeed

      qc.dontReceive // Must not close connection
    }

    "handle HTTP/1.0 requests with 'Connection: Close' headers" in withQueuingChannel(Action(Results.Ok)) { qc =>
      val request = new DefaultHttpRequest(HttpVersion.HTTP_1_0, HttpMethod.GET, "/")
      request.headers().add(CONNECTION, "Close")
      qc.sendOrderedMessage(request)

      val responseMessage = qc.receive.asInstanceOf[Message]
      val httpResponse = responseMessage.msg.asInstanceOf[DefaultHttpResponse]
      httpResponse.getStatus.getCode must_== OK
      httpResponse.headers().get(HttpHeaders.Names.CONTENT_LENGTH) must_== "0"
      qc.succeed

      qc.receive.asInstanceOf[Close.type]
      qc.dontReceive // Must not close connection twice
    }

  }

}