http-mock

Real http server for stubbing and expectations in Scala

License	MIT License
GroupId	sc.ala
ArtifactId	http-mock_2.12
Last Version	0.3.4
Release Date	Nov 22, 2017
Type	jar
Description	http-mock Real http server for stubbing and expectations in Scala
Project URL	https://github.com/maiha/http-mock
Project Organization	sc.ala
Source Code Management	https://github.com/maiha/http-mock

Download http-mock_2.12

Filename	Size
http-mock_2.12-0.3.4.pom
http-mock_2.12-0.3.4.jar	90 KB
http-mock_2.12-0.3.4-sources.jar	8 KB
http-mock_2.12-0.3.4-javadoc.jar	709 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/sc.ala/http-mock_2.12/ -->
<dependency>
    <groupId>sc.ala</groupId>
    <artifactId>http-mock_2.12</artifactId>
    <version>0.3.4</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/sc.ala/http-mock_2.12/
implementation 'sc.ala:http-mock_2.12:0.3.4'

Gradle Kotlin

// https://jarcasting.com/artifacts/sc.ala/http-mock_2.12/
implementation ("sc.ala:http-mock_2.12:0.3.4")

Apache Buildr

'sc.ala:http-mock_2.12:jar:0.3.4'

Apache Ivy

<dependency org="sc.ala" name="http-mock_2.12" rev="0.3.4">
  <artifact name="http-mock_2.12" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='sc.ala', module='http-mock_2.12', version='0.3.4')
)

Scala SBT

libraryDependencies += "sc.ala" % "http-mock_2.12" % "0.3.4"

Leiningen

[sc.ala/http-mock_2.12 "0.3.4"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.scala-lang : scala-library	jar	2.12.4
com.typesafe.play : play-netty-server_2.12	jar	2.6.7

test (2)

Group / Artifact	Type	Version
org.scalatest : scalatest_2.12	jar	3.0.4
com.ning : async-http-client	jar	1.9.40

Project Modules

There are no modules declared in this project.

HttpMock

Real http server for stubbing and expectations in Scala

Features

• Stubbing HTTP requests at real Http Server
  • responds always OK for any methods and paths
  • supported methods: GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS
• Expecting HTTP requests as AccessLog
  • asserts AccessLog about methods and counts

Stubbing

start (random port)

import sc.ala.http.mock._
val server = HttpMock.start()
server.port  // => 37781 (automatically set by default)
// send requests to "http://127.0.0.1:37781" (or server.url)
server.stop

start with port

val server = HttpMock.start(9000)
server.port  // => 9000

restartable

• HttpMock is immutable

val server    = HttpMock.start(9000)  // GET: ok
val stopped   = server.stop()         // GET: error
val restarted = stopped.start()       // GET: ok

loan pattern

• run() ensures server.stop() after action

HttpMock.run()      { server => ... }
HttpMock.run(port)  { server => ... }
Setting(port).run() { server => ... }

restrict methods

• default: accept all methods

val server = Setting(methods = Set(GET, POST)).start()
/*
  GET  => 200
  POST => 200
  PUT  => 404
*/

customize request handler

val server = Setting(handler = {
    case h: RequestHeader if h.version == "HTTP/1.0" => Results.HttpVersionNotSupported
})
/*
  GET  => 200
  GET with HTTP/1.0 => 505
*/

Expectations

• implemented expectations:
  • method, body, header, count

import sc.ala.http.mock._
import scala.concurrent.duration._

val server = HttpMock.start(9000)

assert methods and counts

curl http://127.0.0.1:9000/

server.logs.expect(GET , count = 1)(1.second)  // (PASS)
server.logs.expect(GET , count = 2)(1.second)  // java.lang.AssertionError
server.logs.expect(POST, count = 1)(1.second)  // java.lang.AssertionError

server.stop()

assert methods and body and headers

curl -X POST -H "Content-type: application/octet-stream" http://127.0.0.1:9000/ -d foo
curl -X POST -H "Content-type: application/octet-stream" http://127.0.0.1:9000/ -d bar
curl -X POST -H "Content-type: application/octet-stream" -H "X-ID: 1" http://127.0.0.1:9000/ -d bar

server.logs.expect(POST).body("foo")(1.second)           // (PASS)
server.logs.expect(POST).body("bar")(1.second)           // java.lang.AssertionError
server.logs.expect(POST).body("bar").count(2)(1.second)  // (PASS)
server.logs.expect(POST).body("baz")(1.second)           // java.lang.AssertionError
server.logs.expect(POST).header("X-ID", "1")(1.second)   // (PASS)

server.stop()

assert bodies as Set

curl -X POST -H "Content-type: application/octet-stream" http://127.0.0.1:9000/ -d foo
curl -X POST -H "Content-type: application/octet-stream" http://127.0.0.1:9000/ -d bar
curl -X POST -H "Content-type: application/octet-stream" -H "X-ID: 1" http://127.0.0.1:9000/ -d bar

server.logs.expect(POST).bodies(Set("foo", "bar"))(1.second)  // (PASS)
server.logs.expect(POST).bodies(Set("bar", "foo"))(1.second)  // (PASS)
server.logs.expect(POST).bodies(Set("foo", "XXX"))(1.second)  // java.lang.AssertionError

server.stop()

using in Spec

import sc.ala.http.mock._
import scala.concurrent.duration._
import org.scalatest.FunSpec

class FooSpec extends FunSpec {
  describe("foo") {
    it("test with real httpd") {
      HttpMock.run { server =>
        // your application logic to `server.url`
        ...

        // assert your requests like this
        server.logs.expect(POST, count = 2)(3.seconds)
      }
    }
  }
}

TODO

Expectations

• support path, request parameters and request bodies

Library

See build.sbt

Release

% sbt
> + compile
> + publishSigned
> + sonatypeRelease

If you got Unable to find credentials in publishSigned phase, it might have to do with credentials at ~/.sbt/0.13/sonatype.sbt.

[error] Unable to find credentials for [Sonatype Nexus Repository Manager @ oss.sonatype.org].
[trace] Stack trace suppressed: run last *:publishSigned for the full output.
[error] (*:publishSigned) java.io.IOException: Access to URL https://oss.sonatype.org/service/local/staging/deploy/maven2/sc/ala/http-mock_2.11/0.3.3/http-mock_2.11-0.3.3-javadoc.jar was refused by the server: Unauthorized

See: http://www.scala-sbt.org/release/docs/Using-Sonatype.html

Versions

Version
0.3.4 Nov 22, 2017