changeset 1723:9d2e605dbe6f

Store credentials only if save entitlements is checked. Reviewed-by: aazores Review-thread: http://icedtea.classpath.org/pipermail/thermostat/2015-August/015172.html PR2580
author Severin Gehwolf <sgehwolf@redhat.com>
date Thu, 13 Aug 2015 18:32:36 +0200
parents 601243b928f6
children 4f607fa1813d
files client/core/src/main/java/com/redhat/thermostat/client/ui/ClientPreferencesModel.java client/core/src/test/java/com/redhat/thermostat/client/ui/ClientPreferencesModelTest.java client/core/src/test/resources/test_client_preferences.properties
diffstat 3 files changed, 151 insertions(+), 45 deletions(-) [+]
line wrap: on
line diff
--- a/client/core/src/main/java/com/redhat/thermostat/client/ui/ClientPreferencesModel.java	Thu Mar 19 12:15:08 2015 +0100
+++ b/client/core/src/main/java/com/redhat/thermostat/client/ui/ClientPreferencesModel.java	Thu Aug 13 18:32:36 2015 +0200
@@ -42,23 +42,12 @@
 import com.redhat.thermostat.utils.keyring.Keyring;
 
 public class ClientPreferencesModel {
+
     private ClientPreferences prefs;
     private Keyring keyring;
-
-    private String initialUrl;
-    private String initialUsername;
-
     private char[] password;
-    private String url;
-    private String username;
 
     public ClientPreferencesModel(Keyring keyring, ClientPreferences prefs) {
-        initialUrl = prefs.getConnectionUrl();
-        initialUsername = prefs.getUserName();
-
-        this.username = initialUsername;
-        this.url = initialUrl;
-
         this.prefs = prefs;
         this.keyring = keyring;
     }
@@ -72,59 +61,35 @@
     }
     
     public String getConnectionUrl() {
-        if (getSaveEntitlements()) {
-            return prefs.getConnectionUrl();
-        }
-        return url;
+        return prefs.getConnectionUrl();
     }
 
     public void setConnectionUrl(String url) {
-        this.url = url;
-        if (getSaveEntitlements()) {
-            prefs.setConnectionUrl(url);
-        }
+        prefs.setConnectionUrl(url);
     }
 
     public char[] getPassword() {
         if (getSaveEntitlements()) {
             return keyring.getPassword(getConnectionUrl(), getUserName());
+        } else {
+            return password;
         }
-        return password;
     }
 
     public String getUserName() {
-        if (getSaveEntitlements()) {
-            return prefs.getUserName();
-        }
-        return username;
+        return prefs.getUserName();
     }
 
     public void setCredentials(String userName, char[] password) {
-        this.username = userName;
+        prefs.setUserName(userName);
         this.password = password;
-
-        if (getSaveEntitlements()) {
-            prefs.setUserName(userName);
-            keyring.savePassword(getConnectionUrl(), userName, password);
-        }
     }
     
     public void flush() throws IOException {
         if (getSaveEntitlements()) {
-            keyring.savePassword(getConnectionUrl(), username, password);
-            prefs.flush();
-        } else {
-            // getSaveEntitlements() should still be written to file, it may have changed.
-            String currentUrl = getConnectionUrl();
-            String currentUser = getUserName();
-            prefs.setConnectionUrl(initialUrl);
-            prefs.setUserName(initialUsername);
-            prefs.flush();
-            prefs.setConnectionUrl(currentUrl);
-            prefs.setUserName(currentUser);
-            
-        }
-        keyring.savePassword(getConnectionUrl(), username, password);
+            keyring.savePassword(getConnectionUrl(), getUserName(), password);
+        } 
+        prefs.flush(); // preferences are always written back on flush()
     }
 
     public ClientPreferences getPreferences() {
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/client/core/src/test/java/com/redhat/thermostat/client/ui/ClientPreferencesModelTest.java	Thu Aug 13 18:32:36 2015 +0200
@@ -0,0 +1,138 @@
+/*
+ * Copyright 2012-2015 Red Hat, Inc.
+ *
+ * This file is part of Thermostat.
+ *
+ * Thermostat 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 2, or (at your
+ * option) any later version.
+ *
+ * Thermostat 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 Thermostat; see the file COPYING.  If not see
+ * <http://www.gnu.org/licenses/>.
+ *
+ * Linking this code with other modules is making a combined work
+ * based on this code.  Thus, the terms and conditions of the GNU
+ * General Public License cover the whole combination.
+ *
+ * As a special exception, the copyright holders of this code give
+ * you permission to link this code with independent modules to
+ * produce an executable, regardless of the license terms of these
+ * independent modules, and to copy and distribute the resulting
+ * executable under terms of your choice, provided that you also
+ * meet, for each linked independent module, the terms and conditions
+ * of the license of that module.  An independent module is a module
+ * which is not derived from or based on this code.  If you modify
+ * this code, you may extend this exception to your version of the
+ * library, but you are not obligated to do so.  If you do not wish
+ * to do so, delete this exception statement from your version.
+ */
+
+package com.redhat.thermostat.client.ui;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Matchers.any;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.times;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.net.URISyntaxException;
+import java.util.Properties;
+
+import org.junit.Before;
+import org.junit.Test;
+
+import com.redhat.thermostat.common.config.ClientPreferences;
+import com.redhat.thermostat.shared.config.CommonPaths;
+import com.redhat.thermostat.utils.keyring.Keyring;
+
+public class ClientPreferencesModelTest {
+
+    private Keyring keyring;
+    private ClientPreferences prefs;
+    private File tempFile;
+    
+    @Before
+    public void setup() throws IOException {
+        keyring = mock(Keyring.class);
+        CommonPaths paths = mock(CommonPaths.class);
+        tempFile = File.createTempFile("thermostat", getClass().getName());
+        tempFile.deleteOnExit();
+        when(paths.getUserClientConfigurationFile()).thenReturn(tempFile);
+        prefs = new ClientPreferences(paths);
+    }
+    
+    /*
+     * Credentials (username/password) should not be stored in keyring/backing
+     * preferences file if save entitlements is false.
+     */
+    @Test
+    public void canSetGetCredentialsMemory() throws IOException {
+        ClientPreferencesModel model = new ClientPreferencesModel(keyring, prefs);
+        model.setSaveEntitlements(false);
+        char[] password = new char[] { 't', 'e', 's', 't' };
+        String username = "tester";
+        model.setCredentials(username, password);
+        assertArrayEquals(password, model.getPassword());
+        assertEquals(username, model.getUserName());
+        // This should not write the username to disk
+        model.flush();
+        Properties props = new Properties();
+        props.load(new FileInputStream(tempFile));
+        assertNull(props.getProperty("username"));
+        verify(keyring, times(0)).savePassword(any(String.class), any(String.class), any(char[].class));
+    }
+    
+    /*
+     * Credentials (username/password) should only get flushed to the
+     * keyring/backing prefs file if saveEntitlements is true.
+     */
+    @Test
+    public void canPersistCredentials() throws IOException {
+        ClientPreferencesModel model = new ClientPreferencesModel(keyring, prefs);
+        model.setSaveEntitlements(true);
+        char[] password = new char[] { 't', 'e', 's', 't' };
+        String username = "tester";
+        model.setCredentials(username, password);
+        // This should not write the username to disk
+        model.flush();
+        when(keyring.getPassword(any(String.class), any(String.class))).thenReturn(password);
+        assertArrayEquals(password, model.getPassword());
+        assertEquals(username, model.getUserName());
+        Properties props = new Properties();
+        props.load(new FileInputStream(tempFile));
+        assertEquals(username, props.getProperty("username"));
+        verify(keyring, times(1)).savePassword("http://127.0.0.1:8999/thermostat/storage", username, password);
+    }
+    
+    @Test
+    public void modelUsesDefaultsFromClientPrefsFile() throws IOException, URISyntaxException {
+        CommonPaths paths = mock(CommonPaths.class);
+        File prefsFile = new File(getClass().getResource("/test_client_preferences.properties").toURI().getPath());
+        when(paths.getUserClientConfigurationFile()).thenReturn(prefsFile);
+        ClientPreferences prefs = new ClientPreferences(paths);
+        ClientPreferencesModel model = new ClientPreferencesModel(keyring, prefs);
+        assertEquals("http://example.com/thermostat/storage", model.getConnectionUrl());
+        assertTrue(model.getSaveEntitlements());
+        assertEquals("my_default_user", model.getUserName());
+    }
+    
+    private void assertArrayEquals(char[] expected, char[] actual) {
+        assertTrue(expected.length == actual.length);
+        for (int i = 0; i < expected.length; i++) {
+            assertTrue(expected[i] == actual[i]);
+        }
+    }
+}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/client/core/src/test/resources/test_client_preferences.properties	Thu Aug 13 18:32:36 2015 +0200
@@ -0,0 +1,3 @@
+username = my_default_user
+connection-url = http://example.com/thermostat/storage
+save-entitlements = true
\ No newline at end of file