-
Notifications
You must be signed in to change notification settings - Fork 163
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #23 from witokondoria/feature/writeYaml
Implemented writeYaml step
- Loading branch information
Showing
8 changed files
with
474 additions
and
1 deletion.
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
162 changes: 162 additions & 0 deletions
162
src/main/java/org/jenkinsci/plugins/pipeline/utility/steps/conf/WriteYamlStep.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,162 @@ | ||
| /* | ||
| * 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>. | ||
| */ | ||
| public class WriteYamlStep extends AbstractStepImpl { | ||
|
|
||
| private String file; | ||
| private Object data; | ||
|
|
||
| @DataBoundConstructor | ||
| public WriteYamlStep(@Nonnull String file, @Nonnull Object data) { | ||
| if ((file == null) || (isBlank(file))) { | ||
| throw new IllegalArgumentException("file parameter must be provided to writeYaml"); | ||
| } | ||
| this.file = file; | ||
| 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; | ||
| } | ||
|
|
||
| /** | ||
| * An Object containing data to be saved. | ||
| * | ||
| * @return data to save as yaml | ||
| */ | ||
| public Object getData() { | ||
| return 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) || | ||
| (obj instanceof Date) || (obj instanceof UUID) || | ||
| (obj == null)) { | ||
| return true; | ||
| } else if (obj instanceof Map) { | ||
| for (Object entry : ((Map)obj).entrySet()) { | ||
| if (!isValidObjectType(((Map.Entry)entry).getKey()) || !isValidObjectType(((Map.Entry)entry).getValue())) { | ||
| return false; | ||
| } | ||
| } | ||
| return true; | ||
| } else if (obj instanceof Collection) { | ||
| for (Object o : ((Collection)obj)) { | ||
| if (!isValidObjectType(o)) { | ||
| return false; | ||
| } | ||
| } | ||
| return true; | ||
| } | ||
| 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 = 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; | ||
| } | ||
| } | ||
| } |
34 changes: 34 additions & 0 deletions
34
...in/resources/org/jenkinsci/plugins/pipeline/utility/steps/conf/WriteYamlStep/config.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,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> |
4 changes: 4 additions & 0 deletions
4
...sources/org/jenkinsci/plugins/pipeline/utility/steps/conf/WriteYamlStep/config.properties
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 to YAML. Must be Boolean, Character, Number, String, URL, Calendar, Date, UUID, null or a Collection/Map of them. |
56 changes: 56 additions & 0 deletions
56
src/main/resources/org/jenkinsci/plugins/pipeline/utility/steps/conf/WriteYamlStep/help.html
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.