Как отправлять сообщения об ошибках в BugTracker.NET из приложения C#?
Чтение страницы документации BugTracker.NET
Документация по API BugTracker.NET Я понял, что мне нужно использовать GET или POST, в чем, я должен признать, я не очень хорош. Я размышлял:
- Есть ли библиотека, которую можно использовать для простой отправки ошибок в BugTracker.NET из приложения C# (или VB.NET)?
Или же, - Если нет библиотеки. Как использовать GET или POST для отправки ошибок в BugTracker.NET?
4 ответа
Спасибо всем за ваши ответы. Используя ваши ответы и другие ресурсы в Интернете, я собрал метод для отправки новой ошибки в BugTracker.NET
Метод возвращает логическое значение, указывающее успех или неудачу, и отображает сообщение для пользователя со статусом.
Это поведение может быть изменено в соответствии с вашими потребностями. В этом методе используется метод POST для отправки сообщений об ошибках, который помогает отправить любой длинный текст в комментарии (я попытался представить содержимое файла журнала в комментариях, и это сработало).
Вот код:
public bool SubmitBugToBugTracker(string serverName,
bool useProxy,
string proxyHost,
int proxyPort,
string userName,
string password,
string description,
string comment,
int projectId)
{
if (!serverName.EndsWith(@"/"))
{
serverName += @"/";
}
string requestUrl = serverName + "insert_bug.aspx";
string requestMethod = "POST";
string requestContentType = "application/x-www-form-urlencoded";
string requestParameters = "username=" + userName
+ "&password=" + password
+ "&short_desc=" + description
+ "&comment=" + comment
+ "&projectid=" + projectId;
// POST parameters (postvars)
byte[] buffer = Encoding.ASCII.GetBytes(requestParameters);
// Initialisation
HttpWebRequest WebReq = (HttpWebRequest)WebRequest.Create(requestUrl);
// Add proxy info if used.
if (useProxy)
{
WebReq.Proxy = new WebProxy(proxyHost, proxyPort);
}
// Method is POST
WebReq.Method = requestMethod;
// ContentType, for the postvars.
WebReq.ContentType = requestContentType;
// Length of the buffer (postvars) is used as contentlength.
WebReq.ContentLength = buffer.Length;
// Open a stream for writing the postvars
Stream PostData = WebReq.GetRequestStream();
//Now we write, and afterwards, we close. Closing is always important!
PostData.Write(buffer, 0, buffer.Length);
PostData.Close();
// Get the response handle, we have no true response yet!
HttpWebResponse WebResp = (HttpWebResponse)WebReq.GetResponse();
// Read the response (the string)
Stream Answer = WebResp.GetResponseStream();
StreamReader _Answer = new StreamReader(Answer);
string responseStream = _Answer.ReadToEnd();
// Find out if bug submission was successfull.
if (responseStream.StartsWith("OK:"))
{
MessageBox.Show("Bug submitted successfully.");
return true;
}
else if (responseStream.StartsWith("ERROR:"))
{
MessageBox.Show("Error occured. Bug hasn't been submitted.\nError Message: " + responseStream);
return false;
}
else
{
MessageBox.Show("Error occured. Bug hasn't been submitted.\nError Message: " + responseStream);
return false;
}
}
Посмотрите этот простой пример из документации о том, как сделать запрос POST, используя.Net. Просто убедитесь, что вы устанавливаете переменные в соответствии с требованиями API BugTracker.NET.
Ниже приведен код службы BugTracker.NET, которая читает электронные письма с сервера pop3, а затем отправляет их в виде ошибок на страницу insert_bug.aspx. Но это не должно быть так сложно.
Просто вызов этого URL также будет работать:
HTTP:\\YOUR-HOST\insert_bug.aspx имя пользователя =YOU& пароль = ВАШ ПАРОЛЬ-&short_desc= Это + в + а + ошибка
Более сложный код:
string post_data = "username =" + HttpUtility.UrlEncode (ServiceUsername) + "& password =" + HttpUtility.UrlEncode (ServicePassword) + "& projectid =" + Convert.ToString (projectid) + "& from =" + HttpUtility.UrlEncode от) + "&short_desc=" + HttpUtility.UrlEncode(subject) + "&message=" + HttpUtility.UrlEncode(message); byte[] bytes = Encoding.UTF8.GetBytes(post_data); // отправляем запрос на веб-сервер HttpWebResponse res = null; try { HttpWebRequest req = (HttpWebRequest) System.Net.WebRequest.Create(Url); req.Credentials = CredentialCache.DefaultCredentials; req.PreAuthenticate = true; //req.Timeout = 200; // может быть? //req.KeepAlive = false; // может быть? req.Method = "POST"; req.ContentType= "application/x-www-form-urlencoded"; req.ContentLength=bytes.Length; Stream request_stream = req.GetRequestStream(); request_stream.Write(байты,0,bytes.Length); request_stream.Close(); res = (HttpWebResponse) req.GetResponse(); } catch (Exception e) { write_line("HttpWebRequest error url=" + Url); write_line(е); } // проверяем ответ if (res!= null) { int http_status = (int) res.StatusCode; write_line (Convert.ToString(http_status)); строка http_response_header = res.Headers["BTNET"]; res.Close(); if (http_response_header!= null) { write_line (http_response_header); // удаляем сообщение только с сервера pop3, если мы // знаем, что сохранены на веб-сервере, хорошо, если (MessageInputFile == "" && http_status == 200 && DeleteMessagesOnServer == "1" && http_response_header.IndexOf("OK") == 0) { write_line ("отправка POP3 команды DELE"); write_line (client.DELE (message_number)); } } else { write_line("Заголовок BTNET HTTP не найден. Пропуск удаления письма с сервера."); write_line ("Увеличение общего количества ошибок"); total_error_count++; } } else { write_line("Нет ответа от веб-сервера. Пропуск удаления письма с сервера."); write_line ("Увеличение общего количества ошибок"); total_error_count ++; }
Я использовал этот метод, но не любил посылать пароль вместе с представленной ошибкой. По разным причинам мы используем внутреннюю систему паролей BugTracker, а не аутентификацию LDAP, поэтому их пароли BugTracker нам не известны. В моем случае все наши пользователи имеют право отправлять сообщения об ошибках, и их логин - это их идентификатор локальной сети. Итак, из их аутентифицированного экземпляра приложения я собираю сообщаемую им проблему, записываю идентификатор проекта, программу и класс, в котором они сообщают о проблеме, и вызываю хранимую процедуру в БД BugTracker, чтобы напрямую вставить элемент.
Негатив, конечно, заключается в том, что это непосредственно в базе данных и может вызвать проблемы с будущими обновлениями, но сейчас это работает хорошо для нас.
(SQL2005 / 2008)
CREATE PROCEDURE [dbo].[Add_Bug]
@strUsername as varchar(20) = '',
@intProjID as integer = 0,
@strSubject as varchar(200),
@strComment as text
AS
BEGIN
SET NOCOUNT ON;
declare @us_id as integer
declare @us_org as integer
declare @st_id as integer
declare @priority as integer
declare @category as integer
declare @errorreturn as integer
declare @assigneduser as integer
declare @newbugid as integer
if (@intProjID = 0 or RTRIM(@strUsername) = '')
RETURN -1
set @priority = 3 -- default to LOW
set @category = 1 -- default to bug
-- look up us_id, us_org from users where us_username = 'lanid'
set @us_id = 0
BEGIN TRY
BEGIN TRANSACTION
select @us_id = us_id, @us_org = us_org from BugTracker.dbo.users
where us_username = @strUsername
if (@@ROWCOUNT = 0 or @us_id = 0 )
BEGIN
-- set to default values to allow entry anyway
-- if not found default to the autobug reporter
-- this is a separate account created just for these reports
set @us_id = 36
set @us_org = 6
END
select @assigneduser = pj_default_user from projects
where pj_id = @intProjID and
pj_auto_assign_default_user = 1
if (@@ROWCOUNT <> 1)
set @assigneduser = NULL
-- get default status as st_id from statuses where st_default = 1
select @st_id = st_id from BugTracker.dbo.statuses where st_default = 1
-- now insert the bug and post comments
insert into bugs (bg_short_desc, bg_reported_user, bg_reported_date,
bg_status, bg_priority, bg_org, bg_category, bg_project,
bg_assigned_to_user, bg_last_updated_user, bg_last_updated_date)
values ( @strSubject, @us_id, getdate(), @st_id, @priority, @us_org,
@category, @intProjID, @assigneduser, @us_id, getdate())
if @@ERROR <> 0
BEGIN
ROLLBACK TRANSACTION
END
ELSE
BEGIN
select @newbugid = @@IDENTITY
insert into bug_posts (bp_bug, bp_type, bp_user, bp_date,
bp_comment, bp_hidden_from_external_users)
values (@newbugid, 'comment', @us_id, getdate(), @strComment, 0)
if @@ERROR <> 0
ROLLBACK TRANSACTION
END
END TRY
BEGIN CATCH
ROLLBACK TRANSACTION
RETURN -2
END CATCH
IF (@@TRANCOUNT > 0)
COMMIT TRANSACTION
RETURN @newbugid
END