вторник, 29 декабря 2009 г.

Опасайтесь долговой ямы!

Прочитал здесь интересное сравнение кода, написанного в стиле "как максимально быстро получить что то работающее", с банковским кредитом. Если время жизни вашей программы ограничено, допустим это курсовая работа "сдал-и-забыл" или это очередная программа из серии "Hello, world!" или какой то прототип, то такой подход позволяет воспользоваться главным приятным свойством всех кредитов - пользуйся сейчас, плати потом. Однако, если с течением времени продолжать писать, неотступая от выбранного стиля, объем кода растет, а с ним растут и "долговые обязательства". Обслуживание такого "кредита" становится тяжелой обузой, мешает нормальному развитию проекта, не дает совершать новые "покупки" в виде нового функционала.



В статье, кроме общего плана действий, дается хороший совет, которому каждый раз немного боязно следовать:

Have the courage and honesty to present the facts as they are. This seemingly risky approach boils down to the very human issues of accountability and trust.
Couch your argument like this: you’ve fielded successful software in the requested amount of time for a provisioned amount of money. In order to achieve this you’ve had to make compromises along the way in response to business pressures. Now, to go forward at a predictable and steady rate, you need to deal with the effects of these compromises. The entire organization has bought them, and now it’s time to pay back.

среда, 16 декабря 2009 г.

Будьте отзывчивыми!

Тестирование это инструмент для повышения качества программного обеспечения. Но "качественное" ПО - понятие многогранное и очень субъективное. Одним из таких критериев качества для конечного пользователя может быть "отзывчивый" пользовательский интерфейс.

Возьмем для примера простую форму:



Нажатие на каждую кнопку приводит к вызову соответсвующего метода у некоторого сервиса. Обычная такая форма, а вот и обычное для такого случая решение:


    public interface ISlowService
    {
        void Method1();
        void Method2();
        void Method3();
    }

    public class Presenter
    {
        public IView View { get; set; }

        public void ExecuteMethod1()
        {
            _service.Method1();
            View.AddMessage("Method1 complete.");
        }

        public void ExecuteMethod2()
        {
            _service.Method2();
            View.AddMessage("Method2 complete.");
        }

        public void ExecuteMethod3()
        {
            _service.Method3();
            View.AddMessage("Method3 complete.");
        }
    }

Запускаем, пробуем. Нажмем кнопку Method1, после чего понажимаем остальные кнопки, попробуем изменить размер окна, развернуть его или даже закрыть. Не работает?! Оказывается, что после нажатия на кнопку Method1, наша форма на одну минуту "замирает", потому что "выполняется" метод сервиса. "Так не бывает!" - скажете вы. Отчего ж... Одна минута - стандартный таймаут операции для WCF сервисов. Мало ли что там могло случиться на стороне сервиса. А пользователь ничего, подождет... Это и есть "обычное" решение такого рода задач.

Попробуем немного улучшить "качество" нашего кода. Решений и подходов для такого рода задач много, некоторые из них построенны на использовании фонового потока для выполнения задач. Но всегда ли так необходимо явно создавать еще один поток в нашем приложении? Посмотрите на этот скриншот:



У вас есть идеи чем могут заниматься 45 потоков в Outlook'е или 29 в Skype или в среднем по 30 "на брата" в инстансах IE? У меня нет таких разумных идей. Да, конечно, эти потоки в большинстве своем бездействуют, переключения между ними "стоят копейки" (в век гигагерцев то), однако если они бездействуют, то зачем их вообще создавать? Попробуем воспользоваться уже существующими в приложении потоками.

Немного изменим наш код:

        private delegate void ExecuteMethodDelegate();

        private void OnCallback(IAsyncResult ar)
        {
            var result = (AsyncResult) ar;
            var caller = (ExecuteMethodDelegate) result.AsyncDelegate;
            caller.EndInvoke(ar);

            var message = (string) ar.AsyncState;
            View.AddMessage(message);
        }

        public override void ExecuteMethod1()
        {
            ExecuteMethodDelegate d = Service.Method1;
            d.BeginInvoke(OnCallback, "Method1 complete.");
        }

        public override void ExecuteMethod2()
        {
            ExecuteMethodDelegate d = Service.Method2;
            d.BeginInvoke(OnCallback, "Method2 complete.");
        }

        public override void ExecuteMethod3()
        {
            Service.Method3();
            View.AddMessage("Method3 complete.");
        }

Мы воспользуемся асинхронными делегатами, которые в свою очередь используют потоки из ThreadPool, который уже существует и чей размер управляется managed runtime.

Запускаем, проверяем. После нажатия на кнопку Method1 мы можем нажимать на другие кнопки, нажатие на кнопку Method3 сразу же добавит строчку в список, делать с окном что угодно - разворачивать, минимизировать и даже закрыть окно и приложение. Однако, по истечении одной минуты ожидания, вместо строчки "Method1 complete." мы получим что то подобное:


Доступ к UI элементу из другого потока... Какие у нас есть варианты решения это проблемы?

  • Связка Control.InvokeRequired + Control.Invoke


        public void AddMessage(string message)
        {
            if (InvokeRequired)
            {
                Invoke(new MethodInvoker(() => AddMessage(message)));
                return;
            }

            listBox1.Items.Add(message);
        }


        Решение работает, однако если в нашем IView будет много методов/свойств, все они "обрастут" такими преамбулами, что не есть хорошо. Плюс, что если кто-то добавит новый метод, и забудет добавить преамбулу? Это может привести к неожиданным ошибкам с непонятной стратегией нахождения/тестирования. Нам нужно некоторое "централизованное" решение.


  • Попробовать "собрать" весь этот механизм внутри Presenter'а:
        private void OnCallback(IAsyncResult ar)
        {
            var result = (AsyncResult) ar;
            var caller = (ExecuteMethodDelegate) result.AsyncDelegate;
            caller.EndInvoke(ar);

            var message = (string) ar.AsyncState;

            var control = (Control) View;
            if (control.InvokeRequired)
                control.Invoke(new MethodInvoker(() => View.AddMessage(message)));
            else
                View.AddMessage(message);
        }


Один факт того, что Presenter'у нужно знать что его View это Control, останавливает меня от использования этого решения.
  • Использовать SynchronizationContext. Данный класс незаслужено игнорируется программистами, а зря...
        class UserState
        {
            public SynchronizationContext SynchronizationContext { get; set; }
            public string Message { get; set; }
        }

        private void OnCallback(IAsyncResult ar)
        {
            var result = (AsyncResult) ar;
            var caller = (ExecuteMethodDelegate) result.AsyncDelegate;
            caller.EndInvoke(ar);

            var userState = (UserState) ar.AsyncState;
            userState.SynchronizationContext.Post(obj => View.AddMessage(userState.Message), null);
        }

Имхо, элегантное решение, лишенное недостатков предыдущих двух. Мы получили "отзывчивый" интерфейс не затратив на это много сил. Попробуйте, не правда ли намного лучше, чем самое первое "обычное" решение? Так что мешает так делать всегда?...

Конечно и у данного решения есть недостатки, ограничивающие область его применения. Например невозможность отмены текущей выполняющейся операции. Это важно для ситуаций, когда операция ожидаемо будет продолжаться долго, например: копирование файлов, инсталяция приложения, расчет каких то сложных данных... Для таких случаев UI приложения должен содержать кнопку "Cancel" или какой то ее аналог. Но таких задач все же меньше, чем "кнопка, нажатие на которую приводит обращению к сервису far far away".

Сольюшн с примером можно взять здесь.

понедельник, 14 декабря 2009 г.

Тестирование UI с помощью White. Часть первая (окончание).

Потихоньку осваиваюсь... Уже умею вставлять в посты форматированный код!
В прошлый раз не получилось выложить сольюшн примера - исправляюсь.
Заодно и скриншот с результатами тестов:


Wanted! Разыскивается!

Итого, мне срочно (пока я не передумал писать) нужно сделать следующие вещи:
  1. Найти утилиту, макрос, whatever для копирования кода из Visual Studio в блог в виде HTML. Не все же мне картинками код вставлять.
  2. Для тех случаев, когда без картинки не обойтись, нужна утилита, позволяющая быстро и удобно захватывать часть экрана либо указанное окно. Чтобы без этих белых "каёмочек"...
  3. Разобраться с дизайном блога, подобрать такой, чтобы ширина рабочей области была больше чем колонка на последней странице сельской газетёнки. Рука писателя размаха просит...
Всякая помощь приветствуется.

суббота, 12 декабря 2009 г.

Тестирование UI с помощью White. Часть первая.

Я полюбил юнит-тесты. Они мои друзья. Они вселяют в меня спокойствие и уверенность в своих действиях, всякий раз когда я принимаюсь за рефакторинг кода. Но есть код, который, как ни старайся, силами "настоящих" (о "настоящих" юнит-тестах как-нибудь в другой раз) юнит-тестов не покроешь - UI код. Да, где то ближе к вершине "пирамиды" тестов (еще одна тема для маленького поста), построенной на прочном фундаменте юнит-тестов, будут End-To-End тесты, User Acceptance тесты и т.д. Но мне хочется иметь быстрое и простое как в написании, так и в поддержке, средство, которое позволит мне тестировать отдельные формы. В конце концов формы - это то, с чем работает пользователь, то что для него и ассоциируется с программой.

Для первого примера возьмем простейшую форму с тремя кнопками и одним полем ввода:

Нажатие на кнопку должно приводить к появлению ее названия в поле ввода. Однако в код вкралась ошибка - нажатие на button3 обрабатывается тем же обработчиком, что и для button1. Обычная ошибка в wiring code. Однако юнит-тестами, даже если бы они тут были, такую ошибку не обнаружить. Посмотрим как нам в этом может помочь White.

Сразу хочу обговорить некоторые важные моменты:
  • Я старался добиться максимально простого кода настройки "окружения" теста. Простота написания теста - меньше причин его не писать.
  • Исходя из вышесказанного я принял за аксиому следующее: один тест-класс тестирует одну форму. Здесь не было никаких технических проблем дать возможность указать для каждого тестового метода какую форму он будет тестировать, но это заметно усложняет настройку "окружения".
  • "Пирамида" тестирования строится снизу вверх. Ничто не заменит юнит-тесты.
Итак, форма есть, создаем тестовый проект:



  1. Удаляем все лишнее.
  2. Добавляем ссылки на сборки White.Core (собственно White) и UnitTesting.White.
  3. Не забываем добавить ссылку на проект с формой, которую мы собираемся тестировать и ссылку на System.Windows.Forms.dll
  4. Класс SimpleFormTestFixture наследуем от TestFixture.
  5. Создаем метод FixtureInitialize, который создает нам саму форму. Метод помечаем аттрибутом FixtureInitialize.
  6. Пишем три тестовых метода ClickButton1, ClickButton2 и ClickButton3, пользуясь средствами API White.
  7. А теперь немного "магии" - в свойствах проекта SimpleForm.Tests меняем Output type на Windows Application.
  8. В тестовый проект добавляем файл, назовем его EntryPoint.cs с таким содержимым:
        [STAThread]
        static void Main()
        {
            TestFixture.Run();
        }

Так... Как оказалось я совершенно не подготовился к своему первому посту! Я не умею копировать код из студии и вставлять его как HTML, каждый раз как я вставляю картинку, у меня съезжает форматирование и картинку надо мучительно долго перетаскивать вниз текста (она не вставляется в текущее местоположение курсора?!). И самое главное, я не знаю как приаттачить файлы сольюшна, чтобы показать как это всё работает. А оно работает, уж поверьте мне!

Поэтому горе-писатель отправляется спать, обещая всем несчастным, кому "посчастливилось" читать этот пост, что в следующий раз я покажу более сложный пример, в котором будет виден и главный недостаток данного подхода к тестированию. Stay tuned!

Updated: опробовал CopySourceAsHtml, вроде неплохо :-)
Wider Two Column Modification courtesy of The Blogger Guide