Test ControllerFactory(预启动初始化阶段)

时间:2012-04-30 23:55:02

标签: asp.net asp.net-mvc asp.net-mvc-3 unit-testing

我想编写一个单元测试来验证我的路由注册和ControllerFactory,以便在给定特定URL的情况下,将创建一个特定的控制器。像这样:

Assert.UrlMapsToController("~/Home/Index",typeof(HomeController));

我修改了“Pro ASP.NET MVC 3 Framework”一书中的代码,看起来它是完美的,只是ControllerFactory.CreateController()调用抛出InvalidOperationException并说This method cannot be called during the application's pre-start initialization stage.

然后我下载了MVC源代码并调试到它,寻找问题的根源。它起源于ControllerFactory,它查找所有引用的程序集 - 以便它可以定位潜在的控制器。在CreateController调用堆栈中的某个地方,特定的麻烦制造者调用是这样的:

internal sealed class BuildManagerWrapper : IBuildManager {
    //...

    ICollection IBuildManager.GetReferencedAssemblies() {
        // This bails with InvalidOperationException with the message
        // "This method cannot be called during the application's pre-start 
        // initialization stage."
        return BuildManager.GetReferencedAssemblies();
    }

    //...
}

I found a SO commentary on this。我仍然想知道是否有可以手动初始化以使上述代码满意的内容。任何人?

但是如果没有......我不禁注意到调用来自IBuildManager的实现。我探讨了the possibility of injecting my own IBuildManager,但我遇到了以下问题:

  • IBuildManager标记为internal,因此我需要其他一些授权派生。事实证明,程序集System.Web.Mvc.Test有一个名为MockBuildManager的类,专为测试场景而设计,这是完美的!这导致了第二个问题。
  • 据我所知,MVC可分发,不附带System.Web.Mvc.Test程序集(DOH!)。
  • 即使MVC distributable与System.Web.Mvc.Test程序集一起提供,但实例MockBuildManager只是解决方案的一半。还需要将该实例提供给DefaultControllerFactory。不幸的是,完成此任务的属性设置器也标记为internal(DOH!)。

简而言之,除非我找到另一种“初始化”MVC框架的方法,否则我现在的选择是:

  • 完全复制DefaultControllerFactory及其依赖项的源代码,以便我可以绕过原始的GetReferencedAssemblies()问题。 (啊!)
  • 完全基于MVC源代码替换MVC distributable与我自己的MVC构建 - 只删除了几个internal修饰符。 (双喔!)

顺便说一下,我知道MvcContrib“TestHelper”看起来很容易实现我的目标,但我认为它只是使用反射来找到控制器 - 而不是使用实际的IControllerFactory来检索控制器类型/实例。

我想要这个测试功能的一个重要原因是我已经创建了一个基于DefaultControllerFactory的自定义控制器工厂,我想要验证它的行为。

1 个答案:

答案 0 :(得分:1)

我不太确定你在这里想要完成什么。如果它只是测试您的路线设置;你只是测试它而不是黑客进入内部的方式会更好。 TDD的第一条规则:只测试你编写的代码(在这种情况下,这是路由设置,而不是MVC完成的实际路由解析技术)。

有很多关于测试路线设置的帖子/博客(只是谷歌的'mvc测试路线')。这一切都归结为在httpcontext中模拟请求并调用GetRouteData。

如果你真的需要一些忍者技能来模拟buildmanager:有一种方法可以解决内部接口,我用它来进行(LinqPad)实验测试。现在大多数.net程序集都有InternalsVisibleToAttribute集,很可能指向另一个签名的测试程序集。通过扫描目标程序集以获取此属性并在运行中创建与名称(和公钥标记)匹配的程序集,您可以轻松访问内部。

请注意,我个人不会在生产测试代码中使用此技术;但这是隔离一些复杂想法的好方法。

void Main()
{
    var bm = BuildManagerMockBase.CreateMock<MyBuildManager>();
    bm.FileExists("IsCool?").Dump();
}

public class MyBuildManager : BuildManagerMockBase
{
    public override bool FileExists(string virtualPath) { return true; }
}

public abstract class BuildManagerMockBase
{
    public static T CreateMock<T>() 
        where T : BuildManagerMockBase
    {
        // Locate the mvc assembly
        Assembly mvcAssembly = Assembly.GetAssembly(typeof(Controller));

        // Get the type of the buildmanager interface
        var buildManagerInterface = mvcAssembly.GetType("System.Web.Mvc.IBuildManager",true);

        // Locate the "internals visible to" attribute and create a public key token that matches the one specified.
        var internalsVisisbleTo = mvcAssembly.GetCustomAttributes(typeof (InternalsVisibleToAttribute), true).FirstOrDefault() as InternalsVisibleToAttribute;
        var publicKeyString = internalsVisisbleTo.AssemblyName.Split("=".ToCharArray())[1];
        var publicKey = ToBytes(publicKeyString);

        // Create a fake System.Web.Mvc.Test assembly with the public key token set
        AssemblyName assemblyName = new AssemblyName();
        assemblyName.Name = "System.Web.Mvc.Test";
        assemblyName.SetPublicKey(publicKey);

        // Get the domain of our current thread to host the new fake assembly
        var domain = Thread.GetDomain();
        var assemblyBuilder = domain.DefineDynamicAssembly(assemblyName, AssemblyBuilderAccess.RunAndSave);
        moduleBuilder = assemblyBuilder.DefineDynamicModule("System.Web.Mvc.Test", "System.Web.Mvc.Test.dll");
        AppDomain currentDom = domain;
        currentDom.TypeResolve += ResolveEvent;

        // Create a new type that inherits from the provided generic and implements the IBuildManager interface
        var typeBuilder = moduleBuilder.DefineType("Cheat", TypeAttributes.NotPublic | TypeAttributes.Class, typeof(T), new Type[] { buildManagerInterface });      
        Type cheatType = typeBuilder.CreateType();

        // Magic!
        var ret = Activator.CreateInstance(cheatType) as T;

        return ret;
    }

    private static byte[] ToBytes(string str)
    {
        List<Byte> bytes = new List<Byte>();

        while(str.Length > 0)
        {
            var bstr = str.Substring(0, 2);
            bytes.Add(Convert.ToByte(bstr, 16));
            str = str.Substring(2);
        }

        return bytes.ToArray();
    }

    private static ModuleBuilder moduleBuilder;

    private static Assembly ResolveEvent(Object sender, ResolveEventArgs args)
    {
        return moduleBuilder.Assembly;
    }

    public virtual bool FileExists(string virtualPath)      { throw new NotImplementedException(); }
    public virtual Type GetCompiledType(string virtualPath) { throw new NotImplementedException(); }
    public virtual ICollection GetReferencedAssemblies()    { throw new NotImplementedException(); }
    public virtual Stream ReadCachedFile(string fileName)   { throw new NotImplementedException(); }
    public virtual Stream CreateCachedFile(string fileName) { throw new NotImplementedException(); }
}