com.auxiliary.http

Class ReadInterfaceFromXml

java.lang.Object

com.auxiliary.http.ReadInterfaceFromAbstract

com.auxiliary.http.ReadInterfaceFromXml

All Implemented Interfaces:

ActionEnvironment, ActionEnvironmentGroup, AssertResponse, BeforeOperation, ExtractResponse, InterfaceGroup

public class ReadInterfaceFromXml
extends ReadInterfaceFromAbstract
implements ActionEnvironmentGroup, AssertResponse, ExtractResponse, BeforeOperation, InterfaceGroup

文件名：ReadInterfaceFromXml.java

用途：用于读取xml文件中的接口信息

编码时间：2022年4月27日 上午8:10:25

修改时间：2022年4月27日 上午8:10:25

Since:

JDK 1.8, autest 3.3.0

Version:

Ver1.0

Author:

彭宇琦

Field Summary

Fields inherited from class com.auxiliary.http.ReadInterfaceFromAbstract

DEFAULT_HOST, DEFAULT_ORD, DEFAULT_SEARCH, interfaceCacheMap

Fields inherited from interface com.auxiliary.http.AssertResponse

ARRAY_END_SYMBOL, ARRAY_START_SYMBOL, JSON_ASSERT_ASSERT_REGEX, JSON_ASSERT_LB, JSON_ASSERT_ORD, JSON_ASSERT_PARAM_NAME, JSON_ASSERT_RB, JSON_ASSERT_SEARCH, JSON_ASSERT_XPATH, SEPARATE_SPLIT_REGEX, SEPARATE_SYMBOL, SEPARATE_TRANSFERRED_MEANING_REGEX

Fields inherited from interface com.auxiliary.http.ExtractResponse

ARRAY_END_SYMBOL, ARRAY_START_SYMBOL, JSON_EXTRACT_LB, JSON_EXTRACT_ORD, JSON_EXTRACT_PARAM_NAME, JSON_EXTRACT_RB, JSON_EXTRACT_SAVE_NAME, JSON_EXTRACT_SEARCH, JSON_EXTRACT_XPATH, SEPARATE_SPLIT_REGEX, SEPARATE_SYMBOL, SEPARATE_TRANSFERRED_MEANING_REGEX

Constructor Summary

Constructors

Constructor and Description
ReadInterfaceFromXml(File xmlFile) 根据xml文件对象，解析接口信息xml文件，并设置接口执行环境及接口默认执行环境

Method Summary

Modifier and Type	Method and Description
HashMap<String,String>	getActionEnvironment() 该方法用于返回所有的执行环境集合
Set<String>	getAssertContent(String interName) 该方法用于返回指定接口的断言内容json串
List<BeforeInterfaceOperation>	getBeforeOperation(String interName) 该方法用于返回接口的所有前置操作方法
String	getEnvironmentGroupName(String envGroupName, String envName) 该方法用于返回指定执行环境组中的环境名称对应的地址
Set<String>	getExtractContent(String interName) 该方法用于指定接口的报文提词内容json串集合
Map<String,String>	getGroupAllEnvironmentName(String envGroupName) 该方法用于返回环境组下的所有环境名称
InterfaceInfo	getInterface(String interName) 该方法用于根据接口名称，返回接口的信息类对象
InterfaceInfo	getInterface(String interName, String environmentName) 该方法用于根据接口名称及所在环境，返回接口的信息类对象
InterfaceInfo	getInterface(String interName, String envGroupName, String environmentName) 该方法用于根据接口名称及所在环境，返回接口的信息类对象
Map<String,InterfaceInfo>	getInterfaceGroup(String groupName) 该方法用于按照接口文件中编写的接口顺序，返回接口组中的所有接口集合
Map<String,InterfaceInfo>	getInterfaceGroup(String groupName, String envGroupName, String environmentName, boolean isOrderlyStorage) 该方法用于按照指定的存储方式，返回接口组中的所有接口集合
List<String>	getParentInterfaceName(String interName) 该方法用于返回接口的所有父层接口名称（不包括当前接口名称）
void	setActionEnvironment(String environmentName) 该方法用于设置当前执行接口的环境
void	switchDefaultGroup() 该方法用于切换到默认环境组的状态，即读取环境组外的环境
void	switchGroup(String envGroupName) 该方法用于切换指定的环境组

Methods inherited from class com.auxiliary.http.ReadInterfaceFromAbstract

clearInterfaceInfoCache

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReadInterfaceFromXml

public ReadInterfaceFromXml(File xmlFile)

根据xml文件对象，解析接口信息xml文件，并设置接口执行环境及接口默认执行环境

Parameters:

xmlFile - xml文件类对象

Since:

autest 3.3.0

Method Detail

getExtractContent

public Set<String> getExtractContent(String interName)

Description copied from interface: ExtractResponse

该方法用于指定接口的报文提词内容json串集合

json串的键值可通过静态属性获取，当没有断言内容时，则json中的键都为空值

Specified by:

getExtractContent in interface ExtractResponse

Parameters:

interName - 接口名称

Returns:

接口响应报文提词内容json串集合

getAssertContent

public Set<String> getAssertContent(String interName)

Description copied from interface: AssertResponse

该方法用于返回指定接口的断言内容json串

json串的键值可通过静态属性获取，当没有断言内容时，则json中的键都为空值

Specified by:

getAssertContent in interface AssertResponse

Parameters:

interName - 接口名称

Returns:

接口断言内容json串

setActionEnvironment

public void setActionEnvironment(String environmentName)

Description copied from interface: ActionEnvironment

该方法用于设置当前执行接口的环境

Specified by:

setActionEnvironment in interface ActionEnvironment

Parameters:

environmentName - 环境名称

getActionEnvironment

public HashMap<String,String> getActionEnvironment()

Description copied from interface: ActionEnvironment

该方法用于返回所有的执行环境集合

Specified by:

getActionEnvironment in interface ActionEnvironment

Returns:

所有执行环境集合

getEnvironmentGroupName

public String getEnvironmentGroupName(String envGroupName,
                                      String envName)

Description copied from interface: ActionEnvironmentGroup

该方法用于返回指定执行环境组中的环境名称对应的地址

Specified by:

getEnvironmentGroupName in interface ActionEnvironmentGroup

Parameters:

envGroupName - 环境组名称

envName - 环境名称

Returns:

对应的地址

getGroupAllEnvironmentName

public Map<String,String> getGroupAllEnvironmentName(String envGroupName)

Description copied from interface: ActionEnvironmentGroup

该方法用于返回环境组下的所有环境名称

Specified by:

getGroupAllEnvironmentName in interface ActionEnvironmentGroup

Parameters:

envGroupName - 环境组名称

Returns:

环境组下的所有环境名称集合

switchGroup

public void switchGroup(String envGroupName)

Description copied from interface: ActionEnvironmentGroup

该方法用于切换指定的环境组

注意：若环境组名称不存在，则不进行切换；若环境组名称传入null或空串，则切换为默认环境组的状态，等同于调用ActionEnvironmentGroup.switchDefaultGroup()方法

Specified by:

switchGroup in interface ActionEnvironmentGroup

Parameters:

envGroupName - 环境组名称

switchDefaultGroup

public void switchDefaultGroup()

Description copied from interface: ActionEnvironmentGroup

该方法用于切换到默认环境组的状态，即读取环境组外的环境

Specified by:

switchDefaultGroup in interface ActionEnvironmentGroup

getInterface

public InterfaceInfo getInterface(String interName)

Description copied from class: ReadInterfaceFromAbstract

该方法用于根据接口名称，返回接口的信息类对象

Specified by:

getInterface in class ReadInterfaceFromAbstract

Parameters:

interName - 接口名称

Returns:

接口信息类对象

getInterface

public InterfaceInfo getInterface(String interName,
                                  String environmentName)

Description copied from interface: ActionEnvironment

该方法用于根据接口名称及所在环境，返回接口的信息类对象

Specified by:

getInterface in interface ActionEnvironment

Parameters:

interName - 接口名称

environmentName - 环境名称

Returns:

接口信息类对象

getInterface

public InterfaceInfo getInterface(String interName,
                                  String envGroupName,
                                  String environmentName)

Description copied from interface: ActionEnvironmentGroup

该方法用于根据接口名称及所在环境，返回接口的信息类对象

Specified by:

getInterface in interface ActionEnvironmentGroup

Parameters:

interName - 接口名称

envGroupName - 环境组名称

environmentName - 环境名称

Returns:

接口信息类对象

getInterfaceGroup

public Map<String,InterfaceInfo> getInterfaceGroup(String groupName)

该方法用于按照接口文件中编写的接口顺序，返回接口组中的所有接口集合

Specified by:

getInterfaceGroup in interface InterfaceGroup

Parameters:

groupName - 接口组名称

Returns:

接口组中的接口集合

Throws:

InterfaceReadToolsException - 当接口组信息读取错误时，抛出的异常

Since:

autest 4.4.0

getInterfaceGroup

public Map<String,InterfaceInfo> getInterfaceGroup(String groupName,
                                                   String envGroupName,
                                                   String environmentName,
                                                   boolean isOrderlyStorage)

该方法用于按照指定的存储方式，返回接口组中的所有接口集合

Parameters:

groupName - 接口组名称

envGroupName - 环境组名称

environmentName - 环境名称

isOrderlyStorage - 是否有序存储，传入true则表示按照有序的方式进行存储；反之，则以无序的方式进行存储

Returns:

接口组中的接口集合

Throws:

InterfaceReadToolsException - 当接口组信息读取错误时，抛出的异常

Since:

autest 4.4.0

See Also:

getInterfaceGroup(String)

getParentInterfaceName

public List<String> getParentInterfaceName(String interName)

Description copied from interface: BeforeOperation

该方法用于返回接口的所有父层接口名称（不包括当前接口名称）

Specified by:

getParentInterfaceName in interface BeforeOperation

Parameters:

interName - 接口名称

Returns:

父层接口名称集合

getBeforeOperation

public List<BeforeInterfaceOperation> getBeforeOperation(String interName)

Description copied from interface: BeforeOperation

该方法用于返回接口的所有前置操作方法

Specified by:

getBeforeOperation in interface BeforeOperation

Returns:

前置操作封装类集合