This page contains examples of provider match and function scripts for some common providers.
GitHub
Provider Match - Hmac Secret
...
This sample Bitbucket function script manages FlexDeploy builds and project streams with the assumption it will be triggered from a Bitbucket push event. Branch creation and deletion all falls under the push event in Bitbucket. This function will create and inactivate FlexDeploy streams as branches are created and deleted, and build all affected projects on a push.
| Info |
|---|
Bitbucket does not send changed files in the push event, but that information is available via the diffstat API. The getChangeLogs function will use that API and as such requires a valid user/password to make the api call. It is recommended that BITBUCKET_USER and BITBUCKET_PASSWORD provider properties are created for passing to this function. |
| Code Block |
|---|
| language | groovy |
|---|
| theme | RDark |
|---|
| title | Bitbucket Push Function Script |
|---|
| linenumbers | true |
|---|
|
def repoName = PAYLOAD.repository.full_name;
def branch;
def isNewBranch = PAYLOAD.push.changes[0].old == null;
def isDeletedBranch = PAYLOAD.push.changes[0].new == null;
def streamCache = [:];
if (isDeletedBranch)
{
branch = PAYLOAD.push.changes[0].old.name;
LOG.info("Running BitbucketPush function: ${repoName}, ${branch}");
LOG.info("Branch ${branch} has been deleted. Inactivating all associated streams");
def logs = BITBUCKET.getChangeLogs(PAYLOAD, BITBUCKET_USER, BITBUCKET_PASSWORD);
// if projectId is passed, then we assume one project per repo and only that project was affected
if (QUERY_PARAMS.projectId)
{
projects = QUERY_PARAMS.projectId;
}
else
{
projects = FLEXDEPLOY.findProjectsForChange(repoName, branch, logs);
}
for (def project in projects)
{
LOG.info("Inactivating stream ${branch} for project ${project}");
FLEXDEPLOY.inactivateStream(project, branch);
}
}
else
{
branch = PAYLOAD.push.changes[0].new.name;
LOG.info("Running BitbucketPush function: ${repoName}, ${branch}");
if (isNewBranch)
{
streamCache = tryCreateStreams(repoName, branch);
}
// find the changed files for the push
def logs = BITBUCKET.getChangeLogs(PAYLOAD, BITBUCKET_USER, BITBUCKET_PASSWORD);
LOG.info(String.format("Building projects for revision: %s", logs.getRevision()));
def projects;
// if projectId is passed, then we assume one project per repo and build that project
if (QUERY_PARAMS.projectId)
{
projects = QUERY_PARAMS.projectId;
}
else
{
projects = FLEXDEPLOY.findProjectsForChange(repoName, branch, logs);
}
LOG.info(String.format("Building projects : %s", projects));
if (projects.size() == 0)
{
LOG.info("No projects found for change");
}
else
{
for (def project in projects)
{
LOG.info("Building project ${project}");
def streamId = findStreamId(project, branch, streamCache, isNewBranch);
def requestId = FLEXDEPLOY.buildProject(streamId, project, logs);
LOG.info("Successfully submitted build request ${requestId} for ${project}.");
}
}
}
// if this commit was on a new branch, get from cache, otherwise check on server
def findStreamId(projectId, streamName, streamCache, isNewBranch)
{
def streamId = null;
if (isNewBranch)
{
streamId = streamCache[projectId];
}
else
{
streamId = FLEXDEPLOY.findStreamId(projectId, streamName);
}
return streamId;
}
// this event is only received once (on creation of a new branch)
def tryCreateStreams(repoName, branch)
{
def allProjects = FLEXDEPLOY.findProjectsForChange(repoName, null, null);
def streams = [:];
for (def project in allProjects)
{
LOG.info(String.format("Creating stream %s on project %s", branch, project));
def streamId = FLEXDEPLOY.createStream(project, branch);
streams[project] = streamId;
}
return streams;
} |
...
| Code Block |
|---|
| language | groovy |
|---|
| theme | RDark |
|---|
| title | Jira Provider Match Script |
|---|
| linenumbers | true |
|---|
|
// perform checks and functions to ensure an incoming message is valid and matches this provider
LOG.fine("Evaluating Jira for incoming message");
def match = false;
// validating based on token and user agent headers
def userAgent = HTTP_HEADERS.get('user-agent');
def token = QUERY_PARAMS.get('token');
if (token && userAgent)
{
//validate token matches what we expect in FlexDeploy
//It's recommended to store the token as an encrypted provider property but it is not done here for completeness sake
LOG.fine("Using token ${token} and user agent ${userAgent}");
if (token.equals('your_custom_token'))
{
if(userAgent.toLowerCase().equals('atlassian webhook http client'))
{
match = true;
}
}
}
LOG.fine("Jira provider is a match: ${match}");
return match; |
Function Script - Create Package
This Jira function creates a project package from the issue key and description. The particular function assumes the Jira project name is the same as the FlexDeploy project name, although an issue could be mapped to a FlexDeploy project in a number of ways. You may want to trigger this package creation whenever a Jira issue is created, or when an issue goes into development.
| Code Block |
|---|
| language | groovy |
|---|
| theme | RDark |
|---|
| title | Create Package on Issue Started |
|---|
| linenumbers | true |
|---|
|
import flexagon.ff.common.core.exceptions.FlexCheckedException;
def functionName = "createPackage";
LOG.info("Running function: ${functionName}");
def issueKey = PAYLOAD.issue.key;
def summary = PAYLOAD.issue.fields.summary;
def projectName = PAYLOAD.issue.project.name;
tryCreatePackage(projectName, issueKey, summary);
def tryCreatePackage(name, description)
{
try
{
LOG.info("Attempting to create package ${name}.");
def projectId = FLEXDEPLOY.findProjectId(projectName);
def packageId = FLEXDEPLOY.createPackage(projectId, name, description, []);
LOG.info("Created package ${name} with id ${packageId} for project ${projectName}");
}
catch (FlexCheckedException e)
{
// this exception indicates the package already exists
if (e.getMessage().contains('JBO-FDML-2700'))
{
LOG.setMessage("Package ${name} already exists.");
}
else
{
throw e;
}
}
} |
Slack
Provider Match Script - Hmac Secret
...