Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: fix Node.js link, add link to Docker Compose examples #1877

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Docs: fix Node.js link, add link to Docker Compose examples #1877

wants to merge 2 commits into from

Conversation

sgerrand
Copy link

馃拋 While browsing the documentation for this excellent project, I came across a broken link and made these changes.

These changes:

  • Fix
    • a broken link to a previous Node.js example (removed in 5104722, did I link to a suitable replacement?)
  • Add
    • A link to the directory of Node.js examples
    • A link to the directory of Docker Compose configuration examples

@sgerrand
Copy link
Author

馃憢 @jamesdbloom, would you please approve the pending workflow when you have a chance?

Screenshot 2024-05-29 at 12 38 02

@sgerrand
Copy link
Author

馃 Looks like there are errors being raised in the Java test suite which are unrelated to this change. Can anyone with more knowledge of this test suite comment on whether this flakiness is normal or not?

[ERROR] Tests run: 14, Failures: 1, Errors: 0, Skipped: 0, Time elapsed: 28.085 s <<< FAILURE! - in org.mockserver.dashboard.DashboardWebSocketHandlerTest
--
聽 | [ERROR] shouldSerialiseEventsWithRequestFilter(org.mockserver.dashboard.DashboardWebSocketHandlerTest)  Time elapsed: 2.013 s  <<< FAILURE!
聽 | java.lang.AssertionError:
聽 | 聽
聽 | Expected: is "{\n  \"logMessages\" : [ {\n    \"key\" : \"2cadd5ed-2de7-447a-a63f-d92d6b2f48f1_log\",\n    \"value\" : {\n      \"description\" : \"05-29 12:51:41.336 RECEIVED_REQUEST   \",\n      \"style\" : {\n        \"paddingBottom\" : \"4px\",\n        \"whiteSpace\" : \"nowrap\",\n        \"overflow\" : \"auto\",\n        \"color\" : \"rgb(114,160,193)\",\n        \"paddingTop\" : \"4px\"\n      },\n      \"messageParts\" : [ {\n        \"key\" : \"2cadd5ed-2de7-447a-a63f-d92d6b2f48f1_0msg\",\n        \"value\" : \"messageFormatThree\"\n      } ]\n    }\n  }, {\n    \"key\" : \"5fb82048-7c7a-4c87-b15b-c6e74c1a5206_log\",\n    \"value\" : {\n      \"description\" : \"05-29 12:51:41.336 INFO               \",\n      \"style\" : {\n        \"style.whiteSpace\" : \"pre-wrap\",\n        \"paddingBottom\" : \"4px\",\n        \"whiteSpace\" : \"nowrap\",\n        \"overflow\" : \"auto\",\n        \"color\" : \"rgb(59,122,87)\",\n        \"paddingTop\" : \"4px\"\n      },\n      \"messageParts\" : [ {\n        \"key\" : \"5fb82048-7c7a-4c87-b15b-c6e74c1a5206_0msg\",\n        \"value\" : \"messageFormat\"\n      } ]\n    }\n  } ],\n  \"recordedRequests\" : [ {\n    \"description\" : \"  /somePathTwo\",\n    \"value\" : {\n      \"path\" : \"/somePathTwo\"\n    },\n    \"key\" : \"2cadd5ed-2de7-447a-a63f-d92d6b2f48f1_request\"\n  } ]\n}"
聽 | but: was "{\n  \"logMessages\" : [ {\n    \"key\" : \"2cadd5ed-2de7-447a-a63f-d92d6b2f48f1_log\",\n    \"value\" : {\n      \"description\" : \"05-29 12:51:41.336 RECEIVED_REQUEST   \",\n      \"style\" : {\n        \"paddingBottom\" : \"4px\",\n        \"whiteSpace\" : \"nowrap\",\n        \"overflow\" : \"auto\",\n        \"color\" : \"rgb(114,160,193)\",\n        \"paddingTop\" : \"4px\"\n      },\n      \"messageParts\" : [ {\n        \"key\" : \"2cadd5ed-2de7-447a-a63f-d92d6b2f48f1_0msg\",\n        \"value\" : \"messageFormatThree\"\n      } ]\n    }\n  }, {\n    \"key\" : \"4729b142-31e5-42cb-8557-fdb2887deb86_log\",\n    \"value\" : {\n      \"description\" : \"05-29 12:51:41.336 RECEIVED_REQUEST   \",\n      \"style\" : {\n        \"paddingBottom\" : \"4px\",\n        \"whiteSpace\" : \"nowrap\",\n        \"overflow\" : \"auto\",\n        \"color\" : \"rgb(114,160,193)\",\n        \"paddingTop\" : \"4px\"\n      },\n      \"messageParts\" : [ {\n        \"key\" : \"4729b142-31e5-42cb-8557-fdb2887deb86_0msg\",\n        \"value\" : \"messageFormatTwo\"\n      } ]\n    }\n  }, {\n    \"key\" : \"58db37b2-df0a-43dd-8bc4-2f5e0479054e_log\",\n    \"value\" : {\n      \"description\" : \"05-29 12:51:41.336 RECEIVED_REQUEST   \",\n      \"style\" : {\n        \"paddingBottom\" : \"4px\",\n        \"whiteSpace\" : \"nowrap\",\n        \"overflow\" : \"auto\",\n        \"color\" : \"rgb(114,160,193)\",\n        \"paddingTop\" : \"4px\"\n      },\n      \"messageParts\" : [ {\n        \"key\" : \"58db37b2-df0a-43dd-8bc4-2f5e0479054e_0msg\",\n        \"value\" : \"messageFormatOne\"\n      } ]\n    }\n  }, {\n    \"key\" : \"5fb82048-7c7a-4c87-b15b-c6e74c1a5206_log\",\n    \"value\" : {\n      \"description\" : \"05-29 12:51:41.336 INFO               \",\n      \"style\" : {\n        \"style.whiteSpace\" : \"pre-wrap\",\n        \"paddingBottom\" : \"4px\",\n        \"whiteSpace\" : \"nowrap\",\n        \"overflow\" : \"auto\",\n        \"color\" : \"rgb(59,122,87)\",\n        \"paddingTop\" : \"4px\"\n      },\n      \"messageParts\" : [ {\n        \"key\" : \"5fb82048-7c7a-4c87-b15b-c6e74c1a5206_0msg\",\n        \"value\" : \"messageFormat\"\n      } ]\n    }\n  }, {\n    \"key\" : \"6a3183c0-ca5c-4062-8d58-9c12ce148431_log\",\n    \"value\" : {\n      \"description\" : \"05-29 12:51:41.336 INFO               \",\n      \"style\" : {\n        \"style.whiteSpace\" : \"pre-wrap\",\n        \"paddingBottom\" : \"4px\",\n        \"whiteSpace\" : \"nowrap\",\n        \"overflow\" : \"auto\",\n        \"color\" : \"rgb(59,122,87)\",\n        \"paddingTop\" : \"4px\"\n      },\n      \"messageParts\" : [ {\n        \"key\" : \"6a3183c0-ca5c-4062-8d58-9c12ce148431_0msg\",\n        \"value\" : \"messageFormat\"\n      } ]\n    }\n  }, {\n    \"key\" : \"009a1f69-5e8a-4387-ae65-5874bbf16cc2_log\",\n    \"value\" : {\n      \"description\" : \"05-29 12:51:41.336 INFO               \",\n      \"style\" : {\n        \"style.whiteSpace\" : \"pre-wrap\",\n        \"paddingBottom\" : \"4px\",\n        \"whiteSpace\" : \"nowrap\",\n        \"overflow\" : \"auto\",\n        \"color\" : \"rgb(59,122,87)\",\n        \"paddingTop\" : \"4px\"\n      },\n      \"messageParts\" : [ {\n        \"key\" : \"009a1f69-5e8a-4387-ae65-5874bbf16cc2_0msg\",\n        \"value\" : \"messagePartOne:\"\n      }, {\n        \"key\" : \"009a1f69-5e8a-4387-ae65-5874bbf16cc2_0arg\",\n        \"multiline\" : false,\n        \"argument\" : true,\n        \"value\" : \"\\\"argumentOne\\\"\"\n      }, {\n        \"key\" : \"009a1f69-5e8a-4387-ae65-5874bbf16cc2_1msg\",\n        \"value\" : \"messagePartTwo:\"\n      }, {\n        \"key\" : \"009a1f69-5e8a-4387-ae65-5874bbf16cc2_1arg\",\n        \"multiline\" : false,\n        \"argument\" : true,\n        \"value\" : \"\\\"argumentTwo\\\"\"\n      } ]\n    }\n  } ],\n  \"recordedRequests\" : [ {\n    \"description\" : \"  /somePathTwo\",\n    \"value\" : {\n      \"path\" : \"/somePathTwo\"\n    },\n    \"key\" : \"2cadd5ed-2de7-447a-a63f-d92d6b2f48f1_request\"\n  }, {\n    \"description\" : \"  /somePathOne\",\n    \"value\" : {\n      \"path\" : \"/somePathOne\"\n    },\n    \"key\" : \"4729b142-31e5-42cb-8557-fdb2887deb86_request\"\n  }, {\n    \"description\" : \"  /somePathOne\",\n    \"value\" : {\n      \"path\" : \"/somePathOne\"\n    },\n    \"key\" : \"58db37b2-df0a-43dd-8bc4-2f5e0479054e_request\"\n  } ]\n}"
聽 | at org.mockserver.dashboard.DashboardWebSocketHandlerTest.shouldRenderFilteredLogEntriesCorrectly(DashboardWebSocketHandlerTest.java:1503)
聽 | at org.mockserver.dashboard.DashboardWebSocketHandlerTest.shouldSerialiseEventsWithRequestFilter(DashboardWebSocketHandlerTest.java:471)
聽 | 聽
聽 | [INFO] Running org.mockserver.clientandserver.ClientAndServerListenerTest
聽 | STARTED: shouldNotifyListener
聽 | FAILED: shouldNotifyListener
聽 | FINISHED: shouldNotifyListener duration: 31
聽 | [ERROR] Tests run: 1, Failures: 1, Errors: 0, Skipped: 0, Time elapsed: 0.032 s <<< FAILURE! - in org.mockserver.clientandserver.ClientAndServerListenerTest
聽 | [ERROR] shouldNotifyListener(org.mockserver.clientandserver.ClientAndServerListenerTest)  Time elapsed: 0.03 s  <<< FAILURE!
聽 | java.lang.AssertionError:
聽 | 聽
聽 | Expected: is <1>
聽 | but: was <0>
聽 | at org.mockserver.clientandserver.ClientAndServerListenerTest.shouldNotifyListener(ClientAndServerListenerTest.java:37)
聽 | 聽
聽 | [INFO]
聽 | [INFO] Results:
聽 | [INFO]
聽 | [ERROR] Failures:
聽 | [ERROR]   ClientAndServerListenerTest.shouldNotifyListener:37
聽 | Expected: is <1>
聽 | but: was <0>
聽 | [ERROR]   DashboardWebSocketHandlerTest.shouldSerialiseEventsWithRequestFilter:471->shouldRenderFilteredLogEntriesCorrectly:1503
聽 | Expected: is "{\n  \"logMessages\" : [ {\n    \"key\" : \"2cadd5ed-2de7-447a-a63f-d92d6b2f48f1_log\",\n    \"value\" : {\n      \"description\" : \"05-29 12:51:41.336 RECEIVED_REQUEST   \",\n      \"style\" : {\n        \"paddingBottom\" : \"4px\",\n        \"whiteSpace\" : \"nowrap\",\n        \"overflow\" : \"auto\",\n        \"color\" : \"rgb(114,160,193)\",\n        \"paddingTop\" : \"4px\"\n      },\n      \"messageParts\" : [ {\n        \"key\" : \"2cadd5ed-2de7-447a-a63f-d92d6b2f48f1_0msg\",\n        \"value\" : \"messageFormatThree\"\n      } ]\n    }\n  }, {\n    \"key\" : \"5fb82048-7c7a-4c87-b15b-c6e74c1a5206_log\",\n    \"value\" : {\n      \"description\" : \"05-29 12:51:41.336 INFO               \",\n      \"style\" : {\n        \"style.whiteSpace\" : \"pre-wrap\",\n        \"paddingBottom\" : \"4px\",\n        \"whiteSpace\" : \"nowrap\",\n        \"overflow\" : \"auto\",\n        \"color\" : \"rgb(59,122,87)\",\n        \"paddingTop\" : \"4px\"\n      },\n      \"messageParts\" : [ {\n        \"key\" : \"5fb82048-7c7a-4c87-b15b-c6e74c1a5206_0msg\",\n        \"value\" : \"messageFormat\"\n      } ]\n    }\n  } ],\n  \"recordedRequests\" : [ {\n    \"description\" : \"  /somePathTwo\",\n    \"value\" : {\n      \"path\" : \"/somePathTwo\"\n    },\n    \"key\" : \"2cadd5ed-2de7-447a-a63f-d92d6b2f48f1_request\"\n  } ]\n}"
聽 | but: was "{\n  \"logMessages\" : [ {\n    \"key\" : \"2cadd5ed-2de7-447a-a63f-d92d6b2f48f1_log\",\n    \"value\" : {\n      \"description\" : \"05-29 12:51:41.336 RECEIVED_REQUEST   \",\n      \"style\" : {\n        \"paddingBottom\" : \"4px\",\n        \"whiteSpace\" : \"nowrap\",\n        \"overflow\" : \"auto\",\n        \"color\" : \"rgb(114,160,193)\",\n        \"paddingTop\" : \"4px\"\n      },\n      \"messageParts\" : [ {\n        \"key\" : \"2cadd5ed-2de7-447a-a63f-d92d6b2f48f1_0msg\",\n        \"value\" : \"messageFormatThree\"\n      } ]\n    }\n  }, {\n    \"key\" : \"4729b142-31e5-42cb-8557-fdb2887deb86_log\",\n    \"value\" : {\n      \"description\" : \"05-29 12:51:41.336 RECEIVED_REQUEST   \",\n      \"style\" : {\n        \"paddingBottom\" : \"4px\",\n        \"whiteSpace\" : \"nowrap\",\n        \"overflow\" : \"auto\",\n        \"color\" : \"rgb(114,160,193)\",\n        \"paddingTop\" : \"4px\"\n      },\n      \"messageParts\" : [ {\n        \"key\" : \"4729b142-31e5-42cb-8557-fdb2887deb86_0msg\",\n        \"value\" : \"messageFormatTwo\"\n      } ]\n    }\n  }, {\n    \"key\" : \"58db37b2-df0a-43dd-8bc4-2f5e0479054e_log\",\n    \"value\" : {\n      \"description\" : \"05-29 12:51:41.336 RECEIVED_REQUEST   \",\n      \"style\" : {\n        \"paddingBottom\" : \"4px\",\n        \"whiteSpace\" : \"nowrap\",\n        \"overflow\" : \"auto\",\n        \"color\" : \"rgb(114,160,193)\",\n        \"paddingTop\" : \"4px\"\n      },\n      \"messageParts\" : [ {\n        \"key\" : \"58db37b2-df0a-43dd-8bc4-2f5e0479054e_0msg\",\n        \"value\" : \"messageFormatOne\"\n      } ]\n    }\n  }, {\n    \"key\" : \"5fb82048-7c7a-4c87-b15b-c6e74c1a5206_log\",\n    \"value\" : {\n      \"description\" : \"05-29 12:51:41.336 INFO               \",\n      \"style\" : {\n        \"style.whiteSpace\" : \"pre-wrap\",\n        \"paddingBottom\" : \"4px\",\n        \"whiteSpace\" : \"nowrap\",\n        \"overflow\" : \"auto\",\n        \"color\" : \"rgb(59,122,87)\",\n        \"paddingTop\" : \"4px\"\n      },\n      \"messageParts\" : [ {\n        \"key\" : \"5fb82048-7c7a-4c87-b15b-c6e74c1a5206_0msg\",\n        \"value\" : \"messageFormat\"\n      } ]\n    }\n  }, {\n    \"key\" : \"6a3183c0-ca5c-4062-8d58-9c12ce148431_log\",\n    \"value\" : {\n      \"description\" : \"05-29 12:51:41.336 INFO               \",\n      \"style\" : {\n        \"style.whiteSpace\" : \"pre-wrap\",\n        \"paddingBottom\" : \"4px\",\n        \"whiteSpace\" : \"nowrap\",\n        \"overflow\" : \"auto\",\n        \"color\" : \"rgb(59,122,87)\",\n        \"paddingTop\" : \"4px\"\n      },\n      \"messageParts\" : [ {\n        \"key\" : \"6a3183c0-ca5c-4062-8d58-9c12ce148431_0msg\",\n        \"value\" : \"messageFormat\"\n      } ]\n    }\n  }, {\n    \"key\" : \"009a1f69-5e8a-4387-ae65-5874bbf16cc2_log\",\n    \"value\" : {\n      \"description\" : \"05-29 12:51:41.336 INFO               \",\n      \"style\" : {\n        \"style.whiteSpace\" : \"pre-wrap\",\n        \"paddingBottom\" : \"4px\",\n        \"whiteSpace\" : \"nowrap\",\n        \"overflow\" : \"auto\",\n        \"color\" : \"rgb(59,122,87)\",\n        \"paddingTop\" : \"4px\"\n      },\n      \"messageParts\" : [ {\n        \"key\" : \"009a1f69-5e8a-4387-ae65-5874bbf16cc2_0msg\",\n        \"value\" : \"messagePartOne:\"\n      }, {\n        \"key\" : \"009a1f69-5e8a-4387-ae65-5874bbf16cc2_0arg\",\n        \"multiline\" : false,\n        \"argument\" : true,\n        \"value\" : \"\\\"argumentOne\\\"\"\n      }, {\n        \"key\" : \"009a1f69-5e8a-4387-ae65-5874bbf16cc2_1msg\",\n        \"value\" : \"messagePartTwo:\"\n      }, {\n        \"key\" : \"009a1f69-5e8a-4387-ae65-5874bbf16cc2_1arg\",\n        \"multiline\" : false,\n        \"argument\" : true,\n        \"value\" : \"\\\"argumentTwo\\\"\"\n      } ]\n    }\n  } ],\n  \"recordedRequests\" : [ {\n    \"description\" : \"  /somePathTwo\",\n    \"value\" : {\n      \"path\" : \"/somePathTwo\"\n    },\n    \"key\" : \"2cadd5ed-2de7-447a-a63f-d92d6b2f48f1_request\"\n  }, {\n    \"description\" : \"  /somePathOne\",\n    \"value\" : {\n      \"path\" : \"/somePathOne\"\n    },\n    \"key\" : \"4729b142-31e5-42cb-8557-fdb2887deb86_request\"\n  }, {\n    \"description\" : \"  /somePathOne\",\n    \"value\" : {\n      \"path\" : \"/somePathOne\"\n    },\n    \"key\" : \"58db37b2-df0a-43dd-8bc4-2f5e0479054e_request\"\n  } ]\n}"
聽 | [INFO]
聽 | [ERROR] Tests run: 92, Failures: 2, Errors: 0, Skipped: 0
聽 | [INFO]
聽 | [INFO] ------------------------------------------------------------------------
聽 | [INFO] Reactor Summary for MockServer 5.15.1-SNAPSHOT:
聽 | [INFO]
聽 | [INFO] MockServer ......................................... SUCCESS [  3.553 s]
聽 | [INFO] MockServer Testing ................................. SUCCESS [  3.261 s]
聽 | [INFO] MockServer Core .................................... SUCCESS [01:41 min]
聽 | [INFO] MockServer Java Client ............................. SUCCESS [04:05 min]
聽 | [INFO] MockServer Integration Test ........................ SUCCESS [03:01 min]
聽 | [INFO] MockServer Web Archive ............................. SUCCESS [01:23 min]
聽 | [INFO] MockServer Proxy Web Archive ....................... SUCCESS [ 41.256 s]
聽 | [INFO] MockServer & Proxy Netty ........................... FAILURE [ 43.883 s]
聽 | [INFO] MockServer JUnit 4 Integration ..................... SKIPPED
聽 | [INFO] MockServer JUnit Jupiter Integration ............... SKIPPED
聽 | [INFO] MockServer Spring Test ............................. SKIPPED
聽 | [INFO] MockServer Examples ................................ SKIPPED
聽 | [INFO] ------------------------------------------------------------------------
聽 | [INFO] BUILD FAILURE
聽 | [INFO] ------------------------------------------------------------------------
聽 | [INFO] Total time:  11:44 min
聽 | [INFO] Finished at: 2024-05-29T12:52:15+01:00
聽 | [INFO] ------------------------------------------------------------------------
聽 | [ERROR] Failed to execute goal org.apache.maven.plugins:maven-surefire-plugin:2.22.2:test (default-test) on project mockserver-netty: There are test failures.
聽 | [ERROR]
聽 | [ERROR] Please refer to /build/mockserver/mockserver-netty/target/surefire-reports for the individual test results.
聽 | [ERROR] Please refer to dump files (if any exist) [date].dump, [date]-jvmRun[N].dump and [date].dumpstream.
聽 | [ERROR] -> [Help 1]
聽 | [ERROR]
聽 | [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
聽 | [ERROR] Re-run Maven using the -X switch to enable full debug logging.
聽 | [ERROR]
聽 | [ERROR] For more information about the errors and possible solutions, please read the following articles:
聽 | [ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoFailureException
聽 | [ERROR]
聽 | [ERROR] After correcting the problems, you can resume the build with the command
聽 | [ERROR]   mvn <args> -rf :mockserver-netty
聽 | 馃毃 Error: The command exited with status 1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@sgerrand