Skip to content

[chore] switch to non-default constructor for YAML and add a lint rule. #2533

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 28, 2023
Merged

[chore] switch to non-default constructor for YAML and add a lint rule. #2533

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
281f0f9
Switch to SafeConstructor for YAML everywhere.
brendandburns Jan 24, 2023
c63574f
Add a rule to block empty YAML constructors.
brendandburns Jan 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -470,6 +470,17 @@
<replacement>INVALID IMPORTS (GUAVA)</replacement>
</replaceRegex>
</format>
<!-- prevents empty SnakeYaml constructor -->
<format>
<includes>
<include>src/**/*.java</include>
</includes>
<replaceRegex>
<name>Forbids new Yaml()</name>
<searchRegex>^.*new Yaml\(\).*$</searchRegex>
<replacement>INVALID CONSTRUCTOR (SNAKEYAML)</replacement>
</replaceRegex>
</format>
</formats>
<java>
<removeUnusedImports /> <!-- self-explanatory -->
Expand Down
3 changes: 2 additions & 1 deletion util/src/main/java/io/kubernetes/client/util/FilePersister.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import java.util.ArrayList;
import java.util.HashMap;
import org.yaml.snakeyaml.Yaml;
import org.yaml.snakeyaml.constructor.SafeConstructor;

public class FilePersister implements ConfigPersister {
File configFile;
Expand Down Expand Up @@ -50,7 +51,7 @@ public void save(
// Note this is imperfect, should protect against other processes writing this file too...
synchronized (configFile) {
try (FileWriter fw = new FileWriter(configFile)) {
Yaml yaml = new Yaml();
Yaml yaml = new Yaml(new SafeConstructor());
yaml.dump(config, fw);
fw.flush();
}
Expand Down
3 changes: 2 additions & 1 deletion util/src/main/java/io/kubernetes/client/util/generic/dynamic/Dynamics.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,12 @@
import io.kubernetes.client.openapi.JSON;
import java.util.Map;
import org.yaml.snakeyaml.Yaml;
import org.yaml.snakeyaml.constructor.SafeConstructor;

public class Dynamics {

static final JSON internalJSONCodec = new JSON();
static final Yaml internalYamlCodec = new Yaml();
static final Yaml internalYamlCodec = new Yaml(new SafeConstructor());

public static DynamicKubernetesObject newFromJson(String jsonContent) {
return newFromJson(internalJSONCodec.getGson(), jsonContent);
Expand Down