Request.GetOwinContext возвращает null в пределах unit test - как проверить проверку подлинности OWIN в unit test?
В настоящее время я пытаюсь выполнить unit test аутентификацию для нового проекта WebAPI, который я пишу, используя OWIN для аутентификации, и у меня возникают проблемы с его запуском в контексте unit test.
Это мой метод тестирования:
[TestMethod]
public void TestRegister()
{
using (WebApp.Start<Startup>("localhost/myAPI"))
using (AccountController ac = new AccountController()
{
Request = new System.Net.Http.HttpRequestMessage
(HttpMethod.Post, "http://localhost/myAPI/api/Account/Register")
})
{
var result = ac.Register(new Models.RegisterBindingModel()
{
Email = "[email protected]",
Password = "[email protected]",
ConfirmPassword = "[email protected]"
}).Result;
Assert.IsNotNull(result);
}
}
Я получаю AggregateException
при получении .Result
со следующим внутренним исключением:
Result Message:
Test method myAPI.Tests.Controllers.AccountControllerTest.TestRegister
threw exception:
System.ArgumentNullException: Value cannot be null.
Parameter name: context
Result StackTrace:
at Microsoft.AspNet.Identity.Owin.OwinContextExtensions
.GetUserManager[TManager](IOwinContext context)
at myAPI.Controllers.AccountController.get_UserManager()
...
Я подтвердил с помощью отладки, что мой метод Startup
вызывается, вызывая ConfigurAuth
:
public void ConfigureAuth(IAppBuilder app)
{
HttpConfiguration config = new HttpConfiguration();
config.MapHttpAttributeRoutes();
app.UseWebApi(config);
// Configure the db context and user manager to use a single
// instance per request
app.CreatePerOwinContext(ApplicationDbContext.Create);
app.CreatePerOwinContext<ApplicationUserManager>
(ApplicationUserManager.Create);
// Enable the application to use a cookie to store information for
// the signed in user
// and to use a cookie to temporarily store information about a
// user logging in with a third party login provider
app.UseCookieAuthentication(new CookieAuthenticationOptions());
app.UseExternalSignInCookie(DefaultAuthenticationTypes.ExternalCookie);
// Configure the application for OAuth based flow
PublicClientId = "self";
OAuthOptions = new OAuthAuthorizationServerOptions
{
TokenEndpointPath = new PathString("/Token"),
Provider = new ApplicationOAuthProvider(PublicClientId),
AuthorizeEndpointPath = new PathString("/api/Account/ExternalLogin"),
AccessTokenExpireTimeSpan = TimeSpan.FromDays(14),
AllowInsecureHttp = true
};
// Enable the application to use bearer tokens to authenticate users
app.UseOAuthBearerTokens(OAuthOptions);
}
Я пробовал несколько вещей, но ничего не работает - я никогда не могу получить контекст OWIN. Тест не работает по следующему коду:
// POST api/Account/Register
[AllowAnonymous]
[Route("Register")]
public async Task<IHttpActionResult> Register(RegisterBindingModel model)
{
if (!ModelState.IsValid)
{
return BadRequest(ModelState);
}
var user = new ApplicationUser()
{ UserName = model.Email, Email = model.Email };
IdentityResult result = await UserManager.CreateAsync(user, model.Password);
if (!result.Succeeded)
{
return GetErrorResult(result);
}
return Ok();
}
Это вызывает свойство UserManager
:
public ApplicationUserManager UserManager
{
get
{
return _userManager ?? Request.GetOwinContext()
.GetUserManager<ApplicationUserManager>();
}
private set
{
_userManager = value;
}
}
Сбой:
return _userManager ?? Request.GetOwinContext()
.GetUserManager<ApplicationUserManager>();
с NullReferenceException
- Request.GetOwinContext
возвращает null
.
Итак, мой вопрос: я подхожу к этому неправильно? Должен ли я просто тестировать ответы JSON? Или есть хороший способ "внутренне" протестировать аутентификацию OWIN?
Ответы
Ответ 1
GetOwinContext вызывает context.GetOwinEnvironment();
который
private static IDictionary<string, object> GetOwinEnvironment(this HttpContextBase context)
{
return (IDictionary<string, object>) context.Items[HttpContextItemKeys.OwinEnvironmentKey];
}
и HttpContextItemKeys.OwinEnvironmentKey - постоянная "owin.Environment"
Поэтому, если вы добавите это в свои объекты httpcontext, это сработает.
var request = new HttpRequest("", "http://google.com", "rUrl=http://www.google.com")
{
ContentEncoding = Encoding.UTF8 //UrlDecode needs this to be set
};
var ctx = new HttpContext(request, new HttpResponse(new StringWriter()));
//Session need to be set
var sessionContainer = new HttpSessionStateContainer("id", new SessionStateItemCollection(),
new HttpStaticObjectsCollection(), 10, true,
HttpCookieMode.AutoDetect,
SessionStateMode.InProc, false);
//this adds aspnet session
ctx.Items["AspSession"] = typeof(HttpSessionState).GetConstructor(
BindingFlags.NonPublic | BindingFlags.Instance,
null, CallingConventions.Standard,
new[] { typeof(HttpSessionStateContainer) },
null)
.Invoke(new object[] { sessionContainer });
var data = new Dictionary<string, object>()
{
{"a", "b"} // fake whatever you need here.
};
ctx.Items["owin.Environment"] = data;
Ответ 2
Чтобы убедиться, что во время тестирования доступен контекст OWIN (то есть, чтобы исправить исключение нулевой ссылки при вызове Request.GetOwinContext()
), вам нужно установить пакет Microsoft.AspNet.WebApi.Owin
NuGet в тестовый проект. После этого вы можете использовать метод расширения SetOwinContext
в запросе.
Пример:
var controller = new MyController();
controller.Request = new HttpRequestMessage(HttpMethod.Post,
new Uri("api/data/validate", UriKind.Relative)
);
controller.Request.SetOwinContext(new OwinContext());
См. https://msdn.microsoft.com/en-us/library/system.net.http.owinhttprequestmessageextensions.setowincontext%28v=vs.118%29.aspx
При этом я согласен с другими ответами для вашего конкретного случая использования - укажите экземпляр AppplicationUserManager или factory в конструкторе. Приведенные выше шаги SetOwinContext
необходимы, если вам нужно напрямую взаимодействовать с контекстом, который будет использоваться вашим тестом.
Ответ 3
Вы можете просто передать UserManager в конструкторе AccountController, поэтому он не пытается найти его в owinContext. Конструктор по умолчанию не поддерживает unit test.
Ответ 4
То, что я обычно делаю, - это ввести AccountController с помощью менеджера пользователя factory. Таким образом, вы можете легко обменять экземпляр пользовательского менеджера, который используется в тесте. По умолчанию factory может принять запрос в конструкторе для продолжения предоставления экземпляров каждого запроса в менеджере пользователя. Ваш тест factory просто возвращает экземпляр менеджера пользователей, с которым вы хотите предоставить свои тесты, я обычно использую тот, который занимает заполненный экземпляр IUserStore, поэтому нет жесткой зависимости от задней части, используемой для хранения идентификационной информации.
Factory интерфейс и класс:
public interface IUserManagerFactory<TUser>
where TUser : class, global::Microsoft.AspNet.Identity.IUser<string>
{
UserManager<TUser> Create();
}
public class UserManagerFactory : IUserManagerFactory<AppUser>
{
private HttpRequestMessage request;
public UserManagerFactory(HttpRequestMessage request)
{
if (request == null)
{
throw new ArgumentNullException("request");
}
this.request = request;
}
public UserManager<AppUser, string> Create()
{
return request.GetOwinContext().GetUserManager<UserManager<AppUser>>();
}
}
AccountController:
public AccountController(IUserManagerFactory<AppUser> userManagerFactory)
{
this.userManagerFactory = userManagerFactory;
}
private UserManager<AppUser> userManager;
public UserManager<AppUser> UserManager
{
get
{
if (this.userManager == null)
{
this.userManager = this.userManagerFactory.Create();
}
return this.userManager;
}
}
Тест factory:
public class TestUserManagerFactory : IUserManagerFactory<AppUser>
{
private IUserStore<AppUser> userStore;
public TestUserManagerFactory()
{
this.userStore = new MockUserStore();
}
public UserManager<AppUser> Create()
{
return new UserManager<AppUser>(new MockUserStore());
}
}
Ответ 5
var data = new Dictionary<string, object>()
{
{"a", "b"} // fake whatever you need here.
};
ctx.Items["owin.Environment"] = data;
Использовал этот фрагмент кода и добавил в HttpContext вместо ctx и unit test работал как шарм.