add rm action to DcmAgent; update documentation for dcm tool #24

oldratlee · oldratlee · commit 6be3b83e0bed · 2015-06-03T20:00:29.000+08:00
diff --git a/library/README.md b/library/README.md
@@ -164,6 +164,7 @@ openjdk7 64-Bit | Linux | travis-ci
 oraclejdk8 64-Bit | Linux | travis-ci
 Mac自带的jdk6 64-Bit | Mac | 个人Mac
 oraclejdk7 64-Bit | Mac | 个人Mac
+oraclejdk8 64-Bit | Mac | 个人Mac
 oraclejdk7 64-Bit | windows server 2012 r2 | appveyor
 oraclejdk7 32-Bit | windows server 2012 r2 | appveyor
 oraclejdk8 64-Bit | windows server 2012 r2 | appveyor
diff --git a/library/src/main/java/com/alibaba/dcm/agent/DcmAgent.java b/library/src/main/java/com/alibaba/dcm/agent/DcmAgent.java
@@ -15,6 +15,7 @@
 
 /**
  * @author Jerry Lee (oldratlee at gmail dot com)
+ * @since 1.4.0
  */
 public class DcmAgent {
     public static final String FILE = "file";
@@ -140,9 +141,13 @@ static Object doAction(String action, String[] arguments) throws Exception {
     static void printResult(String action, Object result, PrintWriter writer) {
         final Method method = action2Method.get(action);
         if (method.getReturnType() != void.class) {
-            writer.println(result.toString());
+            if (writer != null) {
+                writer.println(result.toString());
+            }
+        }
+        if (writer != null) {
+            writer.printf("%s DONE.\n", action);
         }
-        writer.printf("%s DONE.\n", action);
     }
 
     static volatile Map<String, Method> action2Method;
@@ -153,6 +158,7 @@ static synchronized void initAction2Method() throws Exception {
         Map<String, Method> map = new HashMap<String, Method>();
         map.put("set", DnsCacheManipulator.class.getMethod("setDnsCache", String.class, String[].class));
         map.put("get", DnsCacheManipulator.class.getMethod("getDnsCache", String.class));
+        map.put("rm", DnsCacheManipulator.class.getMethod("removeDnsCache", String.class));
 
         map.put("list", DnsCacheManipulator.class.getMethod("getWholeDnsCache"));
         map.put("clear", DnsCacheManipulator.class.getMethod("clearDnsCache"));
diff --git a/library/src/test/java/com/alibaba/dcm/agent/DcmAgentTest.java b/library/src/test/java/com/alibaba/dcm/agent/DcmAgentTest.java
@@ -10,12 +10,12 @@
 import java.util.List;
 
 import static org.hamcrest.CoreMatchers.containsString;
-import static org.hamcrest.CoreMatchers.startsWith;
 import static org.junit.Assert.assertArrayEquals;
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertThat;
 import static org.junit.Assert.assertTrue;
-import static org.junit.Assert.fail;
 
 /**
  * @author Jerry Lee (oldratlee at gmail dot com)
@@ -87,6 +87,23 @@ public void test_agentmain_get() throws Exception {
         DcmAgent.agentmain("get baidu.com");
     }
 
+    @Test
+    public void test_agentmain_rm() throws Exception {
+        DnsCacheManipulator.setDnsCache("baidu.com", "3.3.3.3");
+        DcmAgent.agentmain("rm baidu.com");
+        
+        assertNull(DnsCacheManipulator.getDnsCache("baidu.com"));
+    }
+
+    @Test
+    public void test_agentmain_rm_withFile() throws Exception {
+        DnsCacheManipulator.setDnsCache("baidu.com", "3.3.3.3");
+        assertNotNull(DnsCacheManipulator.getDnsCache("baidu.com"));
+        DcmAgent.agentmain("rm  baidu.com file " + outputFilePath);
+
+        assertNull(DnsCacheManipulator.getDnsCache("baidu.com"));
+    }
+
     @Test
     public void test_agentmain_list() throws Exception {
         DcmAgent.agentmain("   list  ");
diff --git a/tool/README.md b/tool/README.md
@@ -26,12 +26,13 @@ Java Dns Cache Manipulator Tool
 下载
 ----------
 
-运行脚本`dcm.sh`/`dcm.bat`，执行操作。
+在[项目Release页面](https://github.com/alibaba/java-dns-cache-manipulator/releases)下载文件`dcm-tool-x.x.x.tar.gz`。
+
+解压后，运行`bin`目录下的`dcm`脚本（`Shell脚本`）。
 
 ```bash
-$ ./dcm.sh -h
+$ dcm -h
 usage: Options
- -a,--action <arg>     action
  -h,--help             show help
  -p,--pid <arg>        java process id to attach
 ```
@@ -40,7 +41,9 @@ usage: Options
 ---------------
 
 ```bash
-$ ./dcm.sh -p 12345 set baidu.com 1.1.1.1
+# 对进程ID是12345的Java进程，设置域名 baidu.com IP为 1.1.1.1
+$ dcm -p 12345 set baidu.com 1.1.1.1
+set DONE.
 ```
 
 查看`DNS Cache`内容
@@ -49,44 +52,51 @@ $ ./dcm.sh -p 12345 set baidu.com 1.1.1.1
 查看单条
 
 ```bash
-$ ./dcm.sh -p 12345 get baidu.com
+# 对进程ID是12345的Java进程，获取域名 baidu.com 的DNS条目信息
+$ dcm -p 12345 get baidu.com
+DnsCacheEntry{host='baidu.com', ips=[1.1.1.1], expiration=292278994-08-17 15:12:55.807+0800}
+get DONE.
 ```
 
 查看全部
 
 ```bash
-$ ./dcm.sh -p 12345 list
+$ dcm -p 12345 list
+DnsCache{cache=[DnsCacheEntry{host='bar.com', ips=[1.1.1.1], expiration=292278994-08-17 15:12:55.807+0800}, DnsCacheEntry{host='foo.com', ips=[1.1.1.1], expiration=292278994-08-17 15:12:55.807+0800}, DnsCacheEntry{host='baidu.com', ips=[180.149.132.47, 123.125.114.144, 220.181.57.217], expiration=2015-06-03 17:49:42.077+0800}], negativeCache=[]}
+list DONE.
 ```
 
 清空`DNS Cache`
 ---------------
 
 ```bash
-$ ./dcm.sh -p 12345 clear
+$ dcm -p 12345 clear
+clear DONE.
 ```
 
 修改/查看`JVM`缺省的`DNS`的缓存时间
 ---------------
 
 ```bash
 # 查看缓存时间，单位秒。-1表示永远缓存，0表示不缓存
-$ ./dcm.sh -p 12345 getPolicy
+$ dcm -p 12345 getPolicy
+30
+getPolicy DONE.
 
 # 设置缓存时间
-$ ./dcm.sh --pid 12345 setPolicy 5
+$ dcm --pid 12345 setPolicy 5
+setPolicy DONE.
 
 # 查看未命中条目的缓存时间，单位秒。-1表示永远缓存，0表示不缓存
-$ ./dcm.sh -p 12345 getNegativePolicy
+$ dcm -p 12345 getNegativePolicy
+10
+getNegativePolicy DONE.
 
 # 修改未命中条目的缓存时间
-$ ./dcm.sh -p 12345 setNegativePolicy 0
+$ dcm -p 12345 setNegativePolicy 0
+setNegativePolicy DONE.
 ```
 
-:mortar_board: Developer Guide
-=================================
-
-TODO
-
 :books: 相关资料
 =================================
 
diff --git a/tool/assembly.xml b/tool/assembly.xml
@@ -5,7 +5,7 @@
 	<formats>
 		<format>tar.gz</format>
 	</formats>
-	<includeBaseDirectory>false</includeBaseDirectory>
+	<baseDirectory>dcm-${project.version}</baseDirectory>
 	<dependencySets>
 		<dependencySet>
 			<outputDirectory>dependencies</outputDirectory>
diff --git a/tool/scripts/dcm b/tool/scripts/dcm
diff --git a/tool/src/main/java/com/alibaba/dcm/tool/DcmTool.java b/tool/src/main/java/com/alibaba/dcm/tool/DcmTool.java
@@ -16,6 +16,7 @@
 
 /**
  * @author Jerry Lee (oldratlee at gmail dot com)
+ * @since 1.4.0
  */
 public class DcmTool {
     static final String DCM_AGENT_SUCCESS_MARK_LINE = "!!DCM SUCCESS!!";
@@ -27,6 +28,7 @@ public class DcmTool {
     static {
         actionList.add("set");
         actionList.add("get");
+        actionList.add("rm");
 
         actionList.add("list");
         actionList.add("clear");
@@ -76,7 +78,7 @@ public static void main(String[] args) throws Exception {
         }
 
         StringBuilder agentArgument = new StringBuilder();
-        agentArgument.append(action).append(' ');
+        agentArgument.append(action);
         for (int i = 1; i < arguments.length; i++) {
             String s = arguments[i];
             agentArgument.append(' ').append(s);
diff --git a/tool/src/test/java/com/alibaba/dcm/tool/MainForAgentInject.java b/tool/src/test/java/com/alibaba/dcm/tool/MainForAgentInject.java
@@ -6,7 +6,7 @@
 /**
  * @author Jerry Lee (oldratlee at gmail dot com)
  */
-public class TestMainForAgentInject {
+public class MainForAgentInject {
     public static void main(String[] args) throws Exception {
         while (true) {
             System.out.printf("%s: baidu.com: %s\n", new Date(),
