From 99ed831ac95aab428c6d9c6212e99aa0466bc9bf Mon Sep 17 00:00:00 2001
From: "A. Soroka" <ajs6f@apache.org>
Date: Fri, 21 Apr 2017 17:41:10 -0400
Subject: [PATCH] Issue 598: Update Syn configuration root element (#7)

---
 conf/syn-settings.example.xml                 |  4 +-
 .../syn/settings/{Sites.java => Config.java}  |  2 +-
 .../syn/settings/SettingsParser.java          | 32 ++++++------
 .../SettingsParserAlgorithmsTest.java         | 52 +++++++++----------
 .../settings/SettingsParserDigestTest.java    | 30 +++++------
 .../syn/settings/SettingsParserTokenTest.java | 16 +++---
 .../ca/islandora/syn/settings/SitesTest.java  |  4 +-
 .../ca/islandora/syn/valves/SynValveTest.java |  8 +--
 8 files changed, 74 insertions(+), 74 deletions(-)
 rename src/main/java/ca/islandora/syn/settings/{Sites.java => Config.java} (96%)

diff --git a/conf/syn-settings.example.xml b/conf/syn-settings.example.xml
index da1aa96..191ea2a 100644
--- a/conf/syn-settings.example.xml
+++ b/conf/syn-settings.example.xml
@@ -1,4 +1,4 @@
-<sites version='1'>
+<config version='1'>
   <!-- 
   Sites can be specified with a Key inline, or with a reference to a key 
   stored in a file. Both are shown in examples below.
@@ -30,4 +30,4 @@ my secret key
     my super secret token
   </token>
 
-</sites>
+</config>
diff --git a/src/main/java/ca/islandora/syn/settings/Sites.java b/src/main/java/ca/islandora/syn/settings/Config.java
similarity index 96%
rename from src/main/java/ca/islandora/syn/settings/Sites.java
rename to src/main/java/ca/islandora/syn/settings/Config.java
index 9b52244..de74243 100644
--- a/src/main/java/ca/islandora/syn/settings/Sites.java
+++ b/src/main/java/ca/islandora/syn/settings/Config.java
@@ -3,7 +3,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
-public class Sites {
+public class Config {
     private int version = -1;
     private List<Site> sites = new ArrayList<>();
     private List<Token> tokens = new ArrayList<>();
diff --git a/src/main/java/ca/islandora/syn/settings/SettingsParser.java b/src/main/java/ca/islandora/syn/settings/SettingsParser.java
index f7755c4..49c375e 100644
--- a/src/main/java/ca/islandora/syn/settings/SettingsParser.java
+++ b/src/main/java/ca/islandora/syn/settings/SettingsParser.java
@@ -34,16 +34,16 @@ private static Digester getDigester() {
         if (digester == null) {
             digester = new Digester();
             digester.setValidating(false);
-            digester.addObjectCreate("sites", "ca.islandora.syn.settings.Sites");
-            digester.addSetProperties("sites");
-            digester.addObjectCreate("sites/site", "ca.islandora.syn.settings.Site");
-            digester.addSetProperties("sites/site");
-            digester.addCallMethod("sites/site", "setKey", 0);
-            digester.addSetNext("sites/site", "addSite", "ca.islandora.syn.settings.Site");
-            digester.addObjectCreate("sites/token", "ca.islandora.syn.settings.Token");
-            digester.addSetProperties("sites/token");
-            digester.addCallMethod("sites/token", "setToken", 0);
-            digester.addSetNext("sites/token", "addToken", "ca.islandora.syn.settings.Token");
+            digester.addObjectCreate("config", "ca.islandora.syn.settings.Config");
+            digester.addSetProperties("config");
+            digester.addObjectCreate("config/site", "ca.islandora.syn.settings.Site");
+            digester.addSetProperties("config/site");
+            digester.addCallMethod("config/site", "setKey", 0);
+            digester.addSetNext("config/site", "addSite", "ca.islandora.syn.settings.Site");
+            digester.addObjectCreate("config/token", "ca.islandora.syn.settings.Token");
+            digester.addSetProperties("config/token");
+            digester.addCallMethod("config/token", "setToken", 0);
+            digester.addSetNext("config/token", "addToken", "ca.islandora.syn.settings.Token");
         }
         return digester;
     }
@@ -172,8 +172,8 @@ private static Algorithm getHmacAlgorithm(final Site site) {
         }
     }
 
-    private static Sites getSites(final InputStream settings) {
-        Sites sites;
+    private static Config getSites(final InputStream settings) {
+        Config sites;
 
         try {
             sites = getSitesObject(settings);
@@ -192,7 +192,7 @@ private static Sites getSites(final InputStream settings) {
 
     public static Map<String, Algorithm> getSiteAlgorithms(final InputStream settings) {
         final Map<String, Algorithm> algorithms = new HashMap<>();
-        final Sites sites = getSites(settings);
+        final Config sites = getSites(settings);
         if (sites == null) {
             return algorithms;
         }
@@ -251,7 +251,7 @@ public static Map<String, Algorithm> getSiteAlgorithms(final InputStream setting
 
     public static Map<String, Token> getSiteStaticTokens(final InputStream settings) {
         final Map<String, Token> tokens = new HashMap<>();
-        final Sites sites = getSites(settings);
+        final Config sites = getSites(settings);
         if (sites == null) {
             return tokens;
         }
@@ -267,8 +267,8 @@ public static Map<String, Token> getSiteStaticTokens(final InputStream settings)
         return tokens;
     }
 
-    static Sites getSitesObject(final InputStream settings)
+    static Config getSitesObject(final InputStream settings)
             throws IOException, SAXException {
-        return (Sites) getDigester().parse(settings);
+        return (Config) getDigester().parse(settings);
     }
 }
diff --git a/src/test/java/ca/islandora/syn/settings/SettingsParserAlgorithmsTest.java b/src/test/java/ca/islandora/syn/settings/SettingsParserAlgorithmsTest.java
index a4e0fd9..cc85c34 100644
--- a/src/test/java/ca/islandora/syn/settings/SettingsParserAlgorithmsTest.java
+++ b/src/test/java/ca/islandora/syn/settings/SettingsParserAlgorithmsTest.java
@@ -18,11 +18,11 @@ public class SettingsParserAlgorithmsTest {
 
     private void testOneSiteHmacInlineKey(final String algorithm) throws Exception {
         final String testXml = String.join("\n"
-                , "<sites version='1'>"
+                , "<config version='1'>"
                 , "  <site url='http://test.com' algorithm='" + algorithm + "' encoding='plain'>"
                 , "   test data"
                 , "  </site>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
@@ -42,11 +42,11 @@ public void testOneSiteAllHmacInlineKey() throws Exception {
     @Test
     public void testInvalidSitesVersion() throws Exception {
         final String testXml = String.join("\n"
-                , "<sites version='2'>"
+                , "<config version='2'>"
                 , "  <site url='http://test.com' algorithm='HS384' encoding='plain'>"
                 , "   test data"
                 , "  </site>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
@@ -57,11 +57,11 @@ public void testInvalidSitesVersion() throws Exception {
     @Test
     public void testOneSiteHmacBase64() throws Exception {
         final String testXml = String.join("\n"
-                , "<sites version='1'>"
+                , "<config version='1'>"
                 , "  <site url='http://test.com' algorithm='HS256' encoding='base64'>"
                 , "   am9uYXRoYW4gaXMgYXdlc29tZQ=="
                 , "  </site>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
@@ -72,11 +72,11 @@ public void testOneSiteHmacBase64() throws Exception {
     @Test
     public void testOneSiteHmacInvalidBase64() throws Exception {
         final String testXml = String.join("\n"
-                , "<sites version='1'>"
+                , "<config version='1'>"
                 , "  <site url='http://test.com' algorithm='HS256' encoding='base64'>"
                 , "   this is invalid base64"
                 , "  </site>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
@@ -87,11 +87,11 @@ public void testOneSiteHmacInvalidBase64() throws Exception {
     @Test
     public void testOneSiteHmacInvalidEncoding() throws Exception {
         final String testXml = String.join("\n"
-                , "<sites version='1'>"
+                , "<config version='1'>"
                 , "  <site url='http://test.com' algorithm='HS256' encoding='badalgorithm'>"
                 , "   this is invalid base64"
                 , "  </site>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
@@ -104,9 +104,9 @@ private void testOneSiteHmacFileKey(final String algorithm) throws Exception {
         final String path = key.getAbsolutePath();
 
         final String testXml = String.join("\n"
-                , "<sites version='1'>"
+                , "<config version='1'>"
                 , "  <site url='http://test.com' algorithm='" + algorithm + "' encoding='plain' path='" + path + "'/>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
@@ -126,11 +126,11 @@ public void testOneSiteAllHmacFileKey() throws Exception {
     @Test
     public void testSiteBothInlineAndPath() throws Exception {
         final String testXml = String.join("\n"
-                , "<sites version='1'>"
+                , "<config version='1'>"
                 , "  <site url='http://test.com' algorithm='HS384' encoding='plain' path='foo'>"
                 , "   test data"
                 , "  </site>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
@@ -141,9 +141,9 @@ public void testSiteBothInlineAndPath() throws Exception {
     @Test
     public void testSiteNeitherInlineAndPath() throws Exception {
         final String testXml = String.join("\n"
-                , "<sites version='1'>"
+                , "<config version='1'>"
                 , "  <site url='http://test.com' algorithm='HS384' encoding='plain'/>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
@@ -154,9 +154,9 @@ public void testSiteNeitherInlineAndPath() throws Exception {
     @Test
     public void testSiteInvalidPath() throws Exception {
         final String testXml = String.join("\n"
-                , "<sites version='1'>"
+                , "<config version='1'>"
                 , "  <site url='http://test.com' algorithm='HS384' encoding='plain' path='foo'/>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
@@ -167,11 +167,11 @@ public void testSiteInvalidPath() throws Exception {
     @Test
     public void testSiteNoUrlDefault() throws Exception {
         final String testXml = String.join("\n"
-                , "<sites version='1'>"
+                , "<config version='1'>"
                 , "  <site algorithm='HS256' encoding='plain' default='true'>"
                 , "   test data"
                 , "  </site>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
@@ -181,7 +181,7 @@ public void testSiteNoUrlDefault() throws Exception {
 
     private void testOneSiteRsaInlineKey(final String algorithm) throws Exception {
         final String testXml = String.join("\n"
-                , "<sites version='1'>"
+                , "<config version='1'>"
                 , "  <site url='http://test.com' algorithm='" + algorithm + "' encoding='PEM'>"
                 , "-----BEGIN PUBLIC KEY-----"
                 , "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDEVO4MNlZG+iGYhoJd/cBpfMd9"
@@ -190,7 +190,7 @@ private void testOneSiteRsaInlineKey(final String algorithm) throws Exception {
                 , "KOT4nEF7MBGyOSP3KQIDAQAB"
                 , "-----END PUBLIC KEY-----"
                 , "  </site>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
@@ -223,9 +223,9 @@ private void testOneSiteRsaFileKey(final String algorithm) throws Exception {
         Files.write(Paths.get(path), pemPublicKey.getBytes());
 
         final String testXml = String.join("\n"
-                , "<sites version='1'>"
+                , "<config version='1'>"
                 , "  <site url='http://test.com' algorithm='" + algorithm + "' encoding='PEM' path='" + path + "'/>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
@@ -245,11 +245,11 @@ public void testOneSiteAllRsaFileKey() throws Exception {
     @Test
     public void testOneSiteAllRsaInvalidEncoding() throws Exception {
         final String testXml = String.join("\n"
-                , "<sites version='1'>"
+                , "<config version='1'>"
                 , "  <site url='http://test.com' algorithm='RS256' encoding='PEM'>"
                 , "-----BEGIN PUBLIC KEY-----"
                 , "  </site>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
diff --git a/src/test/java/ca/islandora/syn/settings/SettingsParserDigestTest.java b/src/test/java/ca/islandora/syn/settings/SettingsParserDigestTest.java
index 2c23b71..91d4249 100644
--- a/src/test/java/ca/islandora/syn/settings/SettingsParserDigestTest.java
+++ b/src/test/java/ca/islandora/syn/settings/SettingsParserDigestTest.java
@@ -15,13 +15,13 @@ public class SettingsParserDigestTest {
     @Test
     public void testOneSitePath() throws Exception {
         final String testXml = String.join("\n"
-            , "<sites version=\"12\">"
+            , "<config version=\"12\">"
             , "  <site url=\"http://test.com\" algorithm=\"RS384\" path=\"test/path.key\" encoding=\"PEM\"/>"
-            , "</sites>"
+            , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
-        final Sites settings = SettingsParser.getSitesObject(stream);
+        final Config settings = SettingsParser.getSitesObject(stream);
         assertEquals(12, settings.getVersion());
         assertEquals(1, settings.getSites().size());
 
@@ -37,16 +37,16 @@ public void testOneSitePath() throws Exception {
     @Test
     public void testOneSiteKey() throws Exception {
         final String testXml = String.join("\n"
-                , "<sites>"
+                , "<config>"
                 , "  <site url=\"http://test.com\" algorithm=\"RS384\" encoding=\"PEM\" default=\"true\">"
                 , "multiline"
                 , "key"
                 , "  </site>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
-        final Sites settings = SettingsParser.getSitesObject(stream);
+        final Config settings = SettingsParser.getSitesObject(stream);
         assertEquals(-1, settings.getVersion());
         assertEquals(1, settings.getSites().size());
 
@@ -62,38 +62,38 @@ public void testOneSiteKey() throws Exception {
     @Test
     public void testTwoSites() throws Exception {
         final String testXml = String.join("\n"
-                , "<sites>"
+                , "<config>"
                 , "  <site/>"
                 , "  <site/>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
-        final Sites settings = SettingsParser.getSitesObject(stream);
+        final Config settings = SettingsParser.getSitesObject(stream);
         assertEquals(2, settings.getSites().size());
     }
 
     @Test
     public void testOneSiteUnexpectedAttribute() throws Exception {
         final String testXml = String.join("\n"
-                , "<sites>"
+                , "<config>"
                 , "  <site unexpected=\"woh\"/>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
-        final Sites settings = SettingsParser.getSitesObject(stream);
+        final Config settings = SettingsParser.getSitesObject(stream);
     }
 
     @Test
     public void testOneSiteUnexpectedTag() throws Exception {
         final String testXml = String.join("\n"
-                , "<sites>"
+                , "<config>"
                 , "  <islandora/>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
-        final Sites settings = SettingsParser.getSitesObject(stream);
+        final Config settings = SettingsParser.getSitesObject(stream);
     }
 }
diff --git a/src/test/java/ca/islandora/syn/settings/SettingsParserTokenTest.java b/src/test/java/ca/islandora/syn/settings/SettingsParserTokenTest.java
index 2cf50a1..85f1513 100644
--- a/src/test/java/ca/islandora/syn/settings/SettingsParserTokenTest.java
+++ b/src/test/java/ca/islandora/syn/settings/SettingsParserTokenTest.java
@@ -12,11 +12,11 @@ public class SettingsParserTokenTest {
     @Test
     public void testInvalidVersion() throws Exception {
         final String testXml = String.join("\n"
-                , "<sites version='2'>"
+                , "<config version='2'>"
                 , "  <token>"
                 , "   c00lpazzward"
                 , "  </token>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
@@ -27,11 +27,11 @@ public void testInvalidVersion() throws Exception {
     @Test
     public void testTokenNoParams() throws Exception {
         final String testXml = String.join("\n"
-                , "<sites version='1'>"
+                , "<config version='1'>"
                 , "  <token>"
                 , "   c00lpazzward"
                 , "  </token>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
@@ -46,11 +46,11 @@ public void testTokenNoParams() throws Exception {
     @Test
     public void testTokenUser() throws Exception {
         final String testXml = String.join("\n"
-                , "<sites version='1'>"
+                , "<config version='1'>"
                 , "  <token user='denis'>"
                 , "   c00lpazzward"
                 , "  </token>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
@@ -63,11 +63,11 @@ public void testTokenUser() throws Exception {
     @Test
     public void testTokenRole() throws Exception {
         final String testXml = String.join("\n"
-                , "<sites version='1'>"
+                , "<config version='1'>"
                 , "  <token roles='role1,role2,role3'>"
                 , "   c00lpazzward"
                 , "  </token>"
-                , "</sites>"
+                , "</config>"
         );
 
         final InputStream stream = new ByteArrayInputStream(testXml.getBytes());
diff --git a/src/test/java/ca/islandora/syn/settings/SitesTest.java b/src/test/java/ca/islandora/syn/settings/SitesTest.java
index e63beda..22ca6da 100644
--- a/src/test/java/ca/islandora/syn/settings/SitesTest.java
+++ b/src/test/java/ca/islandora/syn/settings/SitesTest.java
@@ -7,7 +7,7 @@ public class SitesTest {
 
     @Test
     public void TestJwtSites() {
-        final Sites sites = new Sites();
+        final Config sites = new Config();
         assertEquals(-1, sites.getVersion());
         sites.setVersion(2);
         assertEquals(2,sites.getVersion());
@@ -21,7 +21,7 @@ public void TestJwtSites() {
 
     @Test
     public void TestToken() {
-        final Sites sites = new Sites();
+        final Config sites = new Config();
         final Token token = new Token();
         assertEquals(0, sites.getTokens().size());
         sites.addToken(token);
diff --git a/src/test/java/ca/islandora/syn/valves/SynValveTest.java b/src/test/java/ca/islandora/syn/valves/SynValveTest.java
index 7aa396c..009d7e5 100644
--- a/src/test/java/ca/islandora/syn/valves/SynValveTest.java
+++ b/src/test/java/ca/islandora/syn/valves/SynValveTest.java
@@ -284,11 +284,11 @@ public void shouldFailAuthBecauseNoSiteMatch() throws Exception {
                 .thenReturn("Bearer " + token);
 
         final String testXml = String.join("\n"
-                , "<sites version='1'>"
+                , "<config version='1'>"
                 , "  <site url='http://test.com' algorithm='HS256' encoding='plain'>"
                 , "secret"
                 , "  </site>"
-                , "</sites>"
+                , "</config>"
         );
         Files.write(Paths.get(this.settings.getAbsolutePath()), testXml.getBytes());
 
@@ -301,7 +301,7 @@ public void shouldFailAuthBecauseNoSiteMatch() throws Exception {
 
     private void createSettings(final File settingsFile) throws Exception {
         final String testXml = String.join("\n"
-                , "<sites version='1'>"
+                , "<config version='1'>"
                 , "  <site url='http://test.com' algorithm='HS256' encoding='plain'>"
                 , "secret"
                 , "  </site>"
@@ -311,7 +311,7 @@ private void createSettings(final File settingsFile) throws Exception {
                 , "  <token>"
                 , "1337"
                 , "  </token>"
-                , "</sites>"
+                , "</config>"
         );
         Files.write(Paths.get(settingsFile.getAbsolutePath()), testXml.getBytes());
     }