3.2.6. Request Unit Test (Receive Messages Process)¶
3.2.6.1. Summary¶
In the request unit test (receive messages process), the operation when one request message is received is simulated and tested.
3.2.6.1.1. Overall picture¶
3.2.6.2. Main Classes, resources¶
| Name | Role | Creation unit |
|---|---|---|
| Request unitTest class | Implement the test logic. | Create one per class (Action) to be tested. |
| Excel file（Test data） | Describe test data, such as preparation data to be stored in the table, expected results and input files. | Create one per test class |
| StandaloneTestSupportTemplate | It provides a test execution environment for batch, messaging, and other processes that run outside the container. | - |
| MessagingRequestTestSupport | Provides test preparation functions and various assertions required for request unit tests of receiving synchronous message process. | - |
| MessagingReceiveTestSupport | Provides test preparation functions and various assertions required for request unit tests of receiving asynchronous message process. | - |
| TestShot | A class that stores information for one test case defined in a datasheet. | - |
| MainForRequestTesting | Main class for testing. Absorb the differences during test execution. | - |
| DbAccessTestSupport | Provides the necessary functions for testing using the database, such as DB preparation data input. | - |
| MQSupport | Provides the necessary functions for testing messaging, such as message creation. | - |
| TestDataConvertor | Interface for editing the test data read from Excel. If necessary, the architect implements the converter for each data type. | - |
3.2.6.3. Structure¶
3.2.6.3.1. StandaloneTestSupportTemplate¶
It provides a test execution environment for batch, messaging, and other processes that run outside the container. Reads test data and executes all test shots (TestShot ).
3.2.6.3.2. TestShot¶
Executes by holding information of 1 TestShot. The TestShot consists of the following elements:
- Preparation of input data
- Launch the main class
- Confirmation of the output results
Provides common preparation process and result checking functions for testing processes that operate outside of containers, such as batch and messaging processes.
Preparation process Confirmation of results Database setup Check for database updates Check log output results Confirm the status code
Since the input data preparation and result confirmation logic is different for each batch and various messaging processes, it can be customized according to the architecture.
3.2.6.3.3. MessagingRequestTestSupport¶
A superclass for testing the receiving synchronous message process. The application programmer creates a test class by inheriting this class.
This class adds the following functions to the preparation process and result confirmation provided by TestShot .
Preparation process Confirmation of results Prepare the request message Confirm the contents of the response message
By using this class, the test source and test data of the request unit test can be standardized, and description of test source can be significantly reduced.
For the specific usage method, refer to How to Execute a Request Unit Test (Receiving Synchronous Message Process).
Tip
This class reads the component configuration file on the main side to PUT the input data into the queue.
nablarch.fw.messaging.FwHeaderDefinitionimplementation class must be registered under the name fwHeaderDefinition.
To use a different name, the FwHeaderDefinition component name used by this class can be changed by overriding getFwHeaderDefinitionName() of this class.
3.2.6.3.4. MessagingReceiveTestSupport¶
A superclass for testing response-free asynchronous message process. The application programmer creates a test class by inheriting this class.
This class adds the following functions to the preparation process and result confirmation provided by TestShot .
Preparation process Prepare the request message
By using this class, the test source and test data of the request unit test can be standardized, and description of test source can be significantly reduced.
For the specific usage method, refer to How to Conduct a Request Unit Test (Receiving Asynchronous Message Process).
3.2.6.3.5. MainForRequestTesting¶
Main class for request unit test. The primary differences from the main class for production are as follows.
- Initialize the system repository from the component configuration file of the test.
- Disable the resident function.
3.2.6.3.6. MQSupport¶
A class that provides operations related to message. Primarily, the following functions are provided.
- Create a request message from the test data and PUT to the receive queue.
- Get a response message from the send queue and compare the content with the expected value of the test data.
3.2.6.3.7. TestDataConvertor¶
Interface for editing the test data read from Excel. If necessary, the architect implements the convertor for each data type, such as XML or JSON.
The implementation class implements the following functions.
- Edits any data read from Excel.
- Dynamically generates the layout definition data to read the edited data.
By implementing this interface, it is possible to add processes such as URL encoding of data written in Japanese to Excel.
The implementation class must be registered in the component configuration file for testing with the key name “TestDataConverter<data type>”.
3.2.6.4. Test data¶
This section describes the test data specific to the messaging process.
3.2.6.4.1. Message¶
For the specific usage method, refer to How to Execute a Request Unit Test (Receiving Synchronous Message Process).
Tip
The handling of padding and binary data is the same as Fixed-length file.