release branch 2.0.5

Author: binbin.hou

CHANGELOG.md

@@ -65,3 +65,9 @@ add junit test
 |:---|:---|:---|:---|:--|:---|
 | 1 | U | 移除对于 log-integration 的依赖 | | 2020-6-15 20:10:40 | |
 | 2 | O | 文档优化 | | 2020-6-15 20:10:40 | |
+
+# release_2.0.5
+
+| 序号 | 变更类型 | 具体 | 说明 | 时间 | 备注 |
+|:---|:---|:---|:---|:--|:---|
+| 1 | F | 新增内存消耗特性 | | 2020-6-16 13:53:54 | |

README-EN.md

@@ -29,11 +29,9 @@
 
 [CHANGELOG](CHANGELOG.md)
 
-### v2.0.4 major change
+### v2.0.5 major change
 
-1. remove log-integration dependency
-
-2. doc optimize
+1. new feature for memory cost
 
 # Quick Start
 
@@ -49,7 +47,7 @@
 <dependency>
     <groupId>com.github.houbb</groupId>
     <artifactId>junitperf</artifactId>
-    <version>2.0.4</version>
+    <version>2.0.5</version>
 </dependency>
 ```
 
@@ -84,7 +82,7 @@ config for test
 | threads | How many threads are used to execute | int | 1 | |
 | warmUp | Preparation time | long | 0 | Unit：mills |
 | duration | Execution time | long | 60_000(1 min) | Unit：mills |
-| statistics | Statistics impl | StatisticsCalculator | DefaultStatisticsCalculator |  |
+| latencyStatistics | Statistics impl | StatisticsCalculator | DefaultStatisticsCalculator |  |
 | reporter | Reporter impl | Reporter | ConsoleReporter |  |
 
 as following：
@@ -109,7 +107,7 @@ public class JunitPerfConfigTest {
 
 ### Reporter types
 
-This is mainly the **output method** for performance test statistics.
+This is mainly the **output method** for performance test latencyStatistics.
 
 The following methods are supported:
 
@@ -190,4 +188,4 @@ Later, style adjustments will be made.
 
 # Road-MAP
 
-- [ ] Memory usage statistics
+- [ ] Memory usage latencyStatistics

README.md

@@ -29,11 +29,9 @@
 
 [变更日志](CHANGELOG.md)
 
-### v2.0.4 主要变更
+### v2.0.5 主要变更
 
-1. 移除对于 log-integration 的依赖
-
-2. 文档优化
+1. 新增内存消耗特性
 
 # 快速开始
 
@@ -49,7 +47,7 @@
 <dependency>
     <groupId>com.github.houbb</groupId>
     <artifactId>junitperf</artifactId>
-    <version>2.0.4</version>
+    <version>2.0.5</version>
 </dependency>
 ```
 
@@ -84,7 +82,7 @@ public class HelloWorldTest {
 | threads | 执行时使用多少线程执行 | int | 1 | |
 | warmUp | 准备时间 | long | 0 | 单位：毫秒 |
 | duration | 执行时间 | long | 60_000(1分钟) | 单位：毫秒 |
-| statistics | 统计实现 | StatisticsCalculator | DefaultStatisticsCalculator |  |
+| latencyStatistics | 统计实现 | StatisticsCalculator | DefaultStatisticsCalculator |  |
 | reporter | 报告实现 | Reporter | ConsoleReporter |  |
 
 使用如下：
@@ -171,6 +169,7 @@ public class JunitPerfRequireTest {
 [INFO] 2018-01-14 22:16:31.424 [] - Min latency:   200.2112ms (Required: -1.0ms) - PASSED
 [INFO] 2018-01-14 22:16:31.424 [] - Max latency:    205.67862ms (Required: -1.0ms) - PASSED
 [INFO] 2018-01-14 22:16:31.425 [] - Ave latency:    202.97829ms (Required: -1.0ms) - PASSED
+[INFO] 2018-01-14 22:16:31.425 [] - Memory cost:   16byte
 ```
 
 ### HTML 方式
@@ -219,5 +218,6 @@ idea 用户请勾选上图中的选项
 
 # 后期 Road-MAP
 
-- [ ] 内存使用统计
+- [ x ] 内存使用统计
 
+- [ ] 支持线程的 sync 同步执行

pom.xml

@@ -4,7 +4,7 @@
 
     <groupId>com.github.houbb</groupId>
     <artifactId>junitperf</artifactId>
-    <version>2.0.5-SNAPSHOT</version>
+    <version>2.0.5</version>
 
     <properties>
         <!--============================== All Plugins START ==============================-->
@@ -35,6 +35,7 @@
         <junit.version>5.2.0</junit.version>
         <freemarker.version>2.3.23</freemarker.version>
         <google.guava.version>21.0</google.guava.version>
+        <lucene-core.version>4.0.0</lucene-core.version>
 
         <!--sonar-->
         <sonar.java.binaries>target/classes</sonar.java.binaries>
@@ -76,6 +77,12 @@
                 <version>${junit.version}</version>
             </dependency>
 
+            <dependency>
+                <groupId>org.apache.lucene</groupId>
+                <artifactId>lucene-core</artifactId>
+                <version>${lucene-core.version}</version>
+            </dependency>
+
         </dependencies>
     </dependencyManagement>
 
@@ -108,6 +115,11 @@
             <artifactId>junit-jupiter-engine</artifactId>
         </dependency>
 
+        <dependency>
+            <groupId>org.apache.lucene</groupId>
+            <artifactId>lucene-core</artifactId>
+        </dependency>
+
     </dependencies>
 
     <build>

release.bat

@@ -10,9 +10,9 @@ ECHO "============================= RELEASE START..."
 
 :: 版本号信息(需要手动指定)
 :::: 旧版本名称
-SET version=2.0.4
+SET version=2.0.5
 :::: 新版本名称
-SET newVersion=2.0.5
+SET newVersion=2.0.6
 :::: 组织名称
 SET groupName=com.github.houbb
 :::: 项目名称

src/main/java/com/github/houbb/junitperf/core/annotation/JunitPerfConfig.java

@@ -6,19 +6,11 @@
 import com.github.houbb.junitperf.core.report.impl.ConsoleReporter;
 import com.github.houbb.junitperf.core.statistics.StatisticsCalculator;
 import com.github.houbb.junitperf.core.statistics.impl.DefaultStatisticsCalculator;
-
 import org.apiguardian.api.API;
-import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.TestTemplate;
 import org.junit.jupiter.api.extension.ExtendWith;
-import org.junit.platform.commons.annotation.Testable;
 
-import java.lang.annotation.Documented;
-import java.lang.annotation.ElementType;
-import java.lang.annotation.Retention;
-import java.lang.annotation.RetentionPolicy;
-import java.lang.annotation.Target;
-import java.util.Set;
+import java.lang.annotation.*;
 
 /**
  * 执行接口
@@ -38,12 +30,14 @@
     /**
      * 执行时使用多少线程执行
      * @return int val
+     * @since 1.0.0
      */
     int threads() default 1;
 
     /**
      * 准备时间（单位：毫秒）
      * @return time in mills
+     * @since 1.0.0
      */
     long warmUp() default 0L;
 
@@ -52,18 +46,21 @@
      * 默认值：默认为 1min
      * 这里的执行时间不包含准备时间。
      * @return time in mills
+     * @since 1.0.0
      */
     long duration() default 60_000L;
 
     /**
      * 存放统计信息工具
      * @return 统计实现类
+     * @since 1.0.0
      */
     Class<? extends StatisticsCalculator> statistics() default DefaultStatisticsCalculator.class;
 
     /**
      * 存放报告信息类
      * @return 报告信息
+     * @since 1.0.0
      */
     Class<? extends Reporter>[] reporter() default {ConsoleReporter.class};
 

src/main/java/com/github/houbb/junitperf/core/report/impl/ConsoleReporter.java

@@ -57,11 +57,13 @@ public void report(Class testClass, Set<EvaluationContext> evaluationContextSet)
                     statistics.getMaxLatency(MILLISECONDS),
                     evaluationRequire.getRequireMax(),
                     getStatus(evaluationResult.isMaxAchieved()));
-            ConsoleUtil.info("Ave latency:    {}ms (Required: {}ms) - {}",
+            ConsoleUtil.info("Avg latency:    {}ms (Required: {}ms) - {}",
                     statistics.getMeanLatency(MILLISECONDS),
                     evaluationRequire.getRequireAverage(),
                     getStatus(evaluationResult.isAverageAchieved()));
 
+            // 输出内存信息
+            reportMemory(statistics);
 
             for (Map.Entry<Integer, Float> entry : evaluationRequire.getRequirePercentilesMap().entrySet()) {
                 Integer percentile = entry.getKey();
@@ -78,6 +80,15 @@ public void report(Class testClass, Set<EvaluationContext> evaluationContextSet)
         }
     }
 
+    /**
+     * 输出内存消耗信息
+     * @param statistics 统计信息
+     * @since 2.0.5
+     */
+    private void reportMemory(final StatisticsCalculator statistics) {
+        // 内存
+        ConsoleUtil.info("Memory cost:   {}byte", statistics.getMemory());
+    }
 
     /**
      * 获取状态

src/main/java/com/github/houbb/junitperf/core/statistics/StatisticsCalculator.java

@@ -78,4 +78,18 @@ public interface StatisticsCalculator extends Serializable {
      */
     float getMeanLatency(TimeUnit unit);
 
+    /**
+     * 添加内存
+     * @param memoryKb 内存消耗
+     * @since 2.0.5
+     */
+    void setMemory(final long memoryKb);
+
+    /**
+     * 获取内存的消耗
+     * @return 内存消耗
+     * @since 2.0.5
+     */
+    long getMemory();
+
 }

src/main/java/com/github/houbb/junitperf/core/statistics/impl/DefaultStatisticsCalculator.java

@@ -22,9 +22,10 @@ public class DefaultStatisticsCalculator implements StatisticsCalculator {
 
     //region private fields
     /**
-     * 统计方式
+     * 耗时统计方式
+     * @since 1.0.0
      */
-    private final DescriptiveStatistics statistics;
+    private final DescriptiveStatistics latencyStatistics;
 
     /**
      * 执行评价计数
@@ -35,22 +36,38 @@ public class DefaultStatisticsCalculator implements StatisticsCalculator {
      * 错误计数
      */
     private final AtomicLong errorCount = new AtomicLong();
+
+    /**
+     * 内存消耗
+     * @since 2.0.5
+     */
+    private volatile long memoryKb;
+
     //endregion
 
     //region constructor
+    /**
+     * 默认构造器
+     * @since 2.0.5
+     */
     public DefaultStatisticsCalculator() {
         this(new SynchronizedDescriptiveStatistics());
     }
 
-    public DefaultStatisticsCalculator(DescriptiveStatistics statistics) {
-        this.statistics = statistics;
+    /**
+     * 私有构造器
+     * @param latencyStatistics 延迟统计
+     * @since 1.0.0
+     */
+    private DefaultStatisticsCalculator(final DescriptiveStatistics latencyStatistics) {
+        this.latencyStatistics = latencyStatistics;
     }
     //endregion
 
     //region methods
     @Override
     public void addLatencyMeasurement(long executionTimeNs) {
-        statistics.addValue(executionTimeNs);
+        latencyStatistics.addValue(executionTimeNs);
     }
 
     @Override
@@ -80,22 +97,32 @@ public long getEvaluationCount() {
 
     @Override
     public float getLatencyPercentile(int percentile, TimeUnit unit) {
-        return (float)statistics.getPercentile((double)(percentile)) / unit.toNanos(1);
+        return (float) latencyStatistics.getPercentile((double)(percentile)) / unit.toNanos(1);
     }
 
     @Override
     public float getMaxLatency(TimeUnit unit) {
-        return (float)statistics.getMax() / unit.toNanos(1);
+        return (float) latencyStatistics.getMax() / unit.toNanos(1);
     }
 
     @Override
     public float getMinLatency(TimeUnit unit) {
-        return (float)statistics.getMin() / unit.toNanos(1);
+        return (float) latencyStatistics.getMin() / unit.toNanos(1);
     }
 
     @Override
     public float getMeanLatency(TimeUnit unit) {
-        return (float)statistics.getMean() / unit.toNanos(1);
+        return (float) latencyStatistics.getMean() / unit.toNanos(1);
+    }
+
+    @Override
+    public void setMemory(long memoryKb) {
+        this.memoryKb = memoryKb;
+    }
+
+    @Override
+    public long getMemory() {
+        return this.memoryKb;
     }
     //endregion
 

src/main/java/com/github/houbb/junitperf/model/vo/I18nVo.java

@@ -34,6 +34,12 @@ public class I18nVo {
     private String max_latency;
     private String avg_latency;
 
+    /**
+     * 内存消耗
+     * @since 2.0.5
+     */
+    private String memory;
+
     public String getJunit_performance_report() {
         return junit_performance_report;
     }
@@ -161,4 +167,12 @@ public String getRequired() {
     public void setRequired(String required) {
         this.required = required;
     }
+
+    public String getMemory() {
+        return memory;
+    }
+
+    public void setMemory(String memory) {
+        this.memory = memory;
+    }
 }