AVK Selected

Показавшиеся интересными, на мой вкус, посты

Товарищ SergASh начал обсуждение, поскольку некропостинг — отдельным топиком.

Тема ассертов довольно объёмная и как всегда, надо начинать с самого начала. Т.е. с

Зачем нужны ассерты?

    class Sample
    {
        public Sample(int sampleCount)
        {
           SampleCount = sampleCount;
        }

        public int SampleCount { get; private set; }

        public Action<string> SampleCallback { get; set; }

        public void Run<T>(T value) where T: class
        {
            for (int i = 0; i < SampleCount; i++) // (0)
            {
                SampleCallback(value.ToString()); // (1), (2)
            }
        }
    }

    // Usage
    static void UsageSample()
    {
        var sample = new Sample(10)
        {
            SampleCallback = x => Console.WriteLine(x)
        };

        // ...
        // Some code
        // ...

        sample.Run("Hello!");
    }

Код разумеется бессмысленный, зато отлично показывает самые что ни на есть типовые ошибки в коде:
0. SampleCount отрицательный. 100% ошибка с математикой выше по стеку.
1. SampleCallback не проинициализирован. Косяк с настройкой объекта.
2. value = null. NullRefException.

Эти ошибки вылезут только в момент вызова Run(), что в реальном коде может происходить спустя километры кода и минуты времени после создания объекта. Т.е. потенциально отлавливаемый косяк (см. случай с SampleCount) имея только стек/дамп отловить будет проблематично

Готовые решения?

Разумеется, можно добавить проверки в виде if-then-throw, но их массовое применение даёт новые проблемы: копипаста проверок и сообщений, ресурсы (редко, но заказчик, бывает, просит), отладка (надо отличать исключение "100% косяк" от обычных повседневных исключений) и т.д. и т.п. Можете попробовать сами в более-менее большом проекте, через пару лет посмотрим на состояние всей этой радости

Готовые ассерты (Debug.Assert) на мой взгляд могут использовать только мазохисты. В них _всё_ сделано неправильно. UPD. Ответ на вопрос "почему?" вот тут

Тесты тут тоже мало чем помогут, разве что покажут что API у нас кривое и неудобное (я и так это знаю, код взят только для примера

)

Готовые проекты типа TypeLess или check. Написаны по мотивам ассертов для тестов и для продакшна не годятся от слова вообще. Как пример, только одна строчка:

  throw (Exception)Activator.CreateInstance(
    typeof(E),
    new object[]
    {
      errorMsg == null ?
        String.Format(CultureInfo.InvariantCulture, _sb.ToString().Replace("<name>", "{0}"), Name) :
        String.Format(CultureInfo.InvariantCulture, errorMsg.Replace("<name>", "{0}"), Name)
    });

Возможно, есть качественные альтернативы, но, во-первых нам они не попадались. А во вторых, наш код писался когда ещё гитхаба не было, не то что нюгета

Чтобы не писать лишнего: с правильными ассертами тот же код выглядит так:

    class Sample
    {
        public Sample(int sampleCount)
        {
            Code.AssertArgument(sampleCount >= 0, "sampleCount", "Sample count should be positive number.");
            DebugCode.AssertArgument(sampleCount < 5000, "sampleCount", "Sample count assumed to be a smal number. You're doing something wrong. Read usage guidelines.");
            MetricsCode.AssertArgument(sampleCount !=0 , 
                "sampleCount", 
                "TODO: 'Repeat zero times' usually means that there's an logical error. \r\n"+
                "At the same time sampleCount=0 could be threated as 'just skip it', so no zero policy would lead to weird checks across the codebase. \r\n" +
                "We need more samples from real code to do the proper decision.");

            SampleCount = sampleCount;
        }

        public int SampleCount { get; private set; }

        public Action<string> SampleCallback { get; set; }

        public void Run<T>(T value) where T: class
        {
            Code.NotNull(value, "value");
            Code.AssertState(SampleCallback != null, "Fill SampleCallback first!");

            for (int i = 0; i < SampleCount; i++) // (0)
            {
                SampleCallback(value.ToString()); // (1), (2)
            }
        }

        [Conditional(DebugCode.DebugCondition)]
        public void AssertInitialized()
        {
            DebugCode.AssertState(SampleCallback != null, "Fill SampleCallback first!");
        }
    }

Код хелперов в самом простом виде — ниже. Сорри, времени сейчас нет, поэтому пока остановимся на этом. Пожже продолжу. Есть вопросы — спрашивайте.

код

public static class CodeExceptions
{
    static CodeExceptions()
    {
        // При отладке - прерываем при первом нарушеном условии.
#if DEBUG
        BreakOnException = true;
#endif
    }

    public static bool BreakOnException { get; set; }

    [DebuggerHidden]
    public static void BreakIfAttached()
    {
        if (BreakOnException && Debugger.IsAttached)
        {
            Debugger.Break();
        }
    }

    private static string FormatMessage(string messageFormat, params object[] args)
    {
        if (args != null && args.Length > 0)
        {
            messageFormat = string.Format(messageFormat, args);
        }
        return messageFormat;
    }

    [DebuggerHidden]
    public static ArgumentNullException ArgumentNull(string argumentName)
    {
        BreakIfAttached();
        return new ArgumentNullException(argumentName);
    }


    [DebuggerHidden]
    public static ArgumentException ArgumentNullOrEmpty(string argumentName)
    {
        BreakIfAttached();
        return new ArgumentException(
            FormatMessage("String '{0}' should be neither null or empty", argumentName), argumentName);
    }

    [DebuggerHidden]
    public static ArgumentException Argument(
        string argumentName,
        string messageFormat, params object[] args)
    {
        BreakIfAttached();
        return new ArgumentException(FormatMessage(messageFormat, args), argumentName);
    }


    [DebuggerHidden]
    public static InvalidOperationException InvalidOperation(string messageFormat, params object[] args)
    {
        BreakIfAttached();
        return new InvalidOperationException(FormatMessage(messageFormat, args));
    }
}

public static class Code
{
    [DebuggerHidden]
    public static void NotNull<T>(T arg, string argName) where T : class
    {
        if (arg == null)
        {
            throw CodeExceptions.ArgumentNull(argName);
        }
    }

    [DebuggerHidden]
    public static void NotNullOrEmpty(string arg, string argName)
    {
        if (string.IsNullOrEmpty(arg))
        {
            throw CodeExceptions.ArgumentNullOrEmpty(argName);
        }
    }

    [DebuggerHidden]
    public static void AssertArgument(
        bool condition, string argName,
        string message)
    {
        if (!condition)
        {
            throw CodeExceptions.Argument(argName, message);
        }
    }

    [DebuggerHidden]
    public static void AssertArgument(bool condition, string argName, string messageFormat, params object[] args)
    {
        if (!condition)
        {
            throw CodeExceptions.Argument(argName, messageFormat, args);
        }
    }

    /// <summary>
    /// Проверка на корректность состояния
    /// </summary>
    [DebuggerHidden]
    public static void AssertState(bool condition, string message)
    {
        if (!condition)
        {
            throw CodeExceptions.InvalidOperation(message);
        }
    }

    /// <summary>
    /// Проверка на корректность состояния
    /// </summary>
    [DebuggerHidden]
    public static void AssertState(bool condition, string messageFormat, params object[] args)
    {
        if (!condition)
        {
            throw CodeExceptions.InvalidOperation(messageFormat, args);
        }
    }
}

public static class DebugCode
{
    public const string DebugCondition = "DEBUG";

    [Conditional(DebugCondition), DebuggerHidden]
    public static void NotNull<T>(T arg, string argName) where T : class
    {
        Code.NotNull(arg, argName);
    }

    /// <summary>
    /// Проверка на непустую строку.
    /// </summary>
    [Conditional(DebugCondition), DebuggerHidden]
    public static void NotNullOrEmpty(string arg, string argName)
    {
        Code.NotNullOrEmpty(arg, argName);
    }

    /// <summary>
    /// Проверка на корректность аргумента
    /// </summary>
    [Conditional(DebugCondition), DebuggerHidden]
    public static void AssertArgument(bool condition, string argName,
        string message)
    {
        Code.AssertArgument(condition, argName, message);
    }

    /// <summary>
    /// Проверка на корректность аргумента
    /// </summary>
    [Conditional(DebugCondition), DebuggerHidden]
    public static void AssertArgument(
        bool condition, string argName,
        string messageFormat, params object[] args)
    {
        Code.AssertArgument(condition, argName, messageFormat, args);
    }

    /// <summary>
    /// Проверка на корректность состояния
    /// </summary>
    [Conditional(DebugCondition), DebuggerHidden]
    public static void AssertState(bool condition, string message)
    {
        Code.AssertState(condition, message);
    }

    /// <summary>
    /// Проверка на корректность состояния
    /// </summary>
    [Conditional(DebugCondition), DebuggerHidden]
    public static void AssertState(bool condition, string messageFormat, params object[] args)
    {
        Code.AssertState(condition, messageFormat, args);
    }
}

UPD. Добавил ответ на что не так с Debug.Assert().
UPD2. Товарищи несогласные — не томите неизвестностью, мне ж интересно

Что по-вашему не так?

04.06.2015 51 комментарий

комментировать обсудить в форуме

Sharov

04.06.2015 03:46

Здравствуйте, Sinix, Вы писали:

S>Готовые ассерты (Debug.Assert) на мой взгляд могут использовать только мазохисты. В них _всё_ сделано неправильно.

Это еще почему?

AVK Selected

Показавшиеся интересными, на мой вкус, посты

Ассерты и дотнет

Зачем нужны ассерты?

Готовые решения?