Sync docs from master to gh-pages

This commit is contained in:
Marcin Grzejszczak
2017-08-07 17:10:02 +02:00
parent 5cb613702f
commit 261d7fee9c

View File

@@ -101,34 +101,12 @@ $(addBlockSwitches);
<ul class="sectlevel2">
<li><a href="#_introduction">2.1. Introduction</a>
<ul class="sectlevel3">
<li><a href="#_why">2.1.1. Why?</a>
<ul class="sectlevel4">
<li><a href="#_testing_issues">Testing issues</a></li>
</ul>
</li>
<li><a href="#_why">2.1.1. Why?</a></li>
<li><a href="#_purposes">2.1.2. Purposes</a></li>
<li><a href="#_how">2.1.3. How</a>
<ul class="sectlevel4">
<li><a href="#_define_the_contract">Define the contract</a></li>
<li><a href="#_client_side">Client Side</a></li>
<li><a href="#_server_side">Server Side</a></li>
</ul>
</li>
<li><a href="#_step_by_step_guide_to_cdc">2.1.4. Step by step guide to CDC</a>
<ul class="sectlevel4">
<li><a href="#_technical_note">Technical note</a></li>
<li><a href="#_consumer_side_loan_issuance">Consumer side (Loan Issuance)</a></li>
<li><a href="#_producer_side_fraud_detection_server">Producer side (Fraud Detection server)</a></li>
<li><a href="#_consumer_side_loan_issuance_final_step">Consumer side (Loan Issuance) final step</a></li>
</ul>
</li>
<li><a href="#_how">2.1.3. How</a></li>
<li><a href="#_step_by_step_guide_to_cdc">2.1.4. Step by step guide to CDC</a></li>
<li><a href="#_dependencies">2.1.5. Dependencies</a></li>
<li><a href="#_additional_links">2.1.6. Additional links</a>
<ul class="sectlevel4">
<li><a href="#_spring_cloud_contract_video">Spring Cloud Contract video</a></li>
<li><a href="#_readings">Readings</a></li>
</ul>
</li>
<li><a href="#_additional_links">2.1.6. Additional links</a></li>
<li><a href="#_samples">2.1.7. Samples</a></li>
</ul>
</li>
@@ -136,24 +114,8 @@ $(addBlockSwitches);
<ul class="sectlevel3">
<li><a href="#_why_use_spring_cloud_contract_verifier_and_not_x">2.2.1. Why use Spring Cloud Contract Verifier and not X ?</a></li>
<li><a href="#_what_is_this_value_consumer_producer">2.2.2. What is this value(consumer(), producer()) ?</a></li>
<li><a href="#_how_to_do_stubs_versioning">2.2.3. How to do Stubs versioning?</a>
<ul class="sectlevel4">
<li><a href="#_api_versioning">API Versioning</a></li>
<li><a href="#_jar_versioning">JAR versioning</a></li>
<li><a href="#_dev_or_prod_stubs">Dev or prod stubs</a></li>
</ul>
</li>
<li><a href="#_common_repo_with_contracts">2.2.4. Common repo with contracts</a>
<ul class="sectlevel4">
<li><a href="#_repo_structure">Repo structure</a></li>
<li><a href="#_workflow">Workflow</a>
<ul class="sectlevel5">
<li><a href="#_consumer">Consumer</a></li>
<li><a href="#_producer">Producer</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#_how_to_do_stubs_versioning">2.2.3. How to do Stubs versioning?</a></li>
<li><a href="#_common_repo_with_contracts">2.2.4. Common repo with contracts</a></li>
<li><a href="#_can_i_have_multiple_base_classes_for_tests">2.2.5. Can I have multiple base classes for tests?</a></li>
<li><a href="#_how_can_i_debug_the_request_response_being_sent_by_the_generated_tests_client">2.2.6. How can I debug the request/response being sent by the generated tests client?</a></li>
<li><a href="#_how_can_i_debug_the_mapping_request_response_being_sent_by_wiremock">2.2.7. How can I debug the mapping/request/response being sent by WireMock?</a></li>
@@ -164,55 +126,8 @@ $(addBlockSwitches);
</li>
<li><a href="#_spring_cloud_contract_verifier_http">2.3. Spring Cloud Contract Verifier HTTP</a>
<ul class="sectlevel3">
<li><a href="#_gradle_project">2.3.1. Gradle Project</a>
<ul class="sectlevel4">
<li><a href="#_prerequisites">Prerequisites</a>
<ul class="sectlevel5">
<li><a href="#_add_gradle_plugin_with_dependencies">Add gradle plugin with dependencies</a></li>
<li><a href="#_gradle_and_rest_assured_2_0">Gradle and Rest Assured 2.0</a></li>
<li><a href="#_snapshot_versions_for_gradle">Snapshot versions for Gradle</a></li>
<li><a href="#_add_stubs">Add stubs</a></li>
</ul>
</li>
<li><a href="#_run_plugin">Run plugin</a></li>
<li><a href="#_default_setup">Default setup</a></li>
<li><a href="#_configure_plugin">Configure plugin</a>
<ul class="sectlevel5">
<li><a href="#_configuration_options">Configuration options</a></li>
<li><a href="#_single_base_class_for_all_tests">Single base class for all tests</a></li>
<li><a href="#_different_base_classes_for_contracts">Different base classes for contracts</a></li>
</ul>
</li>
<li><a href="#_invoking_generated_tests">Invoking generated tests</a></li>
<li><a href="#_spring_cloud_contract_verifier_on_consumer_side">Spring Cloud Contract Verifier on consumer side</a></li>
</ul>
</li>
<li><a href="#_using_in_your_maven_project">2.3.2. Using in your Maven project</a>
<ul class="sectlevel4">
<li><a href="#_add_maven_plugin">Add maven plugin</a>
<ul class="sectlevel5">
<li><a href="#_maven_and_rest_assured_2_0">Maven and Rest Assured 2.0</a></li>
<li><a href="#_snapshot_versions_for_maven">Snapshot versions for Maven</a></li>
</ul>
</li>
<li><a href="#_add_stubs_2">Add stubs</a></li>
<li><a href="#_run_plugin_2">Run plugin</a></li>
<li><a href="#_configure_plugin_2">Configure plugin</a>
<ul class="sectlevel5">
<li><a href="#_important_configuration_options">Important configuration options</a></li>
<li><a href="#_single_base_class_for_all_tests_2">Single base class for all tests</a></li>
<li><a href="#_different_base_classes_for_contracts_2">Different base classes for contracts</a></li>
</ul>
</li>
<li><a href="#_invoking_generated_tests_2">Invoking generated tests</a></li>
<li><a href="#_faq_with_maven_plugin">FAQ with Maven Plugin</a>
<ul class="sectlevel5">
<li><a href="#_maven_plugin_and_sts">Maven Plugin and STS</a></li>
</ul>
</li>
<li><a href="#_spring_cloud_contract_verifier_on_consumer_side_2">Spring Cloud Contract Verifier on consumer side</a></li>
</ul>
</li>
<li><a href="#_gradle_project">2.3.1. Gradle Project</a></li>
<li><a href="#_using_in_your_maven_project">2.3.2. Using in your Maven project</a></li>
<li><a href="#_scenarios">2.3.3. Scenarios</a></li>
<li><a href="#_stubs_and_transitive_dependencies">2.3.4. Stubs and transitive dependencies</a></li>
</ul>
@@ -221,13 +136,7 @@ $(addBlockSwitches);
<ul class="sectlevel3">
<li><a href="#_integrations">2.4.1. Integrations</a></li>
<li><a href="#_manual_integration_testing">2.4.2. Manual Integration Testing</a></li>
<li><a href="#_publisher_side_test_generation">2.4.3. Publisher side test generation</a>
<ul class="sectlevel4">
<li><a href="#_scenario_1_no_input_message">Scenario 1 (no input message)</a></li>
<li><a href="#_scenario_2_output_triggered_by_input">Scenario 2 (output triggered by input)</a></li>
<li><a href="#_scenario_3_no_output_message">Scenario 3 (no output message)</a></li>
</ul>
</li>
<li><a href="#_publisher_side_test_generation">2.4.3. Publisher side test generation</a></li>
<li><a href="#_consumer_stub_side_generation">2.4.4. Consumer Stub Side generation</a></li>
</ul>
</li>
@@ -239,21 +148,8 @@ $(addBlockSwitches);
</li>
<li><a href="#_stub_runner_core">2.6. Stub Runner Core</a>
<ul class="sectlevel3">
<li><a href="#_retrieving_stubs">2.6.1. Retrieving stubs</a>
<ul class="sectlevel4">
<li><a href="#_stub_downloading">Stub downloading</a></li>
<li><a href="#_classpath_scanning">Classpath scanning</a></li>
</ul>
</li>
<li><a href="#_running_stubs">2.6.2. Running stubs</a>
<ul class="sectlevel4">
<li><a href="#_limitations">Limitations</a></li>
<li><a href="#_running_using_main_app">Running using main app</a></li>
<li><a href="#_http_stubs">HTTP Stubs</a></li>
<li><a href="#_viewing_registered_mappings">Viewing registered mappings</a></li>
<li><a href="#_messaging_stubs">Messaging Stubs</a></li>
</ul>
</li>
<li><a href="#_retrieving_stubs">2.6.1. Retrieving stubs</a></li>
<li><a href="#_running_stubs">2.6.2. Running stubs</a></li>
</ul>
</li>
<li><a href="#_stub_runner_junit_rule">2.7. Stub Runner JUnit Rule</a>
@@ -266,23 +162,14 @@ $(addBlockSwitches);
</li>
<li><a href="#_stub_runner_spring_cloud">2.8. Stub Runner Spring Cloud</a>
<ul class="sectlevel3">
<li><a href="#_stubbing_service_discovery">2.8.1. Stubbing Service Discovery</a>
<ul class="sectlevel4">
<li><a href="#_test_profiles_and_service_discovery">Test profiles and service discovery</a></li>
</ul>
</li>
<li><a href="#_stubbing_service_discovery">2.8.1. Stubbing Service Discovery</a></li>
<li><a href="#_additional_configuration">2.8.2. Additional Configuration</a></li>
</ul>
</li>
<li><a href="#_stub_runner_boot_application">2.9. Stub Runner Boot Application</a>
<ul class="sectlevel3">
<li><a href="#_how_to_use_it">2.9.1. How to use it?</a></li>
<li><a href="#_endpoints">2.9.2. Endpoints</a>
<ul class="sectlevel4">
<li><a href="#_http">HTTP</a></li>
<li><a href="#_messaging">Messaging</a></li>
</ul>
</li>
<li><a href="#_endpoints">2.9.2. Endpoints</a></li>
<li><a href="#_example">2.9.3. Example</a></li>
<li><a href="#_stub_runner_boot_with_service_discovery">2.9.4. Stub Runner Boot with Service Discovery</a></li>
</ul>
@@ -290,148 +177,61 @@ $(addBlockSwitches);
<li><a href="#_stubs_per_consumer">2.10. Stubs Per Consumer</a></li>
<li><a href="#_common">2.11. Common</a>
<ul class="sectlevel3">
<li><a href="#_common_properties_for_junit_and_spring">2.11.1. Common properties for JUnit and Spring</a>
<ul class="sectlevel4">
<li><a href="#_stub_runner_stubs_ids">Stub runner stubs ids</a></li>
</ul>
</li>
<li><a href="#_common_properties_for_junit_and_spring">2.11.1. Common properties for JUnit and Spring</a></li>
</ul>
</li>
<li><a href="#_stub_runner_for_messaging">2.12. Stub Runner for Messaging</a>
<ul class="sectlevel3">
<li><a href="#_stub_triggering">2.12.1. Stub triggering</a>
<ul class="sectlevel4">
<li><a href="#_trigger_by_label">Trigger by label</a>
<ul class="sectlevel5">
<li><a href="#_trigger_by_group_and_artifact_ids">Trigger by group and artifact ids</a></li>
<li><a href="#_trigger_by_artifact_ids">Trigger by artifact ids</a></li>
</ul>
</li>
<li><a href="#_trigger_all_messages">Trigger all messages</a></li>
</ul>
</li>
<li><a href="#_stub_triggering">2.12.1. Stub triggering</a></li>
</ul>
</li>
<li><a href="#_stub_runner_camel">2.13. Stub Runner Camel</a>
<ul class="sectlevel3">
<li><a href="#_adding_it_to_the_project">2.13.1. Adding it to the project</a></li>
<li><a href="#_examples">2.13.2. Examples</a>
<ul class="sectlevel4">
<li><a href="#_stubs_structure">Stubs structure</a></li>
<li><a href="#_scenario_1_no_input_message_2">Scenario 1 (no input message)</a></li>
<li><a href="#_scenario_2_output_triggered_by_input_2">Scenario 2 (output triggered by input)</a></li>
<li><a href="#_scenario_3_input_with_no_output">Scenario 3 (input with no output)</a></li>
</ul>
</li>
<li><a href="#_examples">2.13.2. Examples</a></li>
</ul>
</li>
<li><a href="#_stub_runner_integration">2.14. Stub Runner Integration</a>
<ul class="sectlevel3">
<li><a href="#_adding_it_to_the_project_2">2.14.1. Adding it to the project</a></li>
<li><a href="#_examples_2">2.14.2. Examples</a>
<ul class="sectlevel4">
<li><a href="#_stubs_structure_2">Stubs structure</a></li>
<li><a href="#_scenario_1_no_input_message_3">Scenario 1 (no input message)</a></li>
<li><a href="#_scenario_2_output_triggered_by_input_3">Scenario 2 (output triggered by input)</a></li>
<li><a href="#_scenario_3_input_with_no_output_2">Scenario 3 (input with no output)</a></li>
</ul>
</li>
<li><a href="#_examples_2">2.14.2. Examples</a></li>
</ul>
</li>
<li><a href="#_stub_runner_stream">2.15. Stub Runner Stream</a>
<ul class="sectlevel3">
<li><a href="#_adding_it_to_the_project_3">2.15.1. Adding it to the project</a></li>
<li><a href="#_examples_3">2.15.2. Examples</a>
<ul class="sectlevel4">
<li><a href="#_stubs_structure_3">Stubs structure</a></li>
<li><a href="#_scenario_1_no_input_message_4">Scenario 1 (no input message)</a></li>
<li><a href="#_scenario_2_output_triggered_by_input_4">Scenario 2 (output triggered by input)</a></li>
<li><a href="#_scenario_3_input_with_no_output_3">Scenario 3 (input with no output)</a></li>
</ul>
</li>
<li><a href="#_examples_3">2.15.2. Examples</a></li>
</ul>
</li>
<li><a href="#_stub_runner_spring_amqp">2.16. Stub Runner Spring AMQP</a>
<ul class="sectlevel3">
<li><a href="#_adding_it_to_the_project_4">2.16.1. Adding it to the project</a></li>
<li><a href="#_examples_4">2.16.2. Examples</a>
<ul class="sectlevel4">
<li><a href="#_stubs_structure_4">Stubs structure</a></li>
<li><a href="#_triggering_the_message">Triggering the message</a></li>
<li><a href="#_spring_amqp_test_configuration">Spring AMQP Test Configuration</a></li>
</ul>
</li>
<li><a href="#_examples_4">2.16.2. Examples</a></li>
</ul>
</li>
<li><a href="#_contract_dsl">2.17. Contract DSL</a>
<ul class="sectlevel3">
<li><a href="#_limitations_2">2.17.1. Limitations</a></li>
<li><a href="#_common_top_level_elements">2.17.2. Common Top-Level elements</a>
<ul class="sectlevel4">
<li><a href="#_description">Description</a></li>
<li><a href="#_name">Name</a></li>
<li><a href="#_ignoring_contracts">Ignoring contracts</a></li>
<li><a href="#_passing_values_from_files">Passing values from files</a></li>
</ul>
</li>
<li><a href="#_common_top_level_elements">2.17.2. Common Top-Level elements</a></li>
<li><a href="#_http_top_level_elements">2.17.3. HTTP Top-Level Elements</a></li>
<li><a href="#_request">2.17.4. Request</a></li>
<li><a href="#_response">2.17.5. Response</a></li>
<li><a href="#_dynamic_properties">2.17.6. Dynamic properties</a>
<ul class="sectlevel4">
<li><a href="#_dynamic_properties_inside_the_body">Dynamic properties inside the body</a>
<ul class="sectlevel5">
<li><a href="#_regular_expressions">Regular expressions</a></li>
<li><a href="#_passing_optional_parameters">Passing optional parameters</a></li>
<li><a href="#_executing_custom_methods_on_server_side">Executing custom methods on server side</a></li>
</ul>
</li>
<li><a href="#_referencing_request_from_response">Referencing request from response</a></li>
<li><a href="#_dynamic_properties_in_matchers_sections">Dynamic properties in matchers sections</a></li>
</ul>
</li>
<li><a href="#_dynamic_properties">2.17.6. Dynamic properties</a></li>
<li><a href="#_jax_rs_support">2.17.7. JAX-RS support</a></li>
<li><a href="#_async_support">2.17.8. Async support</a></li>
<li><a href="#_working_with_context_paths">2.17.9. Working with Context Paths</a></li>
<li><a href="#_messaging_top_level_elements">2.17.10. Messaging Top-Level Elements</a>
<ul class="sectlevel4">
<li><a href="#_output_triggered_by_a_method">Output triggered by a method</a></li>
<li><a href="#_output_triggered_by_a_message">Output triggered by a message</a></li>
<li><a href="#_consumer_producer">Consumer / Producer</a></li>
</ul>
</li>
<li><a href="#_messaging_top_level_elements">2.17.10. Messaging Top-Level Elements</a></li>
<li><a href="#_multiple_contracts_in_one_file">2.17.11. Multiple contracts in one file</a></li>
</ul>
</li>
<li><a href="#_customization">2.18. Customization</a>
<ul class="sectlevel3">
<li><a href="#_extending_the_dsl">2.18.1. Extending the DSL</a>
<ul class="sectlevel4">
<li><a href="#_common_jar">Common JAR</a></li>
<li><a href="#_adding_the_dependency_to_project">Adding the dependency to project</a>
<ul class="sectlevel5">
<li><a href="#_test_dependency_in_project_s_dependencies">Test dependency in project&#8217;s dependencies</a></li>
<li><a href="#_test_dependency_in_plugin_s_dependencies">Test dependency in plugin&#8217;s dependencies</a></li>
<li><a href="#_referencing_classes_in_dsls">Referencing classes in DSLs</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#_extending_the_dsl">2.18.1. Extending the DSL</a></li>
</ul>
</li>
<li><a href="#_pluggable_architecture">2.19. Pluggable architecture</a>
<ul class="sectlevel3">
<li><a href="#_custom_contract_converter">2.19.1. Custom contract converter</a>
<ul class="sectlevel4">
<li><a href="#_pact_converter">Pact converter</a>
<ul class="sectlevel5">
<li><a href="#_pact_contract">Pact contract</a></li>
<li><a href="#_pact_for_producers">Pact for producers</a></li>
<li><a href="#_pact_for_consumers">Pact for consumers</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#_custom_contract_converter">2.19.1. Custom contract converter</a></li>
<li><a href="#_custom_test_generator">2.19.2. Custom test generator</a></li>
<li><a href="#_custom_stub_generator">2.19.3. Custom stub generator</a></li>
<li><a href="#_custom_stub_runner">2.19.4. Custom Stub Runner</a></li>