/**
* Returns control when task is complete.
*
* @param json
* @param logger
*/
private String waitForDeploymentCompletion(JSON json, OctopusApi api, Log logger) {
final long WAIT_TIME = 5000;
final double WAIT_RANDOM_SCALER = 100.0;
JSONObject jsonObj = (JSONObject) json;
String id = jsonObj.getString("TaskId");
Task task = null;
String lastState = "Unknown";
try {
task = api.getTask(id);
} catch (IOException ex) {
logger.error("Error getting task: " + ex.getMessage());
return null;
}
logger.info("Task info:");
logger.info("\tId: " + task.getId());
logger.info("\tName: " + task.getName());
logger.info("\tDesc: " + task.getDescription());
logger.info("\tState: " + task.getState());
logger.info("\n\nStarting wait...");
boolean completed = task.getIsCompleted();
while (!completed) {
try {
task = api.getTask(id);
} catch (IOException ex) {
logger.error("Error getting task: " + ex.getMessage());
return null;
}
completed = task.getIsCompleted();
lastState = task.getState();
logger.info("Task state: " + lastState);
if (completed) {
break;
}
try {
Thread.sleep(WAIT_TIME + (long) (Math.random() * WAIT_RANDOM_SCALER));
} catch (InterruptedException ex) {
logger.info("Wait interrupted!");
logger.info(ex.getMessage());
completed = true; // bail out of wait loop
}
}
logger.info("Wait complete!");
return lastState;
}
/**
* Data binding that returns all possible project names to be used in the project autocomplete.
*
* @return
*/
public ComboBoxModel doFillProjectItems() {
setGlobalConfiguration();
ComboBoxModel names = new ComboBoxModel();
try {
Set<com.octopusdeploy.api.Project> projects = api.getAllProjects();
for (com.octopusdeploy.api.Project proj : projects) {
names.add(proj.getName());
}
} catch (Exception ex) {
Logger.getLogger(OctopusDeployDeploymentRecorder.class.getName())
.log(Level.SEVERE, null, ex);
}
return names;
}
/**
* Check that the releaseVersion field is not empty.
*
* @param releaseVersion The release version of the package.
* @param project The project name
* @return Ok if not empty, error otherwise.
*/
public FormValidation doCheckReleaseVersion(
@QueryParameter String releaseVersion, @QueryParameter String project) {
setGlobalConfiguration();
releaseVersion = releaseVersion.trim();
if (project == null || project.isEmpty()) {
return FormValidation.warning(PROJECT_RELEASE_VALIDATION_MESSAGE);
}
com.octopusdeploy.api.Project p;
try {
p = api.getProjectByName(project);
if (p == null) {
return FormValidation.warning(PROJECT_RELEASE_VALIDATION_MESSAGE);
}
} catch (Exception ex) {
return FormValidation.warning(PROJECT_RELEASE_VALIDATION_MESSAGE);
}
OctopusValidator validator = new OctopusValidator(api);
return validator.validateRelease(
releaseVersion, p.getId(), OctopusValidator.ReleaseExistenceRequirement.MustExist);
}
@Override
public boolean perform(AbstractBuild build, Launcher launcher, BuildListener listener) {
// This method deserves a refactor and cleanup.
boolean success = true;
Log log = new Log(listener);
if (Result.FAILURE.equals(build.getResult())) {
log.info("Not deploying due to job being in FAILED state.");
return success;
}
logStartHeader(log);
// todo: getting from descriptor is ugly. refactor?
getDescriptorImpl().setGlobalConfiguration();
OctopusApi api = getDescriptorImpl().api;
VariableResolver resolver = build.getBuildVariableResolver();
EnvVars envVars;
try {
envVars = build.getEnvironment(listener);
} catch (Exception ex) {
log.fatal(
String.format(
"Failed to retrieve environment variables for this build - '%s'", ex.getMessage()));
return false;
}
EnvironmentVariableValueInjector envInjector =
new EnvironmentVariableValueInjector(resolver, envVars);
// NOTE: hiding the member variables of the same name with their env-injected equivalents
String project = envInjector.injectEnvironmentVariableValues(this.project);
String releaseVersion = envInjector.injectEnvironmentVariableValues(this.releaseVersion);
String environment = envInjector.injectEnvironmentVariableValues(this.environment);
String variables = envInjector.injectEnvironmentVariableValues(this.variables);
com.octopusdeploy.api.Project p = null;
try {
p = api.getProjectByName(project);
} catch (Exception ex) {
log.fatal(
String.format(
"Retrieving project name '%s' failed with message '%s'", project, ex.getMessage()));
success = false;
}
com.octopusdeploy.api.Environment env = null;
try {
env = api.getEnvironmentByName(environment);
} catch (Exception ex) {
log.fatal(
String.format(
"Retrieving environment name '%s' failed with message '%s'",
environment, ex.getMessage()));
success = false;
}
if (p == null) {
log.fatal("Project was not found.");
success = false;
}
if (env == null) {
log.fatal("Environment was not found.");
success = false;
}
if (!success) // Early exit
{
return success;
}
Set<com.octopusdeploy.api.Release> releases = null;
try {
releases = api.getReleasesForProject(p.getId());
} catch (Exception ex) {
log.fatal(
String.format(
"Retrieving releases for project '%s' failed with message '%s'",
project, ex.getMessage()));
success = false;
}
if (releases == null) {
log.fatal("Releases was not found.");
return false;
}
Release releaseToDeploy = null;
for (Release r : releases) {
if (releaseVersion.equals(r.getVersion())) {
releaseToDeploy = r;
break;
}
}
if (releaseToDeploy == null) // early exit
{
log.fatal(
String.format(
"Unable to find release version %s for project %s", releaseVersion, project));
return false;
}
Properties properties = new Properties();
try {
properties.load(new StringReader(variables));
} catch (Exception ex) {
log.fatal(
String.format(
"Unable to load entry variables failed with message '%s'", ex.getMessage()));
success = false;
}
// TODO: Can we tell if we need to call? For now I will always try and get variable and use if I
// find them
Set<com.octopusdeploy.api.Variable> variablesForDeploy = null;
try {
String releaseId = releaseToDeploy.getId();
String environmentId = env.getId();
variablesForDeploy =
api.getVariablesByReleaseAndEnvironment(releaseId, environmentId, properties);
} catch (Exception ex) {
log.fatal(
String.format(
"Retrieving variables for release '%s' to environment '%s' failed with message '%s'",
releaseToDeploy.getId(), env.getName(), ex.getMessage()));
success = false;
}
try {
String results =
api.executeDeployment(releaseToDeploy.getId(), env.getId(), variablesForDeploy);
if (isTaskJson(results)) {
JSON resultJson = JSONSerializer.toJSON(results);
String urlSuffix = ((JSONObject) resultJson).getJSONObject("Links").getString("Web");
String url = getDescriptorImpl().octopusHost;
if (url.endsWith("/")) {
url = url.substring(0, url.length() - 2);
}
log.info("Deployment executed: \n\t" + url + urlSuffix);
build.addAction(
new BuildInfoSummary(
BuildInfoSummary.OctopusDeployEventType.Deployment, url + urlSuffix));
if (waitForDeployment) {
log.info("Waiting for deployment to complete.");
String resultState = waitForDeploymentCompletion(resultJson, api, log);
if (resultState == null) {
log.info("Marking build failed due to failure in waiting for deployment to complete.");
success = false;
}
if ("Failed".equals(resultState)) {
log.info("Marking build failed due to deployment task status.");
success = false;
}
}
}
} catch (IOException ex) {
log.fatal("Failed to deploy: " + ex.getMessage());
success = false;
}
return success;
}