forked from fabric8io/kubernetes-client
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(model): octal numbers properly handled for file structs (mode, de…
…faultMode) (6148) fix (kubernetes-model-generator) : Handle deserialization of `defaultMode` field in custom deserializers for VolumeSource types Add custom deserializers to handle correct octal deserialization for these types: - ConfigMapVolumeSource - SecretVolumeSource - DownwardAPIVolumeSource - ProjectedVolumeSource Signed-off-by: Rohan Kumar <[email protected]> --- feat: Jackson module to handle Go (de)serialization nuances Signed-off-by: Marc Nuri <[email protected]>
- Loading branch information
1 parent
541f1fa
commit 9293e0a
Showing
16 changed files
with
565 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
44 changes: 44 additions & 0 deletions
44
kubernetes-client-api/src/test/resources/serialization/cronjob-octal.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| # | ||
| # Copyright (C) 2015 Red Hat, Inc. | ||
| # | ||
| # Licensed 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. | ||
| # | ||
|
|
||
| apiVersion: batch/v1beta1 | ||
| kind: CronJob | ||
| metadata: | ||
| name: update-db | ||
| spec: | ||
| schedule: "*/1 * * * *" | ||
| jobTemplate: | ||
| spec: | ||
| template: | ||
| spec: | ||
| containers: | ||
| - name: update-fingerprints | ||
| image: python:3.6.2-slim | ||
| command: ["/bin/bash"] | ||
| args: ["-c", "python /client/test.py"] | ||
| volumeMounts: | ||
| - name: application-code | ||
| mountPath: /where/ever | ||
| restartPolicy: OnFailure | ||
| volumes: | ||
| - name: application-code | ||
| configMap: | ||
| name: conf | ||
| defaultMode: 0o555 | ||
| items: | ||
| - key: key1 | ||
| path: target | ||
| mode: 0555 |
25 changes: 25 additions & 0 deletions
25
...model-common/src/main/java/io/fabric8/kubernetes/model/jackson/GoCompatibilityModule.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| /* | ||
| * Copyright (C) 2015 Red Hat, Inc. | ||
| * | ||
| * Licensed 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 io.fabric8.kubernetes.model.jackson; | ||
|
|
||
| import com.fasterxml.jackson.databind.module.SimpleModule; | ||
|
|
||
| public class GoCompatibilityModule extends SimpleModule { | ||
|
|
||
| public GoCompatibilityModule() { | ||
| addDeserializer(Integer.class, new GoIntegerDeserializer()); | ||
| } | ||
| } |
71 changes: 71 additions & 0 deletions
71
...model-common/src/main/java/io/fabric8/kubernetes/model/jackson/GoIntegerDeserializer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| /* | ||
| * Copyright (C) 2015 Red Hat, Inc. | ||
| * | ||
| * Licensed 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 io.fabric8.kubernetes.model.jackson; | ||
|
|
||
| import com.fasterxml.jackson.core.JsonParser; | ||
| import com.fasterxml.jackson.databind.BeanProperty; | ||
| import com.fasterxml.jackson.databind.DeserializationContext; | ||
| import com.fasterxml.jackson.databind.JsonDeserializer; | ||
| import com.fasterxml.jackson.databind.deser.ContextualDeserializer; | ||
| import com.fasterxml.jackson.databind.deser.std.StdDeserializer; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Arrays; | ||
| import java.util.HashSet; | ||
| import java.util.Set; | ||
| import java.util.regex.Matcher; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| public class GoIntegerDeserializer extends StdDeserializer<Integer> implements ContextualDeserializer { | ||
|
|
||
| private static final Pattern OCTAL = Pattern.compile("(0[oO]?)([0-7]+)"); | ||
| private static final GoIntegerDeserializer APPLICABLE_INSTANCE = new GoIntegerDeserializer(true); | ||
| private static final Set<String> APPLICABLE_FIELDS = new HashSet<>(Arrays.asList("mode", "defaultMode")); | ||
|
|
||
| private final boolean applicable; | ||
|
|
||
| protected GoIntegerDeserializer() { | ||
| this(false); | ||
| } | ||
|
|
||
| private GoIntegerDeserializer(boolean applicable) { | ||
| super(Integer.class); | ||
| this.applicable = applicable; | ||
| } | ||
|
|
||
| @Override | ||
| public Integer deserialize(JsonParser p, DeserializationContext ctxt) throws IOException { | ||
| final String value = p.getText(); | ||
| if (value == null) { | ||
| return null; | ||
| } | ||
| if (applicable) { | ||
| final Matcher matcher = OCTAL.matcher(value); | ||
| if (matcher.find()) { | ||
| return Integer.valueOf(matcher.group(2), 8); | ||
| } | ||
| } | ||
| return _parseInteger(ctxt, value); | ||
| } | ||
|
|
||
| @Override | ||
| public JsonDeserializer<?> createContextual(DeserializationContext ctxt, BeanProperty property) { | ||
| if (property != null && APPLICABLE_FIELDS.contains(property.getName())) { | ||
| return APPLICABLE_INSTANCE; | ||
| } | ||
| return this; | ||
| } | ||
| } |
101 changes: 101 additions & 0 deletions
101
...l-common/src/test/java/io/fabric8/kubernetes/model/jackson/GoIntegerDeserializerTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| /* | ||
| * Copyright (C) 2015 Red Hat, Inc. | ||
| * | ||
| * Licensed 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 io.fabric8.kubernetes.model.jackson; | ||
|
|
||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import com.fasterxml.jackson.databind.exc.InvalidFormatException; | ||
| import lombok.Data; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Nested; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.TestInstance; | ||
| import org.junit.jupiter.params.ParameterizedTest; | ||
| import org.junit.jupiter.params.provider.Arguments; | ||
| import org.junit.jupiter.params.provider.MethodSource; | ||
|
|
||
| import java.util.stream.Stream; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.assertj.core.api.Assertions.assertThatThrownBy; | ||
| import static org.junit.jupiter.api.TestInstance.Lifecycle.PER_CLASS; | ||
|
|
||
| class GoIntegerDeserializerTest { | ||
|
|
||
| private ObjectMapper context; | ||
|
|
||
| @BeforeEach | ||
| void setUp() { | ||
| context = new ObjectMapper(); | ||
| context.registerModule(new GoCompatibilityModule()); | ||
| } | ||
|
|
||
| @Nested | ||
| @TestInstance(PER_CLASS) | ||
| class Applicable { | ||
|
|
||
| @ParameterizedTest(name = "{index}: with '{'\"{0}\": {1}'}' parses as {2}") | ||
| @MethodSource | ||
| void parsesOctals(String fieldName, String content, Integer expected) throws Exception { | ||
| final IntegerFieldsContainer result = context | ||
| .readValue(String.format("{\"%s\": %s}", fieldName, content), IntegerFieldsContainer.class); | ||
| assertThat(result).hasFieldOrPropertyWithValue(fieldName, expected); | ||
| } | ||
|
|
||
| private Stream<Arguments> parsesOctals() { | ||
| return Stream.of("mode", "defaultMode") | ||
| .flatMap(field -> Stream.of( | ||
| Arguments.of(field, "null", null), | ||
| Arguments.of(field, "\"0555\"", 365), | ||
| Arguments.of(field, "\"0o555\"", 365), | ||
| Arguments.of(field, "\"0O555\"", 365), | ||
| Arguments.of(field, "\"555\"", 555), | ||
| Arguments.of(field, "\"0888\"", 888), | ||
| Arguments.of(field, "\"0o12\"", 10), | ||
| Arguments.of(field, "\"0O12\"", 10))); | ||
| } | ||
| } | ||
|
|
||
| // | ||
| @Nested | ||
| class NotApplicable { | ||
|
|
||
| @Test | ||
| void parsesOctalsAsDecimal() throws Exception { | ||
| final IntegerFieldsContainer result = context | ||
| .readValue("{\"notApplicable\": \"0555\"}", IntegerFieldsContainer.class); | ||
| assertThat(result).hasFieldOrPropertyWithValue("notApplicable", 555); | ||
| } | ||
|
|
||
| @Test | ||
| void throwsExceptionForInvalidOctal() { | ||
| assertThatThrownBy(() -> context.readValue("{\"mode\": \"0o955\"}", IntegerFieldsContainer.class)) | ||
| .isInstanceOf(InvalidFormatException.class); | ||
| } | ||
|
|
||
| @Test | ||
| void throwsExceptionForOctalWithSeparator() { | ||
| assertThatThrownBy(() -> context.readValue("{\"notApplicable\": \"0o555\"}", IntegerFieldsContainer.class)) | ||
| .isInstanceOf(InvalidFormatException.class); | ||
| } | ||
| } | ||
|
|
||
| @Data | ||
| private static final class IntegerFieldsContainer { | ||
| private Integer mode; | ||
| private Integer defaultMode; | ||
| private Integer notApplicable; | ||
| } | ||
| } |
Oops, something went wrong.