Test a service

Service providers can test a service manually or by using automated testing. Choose the method that best suits your service.

• Manual testing: Use the service instance deployment link to deploy a service instance in your own account from a user's perspective.

• Automated testing: Create test cases for different templates and run test tasks to verify template accuracy. Test cases are inherited by subsequent service versions, enabling regression testing across iterations. Automated tests are triggered automatically when you submit a service for review.

Manual testing

Use the service instance deployment link to create a service instance in your account and verify the deployment process.

1. Log on to the Compute Nest console.

2. Find the saved service. Click the service name to open the service details page.

3. Click the Service Test tab and then click the test link to open the service instance creation page.

   On the service instance creation page, verify the user interface (UI).

4. After the test is complete, the Test successful message is displayed on the Service Test tab. This confirms that the service instance was created and the service is available.

Automated testing

Create a test case to customize service template parameters. The test case is linked to the service review process and runs automatically when you submit the service for review. Test cases are inherited by all subsequent service versions, enabling regression testing when you upgrade or update the service.

Test case configuration

A test case is defined in a YAML file. The following example shows a test case configuration for a consul service.

---
parameters:
  SystemDiskSize: 100
  PayType: "PostPaid"
  DataDiskSize: 40
  InstanceType: "$[iact3-auto]"
  AllocatePublicIp: "true"
  DataDiskCategory: "cloud_efficiency"
  InstancePassword: "$[iact3-auto]"
  SystemDiskCategory: "cloud_essd"

You can also click Import Default Configurations in the Add Test Case dialog box to import the default test case configuration for the service. The default configuration uses the parameters defined in the service template.

Parameters

The following table describes the fields in a test case configuration.

Create a test task

To run a test, select a template and test case in your Compute Nest account.

1. In the Test Tasks section, click Create Task. In the dialog box that appears, configure the task information.

   1. Set a name for the test task.

   2. Select a service template and a test case.

      If you have multiple templates, you can add a test case for each template.

   3. Select the region where you want to run the task.

      If you do not select a region, one is randomly selected from the deployment regions that are configured for the service.

2. Click Create Now.

   After you create the task, you can view its progress in the task list. The task appears in the Test Tasks list. The list contains information such as Task Name, Region, Test Case, and Execution Status. The initial execution status is Running.

3. View the report.

   After the task completes, you can view the test configuration and test case information in the execution report.

   1. Click the icon next to the test task name and then click Details.

   2. In the Test Report dialog box, review the task's test configuration, region, and stack. The dialog box has two sections: The Test Configuration section displays the YAML parameters of the template, such as SystemDiskSize, PayType, DataDiskSize, InstanceType, AllocatePublicIp, DataDiskCategory, InstancePassword, and SystemDiskCategory. The Test Case section displays the test name, region, stack, result, and test log in a table. You can click the View link to view the details of the corresponding test log.

4. View the logs.

   You can view information such as the effective parameters, stack details, and error messages in the logs. The log details dialog box shows fields such as Region, StackName, StackId, TestedResult, and ResultReason. For example, if the test result is Failed, the reason might be StackValidationFailed with a message such as Resources.Database.Condition: Unrecognized value 'Please fill in'. This indicates an invalid parameter value. Valid values for boolean types include '0', '1', 'true', 'false', 'yes', 'no', 'on', and 'off'.

Common errors and solutions

The following are common service testing errors and their solutions.

• Error message: In the error log, TestedResult is Failed and ResultReason shows IacerException, can not find any available value for ZoneId in {region}. An example is "IacerException, can not find any available value for ZoneId in cn-qingdao region in [] for default".

  Solution: No corresponding resources are available in the current region. Specify a different region for the task.

• Error message: "Resources.TiDBServerScalingGroupEnable.Properties: : Unknown Property DetachOptions request id: 51341F62-56DC-xxxx-xxxx-xxx"

  Solution: A parameter in the template is invalid. Modify the parameter in the test configuration based on the log message.

Pseudo parameters

Manually entering test parameters for functional verification can be tedious. Use the $[iact3-auto] pseudo parameter to automatically fill in parameter values. Pseudo parameters are supported in the following scenarios:

• The parameter supports an API for querying its constraints. When you call the GetTemplateParameterConstraints operation for the parameter, the operation returns a list of AllowedValues.

• The parameter name has a specific meaning or implies a clear resource type. In this case, the pseudo parameter automatically obtains an appropriate value.

  • For parameters such as VpcId, VswitchId, and SecurityGroupId, the pseudo parameter automatically selects a corresponding instance ID from the current region.

  • For parameters such as VpcName, Password, and Uuid, the pseudo parameter randomly generates a name, password, or UUID value.

  • The pseudo parameter supports names that match the following regular expressions:

    • If a parameter name matches the regular expression vpc(_|)id, it automatically obtains a random VpcId value from the current region.

    • If a parameter name matches v(_|)switch(_|)id, it automatically obtains a VswitchId value from the current region. If the parameter name also contains a value that matches zone(_|)id, the ID of a vSwitch in the corresponding zone is queried.

    • If a parameter name matches security(_|)group(_id|id), it automatically obtains security group information.

    • If a parameter name matches the regular expression r'\w*name', a random string that starts with iacer- is generated.

    • If a parameter name matches the regular expression r'\w*password', a random password that contains uppercase letters, lowercase letters, digits, and special characters is generated.

    • If a parameter name matches the regular expression r'\w*uuid', it automatically generates a UUID.