public async Task Deploy(string id = null)
{
JObject result = GetJsonContent();
// Just block here to read the json payload from the body
using (_tracer.Step("DeploymentService.Deploy(id)"))
{
await _deploymentLock.LockHttpOperationAsync(async() =>
{
try
{
if (_autoSwapHandler.IsAutoSwapOngoing())
{
throw new HttpResponseException(Request.CreateErrorResponse(HttpStatusCode.Conflict, Resources.Error_AutoSwapDeploymentOngoing));
}
bool clean = false;
bool needFileUpdate = true;
if (result != null)
{
clean = result.Value <bool>("clean");
JToken needFileUpdateToken;
if (result.TryGetValue("needFileUpdate", out needFileUpdateToken))
{
needFileUpdate = needFileUpdateToken.Value <bool>();
}
}
string username = null;
AuthUtility.TryExtractBasicAuthUser(Request, out username);
IRepository repository = _repositoryFactory.GetRepository();
if (repository == null)
{
throw new HttpResponseException(Request.CreateErrorResponse(HttpStatusCode.NotFound, Resources.Error_RepositoryNotFound));
}
ChangeSet changeSet = null;
if (!String.IsNullOrEmpty(id))
{
changeSet = repository.GetChangeSet(id);
if (changeSet == null)
{
string message = String.Format(CultureInfo.CurrentCulture, Resources.Error_DeploymentNotFound, id);
throw new HttpResponseException(Request.CreateErrorResponse(HttpStatusCode.NotFound, message));
}
}
await _deploymentManager.DeployAsync(repository, changeSet, username, clean, needFileUpdate);
_autoSwapHandler.HandleAutoSwap(verifyActiveDeploymentIdChanged: false);
}
catch (FileNotFoundException ex)
{
throw new HttpResponseException(Request.CreateErrorResponse(HttpStatusCode.NotFound, ex));
}
});
}
}
public override async Task ProcessRequestAsync(HttpContext context)
{
using (_tracer.Step("FetchHandler"))
{
// Redirect GET /deploy requests to the Kudu root for convenience when using URL from Azure portal
if (String.Equals(context.Request.HttpMethod, "GET", StringComparison.OrdinalIgnoreCase))
{
context.Response.Redirect("~/");
context.ApplicationInstance.CompleteRequest();
return;
}
if (!String.Equals(context.Request.HttpMethod, "POST", StringComparison.OrdinalIgnoreCase))
{
context.Response.StatusCode = (int)HttpStatusCode.NotFound;
context.ApplicationInstance.CompleteRequest();
return;
}
context.Response.TrySkipIisCustomErrors = true;
DeploymentInfo deployInfo = null;
// We are going to assume that the branch details are already set by the time it gets here. This is particularly important in the mercurial case,
// since Settings hardcodes the default value for Branch to be "master". Consequently, Kudu will NoOp requests for Mercurial commits.
string targetBranch = _settings.GetBranch();
try
{
var request = new HttpRequestWrapper(context.Request);
JObject payload = GetPayload(request);
DeployAction action = GetRepositoryInfo(request, payload, targetBranch, out deployInfo);
if (action == DeployAction.NoOp)
{
return;
}
// If Scm is not enabled, we will reject all but one payload for GenericHandler
// This is to block the unintended CI with Scm providers like GitHub
// Since Generic payload can only be done by user action, we loosely allow
// that and assume users know what they are doing. Same applies to git
// push/clone endpoint.
if (!_settings.IsScmEnabled() && !(deployInfo.Handler is GenericHandler || deployInfo.Handler is DropboxHandler))
{
context.Response.StatusCode = (int)HttpStatusCode.Forbidden;
context.ApplicationInstance.CompleteRequest();
return;
}
}
catch (FormatException ex)
{
_tracer.TraceError(ex);
context.Response.StatusCode = 400;
context.Response.Write(ex.Message);
context.ApplicationInstance.CompleteRequest();
return;
}
_tracer.Trace("Attempting to fetch target branch {0}", targetBranch);
bool acquired = await _deploymentLock.TryLockOperationAsync(async() =>
{
if (_autoSwapHandler.IsAutoSwapOngoing())
{
context.Response.StatusCode = (int)HttpStatusCode.Conflict;
context.Response.Write(Resources.Error_AutoSwapDeploymentOngoing);
context.ApplicationInstance.CompleteRequest();
return;
}
await PerformDeployment(deployInfo);
_autoSwapHandler.HandleAutoSwap(verifyActiveDeploymentIdChanged: false);
}, TimeSpan.Zero);
if (!acquired)
{
// Create a marker file that indicates if there's another deployment to pull
// because there was a deployment in progress.
using (_tracer.Step("Update pending deployment marker file"))
{
// REVIEW: This makes the assumption that the repository url is the same.
// If it isn't the result would be buggy either way.
FileSystemHelpers.SetLastWriteTimeUtc(_markerFilePath, DateTime.UtcNow);
}
// Return a http 202: the request has been accepted for processing, but the processing has not been completed.
context.Response.StatusCode = (int)HttpStatusCode.Accepted;
context.ApplicationInstance.CompleteRequest();
}
}
}
public override async Task ProcessRequestAsync(HttpContext context)
{
using (_tracer.Step("FetchHandler"))
{
// Redirect GET /deploy requests to the Kudu root for convenience when using URL from Azure portal
if (String.Equals(context.Request.HttpMethod, "GET", StringComparison.OrdinalIgnoreCase))
{
context.Response.Redirect("~/");
context.ApplicationInstance.CompleteRequest();
return;
}
if (!String.Equals(context.Request.HttpMethod, "POST", StringComparison.OrdinalIgnoreCase))
{
context.Response.StatusCode = (int)HttpStatusCode.NotFound;
context.ApplicationInstance.CompleteRequest();
return;
}
context.Response.TrySkipIisCustomErrors = true;
DeploymentInfo deployInfo = null;
// We are going to assume that the branch details are already set by the time it gets here. This is particularly important in the mercurial case,
// since Settings hardcodes the default value for Branch to be "master". Consequently, Kudu will NoOp requests for Mercurial commits.
string targetBranch = _settings.GetBranch();
try
{
var request = new HttpRequestWrapper(context.Request);
JObject payload = GetPayload(request);
DeployAction action = GetRepositoryInfo(request, payload, targetBranch, out deployInfo);
if (action == DeployAction.NoOp)
{
return;
}
// If Scm is not enabled, we will reject all but one payload for GenericHandler
// This is to block the unintended CI with Scm providers like GitHub
// Since Generic payload can only be done by user action, we loosely allow
// that and assume users know what they are doing. Same applies to git
// push/clone endpoint.
if (!_settings.IsScmEnabled() && !(deployInfo.Handler is GenericHandler || deployInfo.Handler is DropboxHandler))
{
context.Response.StatusCode = (int)HttpStatusCode.Forbidden;
context.ApplicationInstance.CompleteRequest();
return;
}
}
catch (FormatException ex)
{
_tracer.TraceError(ex);
context.Response.StatusCode = 400;
context.Response.Write(ex.Message);
context.ApplicationInstance.CompleteRequest();
return;
}
// for CI payload, we will return Accepted and do the task in the BG
// if isAsync is defined, we will return Accepted and do the task in the BG
// since autoSwap relies on the response header, deployment has to be synchronously.
bool isAsync = String.Equals(context.Request.QueryString["isAsync"], "true", StringComparison.OrdinalIgnoreCase);
bool isBackground = (isAsync || deployInfo.IsContinuous) && !_autoSwapHandler.IsAutoSwapEnabled();
if (isBackground)
{
using (_tracer.Step("Start deployment in the background"))
{
ChangeSet tempChangeSet = null;
IDisposable tempDeployment = null;
if (isAsync)
{
// create temporary deployment before the actual deployment item started
// this allows portal ui to readily display on-going deployment (not having to wait for fetch to complete).
// in addition, it captures any failure that may occur before the actual deployment item started
tempDeployment = _deploymentManager.CreateTemporaryDeployment(
Resources.ReceivingChanges,
out tempChangeSet,
deployInfo.TargetChangeset,
deployInfo.Deployer);
}
PerformBackgroundDeployment(deployInfo, _environment, _settings, _tracer.TraceLevel, context.Request.Url, tempDeployment, tempChangeSet);
}
// to avoid regression, only set location header if isAsync
if (isAsync)
{
// latest deployment keyword reserved to poll till deployment done
context.Response.Headers["Location"] = new Uri(context.Request.Url,
String.Format("/api/deployments/{0}?deployer={1}&time={2}", Constants.LatestDeployment, deployInfo.Deployer, DateTime.UtcNow.ToString("yyy-MM-dd_HH-mm-ssZ"))).ToString();
}
context.Response.StatusCode = (int)HttpStatusCode.Accepted;
context.ApplicationInstance.CompleteRequest();
return;
}
_tracer.Trace("Attempting to fetch target branch {0}", targetBranch);
bool acquired = await _deploymentLock.TryLockOperationAsync(async() =>
{
if (_autoSwapHandler.IsAutoSwapOngoing())
{
context.Response.StatusCode = (int)HttpStatusCode.Conflict;
context.Response.Write(Resources.Error_AutoSwapDeploymentOngoing);
context.ApplicationInstance.CompleteRequest();
return;
}
await PerformDeployment(deployInfo);
_autoSwapHandler.HandleAutoSwap();
}, TimeSpan.Zero);
if (!acquired)
{
// Create a marker file that indicates if there's another deployment to pull
// because there was a deployment in progress.
using (_tracer.Step("Update pending deployment marker file"))
{
// REVIEW: This makes the assumption that the repository url is the same.
// If it isn't the result would be buggy either way.
FileSystemHelpers.SetLastWriteTimeUtc(_markerFilePath, DateTime.UtcNow);
}
// Return a http 202: the request has been accepted for processing, but the processing has not been completed.
context.Response.StatusCode = (int)HttpStatusCode.Accepted;
context.ApplicationInstance.CompleteRequest();
}
}
}
public async Task PerformDeployment(DeploymentInfo deploymentInfo, IDisposable tempDeployment = null, ChangeSet tempChangeSet = null)
{
DateTime currentMarkerFileUTC;
DateTime nextMarkerFileUTC = FileSystemHelpers.GetLastWriteTimeUtc(_markerFilePath);
ChangeSet lastChange = null;
do
{
// save the current marker
currentMarkerFileUTC = nextMarkerFileUTC;
string targetBranch = _settings.GetBranch();
using (_tracer.Step("Performing fetch based deployment"))
{
// create temporary deployment before the actual deployment item started
// this allows portal ui to readily display on-going deployment (not having to wait for fetch to complete).
// in addition, it captures any failure that may occur before the actual deployment item started
tempDeployment = tempDeployment ?? _deploymentManager.CreateTemporaryDeployment(
Resources.ReceivingChanges,
out tempChangeSet,
deploymentInfo.TargetChangeset,
deploymentInfo.Deployer);
ILogger innerLogger = null;
try
{
ILogger logger = _deploymentManager.GetLogger(tempChangeSet.Id);
// Fetch changes from the repository
innerLogger = logger.Log(Resources.FetchingChanges);
IRepository repository = _repositoryFactory.EnsureRepository(deploymentInfo.RepositoryType);
try
{
await deploymentInfo.Handler.Fetch(repository, deploymentInfo, targetBranch, innerLogger, _tracer);
}
catch (BranchNotFoundException)
{
// mark no deployment is needed
deploymentInfo.TargetChangeset = null;
}
// set to null as Deploy() below takes over logging
innerLogger = null;
// The branch or commit id to deploy
string deployBranch = !String.IsNullOrEmpty(deploymentInfo.CommitId) ? deploymentInfo.CommitId : targetBranch;
// In case the commit or perhaps fetch do no-op.
if (deploymentInfo.TargetChangeset != null && ShouldDeploy(repository, deploymentInfo, deployBranch))
{
// Perform the actual deployment
var changeSet = repository.GetChangeSet(deployBranch);
if (changeSet == null && !String.IsNullOrEmpty(deploymentInfo.CommitId))
{
throw new InvalidOperationException(String.Format("Invalid revision '{0}'!", deploymentInfo.CommitId));
}
lastChange = changeSet;
// Here, we don't need to update the working files, since we know Fetch left them in the correct state
// unless for GenericHandler where specific commitId is specified
bool deploySpecificCommitId = !String.IsNullOrEmpty(deploymentInfo.CommitId);
await _deploymentManager.DeployAsync(repository, changeSet, deploymentInfo.Deployer, clean : false, needFileUpdate : deploySpecificCommitId);
}
}
catch (Exception ex)
{
if (innerLogger != null)
{
innerLogger.Log(ex);
}
// In case the commit or perhaps fetch do no-op.
if (deploymentInfo.TargetChangeset != null)
{
IDeploymentStatusFile statusFile = _status.Open(deploymentInfo.TargetChangeset.Id);
if (statusFile != null)
{
statusFile.MarkFailed();
}
}
throw;
}
// only clean up temp deployment if successful
tempDeployment.Dispose();
}
// check marker file and, if changed (meaning new /deploy request), redeploy.
nextMarkerFileUTC = FileSystemHelpers.GetLastWriteTimeUtc(_markerFilePath);
} while (deploymentInfo.IsReusable && currentMarkerFileUTC != nextMarkerFileUTC);
if (lastChange != null && _autoSwapHandler.IsAutoSwapEnabled())
{
IDeploymentStatusFile statusFile = _status.Open(lastChange.Id);
if (statusFile.Status == DeployStatus.Success)
{
// if last change is not null and finish successfully, mean there was at least one deployoment happened
// since deployment is now done, trigger swap if enabled
await _autoSwapHandler.HandleAutoSwap(lastChange.Id, _deploymentManager.GetLogger(lastChange.Id), _tracer);
}
}
}
public async Task <HttpResponseMessage> Deploy(string id = null)
{
JObject result = GetJsonContent();
// Just block here to read the json payload from the body
using (_tracer.Step("DeploymentService.Deploy(id)"))
{
HttpResponseMessage response = Request.CreateResponse(HttpStatusCode.OK);
await _deploymentLock.LockHttpOperationAsync(async() =>
{
try
{
if (_autoSwapHandler.IsAutoSwapOngoing())
{
throw new HttpResponseException(Request.CreateErrorResponse(HttpStatusCode.Conflict, Resources.Error_AutoSwapDeploymentOngoing));
}
DeployResult deployResult;
if (TryParseDeployResult(id, result, out deployResult))
{
using (_tracer.Step("DeploymentService.Create(id)"))
{
CreateDeployment(deployResult, result.Value <string>("details"));
deployResult.Url = Request.RequestUri;
deployResult.LogUrl = UriHelper.MakeRelative(Request.RequestUri, "log");
response = Request.CreateResponse(HttpStatusCode.OK, ArmUtils.AddEnvelopeOnArmRequest(deployResult, Request));
return;
}
}
bool clean = false;
bool needFileUpdate = true;
if (result != null)
{
clean = result.Value <bool>("clean");
JToken needFileUpdateToken;
if (result.TryGetValue("needFileUpdate", out needFileUpdateToken))
{
needFileUpdate = needFileUpdateToken.Value <bool>();
}
}
string username = null;
AuthUtility.TryExtractBasicAuthUser(Request, out username);
IRepository repository = _repositoryFactory.GetRepository();
if (repository == null)
{
throw new HttpResponseException(Request.CreateErrorResponse(HttpStatusCode.NotFound, Resources.Error_RepositoryNotFound));
}
ChangeSet changeSet = null;
if (!String.IsNullOrEmpty(id))
{
changeSet = repository.GetChangeSet(id);
if (changeSet == null)
{
string message = String.Format(CultureInfo.CurrentCulture, Resources.Error_DeploymentNotFound, id);
throw new HttpResponseException(Request.CreateErrorResponse(HttpStatusCode.NotFound, message));
}
}
await _deploymentManager.DeployAsync(repository, changeSet, username, clean, needFileUpdate);
_autoSwapHandler.HandleAutoSwap();
}
catch (FileNotFoundException ex)
{
throw new HttpResponseException(Request.CreateErrorResponse(HttpStatusCode.NotFound, ex));
}
});
return(response);
}
}
