update docs

keva-dev · Dec 23, 2021 · 65afe47 · 65afe47
1 parent 4fdb23d
commit 65afe47
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 43 deletions.
diff --git a/config/src/test/java/com/keva/config/ArgsParserTest.java b/config/src/test/java/com/keva/config/ArgsParserTest.java
@@ -1,21 +1,20 @@
 package com.keva.config;
 
+import com.keva.config.util.ArgsHolder;
 import com.keva.config.util.ArgsParser;
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNull;
 
-import lombok.var;
-
 class ArgsParserTest {
 
     @Test
     void parse() {
         String[] args = {
                 "--p", "123123", "--a", "--b"
         };
-        var parse = ArgsParser.parse(args);
+        ArgsHolder parse = ArgsParser.parse(args);
         assertEquals("true", parse.getFlag("a"));
         assertEquals("true", parse.getFlag("b"));
         assertEquals("123123", parse.getArgVal("p"));

diff --git a/core/src/test/java/dev/keva/core/server/AbstractServerTest.java b/core/src/test/java/dev/keva/core/server/AbstractServerTest.java
@@ -14,7 +14,6 @@
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.ExecutionException;
 
-import lombok.var;
 import redis.clients.jedis.params.ZAddParams;
 
 import static org.junit.jupiter.api.Assertions.*;
@@ -96,7 +95,7 @@ void getSetEmptyString() {
     @Test
     void del() {
         try {
-            var setAbc = jedis.set("abc", "123");
+            String setAbc = jedis.set("abc", "123");
             val getAbc = jedis.get("abc");
             val delAbc = jedis.del("abc");
             val getAbcNull = jedis.get("abc");
@@ -187,7 +186,7 @@ void transactionWatch() {
     void getSetExpire() {
         try {
             val setAbc = jedis.set("abc", "123");
-            var getAbc = jedis.get("abc");
+            String getAbc = jedis.get("abc");
             val expireAbc = jedis.expire("abc", 1L);
 
             assertEquals("OK", setAbc);
@@ -208,8 +207,8 @@ void getSetExpire() {
     void updateExpire() {
         try {
             val setAbc = jedis.set("abc", "123");
-            var getAbc = jedis.get("abc");
-            var expireAbc = jedis.expire("abc", 1L);
+            String getAbc = jedis.get("abc");
+            Long expireAbc = jedis.expire("abc", 1L);
 
             assertEquals("OK", setAbc);
             assertEquals("123", getAbc);
@@ -237,7 +236,7 @@ void updateExpire() {
     void getSetExpireAt() {
         try {
             val setAbc = jedis.set("abc", "123");
-            var getAbc = jedis.get("abc");
+            String getAbc = jedis.get("abc");
             val oneSecondLaterTime = System.currentTimeMillis() + 1000;
             val expireAbc = jedis.expireAt("abc", oneSecondLaterTime);
 
@@ -258,8 +257,8 @@ void getSetExpireAt() {
     @Test
     void setAfterExpireAt() {
         try {
-            var setAbc = jedis.set("abc", "123");
-            var getAbc = jedis.get("abc");
+            String setAbc = jedis.set("abc", "123");
+            String getAbc = jedis.get("abc");
             val oneSecondLaterTime = System.currentTimeMillis() + 1000;
             val expireAbc = jedis.expireAt("abc", oneSecondLaterTime);
 
@@ -313,19 +312,17 @@ void getSetLongKeyString() {
     @Timeout(30)
     void pubsub() throws ExecutionException, InterruptedException {
         CompletableFuture<String> future = new CompletableFuture<>();
-        new Thread(() -> {
-            subscriber.subscribe(new JedisPubSub() {
-                @Override
-                public void onMessage(String channel, String message) {
-                    future.complete(message);
-                }
-
-                @Override
-                public void onSubscribe(String channel, int subscribedChannels) {
-                    jedis.publish("test", "Test message");
-                }
-            }, "test");
-        }).start();
+        new Thread(() -> subscriber.subscribe(new JedisPubSub() {
+            @Override
+            public void onMessage(String channel, String message) {
+                future.complete(message);
+            }
+
+            @Override
+            public void onSubscribe(String channel, int subscribedChannels) {
+                jedis.publish("test", "Test message");
+            }
+        }, "test")).start();
         val message = future.get();
         assertEquals("Test message", message);
     }
@@ -832,36 +829,32 @@ void setrange() {
 
     @Test
     void zaddWithXXAndNXErrs() {
-        assertThrows(JedisDataException.class, () -> {
-            jedis.zadd("zset", 1.0, "val", new ZAddParams().xx().nx());
-        });
+        assertThrows(JedisDataException.class, () ->
+                jedis.zadd("zset", 1.0, "val", new ZAddParams().xx().nx()));
     }
 
     @Test
     void zaddSingleWithNxAndGtErrs() {
-        assertThrows(JedisDataException.class, () -> {
-            jedis.zadd("zset", 1.0, "val", new ZAddParams().gt().nx());
-        });
+        assertThrows(JedisDataException.class, () ->
+                jedis.zadd("zset", 1.0, "val", new ZAddParams().gt().nx()));
     }
 
     @Test
     void zaddSingleWithNxAndLtErrs() {
-        assertThrows(JedisDataException.class, () -> {
-            jedis.zadd("zset", 1.0, "val", new ZAddParams().lt().nx());
-        });
+        assertThrows(JedisDataException.class, () ->
+                jedis.zadd("zset", 1.0, "val", new ZAddParams().lt().nx()));
     }
 
     @Test
     void zaddSingleWithGtAndLtErrs() {
-        assertThrows(JedisDataException.class, () -> {
-            jedis.zadd("zset", 1.0, "val", new ZAddParams().lt().gt());
-        });
+        assertThrows(JedisDataException.class, () ->
+                jedis.zadd("zset", 1.0, "val", new ZAddParams().lt().gt()));
     }
 
     @Test
     void zaddSingleWithoutOptions() {
         try {
-            var result = jedis.zadd("zset", 1.0, "val");
+            Long result = jedis.zadd("zset", 1.0, "val");
             assertEquals(1, result);
 
             result = jedis.zadd("zset", 1.0, "val");
@@ -879,7 +872,7 @@ void zaddMultipleWithoutOptions() {
             for(int i=0; i<numMembers; ++i) {
                 members.put(Integer.toString(i), (double) i);
             }
-            var result = jedis.zadd("zset", members);
+            Long result = jedis.zadd("zset", members);
             assertEquals(numMembers, result);
 
             result = jedis.zadd("zset", members);
@@ -892,7 +885,7 @@ void zaddMultipleWithoutOptions() {
     @Test
     void zaddCh() {
         try {
-            var result = jedis.zadd("zset", 1.0, "mem", new ZAddParams().ch());
+            Long result = jedis.zadd("zset", 1.0, "mem", new ZAddParams().ch());
             assertEquals(1, result);
 
             result = jedis.zadd("zset", 1.0, "mem", new ZAddParams().ch());

diff --git a/docs/src/.vuepress/config.js b/docs/src/.vuepress/config.js
@@ -82,7 +82,8 @@ module.exports = {
           collapsable: false,
           children: [
             'insight/design',
-            'insight/benchmark'
+            'insight/benchmark',
+            'insight/release-notes',
           ]
         },
         'roadmap',

diff --git a/docs/src/guide/developer-guide.md b/docs/src/guide/developer-guide.md
@@ -231,3 +231,13 @@ public void a() { ... }
                         // <-- Remove this extra line.
 public void b() { ... }
 ```
+
+## Git flow
+
+Follow the [Git flow](https://git-scm.com/book/en/v2/Git-Branching-and-Merging)
+
+For feature PR (to develop) use squash merge, for release PR (to master) use rebase merge,
+commit message merged to master/develop branch should be lowercase first word
+(e.g. "fix: some bug").
+
+All pull requests must be passed to the code review and passed all the tests.
diff --git a/docs/src/guide/insight/release-notes.md b/docs/src/guide/insight/release-notes.md
@@ -0,0 +1,3 @@
+# Release Notes
+
+Visit [Release](https://github.com/keva-dev/keva/releases)
diff --git a/docs/src/guide/roadmap.md b/docs/src/guide/roadmap.md
@@ -8,14 +8,13 @@
 
 ## Todo-list
 
-- Implement various Redis commands
-- Implement RDB, AOF persistence mode
+- Implement various Redis commands :heavy_check_mark:
+- Implement RDB, AOF persistence mode :heavy_check_mark:
 - Implement Pub/Sub :heavy_check_mark:
 - Implement Transactions :heavy_check_mark:
 - Implement Replication ([@axblueblader](https://github.com/axblueblader))
 - Implement Keva Proxy ([@haphananhtuan](https://github.com/haphananhtuan))
 - Implement Keva Sentinel ([@duongcongtoai](https://github.com/duongcongtoai))
 - Implement Keva SQL (TBD)
 - Implement Keva security
-- Publish dedicated Maven package for `protocol` and `config`
 - Create automation for release workflow