public void TraceBeginEnd_Traces()
{
// Arrange
TestTraceWriter traceWriter = new TestTraceWriter();
HttpRequestMessage request = new HttpRequestMessage();
TraceRecord[] expectedTraces = new TraceRecord[]
{
new TraceRecord(request, "testCategory", TraceLevel.Info)
{
Kind = TraceKind.Begin, Operator = "tester", Operation = "testOp", Message = "beginMessage"
},
new TraceRecord(request, "testCategory", TraceLevel.Info)
{
Kind = TraceKind.End, Operator = "tester", Operation = "testOp", Message = "endMessage"
},
};
// Act
traceWriter.TraceBeginEnd(request,
"testCategory",
TraceLevel.Info,
"tester",
"testOp",
beginTrace: (tr) => { tr.Message = "beginMessage"; },
execute: () => { },
endTrace: (tr) => { tr.Message = "endMessage"; },
errorTrace: (tr) => { tr.Message = "won't happen"; });
// Assert
Assert.Equal <TraceRecord>(expectedTraces, traceWriter.Traces, new TraceRecordComparer());
}
public void TraceBeginEnd_Traces_And_Throws_When_Execute_Throws()
{
// Arrange
TestTraceWriter traceWriter = new TestTraceWriter();
HttpRequestMessage request = new HttpRequestMessage();
InvalidOperationException exception = new InvalidOperationException("test exception");
TraceRecord[] expectedTraces = new TraceRecord[]
{
new TraceRecord(request, "testCategory", TraceLevel.Info)
{
Kind = TraceKind.Begin, Operator = "tester", Operation = "testOp", Message = "beginMessage"
},
new TraceRecord(request, "testCategory", TraceLevel.Error)
{
Kind = TraceKind.End, Operator = "tester", Operation = "testOp", Exception = exception, Message = "errorMessage"
},
};
// Act
Exception thrown = Assert.Throws <InvalidOperationException>(
() => traceWriter.TraceBeginEnd(request,
"testCategory",
TraceLevel.Info,
"tester",
"testOp",
beginTrace: (tr) => { tr.Message = "beginMessage"; },
execute: () => { throw exception; },
endTrace: (tr) => { tr.Message = "won't happen"; },
errorTrace: (tr) => { tr.Message = "errorMessage"; }));
// Assert
Assert.Equal <TraceRecord>(expectedTraces, traceWriter.Traces, new TraceRecordComparer());
Assert.Same(exception, thrown);
}
public void TraceBeginEnd_Accepts_Null_Trace_Actions()
{
// Arrange
TestTraceWriter traceWriter = new TestTraceWriter();
HttpRequestMessage request = new HttpRequestMessage();
// Act & Assert
traceWriter.TraceBeginEnd(request,
"",
TraceLevel.Off,
"",
"",
beginTrace: null,
execute: () => { },
endTrace: null,
errorTrace: null);
}
public void TraceBeginEnd_Throws_With_Null_Execute_Action()
{
// Arrange
TestTraceWriter traceWriter = new TestTraceWriter();
HttpRequestMessage request = new HttpRequestMessage();
// Act & Assert
Assert.ThrowsArgumentNull(() => traceWriter.TraceBeginEnd(request,
"",
TraceLevel.Off,
"",
"",
beginTrace: null,
execute: null,
endTrace: null,
errorTrace: null),
"execute");
}
public void TraceBeginEnd_Invokes_EndTrace()
{
// Arrange
TestTraceWriter traceWriter = new TestTraceWriter();
HttpRequestMessage request = new HttpRequestMessage();
bool invoked = false;
// Act
traceWriter.TraceBeginEnd(request,
"",
TraceLevel.Off,
"",
"",
beginTrace: (tr) => { },
execute: () => { },
endTrace: (tr) => { invoked = true; },
errorTrace: (tr) => { });
// Assert
Assert.True(invoked);
}
public void TraceBeginEnd_Invokes_ErrorTrace()
{
// Arrange
TestTraceWriter traceWriter = new TestTraceWriter();
HttpRequestMessage request = new HttpRequestMessage();
Exception exception = new InvalidOperationException();
bool invoked = false;
// Act
Exception thrown = Assert.Throws <InvalidOperationException>(
() => traceWriter.TraceBeginEnd(request,
"",
TraceLevel.Off,
"",
"",
beginTrace: (tr) => { },
execute: () => { throw exception; },
endTrace: (tr) => { },
errorTrace: (tr) => { invoked = true; }));
// Assert
Assert.True(invoked);
Assert.Same(exception, thrown);
}
public void TraceBeginEnd_Does_Not_Invoke_ErrorTrace_Unless_Error_Occurs()
{
// Arrange
TestTraceWriter traceWriter = new TestTraceWriter();
HttpRequestMessage request = new HttpRequestMessage();
bool invoked = false;
// Act
traceWriter.TraceBeginEnd(request,
"",
TraceLevel.Info,
"",
"",
beginTrace: (tr) => { },
execute: () => { },
endTrace: (tr) => { },
errorTrace: (tr) => { invoked = true; });
// Assert
Assert.False(invoked);
}
public void TraceBeginEnd_Invokes_ErrorTrace_When_Tracing_Only_Errors()
{
// Arrange
TestTraceWriter traceWriter = new TestTraceWriter();
traceWriter.TraceSelector = (rqst, category, level) => level >= TraceLevel.Error;
HttpRequestMessage request = new HttpRequestMessage();
Exception exception = new InvalidOperationException();
bool invoked = false;
// Act
Exception thrown = Assert.Throws<InvalidOperationException>(
() => traceWriter.TraceBeginEnd(request,
"",
TraceLevel.Off,
"",
"",
beginTrace: (tr) => { },
execute: () => { throw exception; },
endTrace: (tr) => { },
errorTrace: (tr) => { invoked = true; }));
// Assert
Assert.True(invoked);
Assert.Same(exception, thrown);
}
public void TraceBeginEnd_Does_Not_Invoke_EndTrace_When_Tracing_Only_High_Level()
{
// Arrange
TestTraceWriter traceWriter = new TestTraceWriter();
traceWriter.TraceSelector = (rqst, category, level) => level >= TraceLevel.Error;
HttpRequestMessage request = new HttpRequestMessage();
bool invoked = false;
// Act
traceWriter.TraceBeginEnd(request,
"",
TraceLevel.Info,
"",
"",
beginTrace: (tr) => { },
execute: () => { },
endTrace: (tr) => { invoked = true; },
errorTrace: (tr) => { });
// Assert
Assert.False(invoked);
}
public void TraceBeginEnd_Does_Not_Invoke_EndTrace_When_Error_Occurs()
{
// Arrange
TestTraceWriter traceWriter = new TestTraceWriter();
HttpRequestMessage request = new HttpRequestMessage();
Exception exception = new InvalidOperationException();
bool invoked = false;
// Act
Exception thrown = Assert.Throws<InvalidOperationException>(
() => traceWriter.TraceBeginEnd(request,
"",
TraceLevel.Off,
"",
"",
beginTrace: (tr) => { },
execute: () => { throw exception; },
endTrace: (tr) => { invoked = true; },
errorTrace: (tr) => { }));
// Assert
Assert.False(invoked);
Assert.Same(exception, thrown);
}
public void TraceBeginEnd_Invokes_EndTrace()
{
// Arrange
TestTraceWriter traceWriter = new TestTraceWriter();
HttpRequestMessage request = new HttpRequestMessage();
bool invoked = false;
// Act
traceWriter.TraceBeginEnd(request,
"",
TraceLevel.Off,
"",
"",
beginTrace: (tr) => { },
execute: () => { },
endTrace: (tr) => { invoked = true; },
errorTrace: (tr) => { });
// Assert
Assert.True(invoked);
}
public void TraceBeginEnd_Accepts_Null_Trace_Actions()
{
// Arrange
TestTraceWriter traceWriter = new TestTraceWriter();
HttpRequestMessage request = new HttpRequestMessage();
// Act & Assert
traceWriter.TraceBeginEnd(request,
"",
TraceLevel.Off,
"",
"",
beginTrace: null,
execute: () => { },
endTrace: null,
errorTrace: null);
}
public void TraceBeginEnd_Traces_And_Throws_AggregateException()
{
// Arrange
TestTraceWriter traceWriter = new TestTraceWriter();
HttpRequestMessage request = new HttpRequestMessage();
List<TraceRecord> expectedTraces = new List<TraceRecord>
{
new TraceRecord(request, "testCategory", TraceLevel.Error) { Kind = TraceKind.Begin, Operator = "tester", Operation = "testOp", Message = "beginMessage" },
new TraceRecord(request, "testCategory", TraceLevel.Warn)
{
Kind = TraceKind.End, Operator = "tester", Operation = "testOp", Exception = null,
// In the aggregateException, only the httpResponseException with the highest status code will be reflected in the trace record's message.
// In this test case, it should be NotFound.
Message = "UserMessage='The request is invalid.', ModelStateError=[key=[error], username=[invalid]]",
Status = Net.HttpStatusCode.NotFound
},
};
// Act
// Errors and exceptions are instantiated in the `execute` func to avoid the variation of error messages for culture issues.
Exception thrown = Assert.Throws<AggregateException>(
() => traceWriter.TraceBeginEnd(request,
"testCategory",
TraceLevel.Error,
"tester",
"testOp",
beginTrace: (tr) => { tr.Message = "beginMessage"; },
execute: () =>
{
AggregateException aggEx = CreateAggregateException(request);
// To satisfy TraceRecordComparer().
expectedTraces[1].Exception = aggEx;
throw aggEx;
},
endTrace: (tr) => { tr.Message = "won't Happen"; },
errorTrace: null));
// Assert
Assert.Equal<TraceRecord>(expectedTraces, traceWriter.Traces, new TraceRecordComparer());
Assert.Same(thrown, expectedTraces[1].Exception);
}
public void TraceBeginEnd_Does_Not_Trace_HttpResponseException_When_Tracing_Only_Higher_Level()
{
// Arrange
TestTraceWriter traceWriter = new TestTraceWriter();
traceWriter.TraceSelector = (rqst, category, level) => level >= TraceLevel.Error;
HttpRequestMessage request = new HttpRequestMessage();
bool invoked = false;
Exception exception = new HttpResponseException(Net.HttpStatusCode.NotFound);
// Act
Exception thrown = Assert.Throws<HttpResponseException>(
() => traceWriter.TraceBeginEnd(request,
"",
TraceLevel.Info,
"",
"",
beginTrace: (tr) => { invoked = true; },
execute: () => { throw exception; },
endTrace: (tr) => { },
errorTrace: (tr) => { }));
// Assert
Assert.False(invoked);
Assert.Empty(traceWriter.Traces);
Assert.Same(thrown, exception);
}
public void TraceBeginEnd_Traces()
{
// Arrange
TestTraceWriter traceWriter = new TestTraceWriter();
HttpRequestMessage request = new HttpRequestMessage();
TraceRecord[] expectedTraces = new TraceRecord[]
{
new TraceRecord(request, "testCategory", TraceLevel.Info) { Kind = TraceKind.Begin, Operator = "tester", Operation = "testOp", Message = "beginMessage" },
new TraceRecord(request, "testCategory", TraceLevel.Info) { Kind = TraceKind.End, Operator = "tester", Operation = "testOp", Message = "endMessage" },
};
// Act
traceWriter.TraceBeginEnd(request,
"testCategory",
TraceLevel.Info,
"tester",
"testOp",
beginTrace: (tr) => { tr.Message = "beginMessage"; },
execute: () => { },
endTrace: (tr) => { tr.Message = "endMessage"; },
errorTrace: (tr) => { tr.Message = "won't happen"; });
// Assert
Assert.Equal<TraceRecord>(expectedTraces, traceWriter.Traces, new TraceRecordComparer());
}
public void TraceBeginEnd_Throws_With_Null_Execute_Action()
{
// Arrange
TestTraceWriter traceWriter = new TestTraceWriter();
HttpRequestMessage request = new HttpRequestMessage();
// Act & Assert
Assert.ThrowsArgumentNull(() => traceWriter.TraceBeginEnd(request,
"",
TraceLevel.Off,
"",
"",
beginTrace: null,
execute: null,
endTrace: null,
errorTrace: null),
"execute");
}
public void TraceBeginEnd_Traces_And_Throws_When_Execute_Throws()
{
// Arrange
TestTraceWriter traceWriter = new TestTraceWriter();
HttpRequestMessage request = new HttpRequestMessage();
InvalidOperationException exception = new InvalidOperationException("test exception");
TraceRecord[] expectedTraces = new TraceRecord[]
{
new TraceRecord(request, "testCategory", TraceLevel.Info) { Kind = TraceKind.Begin, Operator = "tester", Operation = "testOp", Message = "beginMessage" },
new TraceRecord(request, "testCategory", TraceLevel.Error) { Kind = TraceKind.End, Operator = "tester", Operation = "testOp", Exception = exception, Message = "errorMessage" },
};
// Act
Exception thrown = Assert.Throws<InvalidOperationException>(
() => traceWriter.TraceBeginEnd(request,
"testCategory",
TraceLevel.Info,
"tester",
"testOp",
beginTrace: (tr) => { tr.Message = "beginMessage"; },
execute: () => { throw exception; },
endTrace: (tr) => { tr.Message = "won't happen"; },
errorTrace: (tr) => { tr.Message = "errorMessage"; }));
// Assert
Assert.Equal<TraceRecord>(expectedTraces, traceWriter.Traces, new TraceRecordComparer());
Assert.Same(exception, thrown);
}
public void TraceBeginEnd_Traces_And_Throws_HttpResponseException()
{
// Arrange
TestTraceWriter traceWriter = new TestTraceWriter();
HttpRequestMessage request = new HttpRequestMessage();
HttpResponseException exception = new HttpResponseException(Net.HttpStatusCode.NotFound);
List<TraceRecord> expectedTraces = new List<TraceRecord>
{
new TraceRecord(request, "testCategory", TraceLevel.Error) { Kind = TraceKind.Begin, Operator = "tester", Operation = "testOp", Message = "beginMessage" },
new TraceRecord(request, "testCategory", TraceLevel.Warn) { Kind = TraceKind.End, Operator = "tester", Operation = "testOp", Exception = exception, Message = "errorMessage",
Status = Net.HttpStatusCode.NotFound },
};
// Act
Exception thrown = Assert.Throws<HttpResponseException>(
() => traceWriter.TraceBeginEnd(request,
"testCategory",
TraceLevel.Error,
"tester",
"testOp",
beginTrace: (tr) => { tr.Message = "beginMessage"; },
execute: () => { throw exception; },
endTrace: (tr) => { tr.Message = "won't Happen"; },
errorTrace: (tr) => { tr.Message = "errorMessage"; }));
// Assert
Assert.Equal<TraceRecord>(expectedTraces, traceWriter.Traces, new TraceRecordComparer());
Assert.Same(thrown, exception);
}