ตรวจสอบว่าโค้ดทำงานเป็นส่วนหนึ่งของการทดสอบหน่วยหรือไม่

ฉันมีการทดสอบหน่วย (nUnit) หลายชั้นที่เรียกซ้อนกันวิธีการจะล้มเหลวหากทำงานผ่านการทดสอบหน่วย

ตามหลักการแล้วคุณจะใช้บางอย่างเช่นการเยาะเย้ยเพื่อตั้งค่าวัตถุที่วิธีนี้ขึ้นอยู่กับ แต่นี่เป็นรหัสของบุคคลที่สามและฉันไม่สามารถทำได้โดยไม่ต้องทำงานมาก

ฉันไม่ต้องการตั้งค่าวิธีการเฉพาะ nUnit - ที่นี่มีหลายระดับเกินไปและเป็นวิธีที่ไม่ดีในการทดสอบหน่วย

แต่สิ่งที่ฉันต้องการจะทำคือเพิ่มสิ่งนี้ให้ลึกลงไปใน call stack

#IF DEBUG // Unit tests only included in debug build
if (IsRunningInUnitTest)
   {
   // Do some setup to avoid error
   }
#endif

มีแนวคิดเกี่ยวกับวิธีการเขียน IsRunningInUnitTest อย่างไร?

ปล. ฉันรู้อยู่เต็มอกว่านี่ไม่ใช่การออกแบบที่ยอดเยี่ยม แต่ฉันคิดว่ามันดีกว่าทางเลือกอื่น

ฉันเคยทำสิ่งนี้มาก่อน - ฉันต้องกลั้นจมูกในขณะที่ทำ แต่ฉันทำไปแล้ว ลัทธิปฏิบัตินิยมเอาชนะความเชื่อทุกครั้ง แน่นอนถ้ามีเป็นวิธีที่ดีที่คุณสามารถ refactor จะหลีกเลี่ยงมันว่าจะดี

โดยพื้นฐานแล้วฉันมีคลาส "UnitTestDetector" ซึ่งตรวจสอบว่ามีการโหลดแอสเซมบลี NUnit framework ใน AppDomain ปัจจุบันหรือไม่ จำเป็นต้องทำเพียงครั้งเดียวจากนั้นแคชผลลัพธ์ น่าเกลียด แต่เรียบง่ายและมีประสิทธิภาพ

แนวคิดของจอนนี่คือสิ่งที่ฉันคิดขึ้นมา -

using System;
using System.Reflection;

/// <summary>
/// Detect if we are running as part of a nUnit unit test.
/// This is DIRTY and should only be used if absolutely necessary 
/// as its usually a sign of bad design.
/// </summary>    
static class UnitTestDetector
{

    private static bool _runningFromNUnit = false;      

    static UnitTestDetector()
    {
        foreach (Assembly assem in AppDomain.CurrentDomain.GetAssemblies())
        {
            // Can't do something like this as it will load the nUnit assembly
            // if (assem == typeof(NUnit.Framework.Assert))

            if (assem.FullName.ToLowerInvariant().StartsWith("nunit.framework"))
            {
                _runningFromNUnit = true;
                break;
            }
        }
    }

    public static bool IsRunningFromNUnit
    {
        get { return _runningFromNUnit; }
    }
}

บีบลงที่ด้านหลังพวกเราทุกคนตัวโตพอที่จะรับรู้เมื่อเราทำบางสิ่งที่เราไม่ควรทำ

ดัดแปลงมาจากคำตอบของ Ryan อันนี้ใช้สำหรับกรอบการทดสอบหน่วย MS

เหตุผลที่ฉันต้องการเพราะฉันแสดง MessageBox เกี่ยวกับข้อผิดพลาด แต่การทดสอบหน่วยของฉันยังทดสอบรหัสการจัดการข้อผิดพลาดและฉันไม่ต้องการให้กล่องข้อความปรากฏขึ้นเมื่อเรียกใช้การทดสอบหน่วย

/// <summary>
/// Detects if we are running inside a unit test.
/// </summary>
public static class UnitTestDetector
{
    static UnitTestDetector()
    {
        string testAssemblyName = "Microsoft.VisualStudio.QualityTools.UnitTestFramework";
        UnitTestDetector.IsInUnitTest = AppDomain.CurrentDomain.GetAssemblies()
            .Any(a => a.FullName.StartsWith(testAssemblyName));
    }

    public static bool IsInUnitTest { get; private set; }
}

และนี่คือการทดสอบหน่วยสำหรับมัน:

    [TestMethod]
    public void IsInUnitTest()
    {
        Assert.IsTrue(UnitTestDetector.IsInUnitTest, 
            "Should detect that we are running inside a unit test."); // lol
    }

การทำให้โซลูชันของ Ryan ง่ายขึ้นคุณสามารถเพิ่มคุณสมบัติคงที่ต่อไปนี้ให้กับคลาสใดก็ได้:

    public static readonly bool IsRunningFromNUnit = 
        AppDomain.CurrentDomain.GetAssemblies().Any(
            a => a.FullName.ToLowerInvariant().StartsWith("nunit.framework"));

ฉันใช้วิธีการคล้าย ๆ กับ tallseth

นี่คือรหัสพื้นฐานที่สามารถแก้ไขได้อย่างง่ายดายเพื่อรวมแคช ความคิดที่ดีอีกประการหนึ่งคือการเพิ่มตัวตั้งค่าIsRunningInUnitTestและเรียกUnitTestDetector.IsRunningInUnitTest = falseไปยังจุดเริ่มต้นหลักของโครงการของคุณเพื่อหลีกเลี่ยงการเรียกใช้โค้ด

public static class UnitTestDetector
{
    public static readonly HashSet<string> UnitTestAttributes = new HashSet<string> 
    {
        "Microsoft.VisualStudio.TestTools.UnitTesting.TestClassAttribute",
        "NUnit.Framework.TestFixtureAttribute",
    };
    public static bool IsRunningInUnitTest
    {
        get
        {
            foreach (var f in new StackTrace().GetFrames())
                if (f.GetMethod().DeclaringType.GetCustomAttributes(false).Any(x => UnitTestAttributes.Contains(x.GetType().FullName)))
                    return true;
            return false;
        }
    }
}

อาจมีประโยชน์ตรวจสอบ ProcessName ปัจจุบัน:

public static bool UnitTestMode
{
    get 
    { 
        string processName = System.Diagnostics.Process.GetCurrentProcess().ProcessName;

        return processName == "VSTestHost"
                || processName.StartsWith("vstest.executionengine") //it can be vstest.executionengine.x86 or vstest.executionengine.x86.clr20
                || processName.StartsWith("QTAgent");   //QTAgent32 or QTAgent32_35
    }
}

และควรตรวจสอบฟังก์ชั่นนี้โดย unittest:

[TestClass]
public class TestUnittestRunning
{
    [TestMethod]
    public void UnitTestRunningTest()
    {
        Assert.IsTrue(MyTools.UnitTestMode);
    }
}

ข้อมูลอ้างอิง:
Matthew Watson ในhttp://social.msdn.microsoft.com/Forums/en-US/csharplanguage/thread/11e68468-c95e-4c43-b02b-7045a52b407e/

ในโหมดการทดสอบน่าจะเป็นAssembly.GetEntryAssembly()null

#IF DEBUG // Unit tests only included in debug build 
  if (Assembly.GetEntryAssembly() == null)    
  {
    // Do some setup to avoid error    
  }
#endif 

โปรดทราบว่าถ้าAssembly.GetEntryAssembly()เป็นnull,Assembly.GetExecutingAssembly()ไม่ได้

เอกสารกล่าวว่า: ในGetEntryAssemblyวิธีการที่จะสามารถกลับมาnullเมื่อมีการจัดการชุมนุมได้รับการโหลดจากโปรแกรมประยุกต์ที่ไม่มีการจัดการ

บางแห่งในโครงการที่กำลังทดสอบ:

public static class Startup
{
    public static bool IsRunningInUnitTest { get; set; }
}

ที่ไหนสักแห่งในโครงการทดสอบหน่วยของคุณ:

[TestClass]
public static class AssemblyInitializer
{
    [AssemblyInitialize]
    public static void Initialize(TestContext context)
    {
        Startup.IsRunningInUnitTest = true;
    }
}

สวยหรูไม่มี. แต่ตรงไปตรงมาและรวดเร็ว AssemblyInitializerใช้สำหรับการทดสอบ MS ฉันคาดหวังว่ากรอบการทดสอบอื่น ๆ จะมีคุณสมบัติเทียบเท่า

ฉันใช้สิ่งนี้เท่านั้นสำหรับการข้ามตรรกะที่ปิดใช้งาน TraceAppenders ทั้งหมดใน log4net ระหว่างการเริ่มต้นเมื่อไม่มีดีบักที่แนบมา สิ่งนี้ช่วยให้การทดสอบหน่วยล็อกไปยังหน้าต่างผลลัพธ์ Resharper แม้ว่าจะทำงานในโหมดไม่แก้ไขจุดบกพร่องก็ตาม

วิธีการที่ใช้ฟังก์ชันนี้เรียกว่าเมื่อเริ่มต้นแอปพลิเคชันหรือเมื่อเริ่มการติดตั้งทดสอบ

คล้ายกับโพสต์ของ Ryan แต่ใช้ LINQ ลดความต้องการ System.Reflection ไม่แคชผลลัพธ์และเป็นแบบส่วนตัวเพื่อป้องกันการใช้ผิดวัตถุประสงค์ (โดยไม่ได้ตั้งใจ)

    private static bool IsNUnitRunning()
    {
        return AppDomain.CurrentDomain.GetAssemblies().Any(assembly => assembly.FullName.ToLowerInvariant().StartsWith("nunit.framework"));
    }

การอ้างอิงถึง nunit framework ไม่ได้หมายความว่าการทดสอบกำลังทำงานอยู่ ตัวอย่างเช่นใน Unity เมื่อคุณเปิดใช้งานโหมดเล่นการทดสอบการอ้างอิงแม่ชีจะถูกเพิ่มเข้าไปในโปรเจ็กต์ และเมื่อคุณเรียกใช้เกมการอ้างอิงจะมีอยู่ดังนั้น UnitTestDetector จะทำงานไม่ถูกต้อง

แทนที่จะตรวจสอบการชุมนุมของแม่ชีเราสามารถขอให้แม่ชี api ตรวจสอบว่าเป็นรหัสที่ดำเนินการทดสอบตอนนี้หรือไม่

using NUnit.Framework;

// ...

if (TestContext.CurrentContext != null)
{
    // nunit test detected
    // Do some setup to avoid error
}

แก้ไข:

ระวังว่าTestContext อาจถูกสร้างขึ้นโดยอัตโนมัติหากจำเป็น

เพียงใช้สิ่งนี้:

AppDomain.CurrentDomain.IsDefaultAppDomain()

ในโหมดทดสอบจะส่งคืนเท็จ

ฉันไม่พอใจที่มีปัญหานี้เมื่อเร็ว ๆ นี้ ฉันแก้ไขด้วยวิธีที่แตกต่างกันเล็กน้อย ก่อนอื่นฉันไม่เต็มใจที่จะตั้งสมมติฐานว่ากรอบงานแม่ชีจะไม่ถูกโหลดนอกสภาพแวดล้อมการทดสอบ ฉันกังวลเป็นพิเศษเกี่ยวกับนักพัฒนาที่ใช้แอปบนเครื่องของพวกเขา เลยเดินกองโทรแทน ประการที่สองฉันสามารถตั้งสมมติฐานได้ว่ารหัสทดสอบจะไม่ถูกรันกับไบนารีรุ่นดังนั้นฉันจึงแน่ใจว่าไม่มีรหัสนี้ในระบบรีลีส

internal abstract class TestModeDetector
{
    internal abstract bool RunningInUnitTest();

    internal static TestModeDetector GetInstance()
    {
    #if DEBUG
        return new DebugImplementation();
    #else
        return new ReleaseImplementation();
    #endif
    }

    private class ReleaseImplementation : TestModeDetector
    {
        internal override bool RunningInUnitTest()
        {
            return false;
        }
    }

    private class DebugImplementation : TestModeDetector
    {
        private Mode mode_;

        internal override bool RunningInUnitTest()
        {
            if (mode_ == Mode.Unknown)
            {
                mode_ = DetectMode();
            }

            return mode_ == Mode.Test;
        }

        private Mode DetectMode()
        {
            return HasUnitTestInStack(new StackTrace()) ? Mode.Test : Mode.Regular;
        }

        private static bool HasUnitTestInStack(StackTrace callStack)
        {
            return GetStackFrames(callStack).SelectMany(stackFrame => stackFrame.GetMethod().GetCustomAttributes(false)).Any(NunitAttribute);
        }

        private static IEnumerable<StackFrame> GetStackFrames(StackTrace callStack)
        {
            return callStack.GetFrames() ?? new StackFrame[0];
        }

        private static bool NunitAttribute(object attr)
        {
            var type = attr.GetType();
            if (type.FullName != null)
            {
                return type.FullName.StartsWith("nunit.framework", StringComparison.OrdinalIgnoreCase);
            }
            return false;
        }

        private enum Mode
        {
            Unknown,
            Test,
            Regular
        }

ใช้งานได้เหมือนมีเสน่ห์

if (AppDomain.CurrentDomain.GetAssemblies().FirstOrDefault(x => x.FullName.ToLowerInvariant().StartsWith("nunit.framework")) != null)
{
    fileName = @"C:\Users\blabla\xxx.txt";
}
else
{
    var sfd = new SaveFileDialog
    {     ...     };
    var dialogResult = sfd.ShowDialog();
    if (dialogResult != DialogResult.OK)
        return;
    fileName = sfd.FileName;
}

.

การทดสอบหน่วยจะข้ามจุดเข้าใช้งาน อย่างน้อยสำหรับ wpf main()จะไม่มีการเรียกใช้โปรแกรม winforms และ console

หากเรียกเมธอดหลักเกินกว่าที่เราอยู่ในรันไทม์มิฉะนั้นเราจะอยู่ในโหมดทดสอบหน่วย :

public static bool IsUnitTest { get; private set; } = true;

[STAThread]
public static void main()
{
    IsUnitTest = false;
    ...
}

การพิจารณาโค้ดของคุณเป็นเรื่องปกติที่รันในเธรดหลัก (gui) ของแอ็พพลิเคชันฟอร์ม windows และคุณต้องการให้ทำงานแตกต่างกันในขณะที่รันในการทดสอบคุณสามารถตรวจสอบได้

if (SynchronizationContext.Current == null)
{
    // code running in a background thread or from within a unit test
    DoSomething();
}
else
{
    // code running in the main thread or any other thread where
    // a SynchronizationContext has been set with
    // SynchronizationContext.SetSynchronizationContext(synchronizationContext);
    DoSomethingAsync();
}

ฉันใช้สิ่งนี้สำหรับรหัสที่ฉันต้องการfire and forgotในแอปพลิเคชัน gui แต่ในการทดสอบหน่วยฉันอาจต้องการผลลัพธ์ที่คำนวณเพื่อการยืนยันและฉันไม่ต้องการยุ่งกับเธรดหลายชุดที่ทำงานอยู่

ใช้ได้กับ MSTest ข้อดีคือรหัสของฉันไม่จำเป็นต้องตรวจสอบกรอบการทดสอบเองและถ้าฉันต้องการพฤติกรรม async ในการทดสอบบางอย่างฉันสามารถตั้งค่า SynchronizationContext ของฉันเองได้

โปรดทราบว่านี่ไม่ใช่วิธีการที่เชื่อถือDetermine if code is running as part of a unit testได้ตามที่ OP ร้องขอเนื่องจากโค้ดอาจทำงานภายในเธรด แต่สำหรับบางสถานการณ์นี่อาจเป็นทางออกที่ดี (เช่น: หากฉันรันจากเธรดพื้นหลังอยู่แล้วอาจไม่จำเป็น เพื่อเริ่มต้นใหม่)

แอปพลิเคชันปัจจุบันเป็นโมฆะเมื่อทำงานภายใต้เครื่องทดสอบหน่วย อย่างน้อยสำหรับแอป WPF ของฉันโดยใช้ MS Unit tester นี่เป็นการทดสอบที่ง่ายหากจำเป็น นอกจากนี้สิ่งที่ควรคำนึงถึงเมื่อใช้แอปพลิเคชันปัจจุบันอยู่ในรหัสของคุณ

ฉันใช้สิ่งต่อไปนี้ใน VB ในโค้ดของฉันเพื่อตรวจสอบว่าเราอยู่ในการทดสอบหน่วยหรือไม่ โดยเฉพาะฉันไม่ต้องการให้การทดสอบเปิด Word

    If Not Application.ProductName.ToLower().Contains("test") then
        ' Do something 
    End If

วิธีการใช้การสะท้อนและสิ่งนี้:

var underTest = Assembly.GetCallingAssembly ()! = typeof (MainForm) .Assembly;

แอสเซมบลีการโทรจะเป็นกรณีทดสอบของคุณและเพียงแค่แทนที่ MainForm บางประเภทที่อยู่ในโค้ดของคุณที่กำลังทดสอบ

มีวิธีง่ายๆเช่นกันเมื่อคุณกำลังทดสอบชั้นเรียน ...

เพียงแค่ให้คลาสที่คุณกำลังทดสอบคุณสมบัติเช่นนี้:

// For testing purposes to avoid running certain code in unit tests.
public bool thisIsUnitTest { get; set; }

ตอนนี้การทดสอบหน่วยของคุณสามารถตั้งค่าบูลีน "thisIsUnitTest" เป็นจริงได้ดังนั้นในโค้ดที่คุณต้องการข้ามให้เพิ่ม:

   if (thisIsUnitTest)
   {
       return;
   } 

ง่ายและเร็วกว่าการตรวจสอบชุดประกอบ ทำให้ฉันนึกถึง Ruby On Rails ที่คุณต้องการดูว่าคุณอยู่ในสภาพแวดล้อมการทดสอบหรือไม่