/// <summary>
/// Check if a WorkItem of the given Type and with the same hash already exists on VSTS/TFS
/// </summary>
/// <param name="exceptionHash">The MD5 hash of the exception to report</param>
/// <param name="workItemType">The WorkItem Type (Bug or Task)</param>
/// <param name="account">Account info for VSTS/TFS</param>
/// <returns></returns>
public static async Task<WorkItemData> GetExistentWorkItemId(string exceptionHash, WorkItemType workItemType, Account account)
{
//Pattern:
//POST https://{account}.visualstudio.com/defaultcollection/_apis/wit/wiql?api-version={version}
var wiqlRequestUrl = $"{account.Url}/{account.CollectionName}/_apis/wit/wiql?{_apiVersion}";
var workItemQueryPOSTData = new WorkItemWIQLRequest()
{
Query = $"Select [System.Id] From WorkItems Where [System.WorkItemType] = '{workItemType.ToString()}' AND [State] <> 'Done' AND [State] <> 'Removed' " +
$"AND [System.TeamProject] = '{account.ProjectName}' AND [Microsoft.VSTS.Build.FoundIn] = '{exceptionHash}'"
};
using (var handler = new HttpClientHandler())
{
if (!account.IsVSTS) //is TFS, requires NTLM
handler.Credentials = new System.Net.NetworkCredential(account.Username, account.Password);
using (var client = new HttpClient(handler))
{
if (account.IsVSTS)
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
//Set alternate credentials
string credentials = $"{account.Username}:{account.Password}";
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic",
Convert.ToBase64String(Converters.StringToAsciiConverter.StringToAscii(credentials)));
try
{
var responseBody = await HttpOperationsHelper.PostAsync(client, wiqlRequestUrl, workItemQueryPOSTData);
var responseBodyObj = JsonConvert.DeserializeObject<dynamic>(responseBody);
var workItems = (JArray)responseBodyObj.workItems;
if (workItems.HasValues)
{
//Retrieve bug data
var id = workItems.First.Value<int>("id");
//Pattern:
//GET https://{account}.visualstudio.com/defaultcollection/_apis/wit/WorkItems?id={id}&api-version=1.0
var dataRequestUrl = $"{account.Url}/{account.CollectionName}/_apis/wit/WorkItems?id={id}&{_apiVersion}";
responseBody = await HttpOperationsHelper.GetAsync(client, dataRequestUrl);
var workItemData = JsonConvert.DeserializeObject<WorkItemData>(responseBody);
//Retrieve bug history
//Pattern:
//GET https://{account}.visualstudio.com/defaultcollection/_apis/wit/WorkItems/{id}/history
var historyRequestUrl = $"{account.Url}/{account.CollectionName}/_apis/wit/WorkItems/{id}/history";
responseBody = await HttpOperationsHelper.GetAsync(client, historyRequestUrl);
responseBodyObj = JsonConvert.DeserializeObject<dynamic>(responseBody);
var historyItems = (JArray)responseBodyObj.value;
if (historyItems.HasValues)
workItemData.History = historyItems.ToObject<List<History>>();
return workItemData;
}
}
catch (Exception ex)
{
int i = 1;
}
return null;
}
}
}
/// <summary>
/// Updates the Title and the History of an Existing WorkItem
/// </summary>
/// <param name="workItemData">The WorkItem to update</param>
/// <param name="account">Account info for VSTS/TFS</param>
/// <returns></returns>
public static async Task<BugGuardianResponse> UpdateWorkItem(WorkItemData workItemData, Account account)
{
// Pattern:
//PATCH https://{account}.visualstudio.com/defaultcollection/_apis/wit/workitems/{wworkitemid}?api-version={version}
var updateRequestUrl = $"{account.Url}/{account.CollectionName}/_apis/wit/workitems/{workItemData.ID}?{_apiVersion}";
var historyMessage = "Exception thrown again";
var reportedTimes = (workItemData.History?.Where(h => h.Value.Contains(historyMessage)).Count() ?? 0) + 2;
var newTitle = $"{workItemData.Title.Replace($" ({reportedTimes - 1})", string.Empty)} ({reportedTimes})";
var workItemCreatePATCHData = new List<APIRequest>();
//Update Title
workItemCreatePATCHData.Add(
new WorkItemCreateRequest()
{
Operation = WITOperationType.add,
Path = TitleField,
Value = newTitle
});
//Update History
workItemCreatePATCHData.Add(
new WorkItemCreateRequest()
{
Operation = WITOperationType.add,
Path = HistoryField,
Value = $"{historyMessage} (Total: {reportedTimes})"
});
using (var handler = new HttpClientHandler())
{
if (!account.IsVSTS) //is TFS, requires NTLM
handler.Credentials = new System.Net.NetworkCredential(account.Username, account.Password);
using (var client = new HttpClient(handler))
{
if (account.IsVSTS)
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
//Set alternate credentials
string credentials = $"{account.Username}:{account.Password}";
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic",
Convert.ToBase64String(Converters.StringToAsciiConverter.StringToAscii(credentials)));
try
{
var responseBody = await HttpOperationsHelper.PatchAsync(client, updateRequestUrl, workItemCreatePATCHData);
return new BugGuardianResponse() { Success = true, Response = responseBody };
}
catch (Exception internalException)
{
return new BugGuardianResponse() { Success = false, Response = "An error occured. See the Exception.", Exception = internalException };
}
}
}
}
protected virtual void Dispose(bool disposing)
{
if (!disposedValue)
{
if (disposing)
_account = null;
disposedValue = true;
}
}
/// <summary>
/// Create a new Work Item with the given values
/// </summary>
/// <param name="workItemType">The WorkItem Type (Bug or Task)</param>
/// <param name="ex">The exception to report</param>
/// <param name="account">Account info for VSTS/TFS</param>
/// <param name="message">Optional message to be added to the WorkItem</param>
/// <param name="tags">Optional tags (list separated by comma) to be added to the WorkItem</param>
/// <returns></returns>
public static async Task<BugGuardianResponse> CreateNewWorkItem(WorkItemType workItemType, Exception ex, Account account, string message, IEnumerable<string> tags)
{
//Pattern:
//PATCH https://{account}.visualstudio.com/defaultcollection/{project}/_apis/wit/workitems/${workitemtypename}?api-version={version}
//See https://www.visualstudio.com/integrate/api/wit/fields for the fields explanation
var createRequestUrl = $"{account.Url}/{account.CollectionName}/{account.ProjectName}/_apis/wit/workitems/${workItemType.ToString()}?{_apiVersion}";
var workItemCreatePATCHData = new List<APIRequest>();
//Title: Exception Name
workItemCreatePATCHData.Add(
new WorkItemCreateRequest()
{
Operation = WITOperationType.add,
Path = TitleField,
Value = ExceptionsHelper.BuildExceptionTitle(ex)
});
//Tags
workItemCreatePATCHData.Add(
new WorkItemCreateRequest()
{
Operation = WITOperationType.add,
Path = TagsField,
Value = DefaultTags + (tags != null ? string.Join(";", tags) : String.Empty)
});
if (workItemType == WorkItemType.Bug)
{
//BUG
//Repro Steps: Stack Trace
workItemCreatePATCHData.Add(
new WorkItemCreateRequest()
{
Operation = WITOperationType.add,
Path = ReproStepsField,
Value = ExceptionsHelper.BuildExceptionString(ex, message) // Include custom message, if any
});
//System Info
workItemCreatePATCHData.Add(
new WorkItemCreateRequest()
{
Operation = WITOperationType.add,
Path = SystemInfoField,
Value = SystemInfoHelper.BuildSystemInfoString()
});
}
else
{
//TASK
//Description: Stack Trace + System info
workItemCreatePATCHData.Add(
new WorkItemCreateRequest()
{
Operation = WITOperationType.add,
Path = workItemType == WorkItemType.Bug ? ReproStepsField : DescriptionField,
Value = $"{ExceptionsHelper.BuildExceptionString(ex, message)}<br /><hr /><br />{SystemInfoHelper.BuildSystemInfoString()}" // Include custom message, if any
});
}
//FoundIn: Hash of stack trace
workItemCreatePATCHData.Add(
new WorkItemCreateRequest()
{
Operation = WITOperationType.add,
Path = FoundInField,
Value = ExceptionsHelper.BuildExceptionHash(ex)
});
using (var handler = new HttpClientHandler())
{
if (!account.IsVSTS) //is TFS, requires NTLM
handler.Credentials = new System.Net.NetworkCredential(account.Username, account.Password);
using (var client = new HttpClient(handler))
{
if (account.IsVSTS)
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
//Set alternate credentials
string credentials = $"{account.Username}:{account.Password}";
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic",
Convert.ToBase64String(Converters.StringToAsciiConverter.StringToAscii(credentials)));
try
{
var responseBody = await HttpOperationsHelper.PatchAsync(client, createRequestUrl, workItemCreatePATCHData);
return new BugGuardianResponse() { Success = true, Response = responseBody };
}
catch (Exception internalException)
{
return new BugGuardianResponse() { Success = false, Response = "An error occured. See the Exception.", Exception = internalException };
}
}
}
}
public Creator()
{
_account = Helpers.AccountHelper.GenerateAccount();
}