Split repository API for module and DS management. Refactor utility usage (#524)

* Split DS management and reduce util usage. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Split sw module and type management. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Sonar issues. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Make sonar listen to the exception! Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Register both beans. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Split JPA implementations. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Revert user details change. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fix compilation errors. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fix bean queries. Fix image path. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Document preferred utility usage. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fix exmaples and revert unintended checkin. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Code cleanup. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Typos, readibility. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Remove unused reference. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Rollouts cache delete aware. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Fix rolloutgroup delete event. Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com> * Add new RolloutGroupDeletedEvent event Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>
2017-06-01 06:28:59 +02:00
parent 0ab995d1a4
commit 67a4677ef6
203 changed files with 2738 additions and 2320 deletions
--- a/hawkbit-core/src/main/java/org/eclipse/hawkbit/api/ArtifactUrlHandlerProperties.java
+++ b/hawkbit-core/src/main/java/org/eclipse/hawkbit/api/ArtifactUrlHandlerProperties.java
@@ -8,6 +8,7 @@
 */
 package org.eclipse.hawkbit.api;

+import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
@@ -15,8 +16,6 @@ import java.util.Map;

 import org.springframework.boot.context.properties.ConfigurationProperties;

-import com.google.common.collect.Lists;
-
 /**
 * Artifact handler properties class for holding all supported protocols with
 * host, ip, port and download pattern.
@@ -85,7 +84,7 @@ public class ArtifactUrlHandlerProperties {
        /**
         * Support for the following hawkBit API.
         */
-        private List<ApiType> supports = Lists.newArrayList(ApiType.DDI, ApiType.DMF);
+        private List<ApiType> supports = Arrays.asList(ApiType.DDI, ApiType.DMF);

        public boolean isEnabled() {
            return enabled;
--- a/hawkbit-core/src/main/java/org/eclipse/hawkbit/api/PropertyBasedArtifactUrlHandler.java
+++ b/hawkbit-core/src/main/java/org/eclipse/hawkbit/api/PropertyBasedArtifactUrlHandler.java
@@ -8,7 +8,12 @@
 */
 package org.eclipse.hawkbit.api;

+import java.io.UnsupportedEncodingException;
 import java.net.URI;
+import java.net.URLEncoder;
+import java.nio.charset.StandardCharsets;
+import java.util.Arrays;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
@@ -17,12 +22,9 @@ import java.util.Set;
 import java.util.stream.Collectors;

 import org.eclipse.hawkbit.api.ArtifactUrlHandlerProperties.UrlProtocol;
-
-import com.google.common.base.Joiner;
-import com.google.common.base.Splitter;
-import com.google.common.base.Strings;
-import com.google.common.collect.Maps;
-import com.google.common.net.UrlEscapers;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.util.StringUtils;

 /**
 * Implementation for ArtifactUrlHandler for creating urls to download resource
@@ -43,6 +45,8 @@ import com.google.common.net.UrlEscapers;
 */
 public class PropertyBasedArtifactUrlHandler implements ArtifactUrlHandler {

+    private static final Logger LOG = LoggerFactory.getLogger(PropertyBasedArtifactUrlHandler.class);
+
    private static final String PROTOCOL_PLACEHOLDER = "protocol";
    private static final String CONTROLLER_ID_PLACEHOLDER = "controllerId";
    private static final String TARGET_ID_BASE10_PLACEHOLDER = "targetId";
@@ -99,7 +103,7 @@ public class PropertyBasedArtifactUrlHandler implements ArtifactUrlHandler {
        for (final Entry<String, String> entry : entrySet) {
            if (entry.getKey().equals(PORT_PLACEHOLDER)) {
                urlPattern = urlPattern.replace(":{" + entry.getKey() + "}",
-                        Strings.isNullOrEmpty(entry.getValue()) ? "" : (":" + entry.getValue()));
+                        StringUtils.isEmpty(entry.getValue()) ? "" : (":" + entry.getValue()));
            } else {
                urlPattern = urlPattern.replace("{" + entry.getKey() + "}", entry.getValue());
            }
@@ -109,7 +113,7 @@ public class PropertyBasedArtifactUrlHandler implements ArtifactUrlHandler {

    private static Map<String, String> getReplaceMap(final UrlProtocol protocol, final URLPlaceholder placeholder,
            final URI requestUri) {
-        final Map<String, String> replaceMap = Maps.newHashMapWithExpectedSize(19);
+        final Map<String, String> replaceMap = new HashMap<>();
        replaceMap.put(IP_PLACEHOLDER, protocol.getIp());
        replaceMap.put(HOSTNAME_PLACEHOLDER, protocol.getHostname());

@@ -117,8 +121,13 @@ public class PropertyBasedArtifactUrlHandler implements ArtifactUrlHandler {
        replaceMap.put(PORT_REQUEST_PLACEHOLDER, getRequestPort(protocol, requestUri));
        replaceMap.put(HOSTNAME_WITH_DOMAIN_REQUEST_PLACEHOLDER, computeHostWithRequestDomain(protocol, requestUri));

-        replaceMap.put(ARTIFACT_FILENAME_PLACEHOLDER,
-                UrlEscapers.urlFragmentEscaper().escape(placeholder.getSoftwareData().getFilename()));
+        try {
+            replaceMap.put(ARTIFACT_FILENAME_PLACEHOLDER,
+                    URLEncoder.encode(placeholder.getSoftwareData().getFilename(), StandardCharsets.UTF_8.toString()));
+        } catch (final UnsupportedEncodingException e) {
+            LOG.error("Could not encode {}", placeholder.getSoftwareData().getFilename(), e);
+        }
+
        replaceMap.put(ARTIFACT_SHA1_PLACEHOLDER, placeholder.getSoftwareData().getSha1Hash());
        replaceMap.put(PROTOCOL_PLACEHOLDER, protocol.getProtocol());
        replaceMap.put(PORT_PLACEHOLDER, getPort(protocol));
@@ -168,14 +177,14 @@ public class PropertyBasedArtifactUrlHandler implements ArtifactUrlHandler {
            return protocol.getHostname();
        }

-        final String host = Splitter.on('.').trimResults().omitEmptyStrings().splitToList(protocol.getHostname())
-                .get(0);
+        final String host = StringUtils.delimitedListToStringArray(protocol.getHostname(), ".")[0].trim();

-        final List<String> domainElements = Splitter.on('.').trimResults().omitEmptyStrings()
-                .splitToList(requestUri.getHost());
-        final String domain = Joiner.on(".").join(domainElements.subList(1, domainElements.size()));
+        final List<String> domainElements = Arrays
+                .asList(StringUtils.delimitedListToStringArray(requestUri.getHost(), "."));
+        final String domain = StringUtils.collectionToDelimitedString(domainElements.subList(1, domainElements.size()),
+                ".");

-        if (Strings.isNullOrEmpty(domain)) {
+        if (StringUtils.isEmpty(domain)) {
            return protocol.getHostname();
        }

--- a/hawkbit-core/src/main/java/org/eclipse/hawkbit/tenancy/configuration/InvalidTenantConfigurationKeyException.java
+++ b/hawkbit-core/src/main/java/org/eclipse/hawkbit/tenancy/configuration/InvalidTenantConfigurationKeyException.java
@@ -8,8 +8,8 @@
 */
 package org.eclipse.hawkbit.tenancy.configuration;

-import org.eclipse.hawkbit.exception.SpServerError;
 import org.eclipse.hawkbit.exception.AbstractServerRtException;
+import org.eclipse.hawkbit.exception.SpServerError;

 /**
 * The {@link #InvalidTenantConfigurationKeyException} is thrown when an invalid
--- a/hawkbit-core/src/main/java/org/eclipse/hawkbit/tenancy/configuration/validator/TenantConfigurationValidatorException.java
+++ b/hawkbit-core/src/main/java/org/eclipse/hawkbit/tenancy/configuration/validator/TenantConfigurationValidatorException.java
@@ -8,8 +8,8 @@
 */
 package org.eclipse.hawkbit.tenancy.configuration.validator;

-import org.eclipse.hawkbit.exception.SpServerError;
 import org.eclipse.hawkbit.exception.AbstractServerRtException;
+import org.eclipse.hawkbit.exception.SpServerError;

 /**
 * Exception which is thrown, when the validation of the configuration value has
--- a/hawkbit-core/src/test/java/org/eclipse/hawkbit/api/PropertyBasedArtifactUrlHandlerTest.java
+++ b/hawkbit-core/src/test/java/org/eclipse/hawkbit/api/PropertyBasedArtifactUrlHandlerTest.java
@@ -9,10 +9,10 @@
 package org.eclipse.hawkbit.api;

 import static org.assertj.core.api.Assertions.assertThat;
-import static org.junit.Assert.assertEquals;

 import java.net.URI;
 import java.net.URISyntaxException;
+import java.util.Arrays;
 import java.util.List;

 import org.eclipse.hawkbit.api.ArtifactUrlHandlerProperties.UrlProtocol;
@@ -22,8 +22,6 @@ import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.mockito.runners.MockitoJUnitRunner;

-import com.google.common.collect.Lists;
-
 import ru.yandex.qatools.allure.annotations.Description;
 import ru.yandex.qatools.allure.annotations.Features;
 import ru.yandex.qatools.allure.annotations.Stories;
@@ -41,7 +39,8 @@ public class PropertyBasedArtifactUrlHandlerTest {

    private static final long TENANT_ID = 456789L;
    private static final String CONTROLLER_ID = "Test";
-    private static final String FILENAME = "Afile1234";
+    private static final String FILENAME_DECODE = "test123!§$%&";
+    private static final String FILENAME_ENCODE = "test123%21%C2%A7%24%25%26";
    private static final long SOFTWAREMODULEID = 87654L;
    private static final long TARGETID = 3474366L;
    private static final String TARGETID_BASE62 = "EZqA";
@@ -57,7 +56,7 @@ public class PropertyBasedArtifactUrlHandlerTest {
    private ArtifactUrlHandlerProperties properties;

    private static URLPlaceholder placeholder = new URLPlaceholder(TENANT, TENANT_ID, CONTROLLER_ID, TARGETID,
-            new SoftwareData(SOFTWAREMODULEID, FILENAME, ARTIFACTID, SHA1HASH));
+            new SoftwareData(SOFTWAREMODULEID, FILENAME_DECODE, ARTIFACTID, SHA1HASH));

    @Before
    public void setup() {
@@ -72,13 +71,12 @@ public class PropertyBasedArtifactUrlHandlerTest {
        properties.getProtocols().put("download-http", new UrlProtocol());

        final List<ArtifactUrl> ddiUrls = urlHandlerUnderTest.getUrls(placeholder, ApiType.DDI);
-        assertEquals(Lists.newArrayList(
+        assertThat(ddiUrls).containsExactly(
                new ArtifactUrl("http".toUpperCase(), "download-http", HTTP_LOCALHOST + TENANT + "/controller/v1/"
-                        + CONTROLLER_ID + "/softwaremodules/" + SOFTWAREMODULEID + "/artifacts/" + FILENAME)),
-                ddiUrls);
+                        + CONTROLLER_ID + "/softwaremodules/" + SOFTWAREMODULEID + "/artifacts/" + FILENAME_ENCODE));

        final List<ArtifactUrl> dmfUrls = urlHandlerUnderTest.getUrls(placeholder, ApiType.DMF);
-        assertEquals(ddiUrls, dmfUrls);
+        assertThat(ddiUrls).isEqualTo(dmfUrls);
    }

    @Test
@@ -89,7 +87,7 @@ public class PropertyBasedArtifactUrlHandlerTest {
        proto.setPort(5683);
        proto.setProtocol(TEST_PROTO);
        proto.setRel(TEST_REL);
-        proto.setSupports(Lists.newArrayList(ApiType.DMF));
+        proto.setSupports(Arrays.asList(ApiType.DMF));
        proto.setRef("{protocol}://{ip}:{port}/fw/{tenant}/{controllerId}/sha1/{artifactSHA1}");
        properties.getProtocols().put(TEST_PROTO, proto);

@@ -98,8 +96,8 @@ public class PropertyBasedArtifactUrlHandlerTest {
        assertThat(urls).isEmpty();
        urls = urlHandlerUnderTest.getUrls(placeholder, ApiType.DMF);

-        assertEquals(Lists.newArrayList(new ArtifactUrl(TEST_PROTO.toUpperCase(), TEST_REL,
-                "coap://127.0.0.1:5683/fw/" + TENANT + "/" + CONTROLLER_ID + "/sha1/" + SHA1HASH)), urls);
+        assertThat(urls).containsExactly(new ArtifactUrl(TEST_PROTO.toUpperCase(), TEST_REL,
+                "coap://127.0.0.1:5683/fw/" + TENANT + "/" + CONTROLLER_ID + "/sha1/" + SHA1HASH));
    }

    @Test
@@ -110,7 +108,7 @@ public class PropertyBasedArtifactUrlHandlerTest {
        proto.setPort(5683);
        proto.setProtocol(TEST_PROTO);
        proto.setRel(TEST_REL);
-        proto.setSupports(Lists.newArrayList(ApiType.DMF));
+        proto.setSupports(Arrays.asList(ApiType.DMF));
        proto.setRef("{protocol}://{ip}:{port}/fws/{tenant}/{targetIdBase62}/{artifactIdBase62}");
        properties.getProtocols().put("ftp", proto);

@@ -119,9 +117,8 @@ public class PropertyBasedArtifactUrlHandlerTest {
        assertThat(urls).isEmpty();
        urls = urlHandlerUnderTest.getUrls(placeholder, ApiType.DMF);

-        assertEquals(Lists.newArrayList(new ArtifactUrl(TEST_PROTO.toUpperCase(), TEST_REL,
-                TEST_PROTO + "://127.0.0.1:5683/fws/" + TENANT + "/" + TARGETID_BASE62 + "/" + ARTIFACTID_BASE62)),
-                urls);
+        assertThat(urls).containsExactly(new ArtifactUrl(TEST_PROTO.toUpperCase(), TEST_REL,
+                TEST_PROTO + "://127.0.0.1:5683/fws/" + TENANT + "/" + TARGETID_BASE62 + "/" + ARTIFACTID_BASE62));
    }

    @Test
@@ -134,15 +131,15 @@ public class PropertyBasedArtifactUrlHandlerTest {
        proto.setPort(5683);
        proto.setProtocol(TEST_PROTO);
        proto.setRel(TEST_REL);
-        proto.setSupports(Lists.newArrayList(ApiType.DDI));
+        proto.setSupports(Arrays.asList(ApiType.DDI));
        proto.setRef("{protocol}://{hostnameRequest}:{port}/fws/{tenant}/{targetIdBase62}/{artifactIdBase62}");
        properties.getProtocols().put("ftp", proto);

        final List<ArtifactUrl> urls = urlHandlerUnderTest.getUrls(placeholder, ApiType.DDI,
                new URI("https://" + testHost));

-        assertEquals(Lists.newArrayList(new ArtifactUrl(TEST_PROTO.toUpperCase(), TEST_REL, TEST_PROTO + "://"
-                + testHost + ":5683/fws/" + TENANT + "/" + TARGETID_BASE62 + "/" + ARTIFACTID_BASE62)), urls);
+        assertThat(urls).containsExactly(new ArtifactUrl(TEST_PROTO.toUpperCase(), TEST_REL, TEST_PROTO + "://"
+                + testHost + ":5683/fws/" + TENANT + "/" + TARGETID_BASE62 + "/" + ARTIFACTID_BASE62));
    }

    @Test
@@ -156,16 +153,16 @@ public class PropertyBasedArtifactUrlHandlerTest {

        final List<ArtifactUrl> ddiUrls = urlHandlerUnderTest.getUrls(placeholder, ApiType.DDI,
                new URI("http://anotherHost.com:8083"));
-        assertEquals(Lists.newArrayList(new ArtifactUrl("http".toUpperCase(), "download-http",
+
+        assertThat(ddiUrls).containsExactly(new ArtifactUrl("http".toUpperCase(), "download-http",
                "http://localhost:8083/" + TENANT + "/controller/v1/" + CONTROLLER_ID + "/softwaremodules/"
-                        + SOFTWAREMODULEID + "/artifacts/" + FILENAME)),
-                ddiUrls);
+                        + SOFTWAREMODULEID + "/artifacts/" + FILENAME_ENCODE));

        final List<ArtifactUrl> dmfUrls = urlHandlerUnderTest.getUrls(placeholder, ApiType.DMF);
-        assertEquals(Lists.newArrayList(new ArtifactUrl("http".toUpperCase(), "download-http",
+
+        assertThat(dmfUrls).containsExactly(new ArtifactUrl("http".toUpperCase(), "download-http",
                "http://localhost:8080/" + TENANT + "/controller/v1/" + CONTROLLER_ID + "/softwaremodules/"
-                        + SOFTWAREMODULEID + "/artifacts/" + FILENAME)),
-                dmfUrls);
+                        + SOFTWAREMODULEID + "/artifacts/" + FILENAME_ENCODE));
    }

    @Test
@@ -180,15 +177,14 @@ public class PropertyBasedArtifactUrlHandlerTest {

        final List<ArtifactUrl> ddiUrls = urlHandlerUnderTest.getUrls(placeholder, ApiType.DDI,
                new URI("http://anotherHost.com:8083"));
-        assertEquals(Lists.newArrayList(
+        assertThat(ddiUrls).containsExactly(
                new ArtifactUrl("http".toUpperCase(), "download-http", "http://host.com/" + TENANT + "/controller/v1/"
-                        + CONTROLLER_ID + "/softwaremodules/" + SOFTWAREMODULEID + "/artifacts/" + FILENAME)),
-                ddiUrls);
+                        + CONTROLLER_ID + "/softwaremodules/" + SOFTWAREMODULEID + "/artifacts/" + FILENAME_ENCODE));

        final List<ArtifactUrl> dmfUrls = urlHandlerUnderTest.getUrls(placeholder, ApiType.DMF);
-        assertEquals(Lists.newArrayList(new ArtifactUrl("http".toUpperCase(), "download-http",
+        assertThat(dmfUrls).containsExactly(new ArtifactUrl("http".toUpperCase(), "download-http",
                "http://host.bumlux.net/" + TENANT + "/controller/v1/" + CONTROLLER_ID + "/softwaremodules/"
-                        + SOFTWAREMODULEID + "/artifacts/" + FILENAME)),
-                dmfUrls);
+                        + SOFTWAREMODULEID + "/artifacts/" + FILENAME_ENCODE));
+
    }
 }