WebRequest からの WebResponse をモックする
-
01-07-2019 - |
質問
ようやく RESTful Web インターフェイスで動作するアプリの作成に手を出し始めましたが、一連のテストを実行するために F5 キーを押すたびにサーバーに負荷がかかるのではないかと心配しています。
基本的に、さまざまな応答が正しく解析されているかどうかをテストできるように、一連の Web 応答を取得する必要があります。毎回サーバーにアクセスするのではなく、これを 1 回実行して XML を保存し、ローカルで作業できると考えました。
ただし、(私の知る限り) WebResponse は次の方法でのみインスタンス化できるため、WebResponse を「モック」する方法がわかりません。 WebRequest.GetResponse
皆さんはどうやってこの種のことを嘲笑しますか?あなたは?彼らのサーバーに負荷をかけているという事実が本当に気に入らないのです :S コードを変更したくないのです あまりにも たくさんありますが、これを行うエレガントな方法があることを期待しています。
承諾後に更新
ウィルの答えは、私が必要としていた顔面への平手打ちでした。私は基本的な点が欠けていることを知っていました!
- XML を表すプロキシ オブジェクトを返すインターフェイスを作成します。
- インターフェイスを 2 回実装します。1 回目は WebRequest を使用し、もう 1 回目は静的な「応答」を返します。
- 次に、インターフェイス実装は、応答または静的 XML に基づいて戻り値の型をインスタンス化します。
- その後、テスト時または運用時に必要なクラスをサービス層に渡すことができます。
コードを作成したら、いくつかのサンプルを貼り付けます。
解決
まったく同じことをしようとしているときに、この質問を見つけました。答えはどこにも見つかりませんでしたが、もう少し詳しく調べたところ、.Net Framework にこれに対するサポートが組み込まれていることがわかりました。
ファクトリ オブジェクトを登録するには、 WebRequest.RegisterPrefix
どれの WebRequest.Create
そのプレフィックス (または URL) を使用するときに呼び出します。ファクトリ オブジェクトは実装する必要があります IWebRequestCreate
メソッドが 1 つだけあるもの Create
を返す WebRequest
. 。ここでモックを返却できます WebRequest
.
サンプルコードをいくつか載せておきましたhttp://blog.salamandersoft.co.uk/index.php/2009/10/how-to-mock-httpwebrequest-when-unit-testing/
他のヒント
これはモックを必要としない解決策です。の 3 つのコンポーネントをすべて実装します。 WebRequest
: IWebRequestCreate
WebRequest
そして WebResponse
. 。以下を参照してください。私の例では、(スローすることによって)失敗したリクエストを生成します。 WebException
) ですが、「実際の」応答を送信するように調整できるはずです。
class WebRequestFailedCreate : IWebRequestCreate {
HttpStatusCode status;
String statusDescription;
public WebRequestFailedCreate(HttpStatusCode hsc, String sd) {
status = hsc;
statusDescription = sd;
}
#region IWebRequestCreate Members
public WebRequest Create(Uri uri) {
return new WebRequestFailed(uri, status, statusDescription);
}
#endregion
}
class WebRequestFailed : WebRequest {
HttpStatusCode status;
String statusDescription;
Uri itemUri;
public WebRequestFailed(Uri uri, HttpStatusCode status, String statusDescription) {
this.itemUri = uri;
this.status = status;
this.statusDescription = statusDescription;
}
WebException GetException() {
SerializationInfo si = new SerializationInfo(typeof(HttpWebResponse), new System.Runtime.Serialization.FormatterConverter());
StreamingContext sc = new StreamingContext();
WebHeaderCollection headers = new WebHeaderCollection();
si.AddValue("m_HttpResponseHeaders", headers);
si.AddValue("m_Uri", itemUri);
si.AddValue("m_Certificate", null);
si.AddValue("m_Version", HttpVersion.Version11);
si.AddValue("m_StatusCode", status);
si.AddValue("m_ContentLength", 0);
si.AddValue("m_Verb", "GET");
si.AddValue("m_StatusDescription", statusDescription);
si.AddValue("m_MediaType", null);
WebResponseFailed wr = new WebResponseFailed(si, sc);
Exception inner = new Exception(statusDescription);
return new WebException("This request failed", inner, WebExceptionStatus.ProtocolError, wr);
}
public override WebResponse GetResponse() {
throw GetException();
}
public override IAsyncResult BeginGetResponse(AsyncCallback callback, object state) {
Task<WebResponse> f = Task<WebResponse>.Factory.StartNew (
_ =>
{
throw GetException();
},
state
);
if (callback != null) f.ContinueWith((res) => callback(f));
return f;
}
public override WebResponse EndGetResponse(IAsyncResult asyncResult) {
return ((Task<WebResponse>)asyncResult).Result;
}
}
class WebResponseFailed : HttpWebResponse {
public WebResponseFailed(SerializationInfo serializationInfo, StreamingContext streamingContext)
: base(serializationInfo, streamingContext) {
}
}
を作成する必要があります HttpWebResponse
それ以外の場合はサブクラスを作成できないためです。
難しい部分( GetException()
メソッド) は、オーバーライドできない値を入力しています。 StatusCode
そしてここが私たちの最高の相棒の場所です SerializaionInfo
入って来る!ここで、オーバーライドできない値を指定します。明らかに、(の)部分をオーバーライドします。 HttpWebResponse
)あなたはそこまでの残りの道を進むことができます。
それらすべての「名前」をどうやって入手したのですか AddValue()
電話?例外メッセージから!私が満足するまで、順番にすべてを教えてくれるのは十分に良かったです。
現在、コンパイラは「古い」というメッセージを表示しますが、.NET Framework バージョン 4 を含めて、これは機能します。
参考用の(合格した)テストケースを次に示します。
[TestMethod, ExpectedException(typeof(WebException))]
public void WebRequestFailedThrowsWebException() {
string TestURIProtocol = TestContext.TestName;
var ResourcesBaseURL = TestURIProtocol + "://resources/";
var ContainerBaseURL = ResourcesBaseURL + "container" + "/";
WebRequest.RegisterPrefix(TestURIProtocol, new WebRequestFailedCreate(HttpStatusCode.InternalServerError, "This request failed on purpose."));
WebRequest wr = WebRequest.Create(ContainerBaseURL);
try {
WebResponse wrsp = wr.GetResponse();
using (wrsp) {
Assert.Fail("WebRequest.GetResponse() Should not have succeeded.");
}
}
catch (WebException we) {
Assert.IsInstanceOfType(we.Response, typeof(HttpWebResponse));
Assert.AreEqual(HttpStatusCode.InternalServerError, (we.Response as HttpWebResponse).StatusCode, "Status Code failed");
throw we;
}
}
あなたはできません。最善の方法は、それをプロキシ オブジェクトでラップし、それをモックすることです。あるいは、TypeMock など、モックできない型をインターセプトできるモック フレームワークを使用する必要があります。でも、あなたはお金のことを話しているのです。ちょっとしたラッピングをした方が良いでしょう。
どうやらあなたは できる 少し追加の作業を加えます。ここで最も投票数の多かった回答を確認してください。
以前、Microsoft Moles を使用した非常に優れたアプローチを説明している次のブログを見つけました。
http://maraboustork.co.uk/index.php/2011/03/mocking-httpwebresponse-with-moles/
つまり、この解決策は次のことを示唆しています。
[TestMethod]
[HostType("Moles")]
[Description("Tests that the default scraper returns the correct result")]
public void Scrape_KnownUrl_ReturnsExpectedValue()
{
var mockedWebResponse = new MHttpWebResponse();
MHttpWebRequest.AllInstances.GetResponse = (x) =>
{
return mockedWebResponse;
};
mockedWebResponse.StatusCodeGet = () => { return HttpStatusCode.OK; };
mockedWebResponse.ResponseUriGet = () => { return new Uri("http://www.google.co.uk/someRedirect.aspx"); };
mockedWebResponse.ContentTypeGet = () => { return "testHttpResponse"; };
var mockedResponse = "<html> \r\n" +
" <head></head> \r\n" +
" <body> \r\n" +
" <h1>Hello World</h1> \r\n" +
" </body> \r\n" +
"</html>";
var s = new MemoryStream();
var sw = new StreamWriter(s);
sw.Write(mockedResponse);
sw.Flush();
s.Seek(0, SeekOrigin.Begin);
mockedWebResponse.GetResponseStream = () => s;
var scraper = new DefaultScraper();
var retVal = scraper.Scrape("http://www.google.co.uk");
Assert.AreEqual(mockedResponse, retVal.Content, "Should have returned the test html response");
Assert.AreEqual("http://www.google.co.uk/someRedirect.aspx", retVal.FinalUrl, "The finalUrl does not correctly represent the redirection that took place.");
}
これは完璧な解決策ではありませんが、以前はうまく機能していたので、シンプルさのために特別な注意が必要です。
また、タイプモックの例も文書化されています。 タイプモックフォーラム:
using System;
using System.IO;
using System.Net;
using NUnit.Framework;
using TypeMock;
namespace MockHttpWebRequest
{
public class LibraryClass
{
public string GetGoogleHomePage()
{
HttpWebRequest request = (HttpWebRequest)WebRequest.Create("http://www.google.com");
HttpWebResponse response = (HttpWebResponse)request.GetResponse();
using (StreamReader reader = new StreamReader(response.GetResponseStream()))
{
return reader.ReadToEnd();
}
}
}
[TestFixture]
[VerifyMocks]
public class UnitTests
{
private Stream responseStream = null;
private const string ExpectedResponseContent = "Content from mocked response.";
[SetUp]
public void SetUp()
{
System.Text.UTF8Encoding encoding = new System.Text.UTF8Encoding();
byte[] contentAsBytes = encoding.GetBytes(ExpectedResponseContent);
this.responseStream = new MemoryStream();
this.responseStream.Write(contentAsBytes, 0, contentAsBytes.Length);
this.responseStream.Position = 0;
}
[TearDown]
public void TearDown()
{
if (responseStream != null)
{
responseStream.Dispose();
responseStream = null;
}
}
[Test(Description = "Mocks a web request using natural mocks.")]
public void NaturalMocks()
{
HttpWebRequest mockRequest = RecorderManager.CreateMockedObject<HttpWebRequest>(Constructor.Mocked);
HttpWebResponse mockResponse = RecorderManager.CreateMockedObject<HttpWebResponse>(Constructor.Mocked);
using (RecordExpectations recorder = RecorderManager.StartRecording())
{
WebRequest.Create("http://www.google.com");
recorder.CheckArguments();
recorder.Return(mockRequest);
mockRequest.GetResponse();
recorder.Return(mockResponse);
mockResponse.GetResponseStream();
recorder.Return(this.responseStream);
}
LibraryClass testObject = new LibraryClass();
string result = testObject.GetGoogleHomePage();
Assert.AreEqual(ExpectedResponseContent, result);
}
[Test(Description = "Mocks a web request using reflective mocks.")]
public void ReflectiveMocks()
{
Mock<HttpWebRequest> mockRequest = MockManager.Mock<HttpWebRequest>(Constructor.Mocked);
MockObject<HttpWebResponse> mockResponse = MockManager.MockObject<HttpWebResponse>(Constructor.Mocked);
mockResponse.ExpectAndReturn("GetResponseStream", this.responseStream);
mockRequest.ExpectAndReturn("GetResponse", mockResponse.Object);
LibraryClass testObject = new LibraryClass();
string result = testObject.GetGoogleHomePage();
Assert.AreEqual(ExpectedResponseContent, result);
}
}
}