wiremock-unused-stubs-extension

Wiremock API extension to find stub mappigns that haven't matched a rquest

License	The Apache Software License, Version 2.0
Categories	Wire Data Data Structures
GroupId	com.github.masonm
ArtifactId	wiremock-unused-stubs-extension
Last Version	0.3
Release Date	Oct 21, 2019
Type	jar
Description	wiremock-unused-stubs-extension Wiremock API extension to find stub mappigns that haven't matched a rquest
Project URL	https://github.com/MasonM/wiremock-unused-stubs-extension
Source Code Management	https://github.com/MasonM/wiremock-unused-stubs-extension

Download wiremock-unused-stubs-extension

Filename	Size
wiremock-unused-stubs-extension-0.3.pom
wiremock-unused-stubs-extension-0.3.jar	4 KB
wiremock-unused-stubs-extension-0.3-standalone.jar	11 MB
wiremock-unused-stubs-extension-0.3-sources.jar	2 KB
wiremock-unused-stubs-extension-0.3-javadoc.jar	21 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/com.github.masonm/wiremock-unused-stubs-extension/ -->
<dependency>
    <groupId>com.github.masonm</groupId>
    <artifactId>wiremock-unused-stubs-extension</artifactId>
    <version>0.3</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/com.github.masonm/wiremock-unused-stubs-extension/
implementation 'com.github.masonm:wiremock-unused-stubs-extension:0.3'

Gradle Kotlin

// https://jarcasting.com/artifacts/com.github.masonm/wiremock-unused-stubs-extension/
implementation ("com.github.masonm:wiremock-unused-stubs-extension:0.3")

Apache Buildr

'com.github.masonm:wiremock-unused-stubs-extension:jar:0.3'

Apache Ivy

<dependency org="com.github.masonm" name="wiremock-unused-stubs-extension" rev="0.3">
  <artifact name="wiremock-unused-stubs-extension" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='com.github.masonm', module='wiremock-unused-stubs-extension', version='0.3')
)

Scala SBT

libraryDependencies += "com.github.masonm" % "wiremock-unused-stubs-extension" % "0.3"

Leiningen

[com.github.masonm/wiremock-unused-stubs-extension "0.3"]

Dependencies

test (9)

Group / Artifact	Type	Version
com.github.tomakehurst : wiremock	jar	2.14.0
junit : junit	jar	4.12
org.hamcrest : hamcrest-all	jar	1.3
org.jmock : jmock	jar	2.5.1
org.jmock : jmock-junit4	jar	2.5.1
org.skyscreamer : jsonassert	jar	1.2.3
com.toomuchcoding.jsonassert : jsonassert	jar	0.4.7
org.apache.httpcomponents : httpmime	jar	4.5
com.github.tomakehurst : wiremock	jar	2.14.0

Project Modules

There are no modules declared in this project.

Overview

wiremock-unused-stubs-extension is an admin extension for WireMock that adds a new endpoint, /__admin/unused_mappings, for finding and removing stub mappings that have not matched any requests in the journal. This is useful in conjunction with Record and Playback for pruning generated stub mappings.

Building

Run gradle jar to build the JAR without dependencies or gradle fatJar to build a standalone JAR. These will be placed in build/libs/.

Running

Standalone server:

java -jar build/libs/wiremock-unused-stubs-extension-0.3-standalone.jar

With WireMock standalone JAR:

wget -nc http://repo1.maven.org/maven2/com/github/tomakehurst/wiremock-standalone/2.14.0/wiremock-standalone-2.14.0.jar
java \
        -cp wiremock-standalone-2.14.0.jar:build/libs/wiremock-unused-stubs-extension-0.3.jar \
        com.github.tomakehurst.wiremock.standalone.WireMockServerRunner \
        --extensions="com.github.masonm.wiremock.UnusedStubsAdminExtension"

Programmatically in Java:

new WireMockServer(wireMockConfig()
    .extensions("com.github.masonm.wiremock.UnusedStubsAdminExtension"))

Usage

• Call GET /__admin/unused_mappings to retrieve an array of stub mappings that have not matched any requests in the request journal.
• Call DELETE /__admin/unused_mappings to remove all such stub mappings. By default, any body files used by the stub mappings (typically stored in the "__files" directory) will preserved. To remove those too, pass "remove_files" in the query, i.e. DELETE /__admin/unused_mappings?remove_files

Versions

Version
0.3 Oct 21, 2019
0.2 Apr 1, 2018
0.1a Aug 14, 2017