Skip to content

Commit

Permalink
fix fabric8io#4171: limiting clone to kubernetesresources
Browse files Browse the repository at this point in the history
  • Loading branch information
@shawkins
shawkins committed May 25, 2022
1 parent 615b398 commit a75e2ba
Showing 1 changed file with 88 additions and 73 deletions.
161 changes: 88 additions & 73 deletions kubernetes-client-api/src/main/java/io/fabric8/kubernetes/client/utils/Serialization.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@
import io.fabric8.kubernetes.api.model.GenericKubernetesResource;
import io.fabric8.kubernetes.api.model.KubernetesResource;
import io.fabric8.kubernetes.client.KubernetesClientException;
import io.fabric8.kubernetes.client.utils.serialization.UnmatchedFieldTypeModule;
import org.yaml.snakeyaml.Yaml;
import org.yaml.snakeyaml.constructor.SafeConstructor;

import java.io.BufferedInputStream;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
Expand All @@ -39,12 +43,9 @@
import java.util.regex.Pattern;
import java.util.stream.Collectors;

import io.fabric8.kubernetes.client.utils.serialization.UnmatchedFieldTypeModule;
import org.yaml.snakeyaml.Yaml;
import org.yaml.snakeyaml.constructor.SafeConstructor;

public class Serialization {
private Serialization() { }
private Serialization() {
}

public static final UnmatchedFieldTypeModule UNMATCHED_FIELD_TYPE_MODULE = new UnmatchedFieldTypeModule();

Expand All @@ -60,11 +61,13 @@ private Serialization() { }
/**
* {@link ObjectMapper} singleton instance used internally by the Kubernetes client.
*
* <p> The ObjectMapper has an {@link UnmatchedFieldTypeModule} module registered. This module allows the client
* <p>
* The ObjectMapper has an {@link UnmatchedFieldTypeModule} module registered. This module allows the client
* to work with Resources that contain properties that don't match the target field type. This is especially useful
* and necessary to work with OpenShift Templates.
*
* <p> n.b. the use of this module gives precedence to properties present in the additionalProperties Map present
* <p>
* n.b. the use of this module gives precedence to properties present in the additionalProperties Map present
* in most KubernetesResource instances. If a property is both defined in the Map and in the original field, the
* one from the additionalProperties Map will be serialized.
*/
Expand All @@ -75,11 +78,13 @@ public static ObjectMapper jsonMapper() {
/**
* {@link ObjectMapper} singleton instance used internally by the Kubernetes client.
*
* <p> The ObjectMapper has an {@link UnmatchedFieldTypeModule} module registered. This module allows the client
* <p>
* The ObjectMapper has an {@link UnmatchedFieldTypeModule} module registered. This module allows the client
* to work with Resources that contain properties that don't match the target field type. This is especially useful
* and necessary to work with OpenShift Templates.
*
* <p> n.b. the use of this module gives precedence to properties present in the additionalProperties Map present
* <p>
* n.b. the use of this module gives precedence to properties present in the additionalProperties Map present
* in most KubernetesResource instances. If a property is both defined in the Map and in the original field, the
* one from the additionalProperties Map will be serialized.
*/
Expand All @@ -88,8 +93,7 @@ public static ObjectMapper yamlMapper() {
synchronized (Serialization.class) {
if (YAML_MAPPER == null) {
YAML_MAPPER = new ObjectMapper(
new YAMLFactory().disable(YAMLGenerator.Feature.USE_NATIVE_TYPE_ID)
);
new YAMLFactory().disable(YAMLGenerator.Feature.USE_NATIVE_TYPE_ID));
YAML_MAPPER.registerModules(UNMATCHED_FIELD_TYPE_MODULE);
}
}
Expand All @@ -110,7 +114,8 @@ public static void clearYamlMapper() {
/**
* Returns a JSON representation of the given object.
*
* <p> If the provided object contains a JsonAnyGetter annotated method with a Map that contains an entry that
* <p>
* If the provided object contains a JsonAnyGetter annotated method with a Map that contains an entry that
* overrides a field of the provided object, the Map entry will take precedence upon serialization. Properties won't
* be duplicated.
*
Expand All @@ -129,7 +134,8 @@ public static <T> String asJson(T object) {
/**
* Returns a YAML representation of the given object.
*
* <p> If the provided object contains a JsonAnyGetter annotated method with a Map that contains an entry that
* <p>
* If the provided object contains a JsonAnyGetter annotated method with a Map that contains an entry that
* overrides a field of the provided object, the Map entry will take precedence upon serialization. Properties won't
* be duplicated.
*
Expand All @@ -148,8 +154,8 @@ public static <T> String asYaml(T object) {
/**
* Unmarshals a stream.
*
* @param is The {@link InputStream}.
* @param <T> The target type.
* @param is The {@link InputStream}.
* @param <T> The target type.
*
* @return returns de-serialized object
*/
Expand All @@ -159,9 +165,10 @@ public static <T> T unmarshal(InputStream is) {

/**
* Unmarshals a stream optionally performing placeholder substitution to the stream.
* @param is The {@link InputStream}.
* @param parameters A {@link Map} with parameters for placeholder substitution.
* @param <T> The target type.
*
* @param is The {@link InputStream}.
* @param parameters A {@link Map} with parameters for placeholder substitution.
* @param <T> The target type.
* @return returns returns de-serialized object
*/
@SuppressWarnings("unchecked")
Expand All @@ -170,36 +177,38 @@ public static <T> T unmarshal(InputStream is, Map<String, String> parameters) {
if (containsMultipleDocuments(specFile)) {
return (T) getKubernetesResourceList(parameters, specFile);
} else if (specFile.contains(DOCUMENT_DELIMITER)) {
specFile = specFile.replaceAll("^---([ \\t].*?)?\\r?\\n","");
specFile = specFile.replaceAll("\\n---([ \\t].*?)?\\r?\\n?$","\n");
specFile = specFile.replaceAll("^---([ \\t].*?)?\\r?\\n", "");
specFile = specFile.replaceAll("\\n---([ \\t].*?)?\\r?\\n?$", "\n");
}
return unmarshal(new ByteArrayInputStream(specFile.getBytes()), JSON_MAPPER, parameters);
}

/**
* Unmarshals a stream.
* @param is The {@link InputStream}.
* @param mapper The {@link ObjectMapper} to use.
* @param <T> The target type.
*
* @param is The {@link InputStream}.
* @param mapper The {@link ObjectMapper} to use.
* @param <T> The target type.
* @return returns de-serialized object
*/
public static <T> T unmarshal(InputStream is, ObjectMapper mapper) {
return unmarshal(is, mapper, Collections.emptyMap());
return unmarshal(is, mapper, Collections.emptyMap());
}

/**
* Unmarshals a stream optionally performing placeholder substitution to the stream.
* @param is The {@link InputStream}.
* @param mapper The {@link ObjectMapper} to use.
* @param parameters A {@link Map} with parameters for placeholder substitution.
* @param <T> The target type.
*
* @param is The {@link InputStream}.
* @param mapper The {@link ObjectMapper} to use.
* @param parameters A {@link Map} with parameters for placeholder substitution.
* @param <T> The target type.
* @return returns de-serialized object
*/
public static <T> T unmarshal(InputStream is, ObjectMapper mapper, Map<String, String> parameters) {
try (
InputStream wrapped = parameters != null && !parameters.isEmpty() ? ReplaceValueStream.replaceValues(is, parameters) : is;
BufferedInputStream bis = new BufferedInputStream(wrapped)
) {
InputStream wrapped = parameters != null && !parameters.isEmpty() ? ReplaceValueStream.replaceValues(is, parameters)
: is;
BufferedInputStream bis = new BufferedInputStream(wrapped)) {
bis.mark(-1);
int intch;
do {
Expand All @@ -218,11 +227,12 @@ public static <T> T unmarshal(InputStream is, ObjectMapper mapper, Map<String, S

/**
* Unmarshals a {@link String}
* @param str The {@link String}.
* @param <T> template argument denoting type
*
* @param str The {@link String}.
* @param <T> template argument denoting type
* @return returns de-serialized object
*/
public static<T> T unmarshal(String str) {
public static <T> T unmarshal(String str) {
try (InputStream is = new ByteArrayInputStream(str.getBytes(StandardCharsets.UTF_8))) {
return unmarshal(is);
} catch (IOException e) {
Expand All @@ -232,21 +242,23 @@ public static<T> T unmarshal(String str) {

/**
* Unmarshals a {@link String}
* @param str The {@link String}.
* @param type The target type.
* @param <T> template argument denoting type
*
* @param str The {@link String}.
* @param type The target type.
* @param <T> template argument denoting type
* @return returns de-serialized object
*/
public static<T> T unmarshal(String str, final Class<T> type) {
public static <T> T unmarshal(String str, final Class<T> type) {
return unmarshal(str, type, Collections.emptyMap());
}

/**
* Unmarshals a {@link String} optionally performing placeholder substitution to the String.
* @param str The {@link String}.
* @param type The target type.
* @param <T> Template argument denoting type
* @param parameters A hashmap containing parameters
*
* @param str The {@link String}.
* @param type The target type.
* @param <T> Template argument denoting type
* @param parameters A hashmap containing parameters
*
* @return returns de-serialized object
*/
Expand All @@ -265,9 +277,10 @@ public Type getType() {

/**
* Unmarshals an {@link InputStream}.
* @param is The {@link InputStream}.
* @param type The type.
* @param <T> Template argument denoting type
*
* @param is The {@link InputStream}.
* @param type The type.
* @param <T> Template argument denoting type
* @return returns de-serialized object
*/
public static <T> T unmarshal(InputStream is, final Class<T> type) {
Expand All @@ -276,10 +289,11 @@ public static <T> T unmarshal(InputStream is, final Class<T> type) {

/**
* Unmarshals an {@link InputStream} optionally performing placeholder substitution to the stream.
* @param is The {@link InputStream}.
* @param type The type.
* @param parameters A {@link Map} with parameters for placeholder substitution.
* @param <T> Template argument denoting type
*
* @param is The {@link InputStream}.
* @param type The type.
* @param parameters A {@link Map} with parameters for placeholder substitution.
* @param <T> Template argument denoting type
* @return returns de-serialized object
*/
public static <T> T unmarshal(InputStream is, final Class<T> type, Map<String, String> parameters) {
Expand All @@ -291,33 +305,33 @@ public Type getType() {
}, parameters);
}


/**
* Unmarshals an {@link InputStream}.
* @param is The {@link InputStream}.
* @param type The {@link TypeReference}.
* @param <T> Template argument denoting type
*
* @param is The {@link InputStream}.
* @param type The {@link TypeReference}.
* @param <T> Template argument denoting type
* @return returns de-serialized object
*/
public static <T> T unmarshal(InputStream is, TypeReference<T> type) {
return unmarshal(is, type, Collections.emptyMap());
return unmarshal(is, type, Collections.emptyMap());
}

/**
* Unmarshals an {@link InputStream} optionally performing placeholder substitution to the stream.
*
* @param is The {@link InputStream}.
* @param type The {@link TypeReference}.
* @param parameters A {@link Map} with parameters for placeholder substitution.
* @param <T> Template argument denoting type
* @param is The {@link InputStream}.
* @param type The {@link TypeReference}.
* @param parameters A {@link Map} with parameters for placeholder substitution.
* @param <T> Template argument denoting type
*
* @return returns de-serialized object
*/
public static <T> T unmarshal(InputStream is, TypeReference<T> type, Map<String, String> parameters) {
try (
InputStream wrapped = parameters != null && !parameters.isEmpty() ? ReplaceValueStream.replaceValues(is, parameters) : is;
BufferedInputStream bis = new BufferedInputStream(wrapped)
) {
InputStream wrapped = parameters != null && !parameters.isEmpty() ? ReplaceValueStream.replaceValues(is, parameters)
: is;
BufferedInputStream bis = new BufferedInputStream(wrapped)) {
bis.mark(-1);
int intch;
do {
Expand All @@ -337,14 +351,14 @@ public static <T> T unmarshal(InputStream is, TypeReference<T> type, Map<String,

private static List<KubernetesResource> getKubernetesResourceList(Map<String, String> parameters, String specFile) {
return splitSpecFile(specFile).stream().filter(Serialization::validate)
.map(document ->
(KubernetesResource)Serialization.unmarshal(new ByteArrayInputStream(document.getBytes()), parameters))
.collect(Collectors.toList());
.map(
document -> (KubernetesResource) Serialization.unmarshal(new ByteArrayInputStream(document.getBytes()), parameters))
.collect(Collectors.toList());
}

static boolean containsMultipleDocuments(String specFile) {
final long validDocumentCount = splitSpecFile(specFile).stream().filter(Serialization::validate)
.count();
.count();
return validDocumentCount > 1;
}

Expand Down Expand Up @@ -400,21 +414,22 @@ private static <T> T unmarshalJsonStr(String jsonString, TypeReference<T> type)

/**
* Create a copy of the resource via serialization.
*
* @return a deep clone of the resource
* @throws IllegalArgumentException if the cloning cannot be performed
*/
public static <T> T clone(T resource) {
public static <T extends KubernetesResource> T clone(T resource) {
// if full serialization seems too expensive, there is also
//return (T) JSON_MAPPER.convertValue(resource, resource.getClass());
try {
return JSON_MAPPER.readValue(
JSON_MAPPER.writeValueAsString(resource), new TypeReference<T>() {
@Override
public Type getType() {
// Force KubernetesResource so that the KubernetesDeserializer takes over any resource configured deserializer
return resource instanceof GenericKubernetesResource ? resource.getClass() : KubernetesResource.class;
}
});
JSON_MAPPER.writeValueAsString(resource), new TypeReference<T>() {
@Override
public Type getType() {
// Force KubernetesResource so that the KubernetesDeserializer takes over any resource configured deserializer
return resource instanceof GenericKubernetesResource ? resource.getClass() : KubernetesResource.class;
}
});
} catch (JsonProcessingException e) {
throw new IllegalStateException(e);
}
Expand Down

0 comments on commit a75e2ba

Please sign in to comment.