Implemented writeYaml step #23
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,187 @@ | ||
| /* | ||
| * The MIT License (MIT) | ||
| * | ||
| * Copyright (c) 2017 Javier DELGADO | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in all | ||
| * copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| * SOFTWARE. | ||
| */ | ||
|
|
||
| package org.jenkinsci.plugins.pipeline.utility.steps.conf; | ||
|
|
||
| import hudson.Extension; | ||
| import hudson.FilePath; | ||
| import hudson.model.TaskListener; | ||
| import org.jenkinsci.plugins.pipeline.utility.steps.shaded.org.yaml.snakeyaml.DumperOptions; | ||
| import org.jenkinsci.plugins.pipeline.utility.steps.shaded.org.yaml.snakeyaml.Yaml; | ||
| import org.jenkinsci.plugins.workflow.steps.*; | ||
| import org.kohsuke.stapler.DataBoundConstructor; | ||
|
|
||
| import javax.annotation.Nonnull; | ||
| import javax.inject.Inject; | ||
| import java.io.*; | ||
| import java.net.URL; | ||
| import java.nio.file.FileAlreadyExistsException; | ||
| import java.util.*; | ||
|
|
||
| import static org.apache.commons.lang.StringUtils.isBlank; | ||
|
|
||
| /** | ||
| * Writes a yaml file from the workspace. | ||
| * | ||
| * @author Javier DELGADO <witokondoria@gmail.com>. | ||
| */ | ||
|
There was a problem hiding this comment.
There was a problem hiding this comment. not needed. it's not present in any other of the steps. |
||
| public class WriteYamlStep extends AbstractStepImpl { | ||
|
|
||
| private String file; | ||
| private Object data; | ||
|
|
||
| @DataBoundConstructor | ||
| public WriteYamlStep(@Nonnull String file, @Nonnull Object data) { | ||
| if (file == null) { | ||
|
|
||
| throw new IllegalArgumentException("file parameter must be provided to writeYaml"); | ||
| } | ||
| this.file = file; | ||
|
There was a problem hiding this comment. Does it also make sense to verify the patch and to ensure nobody passes an absolute one or a relative with traversal to upper levels? There was a problem hiding this comment. want to trim the string? Forcing a path from within the current current workspace seems fine There was a problem hiding this comment. From the writeFile Step, paths are not verified (so traversal is also possible). Would you prefer a higer level implementation for this check? |
||
| if (data == null) { | ||
| throw new IllegalArgumentException("data parameter must be provided to writeYaml"); | ||
| } else if (!isValidObjectType(data)) { | ||
| throw new IllegalArgumentException("data parameter has invalid content (no-basic classes)"); | ||
| } | ||
| this.data = data; | ||
| } | ||
|
|
||
| /** | ||
| * Name of the yaml file to write. | ||
| * | ||
| * @return file name | ||
| */ | ||
| public String getFile() { | ||
| return file; | ||
| } | ||
|
|
||
| /** | ||
| * Name of the yaml file to write. | ||
| * | ||
| * @param file file name | ||
| */ | ||
| public void setFile(String file) { | ||
|
There was a problem hiding this comment. Do you need setters? If no, I would advice to either remove them and make the fields final OR to convert the class to |
||
| this.file = file; | ||
| } | ||
|
|
||
| /** | ||
| * An Object containing data to be saved. | ||
| * | ||
| * @return data to save as yaml | ||
| */ | ||
| public Object getData() { | ||
| return data; | ||
| } | ||
|
|
||
| /** | ||
| * An Object representing the elements to write. | ||
| * | ||
| * @param data to parse | ||
| */ | ||
| public void setData(Object data) { | ||
| this.data = data; | ||
| } | ||
|
|
||
| private boolean isValidObjectType(Object obj) { | ||
| if ((obj instanceof Boolean) || (obj instanceof Character) || | ||
| (obj instanceof Number) || (obj instanceof String) || | ||
| (obj instanceof URL) || (obj instanceof Calendar) || | ||
|
There was a problem hiding this comment. I had some concerns about this, but it seems it's safe enough: |
||
| (obj instanceof Date) || (obj instanceof UUID) || | ||
| (obj == null)) { | ||
| return true; | ||
|
There was a problem hiding this comment. It is strange, error-prone (E.g. GString, Long, etc.) and ineffective. Why would you need it? There was a problem hiding this comment. Its not a complete and final list, but a one less strict than plain Maps, with objects already whitelisted when toJson invocations: There was a problem hiding this comment. My guess is that the something like: writeYaml data: "${currentBuild.rawBuild}", file: 'data'might be enough There was a problem hiding this comment. will add tests tomorrow! |
||
| } else if (obj instanceof Map) { | ||
| Boolean ret = true; | ||
| Set entry = ((Map) obj).entrySet(); | ||
| Iterator iterator = entry.iterator(); | ||
| while (iterator.hasNext() && ret) { | ||
|
There was a problem hiding this comment. This looks a bit convoluted, something like this would be more readable and simpler I think for (Map.Entry entry : map.entrySet()) {
if (!isValidObject(entry.getKey()) || !isValidObject(entry.getValue())) {
return false;
}
}It also seems like you are overwriting the There was a problem hiding this comment. True that, Its result of a late commit. Will fix it. |
||
| Object next = iterator.next();Object es = ((Map) obj).get(next); | ||
| ret = (isValidObjectType(((Map.Entry)next).getKey()) && isValidObjectType(((Map.Entry)next).getValue())); | ||
| } | ||
| return ret; | ||
| } else if (obj instanceof Collection) { | ||
| Boolean ret = true; | ||
| Iterator iterator = ((Collection) obj).iterator(); | ||
| while (iterator.hasNext() && ret) { | ||
|
There was a problem hiding this comment. Same simplification and issue here as for the Map. for (Object o : ((Collection)obj)) {
if (!isValidObject(o)) {
return false;
}
} |
||
| Object next = iterator.next(); | ||
| ret = isValidObjectType(next); | ||
| } | ||
| return ret; | ||
| } else { | ||
| return false; | ||
| } | ||
| } | ||
|
|
||
| @Extension | ||
| public static class DescriptorImpl extends AbstractStepDescriptorImpl { | ||
|
|
||
| public DescriptorImpl() { | ||
| super(Execution.class); | ||
| } | ||
|
|
||
| @Override | ||
| public String getFunctionName() { | ||
| return "writeYaml"; | ||
| } | ||
|
|
||
| @Override | ||
| public String getDisplayName() { | ||
| return "Write a yaml from an object."; | ||
| } | ||
| } | ||
|
|
||
| public static class Execution extends AbstractSynchronousNonBlockingStepExecution<Void> { | ||
| private static final long serialVersionUID = 1L; | ||
|
|
||
| @StepContextParameter | ||
| private transient TaskListener listener; | ||
|
|
||
| @StepContextParameter | ||
| private transient FilePath ws; | ||
|
|
||
| @Inject | ||
| private transient WriteYamlStep step; | ||
|
|
||
| @Override | ||
| protected Void run () throws Exception { | ||
| FilePath path = null; | ||
| if (!isBlank(step.getFile())) { | ||
| path = ws.child(step.getFile()); | ||
| if (path.exists()) { | ||
| throw new FileAlreadyExistsException(path.getRemote() + " already exist."); | ||
| } | ||
| if (path.isDirectory()) { | ||
| throw new FileNotFoundException(path.getRemote() + " is a directory."); | ||
| } | ||
| } | ||
|
|
||
| DumperOptions options = new DumperOptions(); | ||
| options.setDefaultFlowStyle(DumperOptions.FlowStyle.BLOCK); | ||
| Yaml yaml = new Yaml(options); | ||
|
|
||
| try (OutputStreamWriter writer = new OutputStreamWriter(path.write())) { | ||
| yaml.dump (step.getData(), writer); | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
| } | ||
| } | ||
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,34 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!-- | ||
| ~ The MIT License (MIT) | ||
| ~ | ||
| ~ Copyright (c) 2017 Javier DELGADO. | ||
| ~ | ||
| ~ Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| ~ of this software and associated documentation files (the "Software"), to deal | ||
| ~ in the Software without restriction, including without limitation the rights | ||
| ~ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| ~ copies of the Software, and to permit persons to whom the Software is | ||
| ~ furnished to do so, subject to the following conditions: | ||
| ~ | ||
| ~ The above copyright notice and this permission notice shall be included in all | ||
| ~ copies or substantial portions of the Software. | ||
| ~ | ||
| ~ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| ~ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| ~ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| ~ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| ~ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| ~ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| ~ SOFTWARE. | ||
| --> | ||
| <?jelly escape-by-default='true'?> | ||
| <j:jelly xmlns:j="jelly:core" xmlns:f="/lib/form"> | ||
| <f:entry title="${%file.title}" field="file" description="${%file.description}"> | ||
| <f:textbox /> | ||
| </f:entry> | ||
|
|
||
| <f:entry title="${%text.title}" field="text" description="${%text.description}"> | ||
| <f:textbox /> | ||
| </f:entry> | ||
| </j:jelly> |
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,4 @@ | ||
| file.title=File | ||
| file.description=File to save as YAML | ||
| text.title=Data | ||
| text.description=Object to serialize yo YAML | ||
|
There was a problem hiding this comment. Yo dawg, I heard yo and yo dawg like yo yos. There was a problem hiding this comment. LOL, that made my afternoon |
||
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,56 @@ | ||
| <!-- | ||
| ~ The MIT License (MIT) | ||
| ~ | ||
| ~ Copyright (c) 2017 Javier DELGADO. | ||
| ~ | ||
| ~ Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| ~ of this software and associated documentation files (the "Software"), to deal | ||
| ~ in the Software without restriction, including without limitation the rights | ||
| ~ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| ~ copies of the Software, and to permit persons to whom the Software is | ||
| ~ furnished to do so, subject to the following conditions: | ||
| ~ | ||
| ~ The above copyright notice and this permission notice shall be included in all | ||
| ~ copies or substantial portions of the Software. | ||
| ~ | ||
| ~ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| ~ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| ~ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| ~ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| ~ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| ~ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| ~ SOFTWARE. | ||
| --> | ||
| <p> | ||
| Writes a yaml file in the current working directory from an Object or a String. | ||
| It uses <a href="https://bitbucket.org/asomov/snakeyaml" target="_blank">SnakeYAML</a> as YAML processor. | ||
| The call will fail if the file already exists. | ||
| </p> | ||
| <strong>Fields:</strong> | ||
| <ul> | ||
| <li> | ||
| <code>file</code>: | ||
| Mandatory path to a file in the workspace to write the YAML datas to. | ||
| </li> | ||
| <li> | ||
| <code>data</code>: | ||
| A Mandatory Object containing the data to be serialized. | ||
| </li> | ||
| </ul> | ||
| <p> | ||
| <strong>Examples:</strong><br/> | ||
| <code> | ||
| <pre> | ||
| def amap = ['something': 'my datas', | ||
| 'size': 3, | ||
| 'isEmpty': false] | ||
|
|
||
| writeYaml file: 'datas.yaml', data: amap | ||
| def read = readYaml file: 'datas.yaml' | ||
|
|
||
| assert read.something == 'my datas' | ||
| assert read.size == 3 | ||
| assert read.isEmpty == false | ||
| </pre> | ||
| </code> | ||
| </p> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Time for a new parent pom before trying to fix this.