Merge branch 'wiremock'

Use WireMock in integration tests for mocking external services.

Fix #934

Author: php-coder

NEWS.txt

@@ -22,6 +22,7 @@
 - (functionality)  add support for specifying Zagorski catalog numbers
 - (functionality)  user may specify how many stamps from a series in his/her collection
 - (functionality)  paid users may specify a price that he/she paid for a series
+- (infrastructure) use WireMock in integration tests for mocking external services
 
 0.3
 - (functionality)  implemented possibility to user to add series to his collection

README.md

@@ -45,5 +45,5 @@ If you are programmer/sysadmin or you just feeling that you are able to run a lo
 * *Validation*: JSR-303 (Hibernate Validator)
 * *Logging*: Slf4j (Logback)
 * *Unit tests*: Groovy and Spock Framework (for Java code), jasmine (for JavaScript code)
-* *Integration tests*: Selenium2, RobotFramework, TestNG and fest-assert
+* *Integration tests*: Selenium2, RobotFramework, WireMock, TestNG and fest-assert
 * *Others*: Lombok, Togglz, WebJars

docs/wiremock.md

@@ -0,0 +1,43 @@
+# WireMock
+
+## What and why
+WireMock is a simulator for HTTP-based APIs. We use this tool in the integration tests for mocking
+external services. For example, for testing import of the stamps series from sites.
+
+## Running on TravisCI
+WireMock is automatically running/stopping during integration tests execution (`mvn verify`).
+
+## Running manually
+In order to run the server as a standlone process:
+* uncomment `<keepRunning>` option in the `pom.xml` file
+* execute the `mvn wiremock:run` command
+
+After that the mock server will be available on 8888 port.
+
+## Troubleshooting
+* [run the plugin separately](#running-manually) to be able to test it with a browser/curl
+* append `--verbose` flag to the options from `<params>` tag in the `pom.xml` file. This instructs
+  WireMock to produce more detailed output to the console
+
+## Configuration
+WireMock is fully configured by the `wiremock-maven-plugin` in the `pom.xml` file:
+
+* the server is listening on `8888` port
+* you can refer to the mock server from within RobotFramework test cases by using `${MOCK_SERVER}`
+  variable.
+* static files are reside inside the `src/test/wiremock/__files` directory
+* mocks and stubs are reside inside the `src/test/wiremock/mappings` directory
+
+By our convention the files in these directories should have the same hierarchy as their
+RobotFramework test cases. For instance, the mocks/files used solely by
+`category/creation/logic.robot` test case, should be placed into
+`src/test/wiremock/__files/category/creation/logic` and
+`src/test/wiremock/mappings/category/creation/logic` directories.
+
+In the case, mocks/files are being used by the different test cases, they should reside in a
+directory that is the base for all such test cases.
+
+## Links
+* http://wiremock.org/
+* https://github.com/tomakehurst/wiremock
+* https://github.com/automatictester/wiremock-maven-plugin

pom.xml

@@ -583,6 +583,7 @@
 
 		<togglz.version>2.5.0.Final</togglz.version>
 		<war.plugin.version>3.2.0</war.plugin.version>
+		<wiremock.plugin.version>2.13.1</wiremock.plugin.version>
 	</properties>
 
 	<build>
@@ -986,6 +987,7 @@
 						<variable>BROWSER:htmlunitwithjs</variable>
 						<variable>MAIN_RESOURCE_DIR:${basedir}/src/main/resources/test</variable>
 						<variable>TEST_RESOURCE_DIR:${basedir}/src/test/resources</variable>
+						<variable>MOCK_SERVER:http://127.0.0.1:8888</variable>
 						<!-- See also ru.mystamps.web.Url.SITE constant -->
 						<variable>SITE_URL:http://127.0.0.1:8080</variable>
 					</variables>
@@ -1046,6 +1048,36 @@
 				</executions>
 			</plugin>
 
+			<!--
+				Usage:
+				mvn wiremock:run (run WireMock server with mocks from src/test/wiremock/mappings)
+			-->
+			<plugin>
+				<groupId>uk.co.automatictester</groupId>
+				<artifactId>wiremock-maven-plugin</artifactId>
+				<version>${wiremock.plugin.version}</version>
+				<configuration>
+					<!-- Handy for manual debugging -->
+					<!--
+					<keepRunning>true</keepRunning>
+					-->
+					<dir>${basedir}/src/test/wiremock</dir>
+					<!--
+						The list of available options:
+						http://wiremock.org/docs/running-standalone/
+					-->
+					<!-- Handy for debugging: add &#45;&#45;verbose option -->
+					<params>--port=8888 --disable-banner --no-request-journal --container-threads=4 --jetty-acceptor-threads=1</params>
+				</configuration>
+				<executions>
+					<execution>
+						<goals>
+							<goal>run</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
+			
 		</plugins>
 
 	</build>

src/main/java/ru/mystamps/web/config/ControllersConfig.java

@@ -22,7 +22,6 @@
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
-import org.springframework.context.annotation.Profile;
 
 import lombok.RequiredArgsConstructor;
 
@@ -131,11 +130,5 @@ public SitemapController getSitemapController() {
 	public SuggestionController getSuggestionController() {
 		return new SuggestionController(countryService);
 	}
-
-	@Bean
-	@Profile({ "test", "travis" })
-	public TestController getTestController() {
-		return new TestController();
-	}
 
 }

src/main/java/ru/mystamps/web/controller/TestController.java

@@ -17,10 +17,6 @@
  */
 package ru.mystamps.web.util;
 
-import java.io.IOException;
-
-import javax.servlet.http.HttpServletResponse;
-
 import org.springframework.web.util.UriComponentsBuilder;
 
 public final class ControllerUtils {
@@ -36,10 +32,4 @@ public static String redirectTo(String url, Object... args) {
 		return "redirect:" + dstUrl;
 	}
 
-	public static void printHtml(HttpServletResponse response, String html) throws IOException {
-		response.setContentType("text/html");
-		response.setCharacterEncoding("UTF-8");
-		response.getWriter().println(html);
-	}
-	
 }

src/main/java/ru/mystamps/web/util/ControllerUtils.java

@@ -59,6 +59,14 @@ app.site-parser[1].seller-locator = #test-seller
 app.site-parser[1].price-locator = #test-price
 app.site-parser[1].currency-value = RUB
 
+app.site-parser[2].name = mockserver
+app.site-parser[2].matched-url = http://127.0.0.1:8888
+app.site-parser[2].image-url-locator = #test-image
+app.site-parser[2].short-description-locator = #test-description
+app.site-parser[2].seller-locator = #test-seller
+app.site-parser[2].price-locator = #test-price
+app.site-parser[2].currency-value = RUB
+
 # Full list of autoconfiguration classes:
 # http://docs.spring.io/spring-boot/docs/1.5.x/reference/html/auto-configuration-classes.html
 spring.autoconfigure.exclude: \

src/main/resources/application-test.properties

@@ -56,6 +56,14 @@ app.site-parser[1].seller-locator = #test-seller
 app.site-parser[1].price-locator = #test-price
 app.site-parser[1].currency-value = RUB
 
+app.site-parser[2].name = mockserver
+app.site-parser[2].matched-url = http://127.0.0.1:8888
+app.site-parser[2].image-url-locator = #test-image
+app.site-parser[2].short-description-locator = #test-description
+app.site-parser[2].seller-locator = #test-seller
+app.site-parser[2].price-locator = #test-price
+app.site-parser[2].currency-value = RUB
+
 # Full list of autoconfiguration classes:
 # http://docs.spring.io/spring-boot/docs/1.5.x/reference/html/auto-configuration-classes.html
 # The difference between test profile is that we don't need H2ConsoleAutoConfiguration

src/main/resources/application-travis.properties

@@ -135,7 +135,7 @@ if [ "$RUN_ONLY_INTEGRATION_TESTS" = 'no' ]; then
 	print_status "$POM_STATUS" 'Check sorting of pom.xml'
 
 	if [ "$BOOTLINT_STATUS" != 'skip' ]; then
-		find src -type f -name '*.html' -print0 | xargs -0 bootlint \
+		find src/main -type f -name '*.html' -print0 | xargs -0 bootlint \
 			>bootlint.log 2>&1 || BOOTLINT_STATUS=fail
 	fi
 	print_status "$BOOTLINT_STATUS" 'Run bootlint'

src/main/scripts/ci/check-build-and-verify.sh

@@ -30,27 +30,27 @@ Add image with invalid URL
 	Element Text Should Be  id=image-url.errors  Value must be a valid URL
 
 Add image with URL with invalid response
-	Input Text              id=image-url  ${SITE_URL}/test/invalid/response-400
+	Input Text              id=image-url  ${MOCK_SERVER}/series/response-400
 	Submit Form             id=add-image-form
 	Element Text Should Be  id=image-url.errors  Could not download file
 
 Add image with URL to a file that does not exist
-	Input Text              id=image-url  ${SITE_URL}/test/invalid/response-404
+	Input Text              id=image-url  ${MOCK_SERVER}/series/response-404
 	Submit Form             id=add-image-form
 	Element Text Should Be  id=image-url.errors  File not found
 
 Add image with URL that causes a redirect
-	Input Text              id=image-url  ${SITE_URL}/test/invalid/response-301
+	Input Text              id=image-url  ${MOCK_SERVER}/series/response-301
 	Submit Form             id=add-image-form
 	Element Text Should Be  id=image-url.errors  URL must not redirect to another address
 
 Add image with URL to an empty file
-	Input Text              id=image-url  ${SITE_URL}/test/invalid/empty-jpeg-file
+	Input Text              id=image-url  ${MOCK_SERVER}/series/empty-jpeg-file
 	Submit Form             id=add-image-form
 	Element Text Should Be  id=image-url.errors  File must not be empty
 
 Add image with URL to a file of unsupported type (not an image)
-	Input Text              id=image-url  ${SITE_URL}/test/invalid/not-image-file
+	Input Text              id=image-url  ${MOCK_SERVER}/series/not-image-file
 	Submit Form             id=add-image-form
 	Element Text Should Be  id=image-url.errors  Invalid file type
 

src/test/robotframework/series/add-image/validation.robot

@@ -47,27 +47,27 @@ Create series with invalid image URL
 	Element Text Should Be  id=image-url.errors  Value must be a valid URL
 
 Create series with image URL with invalid response
-	Input Text              id=image-url  ${SITE_URL}/test/invalid/response-400
+	Input Text              id=image-url  ${MOCK_SERVER}/series/response-400
 	Submit Form             id=add-series-form
 	Element Text Should Be  id=image-url.errors  Could not download file
 
 Create series with image URL to a file that does not exist
-	Input Text              id=image-url  ${SITE_URL}/test/invalid/response-404
+	Input Text              id=image-url  ${MOCK_SERVER}/series/response-404
 	Submit Form             id=add-series-form
 	Element Text Should Be  id=image-url.errors  File not found
 
 Create series with image URL that causes a redirect
-	Input Text              id=image-url  ${SITE_URL}/test/invalid/response-301
+	Input Text              id=image-url  ${MOCK_SERVER}/series/response-301
 	Submit Form             id=add-series-form
 	Element Text Should Be  id=image-url.errors  URL must not redirect to another address
 
 Create series with image URL to an empty file
-	Input Text              id=image-url  ${SITE_URL}/test/invalid/empty-jpeg-file
+	Input Text              id=image-url  ${MOCK_SERVER}/series/empty-jpeg-file
 	Submit Form             id=add-series-form
 	Element Text Should Be  id=image-url.errors  File must not be empty
 
 Create series with image URL to a file of unsupported type (not an image)
-	Input Text              id=image-url  ${SITE_URL}/test/invalid/not-image-file
+	Input Text              id=image-url  ${MOCK_SERVER}/series/not-image-file
 	Submit Form             id=add-series-form
 	Element Text Should Be  id=image-url.errors  Invalid file type