增加localStorage的处理

Author: LinuxSuRen

src/main/java/org/suren/autotest/web/framework/annotation/AutoCookie.java

@@ -6,25 +6,31 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import org.suren.autotest.web.framework.page.Page;
+
 /**
  * @author suren
  * @date 2017年6月26日 上午10:17:00
  */
-@Target(ElementType.TYPE)
+@Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)
 @Documented
 public @interface AutoCookie
 {
+    /**
+     * @return Page类
+     */
+    Class<? extends Page> pageClazz();
 
     /**
-     * @return 是否跳过目标方法
+     * @return Page类中代表的属性名称
      */
-    boolean skipMethod() default false;
+    String sessionKey();
 
     /**
-     * @return 是否要执行打开页面操作
+     * @return 是否跳过目标方法
      */
-    boolean openInvoke() default false;
+    boolean skipMethod() default false;
 
     /**
      * @return 保存cookie的文件名，在~/.autotest中

src/main/java/org/suren/autotest/web/framework/annotation/AutoLocalStorage.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2002-2007 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.suren.autotest.web.framework.annotation;
+
+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 org.suren.autotest.web.framework.page.Page;
+
+/**
+ * @author suren
+ * @date 2017年6月30日 下午2:51:25
+ */
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+public @interface AutoLocalStorage
+{
+    /**
+     * @return Page类
+     */
+    Class<? extends Page> pageClazz();
+
+    /**
+     * @return Page类中代表的属性名称
+     */
+    String sessionKey();
+    
+    /**
+     * @return 自定义选项，将会覆盖了localStorage中的选项
+     */
+    AutoItem[] overItems() default {};
+
+    /**
+     * @return 是否跳过目标方法
+     */
+    boolean skipMethod() default true;
+}

src/main/java/org/suren/autotest/web/framework/annotation/AutoSessionStorage.java

@@ -54,9 +54,4 @@
      * @return 是否跳过目标方法
      */
     boolean skipMethod() default true;
-
-    /**
-     * @return 是否要执行打开页面操作
-     */
-    boolean openInvoke() default false;
 }

src/main/java/org/suren/autotest/web/framework/settings/AutoModuleProxy.java

@@ -27,6 +27,8 @@
 import java.lang.reflect.Field;
 import java.lang.reflect.Method;
 import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Properties;
@@ -35,10 +37,13 @@
 import org.openqa.selenium.Cookie;
 import org.openqa.selenium.WebDriver;
 import org.openqa.selenium.WebDriver.Options;
+import org.openqa.selenium.html5.LocalStorage;
 import org.openqa.selenium.html5.SessionStorage;
 import org.openqa.selenium.html5.WebStorage;
 import org.suren.autotest.web.framework.annotation.AutoCookie;
 import org.suren.autotest.web.framework.annotation.AutoExpect;
+import org.suren.autotest.web.framework.annotation.AutoItem;
+import org.suren.autotest.web.framework.annotation.AutoLocalStorage;
 import org.suren.autotest.web.framework.annotation.AutoModule;
 import org.suren.autotest.web.framework.annotation.AutoSessionStorage;
 import org.suren.autotest.web.framework.core.AutoTestException;
@@ -92,6 +97,7 @@ public Object intercept(Object obj, Method method, Object[] args,
         AutoModule autoModule = superCls.getAnnotation(AutoModule.class);
         AutoExpect autoExpect = method.getAnnotation(AutoExpect.class);
         AutoSessionStorage autoSessionStorage = method.getAnnotation(AutoSessionStorage.class);
+        AutoLocalStorage autoLocalStorage = method.getAnnotation(AutoLocalStorage.class);
         AutoCookie autoCookie = method.getAnnotation(AutoCookie.class);
 
         NormalRecord normalRecord = new NormalRecord();
@@ -120,9 +126,18 @@ public Object intercept(Object obj, Method method, Object[] args,
                 {
                     String accountNameValue = ((Text) value).getValue();
                     sessionStorageConfig.setAccount(accountNameValue);
+                    
+                    Map<String, String> customMap = new HashMap<String, String>();
+                    AutoItem[] overItems = autoSessionStorage.overItems();
+                    if(overItems != null && overItems.length > 0)
+                    {
+                    	Arrays.asList(overItems).forEach((item) -> {
+                    		customMap.put(item.key(), item.value());
+                    	});
+                    }
 
                     page.open();
-                    if(loadSessionStorage(accountNameValue))
+                    if(loadSessionStorage(accountNameValue, customMap))
                     {
                         sessionStorageConfig.setAccount(accountNameValue);
 
@@ -139,6 +154,51 @@ public Object intercept(Object obj, Method method, Object[] args,
                 }
             }
 
+            LocalStorageConfig localStorageConfig = new LocalStorageConfig();
+            if(autoLocalStorage != null)
+            {
+            	localStorageConfig.setAutoLoad(true);
+                Class<? extends Page> accountClz = autoLocalStorage.pageClazz();
+                String accountNameField = autoLocalStorage.sessionKey();
+
+                Page page = util.getPage(accountClz);
+                Field accountField = accountClz.getDeclaredField(accountNameField);
+
+                accountField.setAccessible(true);
+                Object value = accountField.get(page);
+
+                if(value instanceof Text)
+                {
+                    String accountNameValue = ((Text) value).getValue();
+                    localStorageConfig.setAccount(accountNameValue);
+                    
+                    Map<String, String> customMap = new HashMap<String, String>();
+                    AutoItem[] overItems = autoLocalStorage.overItems();
+                    if(overItems != null && overItems.length > 0)
+                    {
+                    	Arrays.asList(overItems).forEach((item) -> {
+                    		customMap.put(item.key(), item.value());
+                    	});
+                    }
+
+                    page.open();
+                    if(loadLocalStorage(accountNameValue, customMap))
+                    {
+                    	localStorageConfig.setAccount(accountNameValue);
+
+                        if(autoLocalStorage.skipMethod())
+                        {
+                        	localStorageConfig.setSkipLogin(true);
+                        }
+                    }
+                }
+                else
+                {
+                    throw new AutoTestException("Wrong account type in class: " + accountClz + ", and field : "
+                            + accountNameField + ". It should be Text type.");
+                }
+            }
+            
             //加载cookie信息
             boolean skipForCookie = false;
             if(autoCookie != null && PathUtil.isFile(autoCookie.fileName()))
@@ -147,6 +207,19 @@ public Object intercept(Object obj, Method method, Object[] args,
         		Options manage = util.getEngine().getDriver().manage();
         		File cookieFile = PathUtil.getFile(autoCookie.fileName());
 
+                Class<? extends Page> accountClz = autoCookie.pageClazz();
+                String accountNameField = autoCookie.sessionKey();
+
+                Page page = util.getPage(accountClz);
+                Field accountField = accountClz.getDeclaredField(accountNameField);
+
+                accountField.setAccessible(true);
+                Object value = accountField.get(page);
+                if(value instanceof Text)
+                {
+                    page.open();
+                }
+        		
     			try(ObjectInputStream input = new ObjectInputStream(new FileInputStream(cookieFile)))
     			{
     				Object cookiesObj = input.readObject();
@@ -171,7 +244,7 @@ public Object intercept(Object obj, Method method, Object[] args,
     			}
             }
 
-            if(sessionStorageConfig.isSkipLogin() || skipForCookie)
+            if(sessionStorageConfig.isSkipLogin() || localStorageConfig.isSkipLogin() || skipForCookie)
             {
                 result = Void.TYPE;
             }
@@ -185,6 +258,11 @@ public Object intercept(Object obj, Method method, Object[] args,
             {
                 saveSessionStorage(sessionStorageConfig.getAccount());
             }
+
+            if(localStorageConfig.isAutoLoad())
+            {
+                saveLocalStorage(localStorageConfig.getAccount());
+            }
 
             //保存cookie信息
             if(autoCookie != null)
@@ -251,13 +329,31 @@ private void saveSessionStorage(String account)
             PathUtil.proStore(pro, "sessionStorage." + account);
         }
     }
+    
+    private void saveLocalStorage(String account)
+    {
+        WebDriver driver = util.getEngine().getDriver();
+        if(driver instanceof WebStorage)
+        {
+            WebStorage webStorage = (WebStorage) driver;
+            LocalStorage localStorage = webStorage.getLocalStorage();
+
+            Properties pro = new Properties();
+            for(String key : localStorage.keySet())
+            {
+                pro.setProperty(key, localStorage.getItem(key));
+            }
+
+            PathUtil.proStore(pro, "localStorage." + account);
+        }
+    }
 
     /**
      * 加载sessionStorage信息
      * @param accountNameValue
      * @return
      */
-    private boolean loadSessionStorage(String accountNameValue)
+    private boolean loadSessionStorage(String accountNameValue, Map<String, String> customMap)
     {
         WebDriver webDriver = util.getEngine().getDriver();
         if(webDriver instanceof WebStorage)
@@ -272,6 +368,8 @@ private boolean loadSessionStorage(String accountNameValue)
                 {
                     return false;
                 }
+                
+                pro.putAll(customMap);
 
                 pro.stringPropertyNames().parallelStream().forEach((key) -> {
                     sessionStorage.setItem(key, pro.getProperty(key));
@@ -283,6 +381,35 @@ private boolean loadSessionStorage(String accountNameValue)
 
         return false;
     }
+    
+    private boolean loadLocalStorage(String accountNameValue, Map<String, String> customMap)
+    {
+        WebDriver webDriver = util.getEngine().getDriver();
+        if(webDriver instanceof WebStorage)
+        {
+            WebStorage webStorage = (WebStorage) webDriver;
+            LocalStorage localStorage = webStorage.getLocalStorage();
+
+            Properties pro = new Properties();
+            if(PathUtil.proLoad(pro, "localStorage." + accountNameValue))
+            {
+                if(pro.isEmpty())
+                {
+                    return false;
+                }
+                
+                pro.putAll(customMap);
+
+                pro.stringPropertyNames().parallelStream().forEach((key) -> {
+                	localStorage.setItem(key, pro.getProperty(key));
+                });
+
+                return true;
+            }
+        }
+
+        return false;
+    }
 
     /**
      * 根据注解配置，是否要对异常进行处理

src/main/java/org/suren/autotest/web/framework/settings/LocalStorageConfig.java

@@ -0,0 +1,62 @@
+/*
+ *
+ *  * Copyright 2002-2007 the original author or authors.
+ *  *
+ *  * Licensed under the Apache License, Version 2.0 (the "License");
+ *  * you may not use this file except in compliance with the License.
+ *  * You may obtain a copy of the License at
+ *  *
+ *  *      http://www.apache.org/licenses/LICENSE-2.0
+ *  *
+ *  * Unless required by applicable law or agreed to in writing, software
+ *  * distributed under the License is distributed on an "AS IS" BASIS,
+ *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  * See the License for the specific language governing permissions and
+ *  * limitations under the License.
+ *
+ */
+
+package org.suren.autotest.web.framework.settings;
+
+/**
+ * @author suren
+ */
+public class LocalStorageConfig
+{
+    /** 跳过登录 */
+    private boolean skipLogin;
+    /** 自动加载 */
+    private boolean autoLoad;
+    /** 账户名 */
+    private String account;
+
+    public boolean isSkipLogin()
+    {
+        return skipLogin;
+    }
+
+    public void setSkipLogin(boolean skipLogin)
+    {
+        this.skipLogin = skipLogin;
+    }
+
+    public boolean isAutoLoad()
+    {
+        return autoLoad;
+    }
+
+    public void setAutoLoad(boolean autoLoad)
+    {
+        this.autoLoad = autoLoad;
+    }
+
+    public String getAccount()
+    {
+        return account;
+    }
+
+    public void setAccount(String account)
+    {
+        this.account = account;
+    }
+}