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

kaizimmerm · 2017-05-23T08:52:29Z

One more step in repository refactoring (see #197). I split software and distribution set management for type and instance management (more splits will follow e.g. TagManagement).

Another topic that is constantly bugging many hawkBit developers is the chaos we introduced with using a wide array of utility libraries. You can basically see in code which dev prefers apache or spring utils or Apache commons or JDK stuff.

This cannot be fixed over night. But I documented in the contributors guide a recommended priority and refactored the code base by means of the "low hanging fruits" to implement the new guideline.

I think in the long run we should be able to get rid of Apache commons and reduce guava to use cases where it actually makes sense. Spring utils imho can be used freely, hawkBit is based on Spring and will continue to do so.

Let me know what you think.

Reviewers: @sirwayne @melanieretter

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

Conflicts: hawkbit-dmf/hawkbit-dmf-amqp/src/test/java/org/eclipse/hawkbit/integration/AmqpMessageHandlerServiceIntegrationTest.java hawkbit-repository/hawkbit-repository-jpa/src/test/java/org/eclipse/hawkbit/repository/jpa/ReportManagementTest.java

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

Conflicts: hawkbit-repository/hawkbit-repository-core/pom.xml hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/RepositoryApplicationConfiguration.java

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

melanieretter · 2017-05-23T09:14:46Z

CONTRIBUTING.md

@@ -21,6 +21,27 @@ Please read this if you intend to contribute to the project.
 * Sonarqube:
  * Our rule set can be found [here](https://sonar.ops.bosch-iot-rollouts.com/projects) with navigating to the tab "Quality Profiles", selecting "hawkBit", and then selecting "Actions" - "Back up"

+### Utility library usage
+
+hawkBit has currently both [guava](https://github.com/google/guava) and [Apache commons lang](https://commons.apache.org/proper/commons-lang/) on the classpath in several of its modules. However, we see introducing to many utility libraries problematic as we force these as transitive dependencies on hawkBit users. We in fact are looking into reducing them in future not adding new ones.


... introducing too many...

kaizimmerm · 2017-05-23T09:22:00Z

CQ13563 for using caffeine cache instead of guava. Allows to keep guava out of core. Besides Boot will switch to Caffeine as default anyhow.

kaizimmerm · 2017-05-23T11:16:58Z

...t/src/main/java/org/eclipse/hawkbit/mgmt/client/resource/builder/DistributionSetBuilder.java

@@ -114,7 +113,7 @@ public DistributionSetBuilder description(final String description) {
     * @return a list of {@link MgmtDistributionSetRequestBodyPost}
     */
    public List<MgmtDistributionSetRequestBodyPost> buildAsList(final int offset, final int count) {
-        final ArrayList<MgmtDistributionSetRequestBodyPost> bodyList = Lists.newArrayList();


kaizimmerm · 2017-05-23T11:22:31Z

...t-dmf/hawkbit-dmf-amqp/src/main/java/org/eclipse/hawkbit/amqp/AmqpMessageHandlerService.java

@@ -240,7 +239,9 @@ private void updateActionStatus(final Message message) {
        final Action action = checkActionExist(message, actionUpdateStatus);

        final List<String> messages = actionUpdateStatus.getMessage();
-        if (ArrayUtils.isNotEmpty(message.getMessageProperties().getCorrelationId())) {
+
+        if (message.getMessageProperties().getCorrelationId() != null


Extract into method

kaizimmerm · 2017-05-23T11:41:11Z

hawkbit-security-core/src/test/java/org/eclipse/hawkbit/util/IpUtilTest.java

@@ -8,7 +8,6 @@
 */
 package org.eclipse.hawkbit.util;

-import static com.google.common.net.HttpHeaders.X_FORWARDED_FOR;


keep guava but on text scope

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

melanieretter · 2017-05-23T09:17:41Z

CONTRIBUTING.md

+  * use [guava](https://github.com/google/guava) if feasible
+  * use [Apache commons lang](https://commons.apache.org/proper/commons-lang/) if feasible
+
+Note that the guava project for instance often documents where they thing that JDK is having a similar functionality (e.g. their thoughts on  [Throwables.propagate](https://github.com/google/guava/wiki/Why-we-deprecated-Throwables.propagate)).


thing? Do you mean think?

melanieretter · 2017-05-23T13:07:30Z

hawkbit-core/src/test/java/org/eclipse/hawkbit/api/PropertyBasedArtifactUrlHandlerTest.java

-        assertEquals(Lists.newArrayList(
-                new ArtifactUrl("http".toUpperCase(), "download-http", HTTP_LOCALHOST + TENANT + "/controller/v1/"
-                        + CONTROLLER_ID + "/softwaremodules/" + SOFTWAREMODULEID + "/artifacts/" + FILENAME)),
+        assertEquals(


You use org.assertj.core.api.Assertions.assertThat and org.junit.Assert.assertEquals in this TestClass. I think it would be great to use the same Assert class where it is possible and avoid using different Assert classes.
E.g. in this case you could use
assertThat( Arrays.asList(new ArtifactUrl("http".toUpperCase(), "download-http", HTTP_LOCALHOST + TENANT + "/controller/v1/" + CONTROLLER_ID + "/softwaremodules/" + SOFTWAREMODULEID + "/artifacts/" + FILENAME_ENCODE))) .isEqualTo(ddiUrls);
This could be done in another pull request later on.

melanieretter · 2017-05-23T14:05:26Z

hawkbit-ui/src/main/java/org/eclipse/hawkbit/ui/components/SPUIComponentProvider.java

@@ -199,7 +198,7 @@ public static Panel getDistributionSetInfo(final DistributionSet distributionSet
     * @return Label
     */
    public static Label createNameValueLabel(final String label, final String... values) {
-        final String valueStr = StringUtils.join(Arrays.asList(values), " ");
+        final String valueStr = StringUtils.arrayToCommaDelimitedString(values);


Now the String is comma separated. The original was separated by a space character.

MelleD · 2017-05-24T13:28:47Z

...ource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtDownloadArtifactResource.java

@@ -39,7 +39,7 @@
 public class MgmtDownloadArtifactResource implements MgmtDownloadArtifactRestApi {

    @Autowired
-    private SoftwareManagement softwareManagement;
+    private SoftwareModuleManagement softwareManagement;


Rename ´softwareManagement´ to ´softwareModuleManagement´

MelleD · 2017-05-24T13:34:20Z

hawkbit-ddi-resource/src/main/java/org/eclipse/hawkbit/ddi/rest/resource/DdiRootController.java

@@ -82,7 +82,7 @@
    private ControllerManagement controllerManagement;

    @Autowired
-    private SoftwareManagement softwareManagement;
+    private SoftwareModuleManagement softwareManagement;


Rename softwareManagement to softwareModuleManagement

MelleD · 2017-05-24T13:35:18Z

...source/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtDistributionSetResource.java

@@ -63,7 +63,7 @@
    private static final Logger LOG = LoggerFactory.getLogger(MgmtDistributionSetResource.class);

    @Autowired
-    private SoftwareManagement softwareManagement;
+    private SoftwareModuleManagement softwareManagement;


Rename softwareManagement

MelleD · 2017-05-24T13:35:43Z

...ource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtDownloadArtifactResource.java

@@ -39,7 +39,7 @@
 public class MgmtDownloadArtifactResource implements MgmtDownloadArtifactRestApi {

    @Autowired
-    private SoftwareManagement softwareManagement;
+    private SoftwareModuleManagement softwareManagement;


Rename softwareManagement

MelleD · 2017-05-24T13:36:03Z

...esource/src/main/java/org/eclipse/hawkbit/mgmt/rest/resource/MgmtSoftwareModuleResource.java

@@ -57,7 +57,7 @@
    private ArtifactManagement artifactManagement;

    @Autowired
-    private SoftwareManagement softwareManagement;
+    private SoftwareModuleManagement softwareManagement;


Rename softwareManagement

MelleD · 2017-05-24T13:44:23Z

.../src/main/java/org/eclipse/hawkbit/repository/jpa/builder/JpaDistributionSetTypeBuilder.java

@@ -21,9 +21,9 @@
 */
 public class JpaDistributionSetTypeBuilder implements DistributionSetTypeBuilder {

-    private final SoftwareManagement softwareManagement;
+    private final SoftwareModuleManagement softwareManagement;


Rename softwareManagement

MelleD · 2017-05-24T13:44:37Z

...a/src/main/java/org/eclipse/hawkbit/repository/jpa/builder/JpaDistributionSetTypeCreate.java

@@ -26,9 +26,9 @@
 public class JpaDistributionSetTypeCreate extends AbstractDistributionSetTypeUpdateCreate<DistributionSetTypeCreate>
        implements DistributionSetTypeCreate {

-    private final SoftwareManagement softwareManagement;
+    private final SoftwareModuleManagement softwareManagement;


Rename softwareManagement

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

…nt_api

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

…sage (eclipse-hawkbit#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>

kaizimmerm added 13 commits May 18, 2017 10:03

Split DS management and reduce util usage.

8a7bfa9

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

Split sw module and type management.

6307ca0

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

Sonar issues.

b195145

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

Make sonar listen to the exception!

2690f93

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

Register both beans.

d2fc319

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

Split JPA implementations.

1ff1c39

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

Revert user details change.

76fcba9

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

Fix compilation errors.

9d3846e

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

Fix bean queries. Fix image path.

ac8ccd2

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

Merge branch 'master' into fix_split_management_api

cb909dd

Conflicts: hawkbit-repository/hawkbit-repository-core/pom.xml hawkbit-repository/hawkbit-repository-jpa/src/main/java/org/eclipse/hawkbit/repository/jpa/RepositoryApplicationConfiguration.java

Document preferred utility usage.

748a2e0

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

Fix exmaples and revert unintended checkin.

75a378d

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

melanieretter reviewed May 23, 2017

View reviewed changes

kaizimmerm commented May 23, 2017

View reviewed changes

kaizimmerm requested a review from MelleD May 23, 2017 11:47

Code cleanup.

26baeec

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

melanieretter suggested changes May 23, 2017

View reviewed changes

MelleD reviewed May 24, 2017

View reviewed changes

kaizimmerm added 2 commits May 25, 2017 07:31

Typos, readibility.

321ec23

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

Remove unused reference.

0983f5f

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

kaizimmerm added 4 commits May 31, 2017 17:13

Rollouts cache delete aware.

d233b52

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

Merge branch 'fix_rollout_cache_delete_aware' into fix_split_manageme…

128a9e8

…nt_api

Fix rolloutgroup delete event.

d7f5667

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

Add new RolloutGroupDeletedEvent event

f2f8198

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

kaizimmerm merged commit 67a4677 into eclipse-hawkbit:master Jun 1, 2017

kaizimmerm deleted the fix_split_management_api branch June 1, 2017 04:29

kinbod mentioned this pull request Jun 1, 2017

Split repository API for module and DS management. Refactor utility u… kinbod/hawkbit#7

Merged

kaizimmerm added this to the 0.2.0M4 milestone Feb 7, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

kaizimmerm commented May 23, 2017 •

edited

Loading

melanieretter May 23, 2017

kaizimmerm commented May 23, 2017

kaizimmerm May 23, 2017

kaizimmerm May 23, 2017

kaizimmerm May 23, 2017

melanieretter May 23, 2017

melanieretter May 23, 2017

melanieretter May 23, 2017

MelleD May 24, 2017 •

edited

Loading

MelleD May 24, 2017 •

edited

Loading

MelleD May 24, 2017

MelleD May 24, 2017

MelleD May 24, 2017

MelleD May 24, 2017

MelleD May 24, 2017

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

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

Conversation

kaizimmerm commented May 23, 2017 • edited Loading

Choose a reason for hiding this comment

kaizimmerm commented May 23, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MelleD May 24, 2017 • edited Loading

Choose a reason for hiding this comment

MelleD May 24, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kaizimmerm commented May 23, 2017 •

edited

Loading

MelleD May 24, 2017 •

edited

Loading

MelleD May 24, 2017 •

edited

Loading