3.1.1.1.2. Class Unit Testing of Form/Entity supporting Nablarch Validation¶

3.1.1.1.2.1.1. Create test data¶

Describes how to create the Excel file that contains the test data itself. The Excel file containing the test data is stored with the same name in the same directory as the test source code (only the extension is different).It is a prerequisite that the test cases for validation, test cases for constructors, and test cases for setters and getters will be used one sheet at a time respectively.

For details on how to describe the test data, see Automated Testing Framework, Testing a Class that Uses the Database.

It is a prerequisite that the static master data stored in the database, such as message data and code master, has been input with data managed by the project in advance (these data are not created as individual test data).

3.1.1.1.2.1.2. Create a test class¶

The test class of form/entity unit test should be created to satisfy the following conditions.

• The package of the test class is the same as the Form/Entity to be tested.
• Create a test class with the class name <Form/Entity class name> Test.
• Inherit nablarch.test.core.db.EntityTestSupport.

package nablarch.sample.management.user; // [Description] Package is the same as SystemAccountEntity

import java.util.HashMap;
import java.util.Map;

import org.junit.Test;

import nablarch.test.core.db.EntityTestSupport;

import static org.junit.Assert.assertArrayEquals;
import static org.junit.Assert.assertEquals;

/**
 * Class that executes tests for the SystemAccountEntity class. <br/>
 * Refer to the Excel sheet for test content.
 *
 * @author Miki Habu
 * @since 1.0
 */
public class SystemAccountEntityTest extends EntityTestSupport {
// [Description] Class name is SystemAccountEntityTest and it inherits from EntityTestSupport


// ~ Rest is omitted ~

For details on how to describe the test method, see the code examples described below.

3.1.1.1.2.1.3. Single item validation test case of character type and string length¶

Most of the test cases for single item validation are related to the input character type and string length. For example, assume the following the property.

• Property name “Furigana”
• Maximum string length is 50 characters
• Required items
• Only full-width katakana is allowed

In this case, the following test case should be created.

Case	Perspective
Validation should be successful when full-width Katakana 50 characters are entered.	Check maximum string length and character type
Validation should fail when full-width Katakana 51 characters are entered.	Check of maximum string length
Validation should be successful when 1 full-width Katakana character is entered.	Check of minimum string length and character type
Validation should fail when empty string is entered.	Check of required validation
Validation should fail when Half-width Katakana is entered.	Check character type[1]

[1]	Similarly, there is a need for cases in which Half-width alphabetic characters, Full-width Hiragana, Kanji ..., etc. are input and the detailed examination fails.

There are a large number of test cases for single item validation, and data creation requires time and labor.Therefore, a test method is provided exclusively for single item validation test.As a result, the following effects are expected.

• Facilitates the creation of test cases for single item validation.
• Creates test data with high maintainability, making it easier to review and maintain.

<Parent Form>.<child Form>.<child form property name>.

3.1.1.1.2.1.3.1. How to create a test case table¶

Prepare the following columns.

Column name	Contents to be mentioned
propertyName	The property name to be tested.
allowEmpty	Whether the property allows for no input
min	Minimum string length allowed by the property as input value (optional)
max	Maximum string length allowed by the property as input value
messageIdWhenEmptyInput	Message ID to expect when input is empty (optional) [2]
messageIdWhenInvalidLength	Message ID to expect when input length is incompatible (optional) [3]
messageIdWhenNotApplicable	Message ID to expect when character type is incompatible
Half-width alphabetic characters (半角英字)	Whether half-width alphabetic characters are allowed?
Half-width numbers (半角数字)	Whether half-width numbers are allowed?
Half-width symbols (半角記号)	Whether half-width symbols are allowed?
Half-width kana (半角カナ)	Whether half-width kana are allowed?
Full-width alphabets (全角英字)	Whether full-width alphabets are allowed?
Full-width numbers (全角数字)	Whether full-width numbers are allowed?
Full-width Hiragana (全角ひらがな)	Whether full-width Hiragana are allowed?
Full-width Katakana (全角カタカナ)	Whether full-width Katakana are allowed?
Full-width Kanji (全角漢字)	Whether full-width Kanji are allowed?
Full-width symbols and others (全角記号その他)	Whether full-width symbols and others are allowed?
External characters (外字)	Whether external characters are allowed?

[2]	If messageIdWhenEmptyInput is omitted, the value of emptyInputMessageId set in Automated test framework configuration values is used.

[3]	If messageIdWhenInvalidLength is omitted, the default value set in Automated test framework configuration values is used. Which default value is used when omitted is determined by the descriptions in the max and min fields, as follows.

min column	compiration between max and min	Default value used when omitted
unset	N/A	maxMessageId
set	max > min	maxAndMinMessageId(exceed), underLimitMessageId (insufficient)
set	max = min	fixLengthMessageId

Configure the following values in the column to indicate the permission.

Configuration details	Configuration value	Remarks
allowed	o	Half-width lower-case O
Not allowed	x	lower-case alphabet X

A specific example is shown below.

void testValidateCharsetAndLength(Class entityClass, String sheetName, String id)

 // [Description] ~ Previous is omitted ~

public class SystemAccountEntityTest extends EntityTestSupport {

     /** Entity class to be tested*/
     private static final Class<SystemAccountEntity> ENTITY_CLASS = SystemAccountEntity.class;


     /**
      * Test cases for character type and string length
      */
     @Test
     public void testCharsetAndLength() {
          // [Description] Sheet name containing the test data
          String sheetName = "testCharsetAndLength";

          // [Description] ID of test data
          String id = "charsetAndLength";

          // [Description] Test execution
          testValidateCharsetAndLength(ENTITY_CLASS, sheetName, id);
     }


     // [Description] ~ Rest is omitted ~

3.1.1.1.2.1.4. Other single item validation test cases¶

Most of the single item validation can be tested using the single item validation test cases for character type and string length mentioned above, but some validation is not covered. For example, the range validation for numerical input items is possible.

A simple test system has also been prepared for such single item validation. By describing a pair of one input value and expected message ID for each property, it is possible to test the single item validation using any value.

<Parent Form>.<child Form>.<child form property name>.

3.1.1.1.2.1.4.1. How to create a test case table¶

Prepare the following columns.

Column name	Contents to be mentioned
propertyName	The property name to be tested.
case	Brief description of the test case
input1[4]	Input value [5]
messageId	Message ID that is expected to be generated when the above input value is used for single item validation (blank space if no validation error is expected).

[4]	When specifying multiple parameters for a single key, add columns such as input2 and input3.

[5]	Input values can be created efficiently using the Special ways to write in a cell notation.

A specific example is shown below.

void testSingleValidation(Class entityClass, String sheetName, String id)

// [Description] ~ Previous is omitted ~

public class SystemAccountEntityTest extends EntityTestSupport {

     /** Entity class to be tested*/
     private static final Class<SystemAccountEntity> ENTITY_CLASS = SystemAccountEntity.class;

     /**
      * Single item validation test case of character type and string length
      */
     // [Description] ~ Middle is omitted ~

     /**
      * Test cases for single item validation (not listed above)
      */
     @Test
     public void testSingleValidation() {
         String sheetName = "testSingleValidation";
         String id = "singleValidation";
         testSingleValidation(ENTITY_CLASS, sheetName, id);
     }


      // [Description] ~ Rest is omitted ~

3.1.1.1.2.1.5. Test case for validation method¶

In the single item validation test mentioned above, the annotation given to the setter method of the entity is tested for correctness, and the validation method [6]implemented in the entity is not executed.

Therefore, a separate test must be created if you implement your own validation method in the entity.

3.1.1.1.2.1.5.2. Create test cases and test data¶

3.1.1.1.2.1.5.2.1. Check for validation target¶

When the properties to be validated are specified (see Nablarch Validation), create a case to check whether they are correctly specified.

Prepare data that will cause an error in each single item validation for all properties.If the specification of the properties to be validated are correct, only the properties to be validated should undergo single item validation.Therefore, the names of all properties to be validated, and the message ID when a single item validation error occurs for each property are entered as expected values.

Tip

If a property for validation is accidentally omitted from the validation target, the message ID assertion will fail since the expected message is not output. Also, if a property that is not a target for validation accidentally becomes a target for validation, single item validation will fail due to invalid input value and an unexpected message is output. As a result, validation target errors can be detected.

The property name of all properties for validation and the single item validation error message ID of those properties are listed in the test case table.

The values that result in single item validation errors for all the properties are listed in the input parameters table.

Tip

When creating a test case or test data for the Form unit test, specifying another property of another Form that is held in the property may be required. In this case, it can be specified as follows.

• Example code for Form

public class SampleForm {

    /** System user */
    private SystemUserEntity systemUser;

    /** Telephone number array */
    private UserTelEntity[] userTelArray;

    // [Description] Omitted except for properties

}

• How to specify the Form property being held (when specifying SystemUserEntity.userId)

sampleForm.systemUser.userId

• How to specify the property of the Form array element (when specifying the property of the first UserTelEntity array element)

sampleForm.userTelArray[0].telNoArea

3.1.1.1.2.1.5.2.2. Validation between items¶

Create a case to confirm communications other than the validation target specification that is performed by the Check for validation target validation method, such as validation between items.

In the figure below, a normal case is created for the validation method “newPassword and confirmPassword are the same”.

 // ~ Previous is omitted ~

 /** Entity class to be tested*/
 private static final Class<SystemAccountEntity> ENTITY_CLASS = SystemAccountEntity.class;

 // ~ Middle is omitted ~
 /**
  * {@link SystemAccountEntity#validateForRegisterUser(nablarch.core.validation.ValidationContext)} test.
  */
 @Test
 public void testValidateForRegisterUser() {
     // Execution of validation
     String sheetName = "testValidateForRegisterUser";
     String validateFor = "registerUser";
     testValidateAndConvert(ENTITY_CLASS, sheetName, validateFor);
 }

// ~ Rest is omitted ~

3.1.1.1.2.1.6. Test case for constructor¶

In the test for constructors, create a case to check whether the value specified in the argument is set correctly in the property.At this time, the target properties are all the properties defined in Entity.For the test data, prepare the property name, the data to be set for it, and the expected value (data to be compared with the value obtained by the getter).

In the figure below, values have been specified for each property as follows. When the constructor is given a combination of these values, the test checks whether each property is configured to the specified value (Can the expected value be obtained by calling the getter).

In the actual test code, setting of value to the constructor and checking of the value are performed in the method provided by the automated test framework. For more information, see test code.

3.1.1.1.2.1.6.1. Definition to Excel¶

Test contents of the above configuration values (excerpt)

Property	Value set to the constructor	Expected value (value obtained from the getter)
userId	userid	userid
loginId	loginid	loginid
password	password	password

The following test methods use this data:

// [Description] ~ Previous is omitted ~

public class SystemAccountEntityTest extends EntityTestSupport {

     /** Constructor test */
     @Test
     public void testConstructor() {
         Class<?> entityClass = SystemAccountEntity.class;
         String sheetName = "testAccessor";
         String id = "testConstructor";
         testConstructorAndGetter(entityClass, sheetName, id);
     }

}

Tip

There are restrictions on the type (class) of properties that can be tested with testConstructorAndGetter. If the property does not correspond to the following types (class), the constructor and getter in each test class must be explicitly called to test it.

• String and String array
• BigDecimal and BigDecimal array
• java.util.Date and java.util.Date array (write in yyyy-MM-dd format or yyyy-MM-dd HH:mm:ss format to excel)
• Class with valueOf(String) method and its array class (ex: Integer or Long, java.sql.Date or java.sql.Timestamp etc.)

Examples of individual test execution methods are given below. This example assumes that Form has the property users of type List<String>.

• Example of data description to Excel

  

• Test code example

  /** Constructor test */
  @Test
  public void testConstructor() {
      // [Description]
      // The items that can be commonly tested are tested by using testConstructorAndGetter.
      Class<?> entityClass = SystemAccountEntity.class;
      String sheetName = "testAccessor";
      String id = "testConstructor";
      testConstructorAndGetter(entityClass, sheetName, id);
  
      // [Description]
      // The items that cannot be tested commonly are tested individually.
  
      // [Description]
      // getParamMap is called to acquire the test data of properties to be tested individually.
      // (If there are multiple properties for testing, getListParamMapis used.)
      Map<String, String[]> data = getParamMap(sheetName, "testConstructorOther");
  
      // [Description] Convert Map<String, String[]> to Map<String, Object>, which is the argument of the Entity's constructor
      Map<String, Object> params = new HashMap<String, Object>();
      params.put("users", Arrays.asList(data.get("set")));
  
      // [Description] Generate Entity with Map<String, Object> generated above as the argument.
      SystemAccountEntity entity = new SystemAccountEntity(params);
  
      // [Description] Call getter and confirm that the expected value is returned.
      assertEquals(entity.getUsers(), Arrays.asList(data.get("get")));
  
  }
  

3.1.1.1.2.1.7. Test cases for setters and getters¶

Refer to Test cases for setters and getters .

3.1.1.1.2.1.8. Automated test framework configuration values¶

Describes the initial value configuration required when executing Single item validation test case of character type and string length.

<property name="validators">
  <list>
    <component class="nablarch.core.validation.validator.RequiredValidator">
      <property name="messageId" value="MSG00010"/>
    </component>
    <component class="nablarch.core.validation.validator.LengthValidator">
      <property name="maxMessageId" value="MSG00011"/>
      <property name="maxAndMinMessageId" value="MSG00011"/>
      <property name="fixLengthMessageId" value="MSG00023"/>
    </component>
    <!-- Omitted -->
</property>

<!-- Entity test configuration -->
<component name="entityTestConfiguration" class="nablarch.test.core.entity.EntityTestConfiguration">
  <property name="maxMessageId"        value="MSG00011"/>
  <property name="maxAndMinMessageId"  value="MSG00011"/>
  <property name="fixLengthMessageId"  value="MSG00023"/>
  <property name="underLimitMessageId" value="MSG00011"/>
  <property name="emptyInputMessageId" value="MSG00010"/>
  <property name="characterGenerator">
    <component name="characterGenerator"
               class="nablarch.test.core.util.generator.BasicJapaneseCharacterGenerator"/>
  </property>
</component>