Skip to content

Commit

Permalink
switching logic to use generickubernetes resource, rather than jsonnode
Browse files Browse the repository at this point in the history
  • Loading branch information
@shawkins @manusa
shawkins authored and manusa committed Jun 11, 2021
1 parent c54b261 commit 324fac4
Show file tree
Hide file tree
Showing 7 changed files with 127 additions and 105 deletions.
2 changes: 1 addition & 1 deletion ...s-model-core/src/main/java/io/fabric8/kubernetes/api/model/GenericKubernetesResource.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ public class GenericKubernetesResource implements HasMetadata {
@JsonProperty("metadata")
private ObjectMeta metadata;
@JsonIgnore
private transient Map<String, Object> additionalProperties = new LinkedHashMap<>();
private Map<String, Object> additionalProperties = new LinkedHashMap<>();

@JsonAnyGetter
public Map<String, Object> getAdditionalProperties() {
Expand Down
22 changes: 22 additions & 0 deletions ...del-core/src/test/java/io/fabric8/kubernetes/api/model/GenericKubernetesResourceTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,28 @@ void serializeWithCustomResourceShouldSerialize() {
.hasFieldOrPropertyWithValue("spec.field", "value");
}

@Test
@DisplayName("equality should look at all fields")
void equality() {
// Given
final GenericKubernetesResource gkr = new GenericKubernetesResource();
gkr.setApiVersion("the-cr.example.com/v1");
gkr.setKind("SomeCustomResource");
gkr.setMetadata(new ObjectMetaBuilder().withName("custom-resource-example").build());
gkr.setAdditionalProperties(Collections.singletonMap("spec", Collections.singletonMap("field", "value")));

// clone
final GenericKubernetesResource gkr1 = objectMapper.convertValue(gkr, GenericKubernetesResource.class);
// Then
assertThat(gkr)
.isEqualTo(gkr1);

gkr1.getAdditionalProperties().put("key", "value");

assertThat(gkr)
.isNotEqualTo(gkr1);
}

private static InputStream load(String resource) {
return GenericKubernetesResource.class.getResourceAsStream("/generic-kubernetes-resource/" + resource);
}
Expand Down
7 changes: 4 additions & 3 deletions ...src/main/java/io/fabric8/kubernetes/client/server/mock/KubernetesAttributesExtractor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import org.slf4j.LoggerFactory;

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.StandardCharsets;
import java.util.Collections;
Expand Down Expand Up @@ -291,10 +292,10 @@ private static Attribute parseLabel(String label) {
}

static GenericKubernetesResource toKubernetesResource(String s) {
try (InputStream stream = new ByteArrayInputStream(s.getBytes(StandardCharsets.UTF_8.name()))) {
try (InputStream stream = new ByteArrayInputStream(s.getBytes(StandardCharsets.UTF_8))) {
return Serialization.unmarshal(stream, GenericKubernetesResource.class);
} catch (Exception e) {
return null;
} catch (IOException e) {
throw new RuntimeException(e); // unexpected
}
}

Expand Down
130 changes: 65 additions & 65 deletions ...mock/src/main/java/io/fabric8/kubernetes/client/server/mock/KubernetesCrudDispatcher.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,24 @@
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.node.ObjectNode;

import io.fabric8.kubernetes.api.model.GenericKubernetesResource;
import io.fabric8.kubernetes.api.model.HasMetadata;
import io.fabric8.kubernetes.api.model.ObjectMeta;
import io.fabric8.kubernetes.api.model.Status;
import io.fabric8.kubernetes.api.model.StatusBuilder;
import io.fabric8.kubernetes.api.model.StatusCause;
import io.fabric8.kubernetes.api.model.StatusCauseBuilder;
import io.fabric8.kubernetes.client.KubernetesClientException;
import io.fabric8.kubernetes.client.dsl.base.CustomResourceDefinitionContext;
import io.fabric8.kubernetes.client.dsl.base.OperationSupport;
import io.fabric8.kubernetes.client.utils.KubernetesResourceUtil;
import io.fabric8.kubernetes.client.utils.Serialization;
import io.fabric8.kubernetes.client.utils.Utils;
import io.fabric8.mockwebserver.Context;
import io.fabric8.mockwebserver.crud.Attribute;
import io.fabric8.mockwebserver.crud.AttributeSet;
import io.fabric8.mockwebserver.crud.CrudDispatcher;
import io.fabric8.mockwebserver.crud.ResponseComposer;
import io.fabric8.zjsonpatch.JsonDiff;
import io.fabric8.zjsonpatch.JsonPatch;
import okhttp3.MediaType;
import okhttp3.mockwebserver.MockResponse;
Expand All @@ -53,7 +55,7 @@
import java.util.UUID;
import java.util.concurrent.CopyOnWriteArraySet;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.Supplier;
import java.util.function.Function;
import java.util.stream.Collectors;

import okhttp3.mockwebserver.RecordedRequest;
Expand Down Expand Up @@ -124,7 +126,7 @@ public synchronized MockResponse dispatch(RecordedRequest request) {
*/
@Override
public MockResponse handleCreate(String path, String s) {
return validateRequestBodyAndHandleRequest(s, () -> doCreateOrModify(path, s, ADDED));
return validateRequestBodyAndHandleRequest(s, (g) -> doCreateOrModify(path, g, ADDED));
}

/**
Expand All @@ -134,7 +136,7 @@ public MockResponse handleCreate(String path, String s) {
* @return The {@link MockResponse}
*/
public MockResponse handleReplace(String path, String s) {
return validateRequestBodyAndHandleRequest(s, () -> doCreateOrModify(path, s, MODIFIED));
return validateRequestBodyAndHandleRequest(s, (g) -> doCreateOrModify(path, g, MODIFIED));
}

/**
Expand Down Expand Up @@ -352,7 +354,6 @@ private String fetchResource(String path) {
}
}


private int doDelete(String path, String event) {
List<AttributeSet> items = findItems(attributeExtractor.fromPath(path));

Expand All @@ -377,72 +378,68 @@ private List<AttributeSet> findItems(AttributeSet query) {
.collect(Collectors.toList());
}

private MockResponse doCreateOrModify(String path, String initial, String event) {
private MockResponse doCreateOrModify(String path, GenericKubernetesResource value, String event) {
MockResponse mockResponse = new MockResponse();
// workaround for mockserver https://github.com/fabric8io/mockwebserver/pull/59
Map<String, String> pathValues = kubernetesAttributesExtractor.fromKubernetesPath(path);
AttributeSet attributes = attributeExtractor.fromPath(path);

try {
JsonNode source = context.getMapper().readTree(initial);
int responseCode = HttpURLConnection.HTTP_OK;

if (ADDED.equals(event)) {
HasMetadata h = toKubernetesResource(initial);
if (h != null && h.getMetadata() != null && h.getMetadata().getName() != null) {
attributes = AttributeSet.merge(attributes, new AttributeSet(new Attribute(KubernetesAttributesExtractor.NAME, h.getMetadata().getName())));
}
if (ADDED.equals(event) && value.getMetadata() != null && value.getMetadata().getName() != null) {
attributes = AttributeSet.merge(attributes, new AttributeSet(new Attribute(KubernetesAttributesExtractor.NAME, value.getMetadata().getName())));
}

boolean statusSubresource = crdProcessor.isStatusSubresource(pathValues.get(KubernetesAttributesExtractor.KIND));

GenericKubernetesResource updated = Serialization.clone(value);

List<AttributeSet> items = findItems(attributes);
if (items.isEmpty()) {
if (MODIFIED.equals(event)) {
responseCode = HttpURLConnection.HTTP_NOT_FOUND;
} else {
if (statusSubresource) {
removeStatus(source);
updated.getAdditionalProperties().remove(STATUS);
}
setDefaultMetadata(source, pathValues, null);
setDefaultMetadata(updated, pathValues, null);
}
} else if (ADDED.equals(event)) {
responseCode = HttpURLConnection.HTTP_CONFLICT;
} else if (MODIFIED.equals(event)) {
String existing = map.remove(items.get(0));
JsonNode existingNode = context.getMapper().readTree(existing);
JsonNode status = null;
GenericKubernetesResource existingResource = toKubernetesResource(existing);
Object status = null;
if (isStatusPath(path)) {
status = removeStatus(source);
status = updated.getAdditionalProperties().remove(STATUS);
// set the status on the existing node
source = existingNode;
updated = Serialization.clone(existingResource);
} else {
// preserve status and generated fields
if (statusSubresource) {
status = removeStatus(existingNode);
status = existingResource.getAdditionalProperties().remove(STATUS);
}
setDefaultMetadata(source, pathValues, existingNode.findValue("metadata"));
setDefaultMetadata(updated, pathValues, existingResource.getMetadata());
}
if (statusSubresource || isStatusPath(path)) {
if (status != null) {
((ObjectNode) source).set(STATUS, status);
updated.getAdditionalProperties().put(STATUS, status);
} else {
((ObjectNode) source).remove(STATUS);
updated.getAdditionalProperties().remove(STATUS);
}
}
// re-read without modifications
existingNode = context.getMapper().readTree(existing);
if (JsonDiff.asJson(source, existingNode).isEmpty()) {
if (existingResource.equals(updated)) {
event = null; // no change
}
}

if (responseCode == HttpURLConnection.HTTP_OK) {
String s = context.getMapper().writeValueAsString(source);
AttributeSet features = AttributeSet.merge(attributes, attributeExtractor.fromResource(s));
String s = context.getMapper().writeValueAsString(updated);
AttributeSet features = AttributeSet.merge(attributes, kubernetesAttributesExtractor.extract(updated));
map.put(features, s); // always add back as it was proactively removed
if (event != null && !event.isEmpty()) {
crdProcessor.process(path, initial, false);
crdProcessor.process(path, s, false);
final String response = s;
final String finalEvent = event;
watchEventListeners.stream()
Expand All @@ -462,27 +459,31 @@ private static boolean isStatusPath(String path) {
return path.endsWith("/" + STATUS);
}

private void setDefaultMetadata(JsonNode source, Map<String, String> pathValues, JsonNode exitingMetadata) {
ObjectNode metadata = (ObjectNode)source.findValue("metadata");
UUID uuid = UUID.randomUUID();
if (metadata.get("name") == null) {
metadata.put("name", metadata.get("generateName").asText() + "-" + uuid.toString());
}
if (metadata.get("namespace") == null) {
metadata.put("namespace", pathValues.get(KubernetesAttributesExtractor.NAMESPACE));
}
metadata.put("uid", getOrDefault(exitingMetadata, "uid", uuid.toString()));
// resourceVersion is not yet handled appropriately
metadata.put("resourceVersion", "1");
metadata.put("generation", 1);
metadata.put("creationTimestamp", getOrDefault(exitingMetadata, "creationTimestamp", ZonedDateTime.now(ZoneOffset.UTC).format(DateTimeFormatter.ISO_INSTANT)));
private void setDefaultMetadata(GenericKubernetesResource source, Map<String, String> pathValues, ObjectMeta exitingMetadata) {
ObjectMeta metadata = source.getMetadata();
if (metadata == null) {
metadata = new ObjectMeta();
source.setMetadata(metadata);
}
UUID uuid = UUID.randomUUID();
if (metadata.getName() == null) {
metadata.setName(metadata.getGenerateName() + "-" + uuid.toString());
}
if (metadata.getNamespace() == null) {
metadata.setNamespace(pathValues.get(KubernetesAttributesExtractor.NAMESPACE));
}
metadata.setUid(getOrDefault(exitingMetadata, ObjectMeta::getUid, uuid.toString()));
// resourceVersion is not yet handled appropriately
metadata.setResourceVersion("1");
metadata.setGeneration(1l);
metadata.setCreationTimestamp(getOrDefault(exitingMetadata, ObjectMeta::getCreationTimestamp, ZonedDateTime.now(ZoneOffset.UTC).format(DateTimeFormatter.ISO_INSTANT)));
}

private String getOrDefault(JsonNode node, String name, String defaultValue) {
if (node != null) {
JsonNode field = node.get(name);
if (field != null) {
return field.asText();
private String getOrDefault(ObjectMeta metadata, Function<ObjectMeta, String> extractor, String defaultValue) {
if (metadata != null) {
String result = extractor.apply(metadata);
if (result != null) {
return result;
}
}
return defaultValue;
Expand All @@ -492,34 +493,33 @@ private JsonNode removeStatus(JsonNode source) {
return ((ObjectNode)source).remove(STATUS);
}

private MockResponse validateRequestBodyAndHandleRequest(String s, Supplier<MockResponse> mockResponseSupplier) {
HasMetadata h = toKubernetesResource(s);
if (h != null) {
try {
validateResource(h);
} catch (IllegalArgumentException illegalArgumentException) {
return getUnprocessableEntityMockResponse(s, h, illegalArgumentException);
}
private MockResponse validateRequestBodyAndHandleRequest(String s, Function<GenericKubernetesResource, MockResponse> mockResponseFunction) {
GenericKubernetesResource g = null;
try {
g = toKubernetesResource(s);
validateResource(g);
return mockResponseFunction.apply(g);
} catch (IllegalArgumentException | KubernetesClientException e) {
return getUnprocessableEntityMockResponse(s, g, e);
}
return mockResponseSupplier.get();
}

private MockResponse getUnprocessableEntityMockResponse(String s, HasMetadata h, IllegalArgumentException illegalArgumentException) {
String statusBody = getStatusBody(h, HTTP_UNPROCESSABLE_ENTITY, illegalArgumentException);
private MockResponse getUnprocessableEntityMockResponse(String s, HasMetadata h, Exception ex) {
String statusBody = getStatusBody(h, HTTP_UNPROCESSABLE_ENTITY, ex);
if (statusBody == null) {
statusBody = s;
}
return new MockResponse().setResponseCode(HTTP_UNPROCESSABLE_ENTITY).setBody(statusBody);
}

private String getStatusBody(HasMetadata h, int code, IllegalArgumentException illegalArgumentException) {
String kind = Utils.getNonNullOrElse(h.getKind(), "Unknown");
private String getStatusBody(HasMetadata h, int code, Exception ex) {
String kind = Utils.getNonNullOrElse(KubernetesResourceUtil.getKind(h), "Unknown");
Status status = new StatusBuilder().withStatus("Failure")
.withReason("Invalid")
.withMessage(kind + " is invalid")
.withNewDetails()
.withKind(h.getKind())
.withCauses(getFailureStatusCause(illegalArgumentException))
.withKind(kind)
.withCauses(getFailureStatusCause(ex))
.endDetails()
.withCode(code)
.build();
Expand All @@ -530,9 +530,9 @@ private String getStatusBody(HasMetadata h, int code, IllegalArgumentException i
}
}

private StatusCause getFailureStatusCause(IllegalArgumentException illegalArgumentException) {
private StatusCause getFailureStatusCause(Exception ex) {
return new StatusCauseBuilder()
.withMessage(illegalArgumentException.getMessage())
.withMessage(ex.getMessage())
.withReason("ValueRequired")
.build();
}
Expand Down
Loading

0 comments on commit 324fac4

Please sign in to comment.