Compare commits

...

15 Commits

Author SHA1 Message Date
彭宇琦 3ab7589976 完成增强页面打开断言 2021-02-19 17:50:27 +08:00
彭宇琦 c6cbea3a57 添加其他断言方法 2021-02-18 18:47:13 +08:00
彭宇琦 85e6ea99c9 !19 合并修复的功能代码
Merge pull request !19 from 彭宇琦/release/autest_ver2.1.0
2021-02-18 17:24:36 +08:00
彭宇琦 7fc538a2e4 !18 合并修改的代码
Merge pull request !18 from 彭宇琦/hofix/20210204-工具问题修复
2021-02-18 17:20:20 +08:00
彭宇琦 3b1222eddc 完成元素查找轮询机制 2021-02-18 16:54:53 +08:00
彭宇琦 a77ab169ce 删除无效的标记 2021-02-18 07:52:23 +08:00
彭宇琦 470b7f217b 删除无效的标记 2021-02-18 07:51:47 +08:00
彭宇琦 fe2d94cb95 !17 同步release
Merge pull request !17 from 彭宇琦/release/autest_ver2.1.0
2021-02-07 16:53:12 +08:00
彭宇琦 b76e758c67 !16 添加列表事件的改造
Merge pull request !16 from 彭宇琦/feature/20210207-列表事件改造
2021-02-07 16:51:35 +08:00
彭宇琦 1cf57bd35b 添加随机元素返回及表元素累返回方法 2021-02-07 16:48:24 +08:00
彭宇琦 5feb22981a 修复xml形式读取窗体元素时读取错误的问题 2021-02-06 19:42:55 +08:00
彭宇琦 4c647ad192 添加遗漏的注释 2021-02-06 19:24:35 +08:00
彭宇琦 1f951c3390 升级dom4j 2021-02-06 19:24:01 +08:00
彭宇琦 25695b2320 修复截图时路径错误问题 2021-02-06 19:19:30 +08:00
彭宇琦 95ef5bc5c3 添加等待事件遗漏的注释 2021-02-05 08:15:21 +08:00
14 changed files with 560 additions and 195 deletions

View File

@ -57,10 +57,11 @@
<!-- xml解析工具 -->
<dependency>
<groupId>dom4j</groupId>
<artifactId>dom4j</artifactId>
<version>1.6.1</version>
<groupId>org.dom4j</groupId>
<artifactId>dom4j</artifactId>
<version>2.1.3</version>
</dependency>
<dependency>
<groupId>jaxen</groupId>
<artifactId>jaxen</artifactId>

View File

@ -140,6 +140,17 @@ public class ElementData {
public long getWaitTime() {
return waitTime;
}
/**
* 返回元素定位方式的个数
* <p>
* 若定位方式与定位内容不一致时则返回两者中的最小长度
* </p>
* @return 元素定位方式的个数
*/
public int getLocationSize() {
return Math.min(byTypeList.size(), valueList.size());
}
/**
* 用于添加元素定位外链词语

View File

@ -265,20 +265,13 @@ public abstract class FindElement {
ArrayList<ByType> elementByTypeList = elementData.getByTypeList();
ArrayList<String> elementValueList = elementData.getValueList();
//获取两个列表长度的最小者
int minLength = Math.min(elementByTypeList.size(), elementValueList.size());
//循环遍历所有的定位方式使用根据定位方式判断页面是否存在定位方式指向的元素
for (int index = 0; index < minLength; index++) {
//根据当前元素信息在页面获取元素
List<WebElement> elementList = findElement(elementByTypeList.get(index),
elementValueList.get(index),
elementData.getWaitTime() == -1 ? globalWaitTime : elementData.getWaitTime());
//若获取到的元素列表为空则继续循环调用下一个定位方式
if (elementList.size() != 0) {
return elementList;
}
}
List<WebElement> elementList = findElement(elementByTypeList, elementValueList,
elementData.getWaitTime() == -1 ? globalWaitTime : elementData.getWaitTime());
//若获取到的元素列表为空则继续循环调用下一个定位方式
if (elementList.size() != 0) {
return elementList;
}
throw new TimeoutException("页面上无相应定位方式的元素,元素名称:" + elementData.getName());
}
@ -286,25 +279,35 @@ public abstract class FindElement {
/**
* 根据传入的定位方式枚举以及定位内容在页面查找
* 元素返回查到的元素列表若查不到元素则返回空列表
* @param byType {@link ByType}枚举类
* @param value 元素定位内容
* @param byTypeList {@link ByType}枚举类集合
* @param valueList 元素定位内容集合
* @param waitTime 元素查找超时时间
* @return 页面查找到的{@link WebElement}类对象{@link List}集合
*/
protected List<WebElement> findElement(ByType byType, String value, long waitTime) {
protected List<WebElement> findElement(List<ByType> byTypeList, List<String> valueList, long waitTime) {
try {
return new WebDriverWait(brower.getDriver(), waitTime, 200)
.until(driver -> {
try {
List<WebElement> webElementList = driver.findElements(getBy(value, byType));
if (webElementList != null && webElementList.size() != 0) {
return webElementList;
} else {
return null;
int minLength = Math.min(byTypeList.size(), valueList.size());
//遍历所有的定位方式与定位内容
for (int i = 0; i < minLength; i++) {
try {
//页面查找元素
List<WebElement> webElementList = driver.findElements(getBy(valueList.get(i), byTypeList.get(i)));
//若元素组为空或者获取的元素为空则重新循环反之则返回找到元素
if (webElementList != null && webElementList.size() != 0) {
return webElementList;
} else {
continue;
}
} catch (Exception e) {
//若抛出异常则重新循环
continue;
}
} catch (Exception e) {
return null;
}
//若循环完毕仍未找到元素则返回null
return null;
});
} catch (TimeoutException e) {
return new ArrayList<WebElement>();

View File

@ -84,6 +84,10 @@ public abstract class AbstractEvent {
wait.withTimeout(Duration.ofSeconds(waitTime));
}
/**
* 用于设置是否将页面移至元素所在的位置
* @param isLocationElement 是否将页面移至元素所在的位置
*/
public void setLocationElement(boolean isLocationElement) {
this.isLocationElement = isLocationElement;
}

View File

@ -115,6 +115,7 @@ public class WaitEvent extends AbstractEvent{
* 该方法用于等待指定元素中显示相应的文本可指定显示文本的关键词直到显示相应的关键词为止
* 若不传入关键词则只判断元素加载出文本若元素未出现则返回false
* @param element {@link Element}对象
* @param keys 需要判断的文本
* @return 元素是否存在文本或包含指定文本
* @throws TimeoutException 等待超时时抛出的异常
*/

View File

@ -258,9 +258,10 @@ public final class DataTableEvent extends AbstractEvent {
}
/**
* 通过条件点击{@link DataTableKeywordType#SEARCH_BUTTON}映射的按钮对列表进行搜索方法中需要接收一个
* 返回值为boolean类型的操作若操作的返回值为false时则不会点击按钮可参考以下写法
*
* 通过条件点击{@link DataTableKeywordType#SEARCH_BUTTON}映射的按钮对列表进行搜索
* <p>
* 方法中需要接收一个返回值为boolean类型的操作若操作的返回值为false时
* 则不会点击按钮可参考以下写法
* <code><pre>
* DataTableEvent test = new DataTableEvent(brower);
* test.searchList(() -&gt; {
@ -268,6 +269,7 @@ public final class DataTableEvent extends AbstractEvent {
* return true;
* });
* </pre></code>
* </p>
*
* @param action 返回值为boolean类型的操作
* @return 列表是否有变化
@ -301,6 +303,15 @@ public final class DataTableEvent extends AbstractEvent {
return result;
}
/**
* 用于无条件点击{@link DataTableKeywordType#SEARCH_BUTTON}映射的按钮
*
* @return列表是否有变化
*/
public boolean searchList() {
return searchList(() -> true);
}
/**
* <p>
@ -327,7 +338,6 @@ public final class DataTableEvent extends AbstractEvent {
.filter(table -> !table.isEmpty())
//若当前为空集合则抛出异常
.orElseThrow(() -> new ControlException("当前行元素为空,无法获取"));
}
/**
@ -349,7 +359,7 @@ public final class DataTableEvent extends AbstractEvent {
return rowTextList;
}
/**
* 获取指定列的文本若该列元素异常时则抛出异常
*
@ -371,6 +381,32 @@ public final class DataTableEvent extends AbstractEvent {
return listTextList;
}
/**
* 用于以{@link TableData}的形式返回元素列表
* @return 元素列表
*/
public TableData<Element> getElementTable() {
return new TableData<Element>(elementTable);
}
/**
* 用于随机返回指定列表的随机一个元素
* @param listName 列表名称
* @return 指定列表的随机元素
*/
public Element getRandomElement(String listName) {
//按列表长度获取随机数
int listSize = elementTable.getListSize(listName);
int randomIndex = new Random().nextInt(listSize);
//根据随机数返回元素若当前随机的元素不存在则返回列表第一个元素
//若列表第一个元素仍不存在则跑出异常
return elementTable.getColumnList(listName).get(randomIndex)
.orElse(elementTable.getColumnList(listName).get(0)
.orElseThrow(() -> new ControlException("当前列元素为空,无法获取")));
}
/**
* 用于执行需要断言页面元素的列表操作在其操作方法前后添加了断言操作

View File

@ -1,5 +1,7 @@
package com.auxiliary.selenium.location;
import org.openqa.selenium.By;
/**
* <p>
* <b>文件名</b>ByType.java
@ -57,4 +59,30 @@ public enum ByType {
public String getValue() {
return value;
}
/**
* 根据枚举内容返回相应的{@link By}对象
* @param value 元素的定位内容
* @return 包含定位内容的元素{@link By}对象
*/
public By getBy(String value) {
switch (this) {
case CLASSNAME:
return By.className(value);
case CSS:
return By.cssSelector(value);
case ID:
return By.id(value);
case LINKTEXT:
return By.linkText(value);
case NAME:
return By.name(value);
case TAGNAME:
return By.tagName(value);
case XPATH:
return By.xpath(value);
default:
return null;
}
}
}

View File

@ -59,7 +59,7 @@ public class XmlLocation extends AbstractLocation {
try {
dom = new SAXReader().read(xmlFile);
} catch (DocumentException e) {
throw new IncorrectFileException("xml文件异常文件位置" + xmlFile.getAbsolutePath());
throw new IncorrectFileException("xml文件异常文件位置" + xmlFile.getAbsolutePath(), e);
}
}
@ -76,12 +76,9 @@ public class XmlLocation extends AbstractLocation {
public ArrayList<ByType> findElementByTypeList(String name) {
ArrayList<ByType> byTypeList = new ArrayList<ByType>();
//查询并存储元素下的子元素
@SuppressWarnings("unchecked")
ArrayList<Object> lableElementList = new ArrayList<>(getElementLabelElement(name).elements());
ArrayList<Element> lableElementList = new ArrayList<>(getElementLabelElement(name).elements());
lableElementList.stream()
//强转为Element类型
.map(lable -> (Element)lable)
//获取标签名称
.map(lable -> lable.getName())
//将名称转换为ByType枚举
@ -90,7 +87,6 @@ public class XmlLocation extends AbstractLocation {
.filter(lable -> lable != null)
//存储标签
.forEach(byTypeList::add);
;
return byTypeList;
}
@ -98,25 +94,32 @@ public class XmlLocation extends AbstractLocation {
@Override
public ArrayList<String> findValueList(String name) {
ArrayList<String> valueList = new ArrayList<>();
//查询元素
Element element = getElementLabelElement(name);
//遍历元素下所有的定位标签并将其转换为相应的ByType枚举存储至byTypeList中
for (Object byElement : element.elements()) {
//判断元素是否启用若元素未启用则下一个循环
String isUserText = ((Element) byElement).attributeValue("is_user");
if (isUserText != null && !Boolean.valueOf(isUserText)) {
continue;
}
//判断元素是否启用模板若启用模板则获取模板内容并将定位内容进行转换
String tempId = ((Element) byElement).attributeValue("temp_id");
String value = tempId != null ?
getTemplateValue(tempId, toByType(((Element) byElement).getName())) :
((Element)byElement).getText();
valueList.add(replaceValue(((Element) byElement), value));
}
//查询元素遍历元素下所有的定位标签并过滤掉元素标签
getElementLabelElement(name).elements().stream().filter(ele -> !"element".equals(ele.getName()))
//过滤不启用的标签
.filter(ele -> {
return Optional.ofNullable(ele.attributeValue("is_user"))
.filter(t -> !t.isEmpty())
.map(t -> {
try {
return Boolean.valueOf(t).booleanValue();
} catch (Exception e) {
return true;
}
}).orElse(true);
//根据值或模板将定位内容转译并存储至valueList
}).forEach(ele -> {
String value = "";
String tempId = Optional.ofNullable(ele.attributeValue("temp_id")).orElse("");
if (tempId.isEmpty()) {
value = ele.getText();
} else {
value = getTemplateValue(tempId, toByType(ele.getName()));
}
valueList.add(replaceValue(ele, value));
});
return valueList;
}

View File

@ -1,19 +1,31 @@
package com.auxiliary.selenium.page;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Optional;
import java.util.concurrent.TimeUnit;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.openqa.selenium.NoSuchElementException;
import org.openqa.selenium.WebDriver;
import com.alibaba.fastjson.JSONObject;
import com.auxiliary.selenium.brower.AbstractBrower;
import com.auxiliary.selenium.brower.IncorrectPageException;
import com.auxiliary.selenium.element.ElementData;
import com.auxiliary.selenium.location.ByType;
import com.auxiliary.selenium.location.NoFileLocation;
/**
* <p><b>文件名</b>Page.java</p>
* <p><b>用途</b>用于存储对浏览器加载的页面信息以及页面操作</p>
* <p><b>编码时间</b>2020年4月10日上午8:02:45</p>
* <p><b>修改时间</b>2020年10月12日下午8:02:45</p>
* <p><b>修改时间</b>2021年2月18日下午6:12:14</p>
* @author 彭宇琦
* @version Ver1.0
* @version Ver1.1
* @since JDK 1.8
*
*/
@ -27,9 +39,13 @@ public class Page {
*/
private int loadTime = 120;
/**
* 用于存储目标站点的title
* 用于存储需要断言的内容
*/
private String assertTitle = "";
private HashMap<PageAssertType, List<Object>> assertMap;
/**
* 标记当前是否启用断言
*/
private boolean isAssert = false;
/**
* 用于存储页面的名称
*/
@ -57,6 +73,10 @@ public class Page {
this.url = url;
this.pageName = pageName;
assertMap = new HashMap<>(16);
//初始化断言的内容
Arrays.stream(PageAssertType.values()).forEach(type -> assertMap.put(type, new ArrayList<>()));
//存储页面信息
pageInformationJson.put("页面名称", pageName);
pageInformationJson.put("页面站点", url);
@ -109,14 +129,135 @@ public class Page {
/**
* 用于设置对页面的标题断言
* @param assertTitle 标题断言
* <p>
* <b>注意</b>
* <ol>
* <li>页面断言为一次性断言故添加的断言内容只累积即多次添加断言内容在进行断言时将全部用于判断</li>
* <li>设置的断言内容为正则表达式若设置的断言内容存在正则表达式中的特殊字符则请自行转译
* 否则可能会得到不符合预期的结果</li>
* </ol>
* </p>
* @param titles 标题断言
*/
public void setAssertTitle(String assertTitle) {
this.assertTitle = assertTitle;
pageInformationJson.put("页面断言", assertTitle);
public void setAssertTitle(String...titles) {
Optional.ofNullable(titles).filter(ts -> ts.length != 0).ifPresent(ts -> {
List<Object> list = assertMap.get(PageAssertType.TITLE);
Arrays.stream(ts).forEach(list::add);
assertMap.put(PageAssertType.TITLE, list);
pageInformationJson.put("页面标题断言", list);
//记录启用了断言
isAssert = true;
});
}
/**
* 用于设置对页面的html内容断言
* <p>
* <b>注意</b>
* <ol>
* <li>页面断言为一次性断言故添加的断言内容只累积即多次添加断言内容在进行断言时将全部用于判断</li>
* <li>设置的断言内容为正则表达式若设置的断言内容存在正则表达式中的特殊字符则请自行转译
* 否则可能会得到不符合预期的结果</li>
* </ol>
* </p>
* @param htmls html断言数组
*/
public void setAssertHtml(String...htmls) {
Optional.ofNullable(htmls).filter(ts -> ts.length != 0).ifPresent(ts -> {
List<Object> list = assertMap.get(PageAssertType.HTML);
Arrays.stream(ts).forEach(list::add);
assertMap.put(PageAssertType.HTML, list);
pageInformationJson.put("页面html断言", list);
//记录启用了断言
isAssert = true;
});
}
/**
* 用于设置对页面最终跳转的url
* <p>
* <b>注意</b>
* <ol>
* <li>页面断言为一次性断言故添加的断言内容只累积即多次添加断言内容在进行断言时将全部用于判断</li>
* <li>设置的断言内容为正则表达式若设置的断言内容存在正则表达式中的特殊字符则请自行转译
* 否则可能会得到不符合预期的结果</li>
* </ol>
* </p>
* @param urls url断言数组
*/
public void setAssertUrl(String...urls) {
Optional.ofNullable(urls).filter(ts -> ts.length != 0).ifPresent(ts -> {
List<Object> list = assertMap.get(PageAssertType.URL);
Arrays.stream(ts).forEach(list::add);
assertMap.put(PageAssertType.URL, list);
pageInformationJson.put("页面url断言", list);
//记录启用了断言
isAssert = true;
});
}
/**
* 用于设置对页面的文本内容断言
* <p>
* <b>注意</b>
* <ol>
* <li>页面断言为一次性断言故添加的断言内容只累积即多次添加断言内容在进行断言时将全部用于判断</li>
* <li>页面文本断言不支持正则表达式需要指定确定的关键词否则可能会得到不符合预期的结果</li>
* </ol>
* </p>
* @param texts 页面文本断言数组
*/
public void setAssertText(String...texts) {
Optional.ofNullable(texts).filter(ts -> ts.length != 0).ifPresent(ts -> {
List<Object> list = assertMap.get(PageAssertType.TEXT);
//将文本转换为ElementData类以元素的形式进行断言
Arrays.stream(texts).map(text -> {
NoFileLocation nf = new NoFileLocation();
nf.putElementLocation("文本元素", ByType.XPATH, "//*[contains(text(), '" + text + "')]");
ElementData el = new ElementData("文本元素", nf);
return el;
}).forEach(list::add);
assertMap.put(PageAssertType.TEXT, list);
pageInformationJson.put("页面文本断言", list);
//记录启用了断言
isAssert = true;
});
}
/**
* 用于设置对页面的元素断言
* <p>
* <b>注意</b>
* <ol>
* <li>页面断言为一次性断言故添加的断言内容只累积即多次添加断言内容在进行断言时将全部用于判断</li>
* <li>设置的断言内容为正则表达式若设置的断言内容存在正则表达式中的特殊字符则请自行转译
* 否则可能会得到不符合预期的结果</li>
* </ol>
* </p>
* @param elements 元素断言数组
*/
public void setAssertElement(ElementData...elements) {
Optional.ofNullable(elements).filter(ts -> ts.length != 0).ifPresent(ts -> {
List<Object> list = assertMap.get(PageAssertType.ELEMENT);
Arrays.stream(elements).filter(e -> e != null).forEach(list::add);
assertMap.put(PageAssertType.ELEMENT, list);
pageInformationJson.put("页面元素断言", list);
//记录启用了断言
isAssert = true;
});
}
/**
* 用于设置对页面自动加载次数的限制
* @param rafreshCount 加载次数限制
@ -176,21 +317,119 @@ public class Page {
/**
* 用于对加载的页面信息与断言对比 返回对比结果
* @param driver WebDriver对象
* @return
* @return 断言是否成功
*/
private boolean judgeAssert(WebDriver driver) {
//若页面断言为空则直接返回true
if (assertTitle.isEmpty()) {
if (driver == null) {
throw new IncorrectPageException("未指定WebDriver对象");
}
//判断当前是否启用了断言
if (!isAssert) {
return true;
} else {
//若页面断言不为空且页面信息与断言不相同则返回false
if (!driver.getTitle().equals(assertTitle)) {
return false;
} else {
return true;
}
//遍历断言内容的key值
for (PageAssertType key : assertMap.keySet()) {
//若当前未设置断言则跳过该判断
if (assertMap.get(key).size() == 0) {
continue;
}
//根据关键词对页面进行断言
switch (key) {
case TITLE:
//获取页面标题判断标题是否符合所有的正则若存在不符合的则返回false
if (!assertTextContent(driver.getTitle(), key)) {
return false;
}
break;
case HTML:
//获取页面html判断标题是否符合所有的正则若存在不符合的则返回false
if (!assertTextContent(driver.getPageSource(), key)) {
return false;
}
break;
case URL:
//获取页面url判断标题是否符合所有的正则若存在不符合的则返回false
if (!assertTextContent(driver.getCurrentUrl(), key)) {
return false;
}
break;
//文本与元素判断的机制一致
case TEXT:
case ELEMENT:
//读取需要判断的元素若存在不符合的则返回false
if (!assertElementContent(driver, key)) {
return false;
}
break;
default:
break;
}
}
return true;
}
/**
* 用于对页面文本相关的内容进行断言的方法
* @param content 文本内容
* @param key 断言类型
* @return 断言是否成功
*/
private boolean assertTextContent(String content, PageAssertType key) {
for (Object assertObj : assertMap.get(key)) {
//设置当前值为正则传入的内容为需要判断的字符串
Matcher match = Pattern.compile((String) assertObj).matcher(content);
//若通过该正则在内容中无法找到则返回false
if (!match.find()) {
return false;
}
}
//若通过所有判断则返回true
return true;
}
/**
* 用于对页面元素相关的内容进行断言的方法
* @param driver 页面WebDriver对象
* @param key 断言类型
* @return 断言是否成功
*/
private boolean assertElementContent(WebDriver driver, PageAssertType key) {
for (Object assertObj : assertMap.get(key)) {
//将Object类转换为ElementData类
ElementData e = (ElementData) assertObj;
//获取元素的定位方式
List<ByType> byTypeList = e.getByTypeList();
List<String> valueList = e.getValueList();
//遍历元素的定位方式拼接定位方式为By对象
boolean isSuccess = true;
for (int i = 0; i < e.getLocationSize(); i++) {
try {
driver.findElement(byTypeList.get(i).getBy(valueList.get(i)));
isSuccess = true;
} catch (NoSuchElementException ex) {
isSuccess = false;
}
}
//判断当前查找完所有元素定位方式后是否能在页面找到元素
//若不能找到则直接返回false否则进行下一个判断
if (!isSuccess) {
return false;
} else {
continue;
}
}
//若通过所有判断则返回true
return true;
}
@Override
public int hashCode() {
@ -228,4 +467,40 @@ public class Page {
return false;
return true;
}
/**
* <p><b>文件名</b>Page.java</p>
* <p><b>用途</b>
* 指定页面断言的条件枚举
* </p>
* <p><b>编码时间</b>2021年2月18日下午5:25:34</p>
* <p><b>修改时间</b>2021年2月18日下午5:25:34</p>
* @author 彭宇琦
* @version Ver1.0
* @since JDK 1.8
*
*/
public enum PageAssertType {
/**
* 断言页面标题
*/
TITLE,
/**
* 断言页面html代码
*/
HTML,
/**
* 断言页面最终跳转的url
*/
URL,
/**
* 断言页面文本
*/
TEXT,
/**
* 断言页面元素
*/
ELEMENT
;
}
}

View File

@ -101,10 +101,6 @@ public class Screenshot {
* 该方法用于创建截图并保存到相应的路径下通过指定的截图文件名称和类中存储的WebDriver对象截图保存路径来创建截图
*
* @param imageName 指定的截图文件名
* @throws IOException 文件流状态不正确时抛出的异常
* @throws WebDriverException WebDriver引用错误时抛出的异常
* @throws NullPointerException WebDriver为空时抛出的异常
* @throws UndefinedDirectoryException 截图保存路径或截图名称为指定时抛出的异常
*/
public synchronized File creatImage(String imageName) {
// 调用无参方法
@ -150,7 +146,7 @@ public class Screenshot {
}
//判断是否传入文件名若未传入文件名则指定当前时间戳为文件名
File imageFile = new File(savePathFolder + Optional.ofNullable(fileName).filter(text -> !text.isEmpty())
File imageFile = new File(savePathFolder + "/" + Optional.ofNullable(fileName).filter(text -> !text.isEmpty())
.orElse(String.valueOf(Time.parse().getMilliSecond())) + ".png");
// 截图并将得到的截图转移到指定的目录下

View File

@ -14,10 +14,19 @@ import org.dom4j.io.SAXReader;
import com.auxiliary.testcase.file.IncorrectFileException;
/**
* <p><b>文件名</b>Case.java</p>
* <p><b>用途</b>定义测试用例模板类能返回的基本字段提供其相应的get与set方法但该方法不允许包外调用</p>
* <p><b>编码时间</b>2020年3月3日下午8:07:23</p>
* <p><b>修改时间</b>2020年3月4日 07:39:23</p>
* <p>
* <b>文件名</b>Case.java
* </p>
* <p>
* <b>用途</b>定义测试用例模板类能返回的基本字段提供其相应的get与set方法但该方法不允许包外调用
* </p>
* <p>
* <b>编码时间</b>2020年3月3日下午8:07:23
* </p>
* <p>
* <b>修改时间</b>2020年3月4日 07:39:23
* </p>
*
* @author 彭宇琦
* @version Ver1.0
* @since JDK 1.8
@ -36,12 +45,12 @@ public abstract class Case {
* 用于指向用例标签中的id属性
*/
public static final String ATTRIBUTE_ID = "id";
/**
* 用于标记获取标签下所有的文本
*/
protected final String ALL = "-1:getAllText";
/**
* 用于存储需要替换的词语的开始标记
*/
@ -50,29 +59,30 @@ public abstract class Case {
* 用于存储需要替换的词语的结束标记
*/
protected final String END_SIGN = "}*";
/**
* 用于存储传入到正则表达式中的开始标记
*/
protected final String START_SIGN_REGIX = "\\*\\{";
/**
* 用于指向测试用例xml文件的Document对象
*/
protected Document configXml;
protected Document configXml;
/**
* 存储xml文件中其需要替换的词语
*/
protected HashMap<String, String> wordMap = new HashMap<String, String>(16);
/**
* 存储字段的文本内容
*/
protected HashMap<String, ArrayList<String>> fieldTextMap = new HashMap<String, ArrayList<String>>(16);
/**
* 根据用例xml文件来构造Case类
*
* @param configXmlFile xml配置文件
* @throws IncorrectFileException 文件格式或路径不正确时抛出的异常
*/
@ -81,200 +91,204 @@ public abstract class Case {
try {
configXml = new SAXReader().read(configXmlFile);
} catch (DocumentException e) {
throw new IncorrectFileException("用例xml文件有误" );
throw new IncorrectFileException("用例xml文件有误");
}
//查找并存储替换的词语
// 查找并存储替换的词语
saveWord();
//保存字段的词语
// 保存字段的词语
saveField();
}
/**
* 用于设置需要替换的词语
*
* @param word 测试用例xml库中需要替换的词语
* @param text 被替换的词语
*/
public void setReplaceWord(String word, String text) {
//判断该词语是否存在于textMap中若不存在则抛出异常
// 判断该词语是否存在于textMap中若不存在则抛出异常
if (!wordMap.containsKey(word)) {
throw new IncorrectFileException("未找到需要替换的词语:" + word);
}
//存储替换的词语
// 存储替换的词语
wordMap.put(word, text);
}
/**
* 返回字段内容
*
* @return 字段内容
*/
public HashMap<String, ArrayList<String>> getFieldTextMap() {
return fieldTextMap;
}
/**
* 用于替换文本中需要替换的单词返回替换后的文本
*
* @param text 需要替换的文本
* @return 替换后的文本
*/
protected String replaceText(String text) {
StringBuilder sb = new StringBuilder(text);
//存储替换符的位置
// 存储替换符的位置
int index = 0;
//循环替换content中所有需要替换的信息
while( (index = sb.indexOf(START_SIGN)) != -1 ) {
//存储待替换的变量名
// 循环替换content中所有需要替换的信息
while ((index = sb.indexOf(START_SIGN)) != -1) {
// 存储待替换的变量名
String var = "";
try {
var = sb.substring(index + START_SIGN.length(), sb.indexOf(END_SIGN));
} catch (StringIndexOutOfBoundsException e) {
throw new CaseContentException("词语替换错误,无效的标记字符:" + text);
}
//替换该变量名
// 替换该变量名
sb.replace(index, sb.indexOf(END_SIGN) + END_SIGN.length(), wordMap.get(var));
}
return sb.toString();
}
/**
* 用于获取用例xml中对应用例的标签内的文本并返回替换词语后的文本
* @param caseName 用例名称
*
* @param caseName 用例名称
* @param labelType 标签枚举{@link LabelType}
* @param id 对应标签的id属性
* @param id 对应标签的id属性
* @return 标签中存储的文本并进行处理
*/
protected String getLabelText(String caseName, LabelType labelType, String id) {
//返回处理替换的单词后相应的文本
// 返回处理替换的单词后相应的文本
return getLabelText(caseName, labelType.getName(), id);
}
/**
* 用于获取用例xml中对应用例的标签内的文本并返回替换词语后的文本
* @param caseName 用例名称
*
* @param caseName 用例名称
* @param labelName 标签名称
* @param id 对应标签的id属性
* @param id 对应标签的id属性
* @return 标签中存储的文本并进行处理
*/
protected String getLabelText(String caseName, String labelName, String id) {
//拼接xpath规则"//case[@name='caseName']//标签名称[@id='id']"
String xpath = "//" + LabelType.CASE.getName() +
"[@" + ATTRIBUTE_NAME + "='" +
caseName + "']//" + labelName +
"[@" + ATTRIBUTE_ID + "='" + id +"']";
//获取相应的文本内容
Element textElement = (Element)(configXml.selectSingleNode(xpath));
//判断获取的内容是否为空为空则跑出异常
//判断集合是否存在元素若不存在元素则抛出异常
// 拼接xpath规则"//case[@name='caseName']//标签名称[@id='id']"
String xpath = "//" + LabelType.CASE.getName() + "[@" + ATTRIBUTE_NAME + "='" + caseName + "']//" + labelName
+ "[@" + ATTRIBUTE_ID + "='" + id + "']";
// 获取相应的文本内容
Element textElement = (Element) (configXml.selectSingleNode(xpath));
// 判断获取的内容是否为空为空则跑出异常
// 判断集合是否存在元素若不存在元素则抛出异常
if (textElement == null) {
throw new LabelNotFoundException("用例集“" + caseName + "”中不存在id为“" + id + "”的“" + labelName + "”标签");
}
//返回处理替换的单词后相应的文本
// 返回处理替换的单词后相应的文本
return replaceText(textElement.attributeValue(ATTRIBUTE_VALUE));
}
/**
* 用于获取用例xml中对应用例的标签内所有的文本并返回替换词语后的文本
* @param caseName 用例名称
*
* @param caseName 用例名称
* @param labelType 标签枚举
* @return 标签中存储的文本并进行处理
*/
@SuppressWarnings("unchecked")
protected ArrayList<String> getAllLabelText(String caseName, LabelType labelType) {
//拼接xpath规则"//case[@name='caseName']//标签名称[@id='id']"
String xpath = "//" + LabelType.CASE.getName() +
"[@" + ATTRIBUTE_NAME + "='" +
caseName + "']//" + labelType.getName();
// 拼接xpath规则"//case[@name='caseName']//标签名称[@id='id']"
String xpath = "//" + LabelType.CASE.getName() + "[@" + ATTRIBUTE_NAME + "='" + caseName + "']//"
+ labelType.getName();
//获取所有的节点
List<Element> textElements = configXml.selectNodes(xpath);
//存储节点中的value属性内的文本
ArrayList<String> texts = new ArrayList<String>();
//存储节点值
for (int i = 0; i < textElements.size(); i++) {
texts.add(replaceText(textElements.get(i).attributeValue(ATTRIBUTE_VALUE)));
}
// 存储节点中的value属性内的文本
ArrayList<String> texts = new ArrayList<String>();
// 获取所有的节点
configXml.selectNodes(xpath).stream()
.map(e -> (Element) e)
.map(e -> e.attributeValue(ATTRIBUTE_VALUE))
.map(this::replaceText)
.forEach(texts::add);;
return texts;
}
/**
* 用于获取并存储需要替换的词语
*/
@SuppressWarnings("unchecked")
private void saveWord() {
//获取xml中包含value的元素并将其中包含需要替换的词语存储至wordMap
List<Element> textElement = configXml.selectNodes("//*[@" + ATTRIBUTE_VALUE + "]");
textElement.stream().
//获取元素的value属性将其转换为文本对象
map(e -> e.attributeValue(ATTRIBUTE_VALUE)).
//筛选包含*{的文本
filter(e -> e.indexOf(START_SIGN) > -1).forEach(e -> {
//对文本按照*{切割并筛选包含}*的文本
Arrays.asList(e.split(START_SIGN_REGIX)).stream().filter(s -> s.indexOf(END_SIGN) > -1).
forEach(s -> {
//将需要存储的替换词语存入textMap中
wordMap.put(s.substring(0, s.indexOf(END_SIGN)), "");
});
});
// 获取xml中包含value的元素并将其中包含需要替换的词语存储至wordMap
configXml.selectNodes("//*[@" + ATTRIBUTE_VALUE + "]").stream().map(e -> (Element) e)
// 获取元素的value属性将其转换为文本对象
.map(e -> e.attributeValue(ATTRIBUTE_VALUE))
// 筛选包含*{的文本
.filter(e -> e.indexOf(START_SIGN) > -1).forEach(e -> {
// 对文本按照*{切割并筛选包含}*的文本
Arrays.asList(e.split(START_SIGN_REGIX)).stream().filter(s -> s.indexOf(END_SIGN) > -1)
.forEach(s -> {
// 将需要存储的替换词语存入textMap中
wordMap.put(s.substring(0, s.indexOf(END_SIGN)), "");
});
});
}
/**
* 用于保存xml文件中的字段
*/
@SuppressWarnings("unchecked")
protected void saveField() {
//获取case标签下所有的标签存储至fieldTextMap以初始化所有的字段名称
((List<Element>) (configXml.getRootElement().elements("case"))).forEach(caseElement -> {
((List<Element>) caseElement.elements()).forEach(labelElement -> {
//去掉末尾的s
// 获取case标签下所有的标签存储至fieldTextMap以初始化所有的字段名称
configXml.getRootElement().elements("case").forEach(caseElement -> {
caseElement.elements().forEach(labelElement -> {
// 去掉末尾的s
String name = labelElement.getName();
fieldTextMap.put(name.substring(0, name.length() - 1), new ArrayList<String>());
});
});
}
/**
* 用于添加一行文本
*
* @param labelType 标签名称枚举
* @param text 相应内容
* @param text 相应内容
*/
protected void addFieldText(LabelType labelType, String text) {
fieldTextMap.get(labelType.getName()).add(text);
}
/**
* 用于添加多行文本
*
* @param labelName 标签名称
* @param texts 相应内容
* @param texts 相应内容
*/
protected void addFieldText(String labelName, List<String> texts) {
fieldTextMap.get(labelName).addAll(texts);
}
/**
* 用于添加一行文本
*
* @param labelName 标签名称
* @param text 相应内容
* @param text 相应内容
*/
protected void addFieldText(String labelName, String text) {
fieldTextMap.get(labelName).add(text);
}
/**
* 用于添加多行文本
*
* @param label 标签名称枚举
* @param texts 相应内容
*/
protected void addFieldText(LabelType label, List<String> texts) {
fieldTextMap.get(label.getName()).addAll(texts);
}
/**
* 用于清空字段的内容以避免存储上一次输入的用例
*/
@ -283,29 +297,28 @@ public abstract class Case {
fieldTextMap.get(key).clear();
});
}
/**
* 由于添加与参数相关的数据时需要将关联的字段如步骤及结果都添加至其中
* 若后期关联字段增加则代码量将是成倍的增加故将关联的内容提取出来
* 外部进行添加之后修改关联字段时只需修改该方法即可若传入-1则表示
* 获取xml中该标签下的所有的信息<br>
/**
* 由于添加与参数相关的数据时需要将关联的字段如步骤及结果都添加至其中 若后期关联字段增加则代码量将是成倍的增加故将关联的内容提取出来
* 外部进行添加之后修改关联字段时只需修改该方法即可若传入-1则表示 获取xml中该标签下的所有的信息<br>
* 参数表
* <ol>
* <li>步骤</li>
* <li>预期</li>
* </ol>
*
* @param caseName 读取的用例名称
* @param ids id参数串
* @param ids id参数串
*/
protected void relevanceAddData(String caseName, String...ids) {
//添加步骤
protected void relevanceAddData(String caseName, String... ids) {
// 添加步骤
if (ids[0].equals(ALL)) {
addFieldText(LabelType.STEP, getAllLabelText(caseName, LabelType.STEP));
} else {
addFieldText(LabelType.STEP, getLabelText(caseName, LabelType.STEP, ids[0]));
}
//添加预期
// 添加预期
if (ids[1].equals(ALL)) {
addFieldText(LabelType.EXCEPT, getAllLabelText(caseName, LabelType.EXCEPT));
} else {

View File

@ -66,6 +66,10 @@ public class TableData<T> {
public TableData(Map<String, ? extends List<T>> tableMap) {
tableMap.forEach(this::addColumn);
}
public TableData(TableData<T> tableData) {
this.addTable(tableData);
}
/**
* 用于设置是否对传入的数据列表的个数进行严格校验即在调用{@link #getData(int, int, List)}等获取数据的方法时

View File

@ -465,7 +465,6 @@ public abstract class AbstractWriteExcel<T extends AbstractWriteExcel<T>> {
* @throws IOException 流异常时抛出的异常
* @throws IncorrectFileException 当模板文件内容异常时抛出的异常
*/
@SuppressWarnings("unchecked")
public void writeFile() throws IOException {
// 定义输入流用于读取模版文件
FileInputStream fip = new FileInputStream(tempFile);
@ -507,7 +506,6 @@ public abstract class AbstractWriteExcel<T extends AbstractWriteExcel<T>> {
* @param caseElement case标签对应的elemenet对象
* @return 当前行号
*/
@SuppressWarnings("unchecked")
private void writeContent(int index, XSSFSheet xs, Element caseElement) {
// 获取字段元素需要获取配置xml文件中的以及用例xml文件中的字段
List<Element> fieldElements = caseElement.elements("field");
@ -804,7 +802,6 @@ public abstract class AbstractWriteExcel<T extends AbstractWriteExcel<T>> {
*
* @param sheetName sheet的name属性
*/
@SuppressWarnings("unchecked")
private void getAllColumnId() {
// 清空fieldMap中的内容
// fieldMap.clear();
@ -1148,7 +1145,6 @@ public abstract class AbstractWriteExcel<T extends AbstractWriteExcel<T>> {
* @param content 标记中记录的内容
* @return 类本身
*/
@SuppressWarnings("unchecked")
public FieldMark fieldComment(String sheetName, String field, String content) {
// 查找nowSheetName指向的sheet中的与uuid一致的单元格
Element caseElement = getCaseElement(sheetName);
@ -1183,7 +1179,6 @@ public abstract class AbstractWriteExcel<T extends AbstractWriteExcel<T>> {
* @param markColorsType {@link MarkColorsType}类枚举
* @return 类本身
*/
@SuppressWarnings("unchecked")
public FieldMark changeFieldBackground(String sheetName, String field, MarkColorsType markColorsType) {
// 查找nowSheetName指向的sheet中的与uuid一致的单元格
Element caseElement = getCaseElement(sheetName);
@ -1216,7 +1211,6 @@ public abstract class AbstractWriteExcel<T extends AbstractWriteExcel<T>> {
* @param markColorsType {@link MarkColorsType}类枚举
* @return 类本身
*/
@SuppressWarnings("unchecked")
public FieldMark changeRowBackground(String sheetName, MarkColorsType markColorsType) {
// 查找nowSheetName指向的sheet中的与uuid一致的单元格
Element caseElement = getCaseElement(sheetName);
@ -1244,7 +1238,6 @@ public abstract class AbstractWriteExcel<T extends AbstractWriteExcel<T>> {
* @param markColorsType {@link MarkColorsType}类枚举
* @return 类本身
*/
@SuppressWarnings("unchecked")
public FieldMark changeRowTextColor(String sheetName, MarkColorsType markColorsType) {
// 查找nowSheetName指向的sheet中的与uuid一致的单元格
Element caseElement = getCaseElement(sheetName);
@ -1310,7 +1303,6 @@ public abstract class AbstractWriteExcel<T extends AbstractWriteExcel<T>> {
* @param markColorsType {@link MarkColorsType}类枚举
* @return 类本身
*/
@SuppressWarnings("unchecked")
public FieldMark changeTextColor(String sheetName, String field, int startIndex, int endIndex,
MarkColorsType markColorsType) {
// 查找nowSheetName指向的sheet中的与uuid一致的单元格

View File

@ -239,7 +239,6 @@ public class CreateExcelFile {
*
* @param xw 指向excel文件对象
*/
@SuppressWarnings("unchecked")
private void createDataValidation(XSSFWorkbook xw) {
// 读取所有sheet标签
List<Element> xmlSheetList = xml.getRootElement().elements("sheet");
@ -336,7 +335,6 @@ public class CreateExcelFile {
* @param rowIndex
* @param columnIndex
*/
@SuppressWarnings("unchecked")
private void writeDataValidity(Element datasElement, XSSFSheet dataSheet, int rowIndex, int columnIndex) {
// 添加数据获取相应datas下的所有data标签
List<Element> dataElementList = datasElement.elements();