{"type":"doc","content":[{"type":"paragraph","content":[{"text":"A groovy script can be used in custom gates and steps, as well as for many configuration values on specific steps or gates. Additionally, a gate or step can be skipped by providing a Precondition groovy script. This page includes some sample scripts for these scenarios. See ","type":"text"},{"text":"Pipeline Groovy Variables and Methods","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/FD70/pages/10340174341"}}]},{"text":" for a full listing of the accessible variables and methods in these groovy scripts.","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"c55f0089-2879-40ca-bc5c-a49214e4da74"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"43a2ef4c-48e9-4064-83da-32b0c45c7174"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Custom Gates and Steps","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Override Deploy Target Group on All Projects with Plugin Suffix in Name","type":"text"}]},{"type":"paragraph","content":[{"text":"The following script uses the setInstanceOverride method to set the deploy target group on the stage for each project in the snapshot with 'Plugin' at the end of the name. This could function as a custom gate or step.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"groovy"},"content":[{"text":"snapshotProjects=stgexec.getSnapshotProjects();\nfor(snapshotProject in snapshotProjects)\n{\n if(snapshotProject.getProjectName().endsWith(\"Plugin\"))\n {\n stgexecinfo.setInstanceOverride(snapshotProject.getProjectId(), \"WEBLOGIC\")\n }\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Override Deploy Target Group Based on Project Type","type":"text"}]},{"type":"paragraph","content":[{"text":"In this scenario, the pipeline should only be deploying to the EBS target group for projects with type EBS. This could be used as a custom gate or step.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"groovy"},"content":[{"text":"def projects = stgexec.getSnapshotProjects();\n\nfor (def project in projects)\n{\n\tif (project.getProjectType() != null)\n\t{\n \tif ('EBS'.equals(project.getProjectType()))\n \t{\n \tstgexecinfo.setInstanceOverride(project.getProjectId(), project.getPackageName(), 'EBS');\n \t}\n\t}\n}","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Validate Snapshot Contents","type":"text"}]},{"type":"paragraph","content":[{"text":"A pipeline can prevent deployments of any unexpected projects in the snapshot with a script similar to the following. This would best be implemented as a custom gate in the first stage of the pipeline.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"groovy"},"content":[{"text":"expectedProjects = \"HRWLSConfigurations,HRMDSObjects,HRSOAService,HRJavaApp,ValidatePaymentSB\".split(\",\");\n\nfor (p in stgexec.getSnapshotProjects())\n{\n if (!expectedProjects.contains(p.getProjectName()))\n {\n throw new RuntimeException(\"Project: \" + p.getProjectName() + \" was not expected.\");\n }\n}\n\nreturn \"SUCCESSFUL\";","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Deploy all projects sequentially across the target groups","type":"text"}]},{"type":"paragraph","content":[{"text":"This script will deploy the projects that are in the release one at a time to their target groups, one at a time. It will send all the projects and packages at the first priority level first, and then move on if none have failed to the next priority.","type":"text"}]},{"type":"codeBlock","content":[{"text":"import flexagon.fd.model.pojos.workflowrequest.*;\nimport flexagon.fd.model2.pojo.*;\nimport flexagon.fd.model.jaxb.releaseautomation.model.*;\n\ndef checkRunning(Long requestId){\n if(requestId == -1){\n return \"DONE\";\n }\n sleep(10000);\n List wfes = FLEXDEPLOY.getWorkflowExecutionByWorkflowRequestId(requestId);\n for(wfe in wfes){\n if(wfe.getExecutionStatus() == 'Running' || wfe.getExecutionStatus() == 'Pending'){\n \n return \"WAIT\";\n }\n if(wfe.getExecutionStatus() == 'Failure'){\n return (\"Deployment workflow execution \" + wfe.getWorkflowExecutionId() + \" for project \" + wfe.getProjectId() + \" failed.\");\n }\n }\n return \"DONE\";\n}\n\nLong safeDeploy(Long projectId, String environmentCode, DeployOptions deployOptions){\n if(stgexecinfo.isUserSkipDeploy(projectId)){\n return -1;\n }\n\n deployOptions.setForce(stgexecinfo.isUserForceDeploy(projectId));\n \n try{\n return FLEXDEPLOY.deployProject(projectId,environmentCode,deployOptions);\n }catch(Exception e){\n if(e.getMessage() != null && e.getMessage().contains(\"FDML-00169\")){\n return -1\n }\n return -2;\n }\n}\n\nRelSnapshotVersionDataObject findProjectVersionInfo(ReleaseProjectType p, projects){\n for (RelSnapshotVersionDataObject x in projects){\n if(x.getProjectId() == p.getProjectId() && x.getPackageName() == p.getPackageName()){\n return x;\n }\n }\n return null;\n}\n\nMap> priorityLevels = new HashMap<>();\nList projects = FLEXDEPLOY.getSnapshotDetails(SnapshotId).getVersionDataObjects()\nfor (p in stgexecinfo.getExecutionData().getReleaseProjects().getProject())\n{\n RelSnapshotVersionDataObject rsvdo = findProjectVersionInfo(p, projects);\n if(rsvdo == null){\n //Skipping all utility projects. Those will not be run from this, so this is like deployall step.\n continue;\n }\n\n List prorityLevel = priorityLevels.getOrDefault(rsvdo.getPriority(), []);\n prorityLevel.add(rsvdo);\n priorityLevels.put(rsvdo.getPriority(), prorityLevel);\n}\nfor (Map.Entry> priorityLevel in priorityLevels)\n{\n failed = [];\n for(rsvdo in priorityLevel.getValue())\n {\n DeployOptions deployOptions = new DeployOptions();\n deployOptions.setProjectStreamId(rsvdo.getProjectStreamId());\n deployOptions.setProjectVersionId(rsvdo.getProjectVersionId());\n if(!stgexecinfo.getInstanceOverride(rsvdo.getProjectId(),rsvdo.getPackageName()).isEmpty())\n {\n for( target in stgexecinfo.getInstanceOverride(rsvdo.getProjectId(),rsvdo.getPackageName()))\n {\n\n deployOptions.getInstanceIds().clear();\n deployOptions.getInstanceIds().add(FLEXDEPLOY.getTargetGroupByCode(target).getTargetGroupId())\n \n requestId = safeDeploy(rsvdo.getProjectId(),stgexec.getEnvironmentCode(),deployOptions);\n if(requestId == -2){\n failed += (\"Could not deploy project \" + rsvdo)\n }\n allDone = \"WAIT\";\n while (allDone == \"WAIT\")\n {\n //wait for it to finish before moving on to the next.\n allDone = checkRunning(requestId);\n }\n if(allDone != \"DONE\"){\n failed += allDone;\n }\n }\n } else\n {\n requestId = safeDeploy(rsvdo.getProjectId(),stgexec.getEnvironmentCode(),deployOptions);\n if(requestId == -2){\n failed += (\"Could not deploy project \" + rsvdo)\n }\n allDone = \"WAIT\";\n while (allDone == \"WAIT\")\n {\n //wait for it to finish before moving on to the next.\n allDone = checkRunning(requestId);\n }\n if(allDone != \"DONE\"){\n failed += allDone;\n }\n }\n }\n if (!failed.isEmpty()){\n throw new RuntimeException(\"\" + failed.size() + \" requests in priority group \" + priorityLevel.getKey() + \" failed. \" + failed);\n }\n}\n\n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Change Workflows and Target Groups for all the projects in a specific folder.","type":"text"}]},{"type":"paragraph","content":[{"text":"This is useful when you have many projects in a folder, that will have the same build/deploy workflow, and the same build and deploy instance. ","type":"text"}]},{"type":"codeBlock","content":[{"text":"import flexagon.fd.model.pojos.rest.topology.integrations.SCMInstancePojo;\nimport flexagon.fd.model.pojos.rest.properties.PropertyValuePojo;\nimport flexagon.fd.model.pojos.rest.project.*;\nimport flexagon.fd.core.enums.SCMTypeEnum;\nimport flexagon.fd.core.enums.ProjectTypeEnum;\nimport flexagon.fd.model.pojos.rest.properties.PropertyValuePojo;\nimport flexagon.fd.model.pojos.folder.*;\nimport flexagon.fd.model2.pojo.ProjectDataObject;\n\nimport flexagon.fd.services.groovy.functions.*;\n \nFlexDeploy2Functions FLEXDEPLOY = new FlexDeploy2Functions();\n\ndef projectDataObject = new ProjectDataObject();\nprojectDataObject.setFolderId(8996557);\n\ndef resProjects = FLEXDEPLOY.searchProjects(projectDataObject,10,0).getItems();\n\ndef proj = new ProjectPojo();\n \ndef buildInfo = new ProjectBuildInfo();\ndef deployInfo = new ProjectDeployInfo();\n \nbuildInfo.setWorkflowId(675528L);\nbuildInfo.setInstanceId(303656L);\n \ndeployInfo.setWorkflowId(5885144L);\ndeployInfo.setInstanceIds([303656L]);\n \nproj.setBuildInfo(buildInfo);\nproj.setDeployInfo(deployInfo);\n\nfor(def project:resProjects)\n{\ndef projectId = project.getProjectId();\nFLEXDEPLOY.patchProject(projectId, proj);\n}","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Precondition Scripts","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Execute Step Only for Specific Object Type","type":"text"}]},{"type":"paragraph","content":[{"text":"This could be used to conditionally call a Restart OACore or Generate Jar utility workflow only if OAF_JAVA files are deployed.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#172b4d"}}]}]},{"type":"codeBlock","attrs":{"language":"groovy"},"content":[{"text":"def deployedTypes = stgexec.getProjectWorkflowOutputValues(\"DeployedTypes\");\n\nfor (String listItem : deployedTypes)\n{ \n if (listItem.contains('OAF_JAVA'))\n {\n return true;\n }\n}\n\nreturn false;","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Execute Gate only if Snapshot Projects contain a specific Project Group","type":"text"}]},{"type":"paragraph","content":[{"text":"This is useful when you could want technology/team specific approvals which would only make sense to do when that particular Project Group/Technology is included in the snapshot.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"groovy"},"content":[{"text":"def projectGroup = \"Oracle Integrations\"\nreturn stgexec.getSnapshotProjects().findIndexOf { \n projectGroup in it.getProjectGroupNames() \n} != -1","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Create Comments","type":"text"}]},{"type":"paragraph","content":[{"text":"Use FLEXDEPLOY function createComment with FdCommentDataObject as an argument to create comment. FdCommentDataObject contains commentId, objectId, commentText, parentObjectId, objectType and versionNumber.","type":"text"}]},{"type":"paragraph","content":[{"text":"The below table will explain the Object Types supported and inputs that needs to be passed based on the type.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1800.0,"localId":"69fb5c87-6414-4de4-8a45-7e8d95915bf7"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-accent-gray-subtlest, #F4F5F7)","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Object Type","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-accent-gray-subtlest, #F4F5F7)","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Object Id","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"background":"var(--ds-background-accent-gray-subtlest, #F4F5F7)","rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parent Object Id","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"PIPELINE_GATE_EXEC","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Pipeline stage gate id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Pipeline exec id","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"PIPELINE_STEP_EXEC","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Pipeline stage step id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Pipeline exec id","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"PIPELINE_GATE","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Pipeline stage gate id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"PIPELINE_STEP","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Pipeline stage step id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"RELEASE","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Release definition id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"WORKITEM","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Flx WorkItem id","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":" ","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Below sample script creates a comment for pipeline gate execution object type.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"groovy"},"content":[{"text":"import flexagon.fd.model2.pojo.*;\n\nFdCommentDataObject dObj = new FdCommentDataObject();\ndObj.setObjectId();\ndObj.setParentObjectId();\ndObj.setObjectType(\"PIPELINE_GATE_EXEC\");\ndObj.setCommentText(\"New comment in PIPELINE GATE EXECECUTION through webhook\");\nFdCommentDataObject result = FLEXDEPLOY.createComment(dObj);","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Release Methods from FlexDeploy2Functions class","type":"text"}]},{"type":"paragraph","content":[{"text":"public List createReleaseProjects(Long pReleaseId, List pPojos)","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Use FLEXDEPLOY function createReleaseProjects with List as an argument to create release projects.","type":"text"},{"type":"hardBreak"},{"text":"RelProjectDataObject contains RelProjectId, BuildEnvironmentId, ProjectId, ProjectBranchId, RelDefinitionId, PackageName, ProjectGroups, DeployPriority","type":"text"}]},{"type":"paragraph","content":[{"text":"Prepare the RelProjectDataObject with above details and pass into the createReleaseProjects.","type":"text"}]},{"type":"paragraph","content":[{"text":"Above method can create multiple release projects in the release. If you want to create only one project in the release, then you can use the below method.","type":"text"}]},{"type":"paragraph","content":[{"text":"public RelProjectDataObject createReleaseProject(RelProjectDataObject pPojo)","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Below sample script adds the project to release.","type":"text"}]},{"type":"codeBlock","content":[{"text":"import flexagon.fd.model2.pojo.*;\n\n//For package based project \nRelProjectDataObject dataObj = new RelProjectDataObject();\ndef streamId = FLEXDEPLOY.findStreamId(,);\ndataObj.setBuildEnvironmentId(); // not mandatory\ndataObj.setDeployPriority(); // not mandatory\ndataObj.setPackageName();\ndataObj.setProjectId();\ndataObj.setProjectBranchId();\ndataObj.setRelDefinitionId();\ndataObj.setProjectGroups(); //set project group id as string\nLOG.info(\"Release Project added to release ---- \"+FLEXDEPLOY.createReleaseProject(dataObj));","type":"text"}]},{"type":"paragraph","content":[{"text":"public RelProjectDataObject patchReleaseProject(RelProjectDataObject pRelProjectDataObj)","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Use FLEXDEPLOY function to patch the Release Project details. It should take RelProjectDataObject as an argument to patch the release project details.","type":"text"}]},{"type":"paragraph","content":[{"text":"Prepare the RelProjectDataObject with RelDefinitionId and other required filed to be patched.","type":"text"}]},{"type":"paragraph","content":[{"text":"Below sample script can patch the release project details.","type":"text"}]},{"type":"codeBlock","content":[{"text":"import flexagon.fd.model2.pojo.*;\n\nRelProjectDataObject dataObj = new RelProjectDataObject();\ndef streamId = FLEXDEPLOY.findStreamId(,);\ndataObj.setBuildEnvironmentId();\ndataObj.setDeployPriority(();\ndataObj.setProjectBranchId(streamId);\ndataObj.setRelProjectId();\ndataObj.setProjectGroups(); //set project group id as string\nLOG.info(\"Release Project patched ---- \"+FLEXDEPLOY.patchReleaseProject(dataObj));","type":"text"}]},{"type":"paragraph","content":[{"text":"public RelDefinitionDataObject copyRelease(CopyReleaseInput pCopyReleaseInput)","type":"text","marks":[{"type":"strong"}]}]},{"type":"paragraph","content":[{"text":"Use FLEXDEPLOY function copy Release that copies from source release details to the target or new release. created through copyRelease function.","type":"text"},{"type":"hardBreak"},{"text":"It takes CopyReleaseInput as an argument. CopyReleaseInput contains SourceRelDefinitionId, TargetFolderId, TargetReleaseName along with boolean type inputs are CopyTags, CopyWorkItems, CopyProjects, CopyOverridenRoleMembers, CopyOverridenSettings. Boolean type fields are optional, by default they are set to false so if any of those fields are set to true then those will be copied from source release to target release.","type":"text"}]},{"type":"paragraph","content":[{"text":"Below sample script can create a target release from the source release details.","type":"text"}]},{"type":"codeBlock","content":[{"text":"import flexagon.fd.model2.pojo.*;\n\nRelDefinitionDataObject dataObj = new RelDefinitionDataObject();\nCopyReleaseInput input = new CopyReleaseInput();\ninput.setSourceRelDefinitionId(); //required\ninput.setTargetFolderId(); //required\ninput.setTargetReleaseName(); //required\ninput.setCopyTags(true); // as per requirement set it to true, default is false\ninput.setCopyWorkItems(true); // as per requirement set it to true, default is false\ninput.setCopyProjects(true); // as per requirement set it to true, default is false\ninput.setCopyOverridenRoleMembers(true); // as per requirement set it to true, default is false\ninput.setCopyOverridenSettings(true); // as per requirement set it to true, default is false\ndataObj = FLEXDEPLOY.copyRelease(input);\nLOG.info(\"created release id = \"+dataObj.getRelDefinitionId() + \" release name = \"+dataObj.getRelName() + \" release status = \"+dataObj.getRelStatus());","type":"text"}]},{"type":"paragraph","content":[{"text":" ","type":"text"}]}],"version":1}