Skip to content

Commit 65afe47

Browse files
tuhuynh27tuhuynh27
committed
update docs
1 parent 4fdb23d commit 65afe47

File tree

6 files changed

+48
-43
lines changed

6 files changed

+48
-43
lines changed

‎config/src/test/java/com/keva/config/ArgsParserTest.java‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,20 @@
11
package com.keva.config;
22

3+
import com.keva.config.util.ArgsHolder;
34
import com.keva.config.util.ArgsParser;
45
import org.junit.jupiter.api.Test;
56

67
import static org.junit.jupiter.api.Assertions.assertEquals;
78
import static org.junit.jupiter.api.Assertions.assertNull;
89

9-
import lombok.var;
10-
1110
class ArgsParserTest {
1211

1312
@Test
1413
void parse() {
1514
String[] args = {
1615
"--p", "123123", "--a", "--b"
1716
};
18-
var parse = ArgsParser.parse(args);
17+
ArgsHolder parse = ArgsParser.parse(args);
1918
assertEquals("true", parse.getFlag("a"));
2019
assertEquals("true", parse.getFlag("b"));
2120
assertEquals("123123", parse.getArgVal("p"));

‎core/src/test/java/dev/keva/core/server/AbstractServerTest.java‎

Lines changed: 29 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
import java.util.concurrent.CompletableFuture;
1515
import java.util.concurrent.ExecutionException;
1616

17-
import lombok.var;
1817
import redis.clients.jedis.params.ZAddParams;
1918

2019
import static org.junit.jupiter.api.Assertions.*;
@@ -96,7 +95,7 @@ void getSetEmptyString() {
9695
@Test
9796
void del() {
9897
try {
99-
var setAbc = jedis.set("abc", "123");
98+
String setAbc = jedis.set("abc", "123");
10099
val getAbc = jedis.get("abc");
101100
val delAbc = jedis.del("abc");
102101
val getAbcNull = jedis.get("abc");
@@ -187,7 +186,7 @@ void transactionWatch() {
187186
void getSetExpire() {
188187
try {
189188
val setAbc = jedis.set("abc", "123");
190-
var getAbc = jedis.get("abc");
189+
String getAbc = jedis.get("abc");
191190
val expireAbc = jedis.expire("abc", 1L);
192191

193192
assertEquals("OK", setAbc);
@@ -208,8 +207,8 @@ void getSetExpire() {
208207
void updateExpire() {
209208
try {
210209
val setAbc = jedis.set("abc", "123");
211-
var getAbc = jedis.get("abc");
212-
var expireAbc = jedis.expire("abc", 1L);
210+
String getAbc = jedis.get("abc");
211+
Long expireAbc = jedis.expire("abc", 1L);
213212

214213
assertEquals("OK", setAbc);
215214
assertEquals("123", getAbc);
@@ -237,7 +236,7 @@ void updateExpire() {
237236
void getSetExpireAt() {
238237
try {
239238
val setAbc = jedis.set("abc", "123");
240-
var getAbc = jedis.get("abc");
239+
String getAbc = jedis.get("abc");
241240
val oneSecondLaterTime = System.currentTimeMillis() + 1000;
242241
val expireAbc = jedis.expireAt("abc", oneSecondLaterTime);
243242

@@ -258,8 +257,8 @@ void getSetExpireAt() {
258257
@Test
259258
void setAfterExpireAt() {
260259
try {
261-
var setAbc = jedis.set("abc", "123");
262-
var getAbc = jedis.get("abc");
260+
String setAbc = jedis.set("abc", "123");
261+
String getAbc = jedis.get("abc");
263262
val oneSecondLaterTime = System.currentTimeMillis() + 1000;
264263
val expireAbc = jedis.expireAt("abc", oneSecondLaterTime);
265264

@@ -313,19 +312,17 @@ void getSetLongKeyString() {
313312
@Timeout(30)
314313
void pubsub() throws ExecutionException, InterruptedException {
315314
CompletableFuture<String> future = new CompletableFuture<>();
316-
new Thread(() -> {
317-
subscriber.subscribe(new JedisPubSub() {
318-
@Override
319-
public void onMessage(String channel, String message) {
320-
future.complete(message);
321-
}
322-
323-
@Override
324-
public void onSubscribe(String channel, int subscribedChannels) {
325-
jedis.publish("test", "Test message");
326-
}
327-
}, "test");
328-
}).start();
315+
new Thread(() -> subscriber.subscribe(new JedisPubSub() {
316+
@Override
317+
public void onMessage(String channel, String message) {
318+
future.complete(message);
319+
}
320+
321+
@Override
322+
public void onSubscribe(String channel, int subscribedChannels) {
323+
jedis.publish("test", "Test message");
324+
}
325+
}, "test")).start();
329326
val message = future.get();
330327
assertEquals("Test message", message);
331328
}
@@ -832,36 +829,32 @@ void setrange() {
832829

833830
@Test
834831
void zaddWithXXAndNXErrs() {
835-
assertThrows(JedisDataException.class, () -> {
836-
jedis.zadd("zset", 1.0, "val", new ZAddParams().xx().nx());
837-
});
832+
assertThrows(JedisDataException.class, () ->
833+
jedis.zadd("zset", 1.0, "val", new ZAddParams().xx().nx()));
838834
}
839835

840836
@Test
841837
void zaddSingleWithNxAndGtErrs() {
842-
assertThrows(JedisDataException.class, () -> {
843-
jedis.zadd("zset", 1.0, "val", new ZAddParams().gt().nx());
844-
});
838+
assertThrows(JedisDataException.class, () ->
839+
jedis.zadd("zset", 1.0, "val", new ZAddParams().gt().nx()));
845840
}
846841

847842
@Test
848843
void zaddSingleWithNxAndLtErrs() {
849-
assertThrows(JedisDataException.class, () -> {
850-
jedis.zadd("zset", 1.0, "val", new ZAddParams().lt().nx());
851-
});
844+
assertThrows(JedisDataException.class, () ->
845+
jedis.zadd("zset", 1.0, "val", new ZAddParams().lt().nx()));
852846
}
853847

854848
@Test
855849
void zaddSingleWithGtAndLtErrs() {
856-
assertThrows(JedisDataException.class, () -> {
857-
jedis.zadd("zset", 1.0, "val", new ZAddParams().lt().gt());
858-
});
850+
assertThrows(JedisDataException.class, () ->
851+
jedis.zadd("zset", 1.0, "val", new ZAddParams().lt().gt()));
859852
}
860853

861854
@Test
862855
void zaddSingleWithoutOptions() {
863856
try {
864-
var result = jedis.zadd("zset", 1.0, "val");
857+
Long result = jedis.zadd("zset", 1.0, "val");
865858
assertEquals(1, result);
866859

867860
result = jedis.zadd("zset", 1.0, "val");
@@ -879,7 +872,7 @@ void zaddMultipleWithoutOptions() {
879872
for(int i=0; i<numMembers; ++i) {
880873
members.put(Integer.toString(i), (double) i);
881874
}
882-
var result = jedis.zadd("zset", members);
875+
Long result = jedis.zadd("zset", members);
883876
assertEquals(numMembers, result);
884877

885878
result = jedis.zadd("zset", members);
@@ -892,7 +885,7 @@ void zaddMultipleWithoutOptions() {
892885
@Test
893886
void zaddCh() {
894887
try {
895-
var result = jedis.zadd("zset", 1.0, "mem", new ZAddParams().ch());
888+
Long result = jedis.zadd("zset", 1.0, "mem", new ZAddParams().ch());
896889
assertEquals(1, result);
897890

898891
result = jedis.zadd("zset", 1.0, "mem", new ZAddParams().ch());

‎docs/src/.vuepress/config.js‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,8 @@ module.exports = {
8282
collapsable: false,
8383
children: [
8484
'insight/design',
85-
'insight/benchmark'
85+
'insight/benchmark',
86+
'insight/release-notes',
8687
]
8788
},
8889
'roadmap',

‎docs/src/guide/developer-guide.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -231,3 +231,13 @@ public void a() { ... }
231231
// <-- Remove this extra line.
232232
public void b() { ... }
233233
```
234+
235+
## Git flow
236+
237+
Follow the [Git flow](https://git-scm.com/book/en/v2/Git-Branching-and-Merging)
238+
239+
For feature PR (to develop) use squash merge, for release PR (to master) use rebase merge,
240+
commit message merged to master/develop branch should be lowercase first word
241+
(e.g. "fix: some bug").
242+
243+
All pull requests must be passed to the code review and passed all the tests.

‎docs/src/guide/insight/release-notes.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Release Notes
2+
3+
Visit [Release](https://github.com/keva-dev/keva/releases)

‎docs/src/guide/roadmap.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,13 @@
88

99
## Todo-list
1010

11-
- Implement various Redis commands
12-
- Implement RDB, AOF persistence mode
11+
- Implement various Redis commands :heavy_check_mark:
12+
- Implement RDB, AOF persistence mode :heavy_check_mark:
1313
- Implement Pub/Sub :heavy_check_mark:
1414
- Implement Transactions :heavy_check_mark:
1515
- Implement Replication ([@axblueblader](https://github.com/axblueblader))
1616
- Implement Keva Proxy ([@haphananhtuan](https://github.com/haphananhtuan))
1717
- Implement Keva Sentinel ([@duongcongtoai](https://github.com/duongcongtoai))
1818
- Implement Keva SQL (TBD)
1919
- Implement Keva security
20-
- Publish dedicated Maven package for `protocol` and `config`
2120
- Create automation for release workflow

0 commit comments

Comments
 (0)