Refactore test drivers

Author: kaklakariada

src/main/java/com/github/kaklakariada/fritzbox/AbstractTestHelper.java

@@ -1,3 +1,20 @@
+/**
+ * A Java API for managing FritzBox HomeAutomation
+ * Copyright (C) 2017 Christoph Pirkl <christoph at users.sourceforge.net>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
 package com.github.kaklakariada.fritzbox;
 
 public abstract class AbstractTestHelper {

src/main/java/com/github/kaklakariada/fritzbox/Config.java

@@ -0,0 +1,84 @@
+/**
+ * A Java API for managing FritzBox HomeAutomation
+ * Copyright (C) 2017 Christoph Pirkl <christoph at users.sourceforge.net>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+package com.github.kaklakariada.fritzbox;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.UncheckedIOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.Optional;
+import java.util.Properties;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class Config {
+    private static final Logger LOG = LoggerFactory.getLogger(Config.class);
+    private static final Path DEFAULT_CONFIG = Paths.get("application.properties");
+    private final Properties properties;
+
+    private Config(final Properties properties) {
+        this.properties = properties;
+    }
+
+    public static Config read() {
+        return read(DEFAULT_CONFIG);
+    }
+
+    private static Config read(final Path configFile) {
+        final Path file = configFile.normalize();
+        return new Config(loadProperties(file));
+    }
+
+    private static Properties loadProperties(final Path configFile) {
+        if (!Files.exists(configFile)) {
+            throw new IllegalStateException("Config file not found at '" + configFile + "'");
+        }
+        LOG.info("Reading config file from {}", configFile);
+        try (InputStream stream = Files.newInputStream(configFile)) {
+            final Properties props = new Properties();
+            props.load(stream);
+            return props;
+        } catch (final IOException e) {
+            throw new UncheckedIOException("Error reading config file " + configFile, e);
+        }
+    }
+
+    public String getUrl() {
+        return getMandatoryValue("fritzbox.url");
+    }
+
+    public String getUsername() {
+        return getMandatoryValue("fritzbox.username");
+    }
+
+    public String getPassword() {
+        return getMandatoryValue("fritzbox.password");
+    }
+
+    private String getMandatoryValue(final String param) {
+        return getOptionalValue(param).orElseThrow(
+                () -> new IllegalStateException("Property '" + param + "' not found in config file"));
+    }
+
+    private Optional<String> getOptionalValue(final String param) {
+        return Optional.ofNullable(this.properties.getProperty(param));
+    }
+}

src/main/java/com/github/kaklakariada/fritzbox/HomeAutomation.java

@@ -36,21 +36,26 @@ public class HomeAutomation {
 
     private final FritzBoxSession session;
 
-    private enum ParamName {
+    private enum Param {
         PARAM("param"), LEVEL("level"), TARGET("target");
 
-        private String paramName;
+        private final String name;
 
-        ParamName(String paramName) {
-            this.paramName = paramName;
+        Param(final String name) {
+            this.name = name;
         }
     }
 
-    private HomeAutomation(FritzBoxSession fritzbox) {
+    private HomeAutomation(final FritzBoxSession fritzbox) {
         this.session = fritzbox;
     }
 
-    public static HomeAutomation connect(String baseUrl, String username, String password) {
+    public static HomeAutomation connect(final Config config) {
+        return connect(config.getUrl(), config.getUsername(), config.getPassword());
+    }
+
+    public static HomeAutomation connect(final String baseUrl, final String username, final String password) {
+        LOG.info("Logging in to '{}' with username '{}'", baseUrl, username);
         final FritzBoxSession session = new FritzBoxSession(baseUrl);
         session.login(username, password);
         return new HomeAutomation(session);
@@ -62,33 +67,37 @@ public DeviceList getDeviceListInfos() {
                 deviceList.getApiVersion());
         return deviceList;
     }
-    
-    public Device getDeviceInfos(String deviceAin) {
-        return executeDeviceCommand(deviceAin, "getdeviceinfos", null, Device.class);
+
+    public Device getDeviceInfos(final String deviceAin) {
+        return executeDeviceCommand(deviceAin, "getdeviceinfos", Param.PARAM, null, Device.class);
     }
 
-    private <T> T executeCommand(String command, Class<T> resultType) {
+    private <T> T executeCommand(final String command, final Class<T> resultType) {
         final QueryParameters parameters = QueryParameters.builder().add("switchcmd", command).build();
         return session.getAutenticated(HOME_AUTOMATION_PATH, parameters, resultType);
     }
 
-    private <T> T executeParamCommand(String deviceAin, String command, String parameter, Class<T> responseType) {
-        return executeDeviceCommand(deviceAin, command, ParamName.PARAM, parameter, responseType);
+    private <T> T executeParamCommand(final String deviceAin, final String command, final String parameter,
+            final Class<T> responseType) {
+        return executeDeviceCommand(deviceAin, command, Param.PARAM, parameter, responseType);
     }
 
-    private <T> T executeLevelCommand(String deviceAin, String command, String parameter, Class<T> responseType) {
-        return executeDeviceCommand(deviceAin, command, ParamName.LEVEL, parameter, responseType);
+    private <T> T executeLevelCommand(final String deviceAin, final String command, final String parameter,
+            final Class<T> responseType) {
+        return executeDeviceCommand(deviceAin, command, Param.LEVEL, parameter, responseType);
     }
 
-    private <T> T executeTargetCommand(String deviceAin, String command, String parameter, Class<T> responseType) {
-        return executeDeviceCommand(deviceAin, command, ParamName.TARGET, parameter, responseType);
+    private <T> T executeTargetCommand(final String deviceAin, final String command, final String parameter,
+            final Class<T> responseType) {
+        return executeDeviceCommand(deviceAin, command, Param.TARGET, parameter, responseType);
     }
 
-    private <T> T executeDeviceCommand(String deviceAin, String command, ParamName paramName, String parameter,
-            Class<T> responseType) {
+    private <T> T executeDeviceCommand(final String deviceAin, final String command, final Param paramName,
+            final String parameter,
+            final Class<T> responseType) {
         final Builder paramBuilder = QueryParameters.builder().add("ain", deviceAin).add("switchcmd", command);
         if (parameter != null) {
-            paramBuilder.add(paramName.paramName, parameter);
+            paramBuilder.add(paramName.name, parameter);
         }
         return session.getAutenticated(HOME_AUTOMATION_PATH, paramBuilder.build(), responseType);
     }
@@ -100,58 +109,58 @@ public List<String> getSwitchList() {
         return idList;
     }
 
-    public void switchPowerState(String deviceAin, boolean on) {
+    public void switchPowerState(final String deviceAin, final boolean on) {
         final String command = on ? "setswitchon" : "setswitchoff";
         executeParamCommand(deviceAin, command, null, Boolean.class);
     }
 
-    public void togglePowerState(String deviceAin) {
+    public void togglePowerState(final String deviceAin) {
         executeParamCommand(deviceAin, "setswitchtoggle", null, Boolean.class);
     }
 
-    public void setHkrTsoll(String deviceAin, String tsoll) {
+    public void setHkrTsoll(final String deviceAin, final String tsoll) {
         executeParamCommand(deviceAin, "sethkrtsoll", tsoll, Boolean.class);
     }
 
-    public void setBlind(String deviceAin, String target) {
+    public void setBlind(final String deviceAin, final String target) {
         executeTargetCommand(deviceAin, "setblind", target, Boolean.class);
     }
 
-    public void setLevel(String deviceAin, String level) {
+    public void setLevel(final String deviceAin, final String level) {
         executeLevelCommand(deviceAin, "setlevel", level, Boolean.class);
     }
 
-    public void setLevelPercentage(String deviceAin, String level) {
+    public void setLevelPercentage(final String deviceAin, final String level) {
         executeLevelCommand(deviceAin, "setlevelpercentage", level, Boolean.class);
     }
 
-    public boolean getSwitchState(String deviceAin) {
+    public boolean getSwitchState(final String deviceAin) {
         return executeParamCommand(deviceAin, "getswitchstate", null, Boolean.class);
     }
 
-    public boolean getSwitchPresent(String deviceAin) {
+    public boolean getSwitchPresent(final String deviceAin) {
         return executeParamCommand(deviceAin, "getswitchpresent", null, Boolean.class);
     }
 
-    public String getSwitchName(String deviceAin) {
+    public String getSwitchName(final String deviceAin) {
         return executeParamCommand(deviceAin, "getswitchname", null, String.class);
     }
 
-    public Float getTemperature(String deviceAin) {
+    public Float getTemperature(final String deviceAin) {
         final Integer centiDegree = executeParamCommand(deviceAin, "gettemperature", null, Integer.class);
         return centiDegree == null ? null : centiDegree / 10F;
     }
 
-    public DeviceStats getBasicStatistics(String deviceAin) {
+    public DeviceStats getBasicStatistics(final String deviceAin) {
         return executeParamCommand(deviceAin, "getbasicdevicestats", null, DeviceStats.class);
     }
 
-    public Float getSwitchPowerWatt(String deviceAin) {
+    public Float getSwitchPowerWatt(final String deviceAin) {
         final Integer powerMilliWatt = executeParamCommand(deviceAin, "getswitchpower", null, Integer.class);
         return powerMilliWatt == null ? null : powerMilliWatt / 1000F;
     }
 
-    public Integer getSwitchEnergyWattHour(String deviceAin) {
+    public Integer getSwitchEnergyWattHour(final String deviceAin) {
         return executeParamCommand(deviceAin, "getswitchenergy", null, Integer.class);
     }
 

src/main/java/com/github/kaklakariada/fritzbox/TestBlind.java

@@ -35,16 +35,19 @@
 public class TestBlind extends AbstractTestHelper {
 
     private static final Logger LOG = LoggerFactory.getLogger(TestBlind.class);
+    private static final int WAIT_SECONDS = 20;
 
     private final HomeAutomation homeAutomation;
 
-    final int waitSeconds = 20;
-
     public TestBlind() throws InterruptedException {
-        this.homeAutomation = TestLogin.login();
+        this.homeAutomation = HomeAutomation.connect(Config.read());
 
         // make sure to set back blind to original state
         final List<Device> blindDevices = getBlindDevices();
+        if (blindDevices.isEmpty()) {
+            LOG.warn("No blind devices found");
+            return;
+        }
         final int wasPercenClosed = blindDevices.get(0).getLevelControl().getLevelpercentage();
 
         toggleBlindOpenClose();
@@ -66,8 +69,7 @@ private void toggleBlindOpenClose() throws InterruptedException {
         toggleBlindOpenClose(blindDevices.get(0));
 
         // Start move back
-        LOG.info("Wait {} seconds", waitSeconds);
-        Thread.sleep(waitSeconds * 1000);
+        sleep();
         LOG.info("");
         LOG.info("Status after change");
         blindDevices = getBlindDevices();
@@ -76,12 +78,16 @@ private void toggleBlindOpenClose() throws InterruptedException {
 
         // Show status at end of test
         LOG.info("");
-        LOG.info("Wait {} seconds", waitSeconds);
-        Thread.sleep(waitSeconds * 1000);
+        sleep();
         blindDevices = getBlindDevices();
         showStatus(blindDevices);
     }
 
+    private void sleep() throws InterruptedException {
+        LOG.info("Wait {} seconds", WAIT_SECONDS);
+        Thread.sleep(WAIT_SECONDS * 1000L);
+    }
+
     private void toggleBlindOpenClose(final Device blind) {
         final String ain = getAin(blind.getIdentifier());
         final boolean wasOpen = blind.getLevelControl().getLevel() == 0;
@@ -107,9 +113,7 @@ private void togglePercentOpen() throws InterruptedException {
 
         setPercentOpen(blindDevices.get(0), newPercenClosed);
 
-        // Start move back
-        LOG.info("Wait {} seconds", waitSeconds);
-        Thread.sleep(waitSeconds * 1000);
+        sleep();
         LOG.info("");
         LOG.info("Status after change");
         blindDevices = getBlindDevices();
@@ -118,13 +122,12 @@ private void togglePercentOpen() throws InterruptedException {
 
         // Show status at end of test
         LOG.info("");
-        LOG.info("Wait {} seconds", waitSeconds);
-        Thread.sleep(waitSeconds * 1000);
+        sleep();
         blindDevices = getBlindDevices();
         showStatus(blindDevices);
     }
 
-    private void setPercentOpen(final Device blind, int percent) {
+    private void setPercentOpen(final Device blind, final int percent) {
         final String ain = getAin(blind.getIdentifier());
         final String newLevel = String.valueOf(percent);
 
@@ -136,11 +139,10 @@ private void setPercentOpen(final Device blind, int percent) {
 
     private List<Device> getBlindDevices() {
         final DeviceList devices = homeAutomation.getDeviceListInfos();
-        final List<Device> hkrDevices = devices.getDevices()
+        return devices.getDevices()
                 .stream()
                 .filter(device -> device.getBlind() != null)
                 .collect(Collectors.toList());
-        return hkrDevices;
     }
 
     private void showStatus(final List<Device> blindDevices) {
@@ -153,8 +155,7 @@ private void showStatus(final List<Device> blindDevices) {
         });
     }
 
-    public static void main(String[] args) throws InterruptedException {
+    public static void main(final String[] args) throws InterruptedException {
         new TestBlind();
     }
-
 }