W-14237985 mtf

modules/ROOT/nav.adoc

@@ -75,12 +75,24 @@
   *** xref:sample-data.adoc[Sample Data]
   *** xref:security-best-practices.adoc[Security]
   *** xref:threading-asynchronous-processing.adoc[Threading and Asynchronous Processing]
- ** xref:testing.adoc[Testing your Module]
-  *** xref:testing-writing-your-first-test-case.adoc[Writing Your First Test Case]
  ** xref:about-connector-certification-program-guidelines.adoc[About MuleSoft Connector Certification Program Guidelines]
   *** xref:certification-guidelines-for-connectors.adoc[Technical Guidelines for Connector Certifications]
  ** xref:troubleshooting.adoc[Troubleshooting]
  ** xref:license.adoc[Licensing]
  ** xref:validators.adoc[Validators with Mule SDK]
  ** xref:dmt.adoc[DevKit to SDK Migration Tool]
 * xref:xml-sdk.adoc[XML SDK]
+* xref:testing.adoc[Testing Your Module]
+ ** xref:mtf.adoc[Module Testing Framework (MTF)]
+  *** xref:testing-writing-your-first-munit-test.adoc[Creating Your Test]
+  *** xref:mtf-testing-examples.adoc[MTF Test Examples]
+   **** xref:mtf-testing-sources.adoc[Sources]
+   **** xref:mtf-expecting-errors.adoc[Expected Errors]
+   **** xref:mtf-parameterized-tests.adoc[Parameterization]
+   **** xref:mtf-using-test-classes.adoc[Classes]
+   **** xref:testing-oauth-modules.adoc[OAuth-Enabled Modules]
+   **** xref:mtf-metadata-testing.adoc[Metadata]
+   **** xref:connectivity-testing.adoc[Connectivity]
+  *** xref:munit-extensions-maven-plugin-configuration.adoc[Configuring the MUnit Extensions Maven Plugin]
+  *** xref:munit-extensions-maven-plugin.adoc[Operating the MUnit Extensions Maven Plugin]
+ ** xref:testing-writing-your-first-test-case.adoc[FlowRunner (Deprecated)]

modules/ROOT/pages/connectivity-testing.adoc

@@ -0,0 +1,71 @@
+= Connectivity 
+ifndef::env-site,env-github[]
+include::_attributes.adoc[]
+endif::[]
+
+Test the connectivity defined for your module.
+
+== Before You Begin
+
+* Understand how to define a connection for your module. For more information, refer to xref:connections.adoc[].
+* Add the `mtf-tools` dependency to your project:
++
+[source,xml,linenums]
+----
+<dependency>
+    <groupId>com.mulesoft.munit</groupId>
+    <artifactId>mtf-tools</artifactId>
+    <version>1.2.0</version>
+    <classifier>mule-plugin</classifier>
+    <scope>test</scope>
+</dependency>
+----
+
+== Test Connectivity
+
+The `test-connectivity` processor establishes a connection using the given configuration. If testing connectivity with the given configuration fails, the processor fails with the proper exception, description, and error type (if present).
+
+=== Successful Connection
+
+When you test that a connection is valid, you are validating that the processor does not fail. A successful connection test appears as follows:
+
+[source,xml,linenums]
+----
+<munit:test name="validConnectionTest">
+    <munit:execution>
+        <mtf:test-connectivity config-ref="validConnection"/>
+    </munit:execution>
+</munit:test>
+----
+
+=== Invalid Connection
+
+When a connection fails, the processor fails. Therefore, to test an invalid connection, include an expected exception and expected error description in the test:
+
+[source,xml,linenums]
+----
+<munit:test name="invalidConnectionTest"
+            expectedException="com.example.MyConnectionException"
+            expectedErrorDescription="An error occurred while connecting">
+    <munit:execution>
+        <mtf:test-connectivity config-ref="invalidConnection"/>
+    </munit:execution>
+</munit:test>
+----
+
+If the connection fails with an error type, you can include an expected error type as well:
+
+[source,xml,linenums]
+----
+<munit:test name="invalidConnectionWithErrorTypeTest"
+            expectedException="com.example.MyConnectionException"
+            expectedErrorType="EXAMPLE:INVALID_CREDENTIALS"
+            expectedErrorDescription="An error occurred while connecting">
+    <munit:execution>
+        <mtf:test-connectivity config-ref="invalidConnectionWithErrorType"/>
+    </munit:execution>
+</munit:test>
+----
+
+
+

modules/ROOT/pages/mtf-expecting-errors.adoc

@@ -0,0 +1,75 @@
+= Expected Errors
+ifndef::env-site,env-github[]
+include::_attributes.adoc[]
+endif::[]
+
+Validate the error types and error descriptions that your module throws.
+
+== Before You Begin
+
+You must know how to define the errors that your module throws. For more information, refer to xref:errors.adoc[].
+
+== Example: Error Definition 
+
+In this example, the module defines errors as follows:
+
+.Error type definition
+[source,java,linenums]
+----
+public enum SimpleError implements ErrorTypeDefinition<SimpleError> {
+  INVALID_PARAMETER, TIME_OUT, NOT_ALLOWED
+}
+----
+
+.Error type provider
+[source,java,linenums]
+----
+public class ExecuteErrorsProvider implements ErrorTypeProvider {
+    @Override
+    public Set<ErrorTypeDefinition> getErrorTypes() {
+        HashSet<ErrorTypeDefinition> errors = new HashSet<>();
+        errors.add(SimpleError.INVALID_PARAMETER);
+        errors.add(SimpleError.TIME_OUT);
+        return errors;
+    }
+}
+----
+
+.Operation that throws the error
+[source,java,linenums]
+----
+@Throws(ExecuteErrorsProvider.class)
+public void execute(Integer number) {
+    if (number <= 0) {
+        throw new ModuleException("Parameter 'number' should be greater than 0", SimpleError.INVALID_PARAMETER);
+    }
+}
+----
+
+Use MTF to create tests to validate the expected error type and error description.
+
+== Validate an Expected Error Type
+
+To validate that the error thrown by the module in the example has the proper error type:
+
+[source, xml, linenums]
+----
+<munit:test name="testErrorType" expectedErrorType="TEST-CONNECTOR:INVALID_PARAMETER">
+    <munit:execution>
+        <test-connector:execute number="0"/>
+    </munit:execution>
+</munit:test>
+----
+
+== Validate an Expected Error Description
+
+To validate that the error thrown by the module in the example has the proper error description:
+
+[source, xml, linenums]
+----
+<munit:test name="testErrorDescription" expectedErrorDescription="Parameter 'number' should be greater than 0">
+    <munit:execution>
+        <test-connector:execute number="0"/>
+    </munit:execution>
+</munit:test>
+----