This page contains examples of provider match and function scripts for some common providers.
...
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
// get necessary information from GitHub headers, payload, and query parameters
def event = HTTP_HEADERS["x-github-event"];
LOG.info("Webhook triggered by ${event} event");
def projectId = QUERY_PARAMS.projectId;
def repoName = PAYLOAD.repository.name;
def branch = PAYLOAD.ref;
LOG.info("Running GitHub function for: ${repoName}, ${branch}");
// if projectId was passed, assume event is only associated with this project
if (projectId)
{
//the query param received is a string, we need a long
def lProjectId = new Long(projectId);
if (event.equals("create"))
{
LOG.fine("Creating stream ${branch} for project ${projectId}");
def stream = FLEXDEPLOY.createStream(projectIdlProjectId, branch);
} LOG.setMessage("Successfully created stream ${branch} for project ${projectId}");
}
else if (event.equals("delete"))
{
LOG.fine("Inactivating stream ${branch} for project ${projectId}");
FLEXDEPLOY.inactivateStream(projectIdlProjectId, branch);
LOG.setMessage("Successfully inactivated stream ${branch} for project ${projectId}");
}
}
// get all project ids for projects affected by this SCM change
else
{
def projects = FLEXDEPLOY.findProjectsForChange(repoName, null, null);
if (event.equals("create"))
{
LOG.fine("Creating streams with name ${branch} for projects ${projects}");
for (def project in projects)
{
def stream = FLEXDEPLOY.createStream(project, branch);
LOG.fine("Successfully created stream ${stream}");
}
LOG.setMessage("Successfully created stream ${branch} for projects ${projects}");
}
else if (event.equals("delete"))
{
LOG.fine("Inactivating stream ${branch} for projects ${projects}");
for (def project in projects)
{
FLEXDEPLOY.inactivateStream(project, branch);
}
LOG.setMessage("Successfully inactivated stream ${branch} for projects ${projects}");
}
}
LOG.info("Successfully ran GitHub function for: ${repoName}, ${branch}"); |
...
This sample GitHub function script manages FlexDeploy builds with the assumption it will be triggered only from a GitHub push event. The function first parses the payload for change logs to send to the buildProject function. Using this function isn't necessary, but it saves time during the build, as this step can be skipped. Then, it will either find all FlexDeploy projects affected by this event or use the projectId query parameter, and initiate a build for each project. It will also create the stream if it does not already exist on the project.
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
import flexagon.ff.common.core.exceptions.FlexNotFoundException;
def repoName = PAYLOAD.repository.name;
def branch = PAYLOAD.ref - 'refs/heads/';
def projectId = QUERY_PARAMS.projectId;
def streamId;
LOG.info("Running GitHub push function: ${repoName}, ${branch}");
def logs = GITHUB.getChangeLogs(PAYLOAD);
LOG.info("Building projects for revision: ${logs.getRevision()}");
// if projectId is passed, then we assume one project per repo and build that project
if (projectId)
{
//the query param received is a string, we need a long
def lProjectId = new Long(projectId);
streamId = getStreamId(lProjectId, branch);
FLEXDEPLOY.buildProject(streamId, lProjectId, logs);
LOG.setMessage("Submitted project ${lProjectId} for build");
}
// otherwise find and build affected projects
else
{
// get all project ids for projects affected by this SCM change
def projects = FLEXDEPLOY.findProjectsForChange(repoName, branch, logs);
if (projects.size() == 0)
{
LOG.info('No projects found for change');
LOG.setMessage("No projects found for change");
}
else
{
LOG.info("Building projects : ${projects}");
// get remaining parameters and build each project
for (def project in projects)
{
streamId = getStreamId(project, branch);
def requestId = FLEXDEPLOY.buildProject(streamId, project, logs);
LOG.info("Successfully submitted build request ${requestId} for ${project}.");
}
LOG.setMessage("Submitted projects ${projects} for build");
}
}
//this will create the stream if it doesnt exist
def getStreamId(projectId, branch) {
def streamId;
try {
streamId = FLEXDEPLOY.findStreamId(projectId,branch);
}
catch(FlexNotFoundException fnfe) {
streamId = FLEXDEPLOY.createStream(projectId,branch);
LOG.info("Added stream ${branch} to project ${projectId}")
}
return streamId;
} |
...
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 | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
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;
} |
...