You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by tm...@apache.org on 2022/02/22 09:42:57 UTC
[sling-org-apache-sling-distribution-core] branch master updated: SLING-11154 - Implement DistributionResponse#getDistributionInfo (#56)
This is an automated email from the ASF dual-hosted git repository.
tmaret pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-distribution-core.git
The following commit(s) were added to refs/heads/master by this push:
new 82c9286 SLING-11154 - Implement DistributionResponse#getDistributionInfo (#56)
82c9286 is described below
commit 82c9286f648bc89a129454bc6c0848cbd342446a
Author: Amit Jain <am...@apache.org>
AuthorDate: Tue Feb 22 15:12:51 2022 +0530
SLING-11154 - Implement DistributionResponse#getDistributionInfo (#56)
* Add DistributionResponseInfo object to implementations of DistributionResponse
* Add package id in the item properties returned from the queue resource provider
* Update org.apache.sling.distribution.api to released version 0.6.0
* Added `@Nonnull` annotation to #getDistributionInfo
---
pom.xml | 2 +-
.../impl/CompositeDistributionResponse.java | 30 ++++++-
.../impl/SimpleDistributionResponse.java | 30 +++++--
...xtendedDistributionServiceResourceProvider.java | 1 +
.../impl/DistributionResponseTest.java | 99 ++++++++++++++++++++++
5 files changed, 154 insertions(+), 8 deletions(-)
diff --git a/pom.xml b/pom.xml
index bfef86a..5882ac0 100644
--- a/pom.xml
+++ b/pom.xml
@@ -245,7 +245,7 @@
<dependency>
<groupId>org.apache.sling</groupId>
<artifactId>org.apache.sling.distribution.api</artifactId>
- <version>0.4.0</version>
+ <version>0.6.0</version>
</dependency>
<dependency>
<groupId>org.apache.sling</groupId>
diff --git a/src/main/java/org/apache/sling/distribution/impl/CompositeDistributionResponse.java b/src/main/java/org/apache/sling/distribution/impl/CompositeDistributionResponse.java
index 702494e..be48dea 100644
--- a/src/main/java/org/apache/sling/distribution/impl/CompositeDistributionResponse.java
+++ b/src/main/java/org/apache/sling/distribution/impl/CompositeDistributionResponse.java
@@ -20,9 +20,14 @@
package org.apache.sling.distribution.impl;
+import java.util.ArrayList;
import java.util.List;
+
+import javax.annotation.Nonnull;
+
import org.apache.sling.distribution.DistributionRequestState;
import org.apache.sling.distribution.DistributionResponse;
+import org.apache.sling.distribution.DistributionResponseInfo;
import org.jetbrains.annotations.NotNull;
/**
@@ -38,6 +43,8 @@ public class CompositeDistributionResponse extends SimpleDistributionResponse {
private DistributionRequestState state;
private String message;
+
+ private DistributionResponseInfo info;
public CompositeDistributionResponse(List<DistributionResponse> distributionResponses, int packagesCount, long packagseSize, long exportTime) {
super(DistributionRequestState.DISTRIBUTED, null);
@@ -47,6 +54,7 @@ public class CompositeDistributionResponse extends SimpleDistributionResponse {
this.exportTime = exportTime;
if (distributionResponses.isEmpty()) {
state = DistributionRequestState.DROPPED;
+ this.info = DistributionResponseInfo.NONE;
} else {
state = DistributionRequestState.DISTRIBUTED;
StringBuilder messageBuilder = new StringBuilder("[");
@@ -57,6 +65,17 @@ public class CompositeDistributionResponse extends SimpleDistributionResponse {
int lof = messageBuilder.lastIndexOf(", ");
messageBuilder.replace(lof, lof + 2, "]");
message = messageBuilder.toString();
+ this.info = new DistributionResponseInfo() {
+ @NotNull @Override public String getId() {
+ List<String> ids = new ArrayList<>();
+ for (DistributionResponse response : distributionResponses) {
+ if (response.getDistributionInfo() != null) {
+ ids.add(response.getDistributionInfo().getId());
+ }
+ }
+ return ids.toString();
+ }
+ };
}
}
@@ -76,13 +95,20 @@ public class CompositeDistributionResponse extends SimpleDistributionResponse {
return message;
}
+ @Nonnull
+ @Override
+ public DistributionResponseInfo getDistributionInfo() {
+ return info;
+ }
+
@Override
public String toString() {
return "CompositeDistributionResponse{" +
- "isSuccesful=" + isSuccessful() +
+ "isSuccessful=" + isSuccessful() +
", state=" + state +
", message=" + message +
- '}';
+ ", info={id=" + info.getId() + "}" +
+ '}';
}
diff --git a/src/main/java/org/apache/sling/distribution/impl/SimpleDistributionResponse.java b/src/main/java/org/apache/sling/distribution/impl/SimpleDistributionResponse.java
index 730bb5d..b277fc0 100644
--- a/src/main/java/org/apache/sling/distribution/impl/SimpleDistributionResponse.java
+++ b/src/main/java/org/apache/sling/distribution/impl/SimpleDistributionResponse.java
@@ -19,10 +19,15 @@
package org.apache.sling.distribution.impl;
+import javax.annotation.Nonnull;
+
import org.apache.sling.distribution.DistributionRequestState;
import org.apache.sling.distribution.DistributionResponse;
+import org.apache.sling.distribution.DistributionResponseInfo;
import org.jetbrains.annotations.NotNull;
+import static org.apache.sling.distribution.DistributionResponseInfo.NONE;
+
/**
* Simple implementation of {@link DistributionResponse} where success is given by not being in FAILED state.
*
@@ -31,13 +36,21 @@ public class SimpleDistributionResponse implements DistributionResponse {
private final DistributionRequestState state;
private final String message;
+ private final DistributionResponseInfo info;
- public SimpleDistributionResponse(DistributionRequestState state, String message) {
-
+ public SimpleDistributionResponse(DistributionRequestState state, String message, DistributionResponseInfo info) {
this.state = state;
this.message = message;
+ if (info == null) {
+ info = NONE;
+ }
+ this.info = info;
}
-
+
+ public SimpleDistributionResponse(DistributionRequestState state, String message) {
+ this(state, message, NONE);
+ }
+
public boolean isSuccessful() {
return DistributionRequestState.ACCEPTED.equals(state) || DistributionRequestState.DISTRIBUTED.equals(state);
}
@@ -51,12 +64,19 @@ public class SimpleDistributionResponse implements DistributionResponse {
return message;
}
+ @Nonnull
+ @Override
+ public DistributionResponseInfo getDistributionInfo() {
+ return info;
+ }
+
@Override
public String toString() {
- return "CompositeDistributionResponse{" +
- "isSuccesful=" + isSuccessful() +
+ return "SimpleDistributionResponse{" +
+ "isSuccessful=" + isSuccessful() +
", state=" + state +
", message=" + message +
+ ", info={id=" + info.getId() + "}" +
'}';
}
diff --git a/src/main/java/org/apache/sling/distribution/resources/impl/ExtendedDistributionServiceResourceProvider.java b/src/main/java/org/apache/sling/distribution/resources/impl/ExtendedDistributionServiceResourceProvider.java
index d905a1c..464f485 100644
--- a/src/main/java/org/apache/sling/distribution/resources/impl/ExtendedDistributionServiceResourceProvider.java
+++ b/src/main/java/org/apache/sling/distribution/resources/impl/ExtendedDistributionServiceResourceProvider.java
@@ -202,6 +202,7 @@ public class ExtendedDistributionServiceResourceProvider extends DistributionSer
DistributionPackageInfo packageInfo = DistributionPackageUtils.fromQueueItem(item);
result.put("id", entry.getId());
+ result.put("pkgId", item.getPackageId());
result.put("size", item.getSize());
result.put("paths", packageInfo.getPaths());
result.put("action", packageInfo.getRequestType());
diff --git a/src/test/java/org/apache/sling/distribution/impl/DistributionResponseTest.java b/src/test/java/org/apache/sling/distribution/impl/DistributionResponseTest.java
new file mode 100644
index 0000000..124813a
--- /dev/null
+++ b/src/test/java/org/apache/sling/distribution/impl/DistributionResponseTest.java
@@ -0,0 +1,99 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.sling.distribution.impl;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import org.apache.sling.distribution.DistributionRequestState;
+import org.apache.sling.distribution.DistributionResponse;
+import org.apache.sling.distribution.DistributionResponseInfo;
+import org.jetbrains.annotations.NotNull;
+import org.junit.Test;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+
+public class DistributionResponseTest {
+ @Test
+ public void nullDistributionResponse() {
+ DistributionResponse res1 = new SimpleDistributionResponse(DistributionRequestState.DISTRIBUTED, "success", null);
+
+ assertNotNull(res1.getDistributionInfo());
+ assertEquals("", res1.getDistributionInfo().getId());
+
+ DistributionResponse res2 = new SimpleDistributionResponse(DistributionRequestState.ACCEPTED, "success", null);
+ List<DistributionResponse> responses = new ArrayList<>();
+ responses.add(res1);
+ responses.add(res2);
+ CompositeDistributionResponse compositeResponse = new CompositeDistributionResponse(responses, 2, 0, 0);
+ assertNotNull(compositeResponse.getDistributionInfo());
+ assertEquals(list("", "").toString(), compositeResponse.getDistributionInfo().getId());
+ }
+
+ @Test
+ public void emptyDistributionResponse() {
+ DistributionResponse res1 = new SimpleDistributionResponse(DistributionRequestState.DISTRIBUTED, "success");
+
+ assertNotNull(res1.getDistributionInfo());
+ assertEquals("", res1.getDistributionInfo().getId());
+
+ DistributionResponse res2 = new SimpleDistributionResponse(DistributionRequestState.ACCEPTED, "success");
+ List<DistributionResponse> responses = new ArrayList<>();
+ responses.add(res1);
+ responses.add(res2);
+ CompositeDistributionResponse compositeResponse = new CompositeDistributionResponse(responses, 2, 0, 0);
+ assertNotNull(compositeResponse.getDistributionInfo());
+ assertEquals(list("", "").toString(), compositeResponse.getDistributionInfo().getId());
+ }
+
+ @Test
+ public void nonEmptyDistributionResponse() {
+ DistributionResponse res1 = new SimpleDistributionResponse(DistributionRequestState.DISTRIBUTED, "success",
+ new DistributionResponseInfo() {
+ @NotNull @Override public String getId() {
+ return "res1";
+ }
+ });
+
+ assertNotNull(res1.getDistributionInfo());
+ assertEquals("res1", res1.getDistributionInfo().getId());
+
+ DistributionResponse res2 = new SimpleDistributionResponse(DistributionRequestState.ACCEPTED, "success",
+ new DistributionResponseInfo() {
+ @NotNull @Override public String getId() {
+ return "res2";
+ }
+ });
+ List<DistributionResponse> responses = new ArrayList<>();
+ responses.add(res1);
+ responses.add(res2);
+ CompositeDistributionResponse compositeResponse = new CompositeDistributionResponse(responses, 2, 0, 0);
+ assertNotNull(compositeResponse.getDistributionInfo());
+ assertEquals(list("res1", "res2").toString(), compositeResponse.getDistributionInfo().getId());
+ }
+
+ private List<String> list(String str1, String str2) {
+ List<String> expectedIds = new ArrayList<>();
+ expectedIds.add(str1);
+ expectedIds.add(str2);
+ return expectedIds;
+ }
+}