42 Automating Testing of SOA Composite Applications

42.1.1 Test Cases Overview

The test framework supports testing at the SOA composite application level. In this type of testing, wires, service binding components, service components (such as BPEL processes and Oracle Mediator service components), and reference binding components are tested.

For more information, see Section 42.3, "Creating Test Suites and Test Cases."

42.1.2 Test Suites Overview

Test suites consist of a logical collection of one or more test cases. Each test case contains a set of commands to perform as the test instance is executed. The execution of a test suite is known as a test run. Each test corresponds to a single SOA composite application instance.

For more information, see the following:

• Section 42.3, "Creating Test Suites and Test Cases"

• Section 42.4, "Creating the Contents of Test Cases"

42.1.3 Emulations Overview

Emulations enable you to simulate the behavior of the following components with which your SOA composite application interacts during execution:

• Internal service components inside the composite

• Binding components outside the composite

Instead of invoking another service component or binding component, you can specify a response from the component or reference.

For more information, see the following:

• Section 42.2.2, "Emulations"

• Section 42.4, "Creating the Contents of Test Cases"

42.1.4 Assertions Overview

Assertions enable you to verify variable data or process flow. You can perform the following types of assertions:

• Entire XML document assertions:

  Compare the element values of an entire XML document to the expected element values. For example, compare the exact contents of an entire loan request XML document to another document. The XMLTestCase class in the XMLUnit package includes a collection of methods for performing assertions between XML files. For more information about these methods, visit the following URL:

  http://xmlunit.sourceforge.net
  

• Part section of message assertions:

  Compare the values of a part section of a message to the expected values. An example is a payload part of an entire XML document message.

• Nonleaf element assertions:

  Compare the values of an XML fragment to the expected values. An example is a loan application, which includes leaf elements SSN, email, customerName, and loanAmount.

• Leaf element assertions:

  Compare the value of a selected string or number element or a regular expression pattern to an expected value. An example is the SSN of a loan application.

For more information about asserts, see Section 42.2.3, "Assertions."

42.2.1 Process Initiation

You first define the operation of your process in a binding component service such as a SOAP web service. Example 42-1 defines the operation of initiate to initiate the TestFwk SOA composite application. The initiation payload is also defined in this section:

<?xml version="1.0" encoding="UTF-8" ?>
<!-- Generated by Oracle SCA Test Modeler version 1.0 at [6/13/07 10:50 AM]. -->
<compositeTest compositeDN="TestFwk"
 xmlns="http://xmlns.oracle.com/sca/2006/test">
  <about></about>
  <initiate serviceName="client" operation="initiate" isAsync="true">
    <message>
      <part partName="payload">
        <content>
          <loanApplication xmlns="http://www.autoloan.com/ns/autoloan">
            <SSN>111222333</SSN>
            <email>[email protected]</email>
            <customerName>Joe Smith</customerName>
            <loanAmount>20000</loanAmount>
            <carModel>Camry</carModel>
            <carYear>2007</carYear>
            <creditRating>800</creditRating>
          </loanApplication>
        </content>
      </part>
    </message>
  </initiate>
</compositeTest>

42.2.2 Emulations

You create emulations to simulate the message data that your SOA composite application receives from web service partners.

In the test code in Example 42-2, the loan request is initiated with an error. A fault message is received in return from a web service partner:

<?xml version="1.0" encoding="UTF-8" ?>
<!-- Generated by Oracle SCA Test Modeler version 1.0 at [7/3/07 3:29 PM]. -->
<compositeTest compositeDN="CompositeTest"
 xmlns="http://xmlns.oracle.com/sca/2006/test">
  <about></about>
  <initiate serviceName="client" operation="initiate" isAsync="true">
    <message>
      <part partName="payload">
        <filePath>loanApplication.xml</filePath>
      </part>
    </message>
  </initiate>
  <wireActions wireSource="LoanBroker/CreditRatingService" operation="process">
    <emulate duration="PT0S">
      <fault faultName="ser:NegativeCredit" xmlns:ser="http://services.otn.com">
        <message>
          <part partName="payload">
            <filePath>creditRatingFault.xml</filePath>
          </part>
        </message>
      </fault>
    </emulate>
  </wireActions>
</compositeTest>

Two message files, loanApplication.xml and creditRatingFault.xml, are invoked in this emulation. If the loan application request in loanApplication.xml contains a social security number beginning with 0, the creditRatingFault.xml file returns the fault message shown in Example 42-3:

<error xmlns="http://services.otn.com">
  Invalid SSN, SSN cannot start with digit '0'.
</error>

For more information, see Section 42.4, "Creating the Contents of Test Cases."

42.2.3 Assertions

You create assertions to validate an entire XML document, a part section of a message, a nonleaf element, or a leaf element at a point during SOA composite application execution. Example 42-4 instructs Oracle SOA Suite to ensure that the content of the customername variable matches the content specified.

<?xml version="1.0" encoding="UTF-8" ?>
<!-- Generated by Oracle SCA Test Modeler version 1.0 at [6/13/07 10:51 AM]. -->
<compositeTest compositeDN="TestFwk"
 xmlns="http://xmlns.oracle.com/sca/2006/test">
  <about></about>
  <initiate serviceName="client" operation="initiate" isAsync="true">
    <message>
      <part partName="payload">
        <content>
          <loanApplication xmlns="http://www.autoloan.com/ns/autoloan">
            <SSN>111222333</SSN>
            <email>[email protected]</email>
            <customerName>Joe Smith</customerName>
            <loanAmount>20000</loanAmount>
            <carModel>Camry</carModel>
            <carYear>2007</carYear>
            <creditRating>800</creditRating>
          </loanApplication>
        </content>
      </part>
    </message>
  </initiate>
  <wireActions wireSource="client" operation="initiate">
    <assert comparisonMethod="string">
      <expected>
        <location key="input" partName="payload"
 xpath="/s1:loanApplication/s1:customerName"
 xmlns:s1="http://www.autoloan.com/ns/autoloan"/>
        <simple>Joe Smith</simple>
      </expected>
    </assert>
  </wireActions>
</compositeTest>

For more information, see Section 42.4, "Creating the Contents of Test Cases."

42.2.4 Message Files

Message instance files provide a method for simulating the message data received back from web service partners. You can manually enter the received message data into this XML file or load a file through the test mode of the SOA Composite Editor. For example, the following message file simulates a credit rating result of 900 returned from a partner:

<rating xmlns="http://services.otn.com">900</rating>

For more information about loading message files into test mode, see Section 42.4, "Creating the Contents of Test Cases."

42.3.1 How to Create Test Suites and Test Cases

To create test suites and test cases:

1. Open the SOA Composite Editor.

2. Open the SOA composite application in which to create a test suite.

3. Go to the Application Navigator or Structure window. If the Structure window shown in Figure 42-1 does not appear, select Structure from the View main menu.

   Figure 42-1 Structure Window

   
   Description of "Figure 42-1 Structure Window"
   
   

4. Create a test suite in either of two ways:

   1. In the Application Navigator, right-click testsuites and select Create Test Suite. Figure 42-2 provides details.

      Figure 42-2 Create Test Suite Selection

      
      Description of "Figure 42-2 Create Test Suite Selection"
      
      

   2. In the Structure window, right-click Test Suites and select Create Test Suite. Figure 42-3 provides details.

      Figure 42-3 Create Test Suite Selection

      
      Description of "Figure 42-3 Create Test Suite Selection"
      
      

5. Enter a test suite name (for example, logicTest).

6. Click OK.

   The Create Composite Test dialog appears.

7. Enter a test name (for this example, TestDelivery is entered) and an optional description. This description displays in the Description column of the Test Cases page of the Unit Tests tab in Oracle Enterprise Manager Fusion Middleware Control Console.

8. Click OK.

   This action creates a test named TestDelivery.xml in the Application Navigator, along with the following subfolders:

   • componenttests

     This folder is not used in 11g Release 1.

   • includes

     This folder is not used in 11g Release 1.

   • messages

     Contains message test files that you load into this directory through the test mode user interface.

   • tests

     Contains TestDelivery.xml.

   A TestDelivery.xml folder also displays in the Structure window. Figure 42-4 provides details. This indicates that you are in the test mode of the SOA Composite Editor. You can create test initiations, assertions, and emulations in test mode. No other modifications, such as editing the property dialogs of service components or dropping service components into the editor, can be performed in test mode.

   Figure 42-4 TestDelivery.xml Folder

   
   Description of "Figure 42-4 TestDelivery.xml Folder"
   
   

   The following operating system test suite directory is also created:

   C:\JDeveloper\mywork\application_name\project_name\testsuites\logicTest
   

   The following subdirectories for adding test files are created beneath logicTest: componenttests, includes, messages, and tests.

9. If you want to exit test mode and return to design mode in the SOA Composite Editor, click the last icon below TestDelivery.xml above the designer. Figure 42-5 provides details.

   Figure 42-5 Test Mode Exit

   
   Description of "Figure 42-5 Test Mode Exit"
   
   

10. Save your changes when prompted.

11. Under the testsuites folder in the Application Navigator, double-click TestDelivery.xml to return to test mode. Figure 42-6 provides details.

    Figure 42-6 Test Mode Access

    
    Description of "Figure 42-6 Test Mode Access"
    
    

    Notes:

    • Do not edit the filelist.xml files that display under the subfolders of the testsuites folder. These files are automatically created during design time, and are used during runtime to calculate the number of test cases.

    • You cannot create test suites within other test suites. However, you can organize a test suite into subdirectories.

42.4.1 How to Initiate Inbound Messages

To initiate inbound messages:

You must first initiate the sending of inbound client messages to the SOA composite application.

1. Go to the SOA Composite application in test mode.

2. Double-click the service binding component shown in Figure 42-7 (for this example, named initiate).

   Figure 42-7 Binding Component Service Access

   
   Description of "Figure 42-7 Binding Component Service Access"
   
   

   The Edit Initiate dialog appears.

3. Enter the details shown in Table 42-1:

   Table 42-1 Edit Initiate Dialog Fields and Values

   Field	Value
   Service	Displays the name of the binding component service (client).
   Operation	Displays the operation type of the service binding component (initiate).
   Part	Select the type of inbound message to send (for example, payload).
   Value	Create a simulated message to send from a client:
   Enter Manually	Click to manually enter message data in the Enter Value field. A Generate Sample button enables you to automatically generate a sample file for testing. Click Save As to save the sample file.
   Load From File	Click the Browse icon to load message data from a file. The file is added to the messages folder in the Application Navigator.

   
   

   Figure 42-8 shows this dialog:

   Figure 42-8 Edit Initiate Dialog

   
   Description of "Figure 42-8 Edit Initiate Dialog"
   
   

   Example 42-5 shows an inbound process initiation message from a client:

   Example 42-5 Inbound Process Initiation Message

   <?xml version="1.0" encoding="UTF-8" ?>
   <!-- Generated by Oracle SCA Test Modeler version 1.0 at [7/12/07 8:36 AM]. -->
   <compositeTest compositeDN="CompositeTest"
    xmlns="http://xmlns.oracle.com/sca/2006/test">
     <about/>
     <initiate serviceName="client" operation="initiate" isAsync="true">
       <message>
         <part partName="payload">
           <filePath>loanApplication.xml</filePath>
         </part>
       </message>
     </initiate>
   . . .
   . . .
   

   The loanApplication.xml referenced in the process initiation file contains a loan application payload. Example 42-6 provides details.

   Example 42-6 Loan Application Payload

   <loanApplication xmlns="http://www.autoloan.com/ns/autoloan">
     <SSN>111222333</SSN>
     <email>[email protected]</email>
     <customerName>Joe Smith</customerName>
     <loanAmount>20000</loanAmount>
     <carModel>Camry</carModel>
     <carYear>2007</carYear>
     <creditRating>800</creditRating>
   </loanApplication>
   

4. Click OK.

42.4.2 How to Emulate Outbound Messages

To emulate outbound messages:

You can simulate a message returned from a synchronous web service partner.

1. Go to the SOA composite application in test mode.

2. Beneath the testsuites folder in the Application Navigator, double-click a test case. Figure 42-9 provides details.

   Figure 42-9 Test Case Access

   
   Description of "Figure 42-9 Test Case Access"
   
   

   The SOA composite application in the SOA Composite Editor is refreshed to display in test mode. This mode enables you to define test information.

3. Double-click the wire of the SOA composite application area to test. For the example shown in Figure 42-10, the wire between the LoanBroker process and the synchronous CreditRating web service is selected.

   Figure 42-10 Wire Access

   
   Description of "Figure 42-10 Wire Access"
   
   

   This displays the Wire Actions dialog shown in Figure 42-11, from which you can design emulations and assertions for the selected part of the SOA composite application.

   Figure 42-11 Wire Actions Dialog

   
   Description of "Figure 42-11 Wire Actions Dialog"
   
   

4. Click the Emulates tab.

5. Click the Add icon.

6. Click Emulate Output.

7. Enter the details described in Table 42-2:

   Table 42-2 Emulate Output Message Dialog Fields and Values

   Field	Value
   Part	Select the message part containing the output (for example, payload).
   Value	Create a simulated output message to return from a web service partner:
   Enter Manually	Click to manually enter message data in the Enter Value field. A Generate Sample button enables you to automatically generate a sample file for testing. Click Save As to save the sample file.
   Load From File	Click the Browse icon to load message data from a file. The file is added to the messages folder in the Application Navigator.
   Duration	Enter the maximum amount of time to wait for the message to be delivered from the web service partner.

   
   

   Figure 42-12 shows this dialog:

   Figure 42-12 Emulate Dialog with Emulate Output Selected

   
   Description of "Figure 42-12 Emulate Dialog with Emulate Output Selected"
   
   

   Example 42-7 shows a simulated output message from a synchronous web service partner that you enter manually or load from a file:

   Example 42-7 Simulated Output Message Example

   <?xml version="1.0" encoding="UTF-8" ?>
   <!-- Generated by Oracle SCA Test Modeler version 1.0 at [7/3/07 3:26 PM]. -->
   <compositeTest compositeDN="CompositeTest"
    xmlns="http://xmlns.oracle.com/sca/2006/test">
     <about></about>
     <initiate serviceName="client" operation="initiate" isAsync="true">
       <message>
         <part partName="payload">
           <filePath>loanApplication.xml</filePath>
         </part>
       </message>
     </initiate>
     <wireActions wireSource="LoanBroker/CreditRatingService" operation="process">
       <emulate duration="PT0S">
         <message>
           <part partName="payload">
             <filePath>creditRatingResult.xml</filePath>
           </part>
         </message>
       </emulate>
     </wireActions>
   </compositeTest>
   

   The creditRatingResult.xml message file referenced in the output message provides details about the credit rating result.

   <rating xmlns="http://services.otn.com">900</rating>
   

8. Click OK.

42.4.3 How to Emulate Callback Messages

To emulate callback messages:

You can simulate a callback message returned from an asynchronous web service partner.

1. Access the Wire Actions dialog by following Step 1 through Step 3.

2. Click the Emulates tab.

3. Click the Add icon.

4. Click Emulate Callback. This field is only enabled for asynchronous processes.

5. Enter the details described in Table 42-3:

   Table 42-3 Emulate Callback Message Fields

   Field	Value
   Callback Operation	Select the callback operation (for example, onResult).
   Callback Message	Displays the callback message name of the asynchronous process.
   Part	Select the message part containing the callback (for example, payload).
   Value	Create a simulated callback message to return from an asynchronous web service partner:
   Enter Manually	Click to manually enter message data in the Enter Value field. A Generate Sample button enables you to automatically generate a sample file for testing. Click Save As to save the sample file.
   Load From File	Click the Browse icon to load message data from a file. The file is added to the messages folder in the Application Navigator.
   Duration	Enter the maximum amount of time to wait for the callback message to be delivered from the web service partner.

   
   

   Figure 42-13 shows this dialog:

   Figure 42-13 Emulate Dialog with Emulate Callback Selected

   
   Description of "Figure 42-13 Emulate Dialog with Emulate Callback Selected"
   
   

   Example 42-8 shows a simulated callback message from a web service partner. You enter this message manually or load it from a file:

   Example 42-8 Simulated Callback Message Example

   <?xml version="1.0" encoding="UTF-8" ?>
   <!-- Generated by Oracle SCA Test Modeler version 1.0 at [7/3/07 3:27 PM]. -->
   <compositeTest compositeDN="CompositeTest"
    xmlns="http://xmlns.oracle.com/sca/2006/test">
     <about></about>
     <initiate serviceName="client" operation="initiate" isAsync="true">
       <message>
         <part partName="payload">
           <filePath>loanApplication.xml</filePath>
         </part>
       </message>
     </initiate>
     <wireActions wireSource="LoanBroker/LoanService" operation="initiate">
       <emulate callbackOperation="onResult" duration="PT0S">
         <message>
           <part partName="payload">
             <filePath>loanOffer.xml</filePath>
           </part>
         </message>
       </emulate>
     </wireActions>
   </compositeTest>
   

   The loanOffer.xml message file referenced in the callback message provides details about the credit rating approval. Example 42-9 provides details.

   Example 42-9 Credit Rating Approval Details

   <loanOffer xmlns="http://www.autoloan.com/ns/autoloan">
     <providerName>Bank Of America</providerName>
     <selected>false</selected>
     <approved>true</approved>
     <APR>1.9</APR>
   </loanOffer>
   

6. Click OK.

42.4.4 How to Emulate Fault Messages

To emulate fault messages:

You can simulate a fault message returned from a web service partner. This simulation enables you to test fault handling capabilities in your process.

1. Access the Wire Actions dialog by following Step 1 through Step 3.

2. Click the Emulates tab.

3. Click the Add icon.

4. Click Emulate Fault.

5. Enter the details described in Table 42-4:

   Table 42-4 Emulate Fault Message Fields

   Field	Value
   Fault	Select the fault type to return from a partner (for example, NegativeCredit).
   Fault Message	Displays the message name.
   Part	Select the message part containing the fault (for example, payload).
   Value	Create a simulated fault message to return from a web service partner:
   Enter Manually	Click to manually enter message data in the Enter Value field. A Generate Sample button enables you to automatically generate a sample file for testing. Click Save As to save the sample file.
   Load From File	Click the Browse icon to load message data from a file. The file is added to the messages folder in the Application Navigator.
   Duration	Enter the maximum amount of time to wait for the fault message to be delivered from the web service partner.

   
   

   Figure 42-14 shows this dialog:

   Figure 42-14 Emulate Dialog with Emulate Fault Selected

   
   Description of "Figure 42-14 Emulate Dialog with Emulate Fault Selected"
   
   

   An example of a simulated fault message from a web service partner that you enter manually or load from a file is shown in Section 42.2.2, "Emulations."

6. Click OK.

42.4.5 How to Create Assertions

To create assertions:

You perform assertions to verify variable data or process flow. Assertions enable you to validate test data in an entire XML document, a part section of a message, a nonleaf element, or a leaf element as a process is executed. This is done by extracting a value and comparing it to an expected value.

1. Access the Wire Actions dialog by following Step 1 through Step 3.

2. Click the Asserts tab.

   Figure 42-15 shows this dialog:

   Figure 42-15 Wire Actions Dialog with Asserts Tab Selected

   
   Description of "Figure 42-15 Wire Actions Dialog with Asserts Tab Selected"
   
   

3. Click the Add icon.

   The Create Assert dialog appears.

4. Select the type of assertion to perform at the top of the dialog, as shown in Table 42-5. If the operation supports only input messages, the Assert Input button is enabled. If the operation supports both input and output messages, the Assert Input and Assert Output buttons are both enabled.

   Table 42-5 Assertion Types

   Type	Description
   Assert Input	Select to create an assertion in the inbound direction.
   Assert Output	Select to create an assertion in the outbound direction.
   Assert Callback	Select to create an assertion on a callback.
   Assert Fault	Select to assert a fault into the application flow.

   
   

5. See the section shown in Table 42-6 based on the type of assertion you want to perform.

   Table 42-6 Assertion Types

   For an Assertion on...	See...
   A part section of a document A nonleaf element An entire XML document	Section 42.4.5.1, "Creating Assertions on a Part Section, Nonleaf Element, or Entire XML Document"
   A leaf element	Section 42.4.5.2, "Creating Assertions on a Leaf Element"

   
   

42.4.6 What You May Need to Know About Assertions

When a test is executed, and the response type returned is different from the type expected, the assertion is skipped. For example, you are expecting a fault (RemoteFault) to be returned for a specific message, but a response (BpelResponseMessage) is instead returned.

As a best practice, always assert and emulate the expected behavior.