This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository
https://gitbox.apache.org/repos/asf/incubator-dolphinscheduler-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 748c456 Automated deployment: Wed Aug 19 07:16:18 UTC 2020
45569da708e965e93094fd2697c0d7bd1a61a5d2
748c456 is described below
commit 748c4567d9702294658b18f6e65818099b888ab1
Author: dailidong <[email protected]>
AuthorDate: Wed Aug 19 07:16:18 2020 +0000
Automated deployment: Wed Aug 19 07:16:18 UTC 2020
45569da708e965e93094fd2697c0d7bd1a61a5d2
---
zh-cn/docs/development/unit-test.html | 56 ++++++++++++++++++++++++++++++++++-
zh-cn/docs/development/unit-test.json | 2 +-
2 files changed, 56 insertions(+), 2 deletions(-)
diff --git a/zh-cn/docs/development/unit-test.html
b/zh-cn/docs/development/unit-test.html
index e8f6447..4b3dfa2 100644
--- a/zh-cn/docs/development/unit-test.html
+++ b/zh-cn/docs/development/unit-test.html
@@ -13,7 +13,7 @@
</head>
<body>
<div id="root"><div class="documentation-page"
data-reactroot=""><header class="header-container header-container-normal"><div
class="header-body"><a href="/zh-cn/index.html"><img class="logo"
src="/img/hlogo_colorful.svg"/></a><div class="search search-normal"><span
class="icon-search"></span></div><span class="language-switch
language-switch-normal">En</span><div class="header-menu"><img
class="header-menu-toggle" src="/img/system/menu_gray.png"/><div><ul
class="ant-menu blackClass an [...]
-<p>Unit Test编写参考<a
href="https://github.com/apache/incubator-dolphinscheduler/blob/dev/escheduler-common/src/test/java/cn/escheduler/common/utils/CollectionUtilsTest.java";>链接</a></p>
+<p>Unit Test 编写参考<a
href="https://github.com/apache/incubator-dolphinscheduler/blob/dev/dolphinscheduler-common/src/test/java/org/apache/dolphinscheduler/common/utils/CollectionUtilsTest.java";>链接</a></p>
<h3>1.写单元测试的收益</h3>
<ul>
<li>单元测试能帮助每个人深入代码细节，了解代码的功能。</li>
@@ -34,6 +34,60 @@
<li>在现阶段，Delta更改代码的测试覆盖设定值为：>＝60%，越高越好。</li>
<li>我们可以在这个页面中看到测试报告: <a
href="https://codecov.io/gh/apache/dolphinscheduler";>https://codecov.io/gh/apache/dolphinscheduler</a></li>
</ul>
+<h2>单元测试基本准则</h2>
+<h3>1： 隔离性与单一性</h3>
+<p>一个测试用例应该精确到方法级别，并应该能够单独执行该测试用例。同时关注点也始终在该方法上（只测试该方法）。</p>
+<p>如果方法过于复杂，开发阶段就应该将其再次进行拆分，对于测试用例来讲，最佳做法是一个用例只关注一个分支（判断）。当对其进行修改后，也仅仅影响一个测试用例的成功与否。这会极大方便我们在开发阶段验证问题和解决问题，但与此同时，也对我们覆盖率提出了极大的挑战。</p>
+<h3>2：自动性</h3>
+<p>单元测试能够自动化进行。强制要求：所有的单元测试必须写在 src/test 下，同时方法命名应该符合规范。基准测试除外。</p>
+<h3>3：可重复性</h3>
+<p>多次执行（任何环境任何时间）结果唯一，且可以重复执行。</p>
+<h3>4：轻量型</h3>
+<p>即任何环境都可快速执行。</p>
+<p>这要求我们尽可能不要依赖太多组件，如各种 spring bean 之类的。在单元测试中，这些都是可被 mock
的，增加这些，会加大我们单测的执行速度，同时也可能会传递污染。</p>
+<p>对于一些数据库、其他外部组件等。尽可能也采用模拟客户端的形式，即不依赖于外部环境，（任何外部依赖的存在都会极大的限制测试用例的可迁移性和稳定性以及结果正确性），这同时也方便开发者在任何环境都能够进行测试。</p>
+<h3>5： 可测性</h3>
+<p>这么多年过去了，你所看到的 mockito 已经成长为 mock 界的 NO.1 了，但他依然不支持 mock
静态方法、构造方法等。甚至官网上一直写着： "Don’t mock everything" 。因此尽量少用静态方法。</p>
+<p>一般建议只在一些工具类提供静态方法，这种情况下也不需要
mock，直接使用真实类即可。如果被依赖类不是工具类，可以将静态方法重构为实例方法。这样更加符合面向对象的设计理念。</p>
+<h3>6： 完备性</h3>
+<p>测试覆盖率，这是个非常费劲的问题，对于核心流程，我们是希望能够达到 90% 的覆盖率，非核心流程要求 60% 以上。</p>
+<p>覆盖率足够高的情况下会减少足够多的bug出现的概率，同时也减少了我们回归测试的成本。这是一个长久的工作，每当开发者新增或者修改代码的时候，相关测试用例与此同时也需要完善。这一点，希望开发者以及相关代码reviewer都能足够重视。</p>
+<h3>7：拒绝无效断言</h3>
+<p>无效断言让测试本身变得毫无意义，它和你的代码正确与否几乎没什么关系，且有可能会给你造成一种成功的假象，这种假象有可能持续到你的代码部署到生产环境。</p>
+<p>关于无效的断言这么几种类型</p>
+<p>1:不同类型的比较。</p>
+<p>2:判断一个具有默认值的对象或者变量不为空。</p>
+<p>这本身显得毫无意义，因此，在进行相关判断的时候应该关注一下其本身是否含有默认值。</p>
+<p>3:断言尽可能采用肯定断言而非否定断言，断言尽可能在一个预知结果范围内,或者是准确的数值，（否则有可能会导致一些不符合你的实际预期但是通过了断言）除非你的代码只关心他是否为空。</p>
+<h3>8:一些单测的注意点</h3>
+<p>1:Thread.sleep()</p>
+<p>测试代码中尽量不要使用 Thread.sleep，这让测试变得不稳定，可能会因为环境或者负载而意外导致失败。建议采用以下方式：</p>
+<p>Awaitility.await().atMost(…)</p>
+<p>2:忽略某些测试类</p>
+<p>@Ignore 注解应该附上相关 issue 地址，方便后续开发者追踪了解该测试被忽略的历史原因。</p>
+<p>如 @Ignore("see #1")</p>
+<p>3: try-catch单元测试异常</p>
+<p>当单元测试中的代码引发异常的时候，测试将失败,因此，不需要使用 try-catch 捕获异常。</p>
+<pre><code>@Test
+public void testMethod() {
+ try {
+ // Some code
+ } catch (MyException e) {
+ Assert.fail(e.getMessage()); // Noncompliant
+ }
+}
+</code></pre>
+<p>你应该这样做：</p>
+<pre><code>@Test
+public void testMethod() throws MyException {
+ // Some code
+}
+</code></pre>
+<p>4:测试异常情况</p>
+<p>当你需要进行异常情况测试时，应该避免在测试代码中包含多个方法的调用（尤其是有多个可以引发相同异常的方法），同时应该明确说明你要测试什么。</p>
+<p>5:拒绝使用 MockitoJUnitRunner.Silent.class</p>
+<p>当单测出现UnnecessaryStubbingException时，请不要第一时间考虑使用
@RunWith(MockitoJUnitRunner.Silent.class) 来解决它，这只是隐藏了问题，
+你应该根据异常提示解决相关问题，这并不是一个困难的工作。当完成更改时，你会发现，你的代码又简洁了许多。</p>
</div></section><footer class="footer-container"><div class="footer-body"><img
src="/img/ds_gray.svg"/><div class="cols-container"><div class="col
col-12"><h3>Disclaimer</h3><p>Apache DolphinScheduler (incubating) is an effort
undergoing incubation at The Apache Software Foundation (ASF), sponsored by
Incubator.
Incubation is required of all newly accepted projects until a further review
indicates
that the infrastructure, communications, and decision making process have
stabilized in a manner consistent with other successful ASF projects.
diff --git a/zh-cn/docs/development/unit-test.json
b/zh-cn/docs/development/unit-test.json
index d0dc567..be64bec 100644
--- a/zh-cn/docs/development/unit-test.json
+++ b/zh-cn/docs/development/unit-test.json
@@ -1,6 +1,6 @@
{
"filename": "unit-test.md",
- "__html": "<h2>Unit Test覆盖率</h2>\n<p>Unit Test编写参考<a
href=\"https://github.com/apache/incubator-dolphinscheduler/blob/dev/escheduler-common/src/test/java/cn/escheduler/common/utils/CollectionUtilsTest.java\";>链接</a></p>\n<h3>1.写单元测试的收益</h3>\n<ul>\n<li>单元测试能帮助每个人深入代码细节，了解代码的功能。</li>\n<li>通过测试用例我们能发现bug，并提交代码的健壮性。</li>\n<li>测试用例同时也是代码的demo用法。</li>\n</ul>\n<h3>2.单元测试用例的一些设计原则</h3>\n<ul>\n<li>应该精心设计好步骤，颗粒度和组合条件。</li>\n<li>注意边界条件。</li>\n<li>单元测试也应该好好设计，不要写无用的代码。</li>\n<li>当你发现一个<code>方法</cod
[...]
+ "__html": "<h2>Unit Test覆盖率</h2>\n<p>Unit Test 编写参考<a
href=\"https://github.com/apache/incubator-dolphinscheduler/blob/dev/dolphinscheduler-common/src/test/java/org/apache/dolphinscheduler/common/utils/CollectionUtilsTest.java\";>链接</a></p>\n<h3>1.写单元测试的收益</h3>\n<ul>\n<li>单元测试能帮助每个人深入代码细节，了解代码的功能。</li>\n<li>通过测试用例我们能发现bug，并提交代码的健壮性。</li>\n<li>测试用例同时也是代码的demo用法。</li>\n</ul>\n<h3>2.单元测试用例的一些设计原则</h3>\n<ul>\n<li>应该精心设计好步骤，颗粒度和组合条件。</li>\n<li>注意边界条件。</li>\n<li>单元测试也应该好好设计，不要写无用的代码。</li>\n<l
[...]
"link": "/zh-cn/docs/development/unit-test.html",
"meta": {}
}
\ No newline at end of file
