The document outlines the importance of software quality in development, emphasizing the value of automation testing, especially for legacy applications. It discusses the Recording HTTP Proxy, specifically Wiremock, detailing its functionalities, usage, and integration with PHP for effective software testing and mocking. Additionally, it covers testing methodologies such as end-to-end testing and how to measure results with various tools, concluding with insights on the limitations of testing tools.

1. The Recording HTTP
Proxy: Not Yet Another
Messiah
Viktor Todorov

2. About me
● Sofia, Bulgaria
● PHP Since 2009
● Software developer at Siteground since 2017
● Heavy Metal heart
● History
● Beer
● Japanese Anime

3. About Me
● Symfony
● NoSQL (Cassandra DB, Redis, Apache Solr/Lucene)
● Automation Testing Freak

4. Recording HTTP Proxy WireMock Measure The Results

5. Recording HTTP Proxy WireMock Measure The Results

6. Recording HTTP Proxy WireMock Measure The Results

7. Part I

8. Software Testing
● Software quality is the responsibility of every team member, especially the developers
● Automation is a great way to improve the quality of your software
● Unit Tests are Good, But Not Perfect. Especially for Legacy Application

9. Issues with Unit/Integration Testing a Legacy Application
● Quite a Big Project
● The Code Is Not Testable
● Where to Start?
● What kind of tests?
● Long Period Until Results
● Management Issues

10. Testing Legacy Application

11. What should we do?

12. I don’t know :(

13. Investigate: Find out how Big Companies are doing it

14. Recording HTTP Proxy

15. Software Testing Pyramid

17. E2E Testing

18. Definition
End-to-end testing is a Software testing methodology to test an application flow from start to end.
The purpose of End to end testing is to simulate the real user scenario and validate the system under
test and its components for integration and data integrity.
https://www.softwaretestinghelp.com/what-is-end-to-end-testing/

19. Source: softwaretestinghelp.com

20. Sample Scenario

21. 1. Register
2. Login into System
3. Add Product to Wishlist
4. Add Product to Wishlist
5. Check the Wishlist
6. Remove a Product from Wishlist
7. Add a Product from Wishlist To Shopping Cart
8. Delete a Product From Shopping Cart
9. Verifying the state

22. What is Recording HTTP Proxy?
A tool that records and replays back raw http requests. The request is sent to the proxy,
recorded in a data store, and the response from the server is returned back to the client.

23. Client Server
HTTP Recording
Proxy
Data Store
Recording Process

24. Client Server
HTTP Recording
Proxy
Data Store
Playback Process

25. Client Server
HTTP Recording
Proxy
Data Store
Replay Process

26. Why using it?
● Keep The Whole HTTP Stack, Serialization, Events, etc.
● Everything is happening only on a server level. No GUI required
● Can replay at anytime
● Can Simulate More Than One Client
● Independent from FE
● Easy to Record.

27. Disadvantages
● Flaky/Fragile Tests
● Less Debug Info
● Costly in terms of speed

28. My Concept

29. Discovering the unexpected is more important than
confirming the known.
George E. P. Box
“
“

30. ● We should be able discover how our project works
● Once recorded, a test should work anytime if no code changed.
● Supports Versions
● Easy To Record
My Goals

31. Data Store

33. Why Apache Solr?
1. I know how to use it
2. Easy to Search
3. Structureless
4. Easy Integration With PHP. Good HTTP API, solariumphp, SolPHP (official)

34. Recordings Structure

35. .HAR Files Format

36. .HAR Files Format
“The HTTP Archive format, or HAR, is a JSON-formatted archive file format for
logging of a web browser's interaction with a site. The common extension for these
files is .har.” Wikipedia.org

38. Why HAR Format?
● Not Created For Recordings!
● Purpose: Debugging HTTP Requests.
● All Info in one place.
● Supported By Other Tools: Postman, Browsers

39. Considerations
● CSRF protection
● Authentication
● Database
● Code Coverage

40. PART II

41. Third Party Integration

43. WireMock

44. About WireMock
● WireMock was originally created by Tom Akehurst in 2011
● Often described as a HTTP Server Mocking Tool
● Apache 2.0 License
● Java
● Good PHP Support via PHP Library
● Good HTTP API

45. Website Web Service
http://localhost:8080/

46. Website Web Service
/files /mappings
http://localhost:8080/

47. $ java -jar wiremock-standalone-2.25.1.jar
port: 8080
enable-browser-proxying: false
disable-banner: false
no-request-journal: false
verbose: false

48. $ composer require --dev wiremock-php/wiremock-php

49. Mappings
GET - /best_conf - Should Return “BGPHP”

50. Mappings
{
"request": {
"method": "GET",
"urlPattern": "/conferences/best_in_the_world"
},
"response": {
"body" : "<items><item><name>BGPHP</name></item></items>"
}
}

51. Types Of Mappings?
● File-Based
● In-Memory

52. Recording File-Based Mappings
$ java -jar wiremock-standalone-2.25.1.jar --record-mappings --proxy-all
https://google.com

53. {
"id" : "6f612257-1241-339a-a558-7707e8d8c9bc",
"request" : {
"url" : "/",
"method" : "GET"
},
"response" : {
"status" : 200,
"bodyFileName" : "body-YE3ab.txt",
"headers" : {
"Content-Type" : "text/html; charset=UTF-8",
"Date" : "Fri, 01 Nov 2019 17:10:09 GMT",
"Expires" : "Fri, 01 Nov 2019 17:10:09 GMT",
"Cache-Control" : "private, max-age=2592000",
"Server" : "gws",
}
},
"uuid" : "6f612257-1241-339a-a558-7707e8d8c9bc"
}

54. Stubbing
Creating a mapping programmatically

55. Using PHP

56. // Create an object to administer a WireMock instance. This is assumed to be at
// localhost:8080 unless these values are overridden.
$wireMock = WireMock::create();
// Stub out a request
$wireMock->stubFor(WireMock::get(WireMock::urlEqualTo('/some/url'))
->willReturn(WireMock::aResponse()
->withHeader('Content-Type', 'text/plain')
->withBody('Hello world!')));
// ... interact with the server ...
// Verify a request
$wireMock->verify(WireMock::postRequestedFor(WireMock::urlEqualTo('/verify/this'))
->withHeader('Content-Type', WireMock::equalTo('text/xml')));

57. // Create an object to administer a WireMock instance. This is assumed to be at
// localhost:8080 unless these values are overridden.
$wireMock = WireMock::create();
// Stub out a request
$wireMock->stubFor(WireMock::get(WireMock::urlEqualTo('/some/url'))
->willReturn(WireMock::aResponse()
->withHeader('Content-Type', 'text/plain')
->withBody('Hello world!')));
// ... interact with the server ...
// Verify a request
$wireMock->verify(WireMock::postRequestedFor(WireMock::urlEqualTo('/verify/this'))
->withHeader('Content-Type', WireMock::equalTo('text/xml')));

58. {
"id" : "6f612257-1241-339a-a558-7707e8d8c9bc",
"request" : {
"url" : "/some/url",
"method" : "GET"
},
"response" : {
"body" : "Hello World",
"headers" : {
"Content-Type" : "text/plain"
}
},
"uuid" : "6f612257-1241-339a-a558-7707e8d8c9bc"
}

59. // Verify a request
$wireMock->verify(WireMock::postRequestedFor(WireMock::urlEqualTo('/verify/this'))
->withHeader('Content-Type', WireMock::equalTo('text/xml')));

60. View Mappings
http://localhost:8080/__admin/mappings

61. Recorder
http://localhost:8080/__admin/recorder/

63. $ curl http://localhost:8080/recordables/123
{
"message": "Congratulations ...."
}

64. POST /__admin/recordings/start
{
"targetBaseUrl": "http://example.mocklab.io"
}
POST /__admin/recordings/stop

65. Snapshotting

66. Snapshotting is effectively “recording after
the fact”. Rather than starting recording at a
specific point, snapshotting allows you to
convert requests already received by
WireMock into stub mappings.

67. POST /__admin/recordings/snapshot
{}

68. Customising Your Recordings
POST /__admin/recordings/start
{
"targetBaseUrl" : "http://example.mocklab.io",
"filters" : {
"urlPathPattern" : "/api/.*",
"method" : "GET",
},
"captureHeaders" : {
"Accept" : { },
"Content-Type" : {
"caseInsensitive" : true
}
},
"requestBodyPattern" : {
"matcher" : "equalToJson",
"ignoreArrayOrder" : false,
"ignoreExtraElements" : true
},
"extractBodyCriteria" : {
"textSizeThreshold" : "2048",
"binarySizeThreshold" : "10240"
},
}

69. States

70. Example: To Do List
Started
1 Item
State 2
State 2
2 Items
State 3
State 3
3 Items
Started
GET /todo/items GET /todo/items GET /todo/items

71. Started State
{
"scenarioName": "To do list",
"requiredScenarioState": "Started",
"newScenarioState": "State 2",
"request": {
"method": "GET",
"url": "/todo/items"
},
"response": {
"status": 200,
"body" : "<items><item>Buy milk</item></items>"
}
}

72. State 2
{
"scenarioName": "To do list",
"requiredScenarioState": "State 2",
"newScenarioState": "State 3",
"request": {
"method": "GET",
"url": "/todo/items"
},
"response": {
"status": 200,
"body" : "<items><item>Buy milk</item><item>Cancel newspaper
subscription</item></items>"
}
}

73. State 3
{
"scenarioName": "To do list",
"requiredScenarioState": "State 3",
"newScenarioState": "Started",
"request": {
"method": "GET",
"url": "/todo/items"
},
"response": {
"status": 200,
"body" : "<items><item>Buy milk</item><item>Cancel newspaper
subscription</item><item>Attend BGPHP Conference</item></items>"
}
}

74. Wiremock browser extension

76. More About WireMock
● Advanced HTTP Mocking With WireMock - Sam Edwards - droidcon 2017
● http://wiremock.org/external-resources/

77. Part III

78. Opencart Test Store

79. What we have to deal with?

83. Goal: Integrate, Test and Measure Results

84. Goal: Integrate, Test and Measure Results

85. Goal: Integrate, Test and Measure Results

86. Goal: Integrate, Test and Measure Results

87. composer.json
{
"require-dev": {
"phpunit/php-code-coverage": "^6.1",
"phpunit/phpcov": "^5.0"
}
}

88. composer.json
{
"require-dev": {
"phpunit/php-code-coverage": "^6.1",
"phpunit/phpcov": "^5.0"
}
}

89. composer.json
{
"require-dev": {
"phpunit/php-code-coverage": "^6.1",
"phpunit/phpcov": "^5.0"
}
}

90. require_once "vendor/autoload.php";
$headers = getallheaders();

91. require_once "vendor/autoload.php";
$headers = getallheaders();
...
if (isset($headers['http-proxy-request-id'])) {
$coverage = new CodeCoverage();
$coverage->filter()->addDirectoryToWhitelist('catalog/');
$coverage->filter()->addDirectoryToWhitelist('system/');
$coverage->start($headers['http-proxy-request-id']);
}
...
if (xdebug_code_coverage_started()) {
$coverage->stop();
$writer = new SebastianBergmannCodeCoverageReportPHP;
$writer->process($coverage, 'coverage-report/php-' . $headers['http-proxy-request-id'] . '.cov');
}

92. require_once "vendor/autoload.php";
$headers = getallheaders();
...
if (isset($headers['http-proxy-request-id'])) {
$coverage = new CodeCoverage();
$coverage->filter()->addDirectoryToWhitelist('catalog/');
$coverage->filter()->addDirectoryToWhitelist('system/');
$coverage->start($headers['http-proxy-request-id']);
}
...
if (xdebug_code_coverage_started()) {
$coverage->stop();
$writer = new SebastianBergmannCodeCoverageReportPHP;
$writer->process($coverage, 'coverage-report/php-' . $headers['http-proxy-request-id'] . '.cov');
}

93. require_once "vendor/autoload.php";
$headers = getallheaders();
...
if (isset($headers['http-proxy-request-id'])) {
$coverage = new CodeCoverage();
$coverage->filter()->addDirectoryToWhitelist('catalog/');
$coverage->filter()->addDirectoryToWhitelist('system/');
$coverage->start($headers['http-proxy-request-id']);
}
...
if (xdebug_code_coverage_started()) {
$coverage->stop();
$writer = new SebastianBergmannCodeCoverageReportPHP;
$writer->process($coverage, 'coverage-report/php-' . $headers['http-proxy-request-id'] . '.cov');
}

94. require_once "vendor/autoload.php";
$headers = getallheaders();
...
if (isset($headers['http-proxy-request-id'])) {
$coverage = new CodeCoverage();
$coverage->filter()->addDirectoryToWhitelist('catalog/');
$coverage->filter()->addDirectoryToWhitelist('system/');
$coverage->start($headers['http-proxy-request-id']);
}
...
if (xdebug_code_coverage_started()) {
$coverage->stop();
$writer = new SebastianBergmannCodeCoverageReportPHP;
$writer->process($coverage, 'coverage-report/php-' . $headers['http-proxy-request-id'] . '.cov');
}

95. After a Couple of Clicks:

96. $ vendor/bin/phpcov merge [files location] --html [report location]

97. $ vendor/bin/phpcov merge [files location] --html [report location]
phpcov 2.0.0 by Sebastian Bergmann.
Generating code coverage report in HTML format ... done

99. Conclusion

100. He who thinks a tool can solve all problems, has a
new problem.
Frederico Toledo
“
“
It’s not a perfect solution

101. Don’t Stop Writing Tests

102. Different Approach

103. Measure The Results

104. HTTP Recording Proxy Tools
● JMeter - Apache
● AQA HTTP Recorder - Chrome
● IBM Rational Tester Workbench
● PoliJS - Netflix
● Postman

105. Thank you.