Skip to content

Added exportDslToGit procedure #13

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

Open
sverb wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Added exportDslToGit procedure #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a5717a
Added exportDslToGit procedure
Jun 5, 2020
56816b9
code review corrections
Jun 5, 2020
70d9d9c
refactored plugin to use EC-Git Pull and Clone procedures instead of …
Nov 4, 2020
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
254 changes: 254 additions & 0 deletions dsl/procedures/exportDslToGit/form.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,254 @@
<!--

Copyright 2019 Electric Cloud, 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.

-->
<editor>
<formElement>
<type>entry</type>
<label>Server Resource</label>
<property>rsrcName</property>
<required>1</required>
<value>local</value>
<documentation>The resource where the DSL files will be checked out from git and imported to the Flow server. The directory on this resource must be accessible from the Flow server.</documentation>
</formElement>
<formElement>
<type>entry</type>
<label>Destination Directory:</label>
<property>dest</property>
<required>1</required>
<documentation>The directory on the resource where the source tree will be created and from where the DSL files are read to be imported in Flow server. This directory must be accessible from the Flow server. In a clustered deployment, all Flow server nodes must have access to this directory.</documentation>
</formElement>
<formElement>
<type>checkbox</type>
<label>Cleanup?:</label>
<property>cleanup</property>
<checkedValue>1</checkedValue>
<uncheckedValue>0</uncheckedValue>
<initiallyChecked>0</initiallyChecked>
<documentation>This option will delete the destination directory with the source tree after the job execution.</documentation>
<required>0</required>
</formElement>
<formElement>
<type>checkbox</type>
<label>Clone?:</label>
<property>clone</property>
<checkedValue>1</checkedValue>
<uncheckedValue>0</uncheckedValue>
<initiallyChecked>0</initiallyChecked>
<documentation>This option will clone a repository into a newly created directory.</documentation>
<required>0</required>
</formElement>

<formElement>
<type>checkbox</type>
<label>Overwrite?:</label>
<property>GitOverwrite</property>
<checkedValue>1</checkedValue>
<uncheckedValue>0</uncheckedValue>
<initiallyChecked>0</initiallyChecked>
<documentation>This option will overwrite a repository if it already exists.</documentation>
<required>0</required>
</formElement>
<formElement>
<type>entry</type>
<label>Git Configuration:</label>
<property>gitConfig</property>
<documentation>The name of a saved Git configuration.</documentation>
<required>1</required>
<configuration>1</configuration>
</formElement>
<formElement>
<type>entry</type>
<label>Git Repository URL:</label>
<property>repoUrl</property>
<documentation>URL to the repository to pull from. ie: 'git://server/repo.git'.</documentation>
<required>1</required>
</formElement>

<formElement>
<type>entry</type>
<label>Remote Branch Name:</label>
<property>branch</property>
<documentation>The name of the Git branch to use. ie: 'experimental'.</documentation>
<required>0</required>
</formElement>

<formElement>
<type>entry</type>
<label>Object Type</label>
<property>objectType</property>
<required>1</required>
<documentation>Object type to generate DSL for.</documentation>
</formElement>
<formElement>
<type>entry</type>
<label>Object Name</label>
<property>objectName</property>
<required>1</required>
<documentation>Object name to generate DSL for.</documentation>
</formElement>
<formElement>
<type>textarea</type>
<property>files</property>
<required>1</required>
<documentation>Files pattern (GLOB) to use to add files to the commit. Each pattern per line.</documentation>
<label>Files:</label>
<value>.</value>>
</formElement>
<formElement>
<type>textarea</type>
<property>message</property>
<required>0</required>
<documentation>Commit message for the newly created commit. If not provided, date and CloudBees CD Job ID will be used to identify the commit.</documentation>
<label>Commit Message:</label>
</formElement>
<formElement>
<type>entry</type>
<property>committerName</property>
<required>1</required>
<documentation>Name of the committer (someone who has committed the code as opposed to the author).</documentation>
<label>Committer Name:</label>
</formElement>
<formElement>
<type>entry</type>
<property>committerEmail</property>
<required>1</required>
<documentation>Email of the committer.</documentation>
<label>Committer Email:</label>
</formElement>
<formElement>
<type>checkbox</type>
<property>removeMissing</property>
<documentation>If checked, the files that are missing from the repository will be removed from SCM.</documentation>
<label>Remove Missing?:</label>
<checkedValue>1</checkedValue>
<uncheckedValue>0</uncheckedValue>
<initiallyChecked>0</initiallyChecked>
</formElement>
<formElement>
<type>checkbox</type>
<property>failOnEmptyCommit</property>
<documentation>If checked, the procedure will fail if there is nothing to commit.</documentation>
<label>Fail on Empty Commit?:</label>
<checkedValue>1</checkedValue>
<uncheckedValue>0</uncheckedValue>
<initiallyChecked>0</initiallyChecked>
</formElement>

<formElement>
<type>checkbox</type>
<label>Suppress Nulls</label>
<property>suppressNulls</property>
<required>0</required>
<checkedValue>1</checkedValue>
<uncheckedValue>0</uncheckedValue>
<value>1</value>
<documentation>Exclude from the generated DSL properties with null value.</documentation>
</formElement>

<formElement>
<type>checkbox</type>
<label>Suppress Defaults</label>
<property>suppressDefaults</property>
<required>0</required>
<checkedValue>1</checkedValue>
<uncheckedValue>0</uncheckedValue>
<value>0</value>
<documentation>Exclude from the generated DSL properties with default value.</documentation>
</formElement>

<formElement>
<type>checkbox</type>
<label>Suppress Parent</label>
<property>suppressParent</property>
<required>0</required>
<checkedValue>1</checkedValue>
<uncheckedValue>0</uncheckedValue>
<value>0</value>
<documentation>Exclude from the generated DSL properties referred to object parent.</documentation>
</formElement>

<formElement>
<type>checkbox</type>
<label>Include ACLs</label>
<property>includeAcls</property>
<required>0</required>
<checkedValue>1</checkedValue>
<uncheckedValue>0</uncheckedValue>
<value>0</value>
<documentation>Include in ACLs for objects.</documentation>
</formElement>

<formElement>
<type>checkbox</type>
<label>Include ACLs in different file</label>
<property>includeAclsInDifferentFile</property>
<required>0</required>
<checkedValue>1</checkedValue>
<uncheckedValue>0</uncheckedValue>
<value>0</value>
<documentation>Include ACLs for generated objects in different file.</documentation>
</formElement>

<formElement>
<type>checkbox</type>
<label>Include All Children</label>
<property>includeAllChildren</property>
<required>0</required>
<checkedValue>1</checkedValue>
<uncheckedValue>0</uncheckedValue>
<value>0</value>
<documentation>Include in the generated DSL all object children. If True - ignore value of 'Include Children' parameter.</documentation>
</formElement>

<formElement>
<type>textarea</type>
<label>Include children</label>
<property>includeChildren</property>
<required>0</required>
<documentation>Comma-separated list of object children the DSL should be generated for.</documentation>
</formElement>

<formElement>
<type>checkbox</type>
<label>Include Children in Same File</label>
<property>includeChildrenInSameFile</property>
<required>0</required>
<checkedValue>1</checkedValue>
<uncheckedValue>0</uncheckedValue>
<value>0</value>
<documentation>Include in the generated DSL all object children. If True - ignore value of 'Include Children' parameter.</documentation>
</formElement>

<formElement>
<type>textarea</type>
<label>Children in Different Files</label>
<property>childrenInDifferentFile</property>
<required>0</required>
<documentation>Comma-separated list of patterns to include, like pipelines, procedures.*, applications.applicationTiers.components</documentation>
</formElement>

<formElement>
<type>entry</type>
<label>Tag:</label>
<property>tag</property>
<documentation>Provide the name of a specific tag to checkout after the clone command.</documentation>
<required>0</required>
<dependsOn>clone</dependsOn>
<condition>${clone} == "1"</condition>
</formElement>

</editor>
80 changes: 80 additions & 0 deletions dsl/procedures/exportDslToGit/procedure.dsl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
import java.io.File

def procName = 'exportDslToGit'
procedure procName, {
jobNameTemplate = 'export-dsl-to-git-$[jobId]'

step 'Clone',
subprocedure: 'Clone',
subproject: '/plugins/EC-Git/project',
condition: '$[/myJob/actualParameters/clone]',
errorHandling:'abortProcedure',
resourceName: '$[rsrcName]',
actualParameter: [
branch: '$[branch]',
config: '$[gitConfig]',
gitRepoFolder: '$[dest]',
overwrite: '$[GitOverwrite]',
repoUrl: '$[repoUrl]',
tag: '$[tag]'
]

step 'Pull',
subprocedure: 'Pull',
subproject: '/plugins/EC-Git/project',
resourceName: '$[rsrcName]',
errorHandling: 'abortProcedure',
actualParameter: [
branch: '$[branch]',
config: '$[gitConfig]',
gitRepoFolder: '$[dest]',
repoUrl: '$[repoUrl]',
]

step 'generateDslToDirectory',
subprocedure: 'generateDslToDirectory',
errorHandling: 'abortProcedure',
actualParameter: [
directory: '$[dest]',
objectType: '$[objectType]',
objectName: '$[objectName]',
pool: '$[rsrcName]',
suppressNulls: '$[suppressNulls]',
suppressDefaults: '$[suppressDefaults]',
suppressParent: '$[suppressParent]',
includeAcls: '$[includeAcls]',
includeAclsInDifferentFile: '$[includeAclsInDifferentFile]',
includeAllChildren: '$[includeAllChildren]',
includeChildren: '$[includeChildren]',
includeChildrenInSameFile: '$[includeChildrenInSameFile]',
childrenInDifferentFile: '$[childrenInDifferentFile]'
]

step 'exportDslToGit',
subprocedure: 'Commit',
subproject:'/plugins/EC-Git/project',
resourceName: '$[rsrcName]',
errorHandling: 'abortProcedure',
actualParameter: [
committerEmail: '$[committerEmail]',
committerName: '$[committerName]',
config: '$[gitConfig]',
failOnEmptyCommit: '$[failOnEmptyCommit]',
files: '$[files]',
gitRepoFolder: '$[dest]',
message: '$[message]',
push: 'true',
removeMissing: '$[removeMissing]'
]

step 'cleanup', {
condition = '''$[/javascript
var cleanup= \'$[cleanup]\';
(cleanup== \'true\' || cleanup== \'1\') ;
]'''
alwaysRun = '1'
command = new File(pluginDir, "dsl/procedures/$procName/steps/cleanup.groovy").text
resourceName = '$[rsrcName]'
shell = 'ec-groovy'
}
}
1 change: 1 addition & 0 deletions dsl/procedures/exportDslToGit/steps/cleanup.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
new File("$[dest]").deleteDir()
15 changes: 8 additions & 7 deletions dsl/procedures/importDslFromGit/form.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
</formElement>
<formElement>
<type>checkbox</type>
<label>Overwrite mode</label>
<label>DSL Overwrite Mode</label>
<property>overwrite</property>
<required>0</required>
<checkedValue>1</checkedValue>
Expand All @@ -54,16 +54,16 @@
</formElement>
<formElement>
<type>entry</type>
<label>Configuration:</label>
<property>config</property>
<label>Configuration Name:</label>
<property>gitConfig</property>
<documentation>The name of a saved SCM configuration.</documentation>
<required>1</required>
<configuration>1</configuration>
</formElement>
<formElement>
<type>entry</type>
<label>Git repository:</label>
<property>GitRepo</property>
<label>Git Repository URL:</label>
<property>repoUrl</property>
<documentation>URL to the repository to pull from. ie: 'git://server/repo.git'.</documentation>
<required>1</required>
</formElement>
Expand All @@ -77,8 +77,9 @@

<formElement>
<type>entry</type>
<label>Remote Branch:</label>
<property>GitBranch</property>
<label>Remote Branch Name:</label>
<property>branch</property>
<value>master</value>
<documentation>The name of the Git branch to use. ie: 'experimental'.</documentation>
<required>0</required>
</formElement>
Expand Down
Loading