Saturday, January 30, 2016

To Unit Test AngularJS with Jasmine in Visual Studio

Сегодняшнею статью я решил посвятить покрытию unit-тестами вашего AngularJS приложения с Jasmine, а также тому, как отлаживать этот проект с Visual Studio. Так как на это все я потратил достаточно долго времени, решил поделиться с вами тем, что у меня получилось. Отправной точкой начала работы для меня стала статья To Unit Test AngularJS with Jasmine in Visual Studio, благодаря которой я смог настроить дебаг тестов с Visual Studio. Также я подружил Resharper 9 с этими тестами. Так что весь этот процесс мы с вами сейчас и рассмотрим. 
1.Первым делом устанавливаем с помощью Visual Studio Extension компонент Chutzpah – это open source Unit test runner. Для этого переходим в меню Tools->Extensions and Updates…
Затем открываем Online->Visual Studio Gallery и ищем в поиске по слову Chutzpah.
Для студии я себе ставил только екстеншн, который позволяет запускать с контекстного меню. Вы же можете поставить себе оба расширения. Мне для отладки приложения полностью хватило только одного расширения по той причине, что я работаю с тестами через Resharper. Для того чтобы это работало в Test Explorer, ставьте себе первый в списке Chutzpah test-адаптер.
2. Нам нужно создать пустое ASP.NET Web Application (Empty), которое назовем AngulaJsUnitTestSample.
На следующем этапе выбираем просто Empty шаблон и нажимаем на кнопку OK.
3. С помощью NuGet Package Manager ставим себе AngularJS.Core.
Либо с помощью Package Manager Console (ALT+T, N, O):
install-package AngularJS.Core
4. Поставим через NuGet Package Manager еще и Jasmine test-фреймворк.
Либо то же самое через PMC (Package Manager Console)
install-package JasmineTest
Затем удаляем с проекта выбранные файлы, как показано на рисунке ниже.
5. Создаем фейковый тест, чтобы проверить работоспособность. Для этого создадим в корне папку Tests, в которую добавим файл JavaScript файл, который назовем jasmineWorks.js, и добавим в него код, показанный ниже.
describe('jasmine works', function () {
    it('sanity check', function () {
        expect(0).toBe(0);
    });
});
После этого, если вы ставили себе адаптер, вы можете запустить ваш тест с Test Explorer (если он не открыт, то выбираем Test -> Windows -> Test Explorer).
И проверяем, что тест успешно отработал.
Можно это тест запустить с кода, используя расширения для контекстного меню. Тогда у вас будет показан результат в виде симпатичной веб-страницы. Для этого поставим курсор в наш тест, нажмем правую клавишу мыши, и в контекстном меню выберем пункт Run JS Tests, если просто хотим собрать тесты и проверить, что они проходят.
Либо выбрать Open in browser, чтобы посмотреть на результат.
Опции Run Chutzpah With позволяют запускать тесты в режиме отладки и посмотреть покрытие кода тестами.
Ниже показано запуск в режиме отладки.
И также покрытие тестами.
6. Добавить просто AngularJS контроллер.
В папку Scripts добавим новый JavaScript файл, который назовем appController.js, реализация которого приведена ниже.
angular.module('app', []).controller('appController', function ($scope) {
    $scope.value = 5;
});
7. Добавить unit test для appController.
Перейдем в папку Tests и добавим туда новый JavaScript файл, который назовем appControllerSpec.js. Ниже приведена его реализация.
/// <reference path="../Scripts/angular.js" />
/// <reference path="../Scripts/angular-mocks.js" />
/// <reference path="../Scripts/appController.js" />

describe('When using appController ', function () {
    //initialize Angular
    beforeEach(module('app'));
    //parse out the scope for use in our unit tests.
    var scope;
    beforeEach(inject(function ($controller, $rootScope) {
        scope = $rootScope.$new();
        var ctrl = $controller('appController', { $scope: scope });
    }));

    it('initial value is 5', function () {
        expect(scope.value).toBe(5);
    });
});
8. Запускаем наш тест.

Это все хорошо для простых проектов, у которых нет никаких зависимостей и т.д. Но что делать, если у нас проект посложнее, в котором есть работа с сетью, есть модули, в которых прописана маршрутизация, и контроллеры принимают множество параметров. Поэтому мы с вас попробуем на уже существующем тестовом проекте для работы со студентами покрыть тестами хотя бы один контроллер. Но для начала я покажу, как настроить Resharper, для того чтобы не запускать тесты через неудобный Test Explorer, который все ваши тесты показывает одним списком, смешивая в кучу все Unit/Integration тесты. JavaScript тесты через решарпер запускаем через WebKit, который называется PhantomJS. Загружаем себе файл phantomjs.exe (настройки актуальны для Windows) по ссылке выше.
Затем открываем Resharper ->Options и ищем в самом низу Tools. Затем в Tools выбираем пункт Unit Testing -> JavaScript Tests.
Теперь по самим настройкам. Первое: ставим галочку Enable Jasmine support и выбираем с выпадающего пункта Jasmine version версию 2.0. После этого нужно также выбрать пункт PhantomJS с указанием пути к папке, в которую вы скачали ваш PhantomJS.exe. На рисунке ниже показано, как все нужно сделать.
Сохраняем и проверяем, что все работает. Для этого выбираем наш Solution и запускам наши тесты с меню решарпера.
Или быстрой комбинацией Ctrl+T, R. Ниже показан результат запуска через Resharper этих же тестов.
Теперь давайте усложним пример, как я писал выше. У нас для примера есть контроллер, который называется studentsCtr. Ниже приведена его реализация.
(function () {
    'use strict';

    angular
        .module('app')
        .controller('studentsCtr', studentsCtr);

    studentsCtr.$inject = ['$scope', '$http', '$location'];

    function studentsCtr($scope, $http, $location) {
        console.log("studentsCtr");

        var url = 'api/Students';
        $http.get(url)
            .success(function (data) {
                $scope.students = data;
            })
            .error(function (error) {
                console.log(error.message);
            });

        $scope.addNewStudent = function () {
            $location.path('/create');
        };

        $scope.editRow = function (entity) {
            $location.path('/edit/' + entity.Id);
        };

        $scope.removeRow = function (index, entity) {
            $http.delete('api/Students/' + entity.Id)
            .success(function () {
                $scope.students.splice(index, 1);
            })
            .error(function (error) {
                console.log(error.Message);
            });
        };
    }
})();
Нам в целом не важно, как это все реализовано на web-странице, нам это просто не интересно. Нас может, разве что, заинтересовать, как построен сам модуль app.js.
(function () {
    'use strict';

    angular.module('app', [
        // Angular modules
        'ngRoute',
        'ui.bootstrap',
        'ui.bootstrap.tpls'
        // Custom modules

        // 3rd Party Modules
       
    ])
    .config(function ($routeProvider, $locationProvider) {
        console.log("app");

        $routeProvider
                .when('/', {
                    templateUrl: 'Views/appview/studentsview.html',
                    controller: 'studentsCtr'
                })
                .when('/create', {
                    templateUrl: 'Views/appview/createstudent.html',
                    controller: 'createStudentCtr'
                })
                .when('/edit/:studentId', {
                    templateUrl: 'Views/appview/createstudent.html',
                    controller: 'editStudentCtr'
                })
                .otherwise({
                    redirectTo: '/'
                });

        $locationProvider.html5Mode(true);
    });
})();
Все этим примеры взяты со статьи. Исходники на скачивание этих примеров будут доступны в конце статьи.
Вернемся теперь к нашему контроллеру studentCtr. Как вы можете заметить, первое действие, которое выполняется здесь, – это с помощью $http контекста мы загружаем данные по студентам с какого-то Web API контроллера. На всякий случай, ниже приведена реализация этого метода.
private StudentContext db = new StudentContext();

// GET: api/Students
public IQueryable<Student> GetStudents()
{
    return db.Students;
}
В данном случае нам даже не важно, как реализован класс Student. Нам важно, чтобы после того, как отработал метод,
var url = 'api/Students';
$http.get(url)
    .success(function (data) {
        $scope.students = data;
    })
    .error(function (error) {
        console.log(error.message);
    });
в $scope.students появились нужные нам данные. Для этого нужно замокать $http наш контекст. Делается это очень просто: в angular-mocks.js есть фейковая реализация $httpBackend, которая заменяет реальную реализацию $httpBackend. Важное замечание: $httpBackend – это не то же самое, что и $http сервис. $http сервис использует $httpBackend для отправки HTTP-сообщений.
Так как теорию мы рассмотрели и, по сути, поняли, что нам нужно мокать, настало самое время приступить к реализации. Для этого нам нужно повторить все действия с данной статьи с пункта 1 по 8-й. Затем, когда у нас будет установлен JasmineTest, можно приступать к самой реализации. Для этого в папку Tests (если этой папки еще нет, то нужно ее создать) добавляю новый JavaScript файл с названием studentsCtrSpec.js. Ниже приведена полная реализация этого файла.
/// <reference path="../Scripts/angular.js" />
/// <reference path="../Scripts/angular-route.js" />
/// <reference path="../Scripts/angular-ui/ui-bootstrap.js" />
/// <reference path="../Scripts/angular-ui/ui-bootstrap-tpls.js" />
/// <reference path="../Scripts/angular-mocks.js" />
/// <reference path="../Scripts/app/app.js" />
/// <reference path="../Scripts/app/controllers/studentsCtr.js" />

describe('When using studentsCtr ', function () {
    beforeEach(module('app'));

    describe("studentsCtr", function () {
        var scope, httpBackend;
        beforeEach(inject(function ($rootScope, $controller, $httpBackend, $http, $location) {
            scope = $rootScope.$new();
            httpBackend = $httpBackend;
            httpBackend.when("GET", "api/Students").respond([{}, {}, {}]);
            $controller('studentsCtr', {
                $scope: scope,
                $http: $http,
                $location: $location
            });
        }));

        it('should GET studentsCtr', function () {
            httpBackend.flush();
            expect(scope.students.length).toBe(3);
        });
    });
});
С самого начала я добавил ссылки на все зависимости, которые есть в проекте. Без них ваш код не заработает. Сейчас я постараюсь детально объяснить почему. Первой строчкой у нас идет вызов такого кода:
beforeEach(module('app'));
Мы пытаемся подгрузить наш app-модуль. Но здесь есть основная проблема. В этом модуле прописано куча зависимостей, без которых это все не будет работать.
angular.module('app', [
    // Angular modules
    'ngRoute',
    'ui.bootstrap',
    'ui.bootstrap.tpls'
    // Custom modules

    // 3rd Party Modules
       
])
Как видите, у нас зависимости от следующих частей:
  • ngRoute – файл angular-route.js
  • ui.bootstrap – ui-bootstrap.js
  • ui.bootstrap.tpls – ui-bootstrap-tpls.js
Теперь вы поняли, почему мы добавили загрузку этих всех зависимостей. Для более сложных проектов эти зависимости можно добавлять в отдельный файл _references.js и использовать уже только его.
Как видите, зависимостей, которые нужно подгружать, достаточно много. И чем их больше, тем сложнее писать нам свои тесты. Ниже приведен код, который может быть и который нужно покрыть тестами.
angular.module("app", ['ngRoute', 'ngTouch', 'ui.grid', 'ui.grid.edit', 'ui.grid.rowEdit',
        'ui.grid.cellNav', 'ui.grid.pagination', 'ui.grid.resizeColumns', 'ui.bootstrap', "ui.bootstrap.tpls", "ui.grid.grouping",'ui.grid.expandable', 'ui.grid.selection', 'ui.grid.pinning', "ngAnimate",
        "crumble", 'angular-loading-bar', 'ng.deviceDetector','ui-notification',"xeditable"])
Как видите, зависимостей очень много. Так что, если у вас такое на проекте, выносите сразу все в отдельный файл.
Следующий код также не очень сложный. В нем мы создаем новый контекст, и если у нас вызывается наш запрос, то возвращаем три пустых объекта, что будет равно трем студентам для нашего списка.
beforeEach(inject(function ($rootScope, $controller, $httpBackend, $http, $location) {
    scope = $rootScope.$new();
    httpBackend = $httpBackend;
    httpBackend.when("GET", "api/Students").respond([{}, {}, {}]);
    $controller('studentsCtr', {
        $scope: scope,
        $http: $http,
        $location: $location
    });
}));
И в самом конце – проверка, что все вызвалось успешно.
it('should GET studentsCtr', function () {
    httpBackend.flush();
    expect(scope.students.length).toBe(3);
});
Метод flush() также проводит проверку, что никаких лишних запросов, кроме наших, не было вызвано. Проверка на количество полученных объектов также в комментировании не нуждается. Ниже показано, как это выглядит в дебаг-режиме.
Если вы запустите в дебаге через Chutzpah, то получите следующий результат:
Я же предпочитаю запуск через Resharper.
Итоги
Думаю, на этой позитивной ноте мы можем заканчивать. Надеюсь, что если вы только начинаете с разбираться с этой темой, сегодняшний материал поможет вам сэкономить время и позволит вам более легко погрузиться в мир тестирования вашего AngularJS и JavaScript кода в ваших проектах.

Исходники к статье: Unit Test AngularJS with Jasmine in Visual Studio

Обзор блога за 2015 год

Сегодня поделюсь обзором написанного в блоге за 2015 год и профессиональными планами на 2016-й.
Год 2015 был достаточно насыщенным в плане личного развития и знакомства с новыми технологиями.  За это время я сумел написать 43 статьи, что, к сожалению, намного меньше, чем в 2014 году. Основная причина заключается в том, что больше времени в 2015-м я уделял изучению новых технологий, фреймворков и паттернов. Все-же кое-что за год удалось усвоить.
  1. Достаточно плотно получилось поработать с Caliburn.Micro, что дало новые ощущения и позволило по-другому взглянуть на мир разработки XAML-приложений, используя MVVM фреймворки, не только такие как Prism и MVVM Light.
  2. Разобрался с C# 6, пробуя его в работе, начиная с CTP версии Visual Studio 2015 (которая имела название Visual Studio 14).
  3. Разобрался, как работают движки для высокоскоростного полнотекстового поиска на базе Lucene.Net (Жаль только, что так и не получилось его внедрить в большой проект через более приоритетные задачи).
  4. На конец года я сменил свое место работы и перешел на веб-разработку, что позволило познакомиться с AngularJS, jQuery templates, ASP.NET MVC. Благодаря этому я начал углубляться в ASP.NET vNext, EntityFramework 7 и Angular 2.
  5. Ну и последнее, что получилось сделать в 2015 году, – это посмотреть на изменения Prism 6, а также на такие кроссплатформенные фреймворки для работы с XAML, как Perspex и OmniXAML.
Самой популярной за 2015 год является статья Prism vs Caliburn.Micro vs Catel vs MvvmLight – по обзору самых популярных MVVM фреймворков.
Также я смог попробовать себя в роли преподавателя, прочитав две лекции: Design Patterns; Repository and Unit of Work, материалы по которым можно взять здесь; и вторая лекция была на тему EF Code First features & Web API, в которой я больше раскрыл возможности в EF6 и новинки в EF7, который на момент лекции был уже RC (release candidate). Ссылки на вторую презентацию и примеры можно взять здесь.
Планы на 2016 год
Итак, чего же ожидать увидеть в моем блоге. Напишу основные профессиональные цели на год в виде списка, чтобы в итоге самому с ними свериться.
  • Разобраться с OAuth и OWIN Forms аутентификацией.
  • Выучить глубоко JavaScript и TypeScript
  • ASP.NET vNext with Angular 2.0
  • Попробовать пройти сертификацию Developing ASP.NET MVC 4 Web Applications или даже всю цепочку MCSD: Web Applications.
  • C# 7
  • EntityFramework 7
  • DDD (Experimenting with CQRS and event driven design)
  • Mentoring
  • Read 20 books in English
Думаю, этих планов больше чем достаточно для одного года. Тем более, бывают случаи, когда одолевает ужасная лень, которую тяжело побороть. Так что подписывайтесь на мой блог; надеюсь, вы также найдете для себя что-то позитивное и новое в этом году. А у меня будет дополнительная мотивация, если буду знать, что мои мысли как программиста могут быть кому-то полезными. 

Tuesday, January 19, 2016

О книге “Programming ASP.NET MVC 4: Developing Real-World Web Applications with ASP.NET MVC”

Здравствуйте, уважаемые друзья. Сегодня проведем небольшой обзор книги Programming ASP.NET MVC 4: Developing Real-World Web Applications with ASP.NET MVC, которая на Amazon имеет рейтинг 3.5.
Основная идея, почему я решил написать этот отзыв, – это попытка уговорить вас не тратить от 24 до 40 долларов за эту книгу. Она не стоит запрашиваемых денег. Буквально пару дней назад закончил ее читать, и пока в голове свежие воспоминания и эмоции, которые возникли от этой книги, решил ими с вами поделиться.
Задумкой автора было ознакомить читателя с разработкой ASP.NET MVC 4 приложения на примере сайта интернет-аукциона, который называется Ebuy. Так вот, если вы ожидаете, что в книге будет рассматриваться разработка этого сайта, то вы ошибаетесь. Точнее, ей посвящены только первые несколько, если быть точнее, то пять первых глав. Затем начинаются нереальные перепрыгивания с одной главы на другую. Мне очень понравился небольшой отрывок комментария, взятый с Amazon.
The book tries to walk you through the building of an online auction site, called Ebuy, but indeed it wasn't executed too well. I wasn't planning on writing the code while reading through the book anyway, so personally I didn't care. If you do enjoy coding as you read, however, you will no doubt be disappointed. I checked out the source code for the book on GitHub, and the source code doesn't do the book justice. The sample code needs to be a bit more feature-rich and show off much more of the book's content to be of real use. Hopefully the authors will add more to the source code. That being said, there are still plenty of good and short samples on ASP.NET MVC and related technology in the book that have nothing to do with Ebuy.
Некоторые читатели этой книги написали, что она очень хороша для опытных разработчиков, но будет сложна в понимании для начинающих. Здесь у меня, к сожалению. мнение не совпадает с большинством.
Во-первых, автор пытается в своей книге охватить буквально все: лучшие практики разработки, использование пакетов NuGet; рассказывает, как это тестировать с помощью unit-тестов; как работают движки для генерации представлений на клиенте, как работает deployment с помощью TFS. Читаешь это все – вроде все отлично: много красивых слов дают уверенность, что это точно можно будет как-то применить. Вот тут то вас и ждет наибольшее разочарование. Я, например, прочитал главу по тестированию и был шокирован. Мне очень сложно представить, чем руководствовался автор, когда пример, приведенный для теста, был реализован с жестким прокидываением DbContext, в реализации это была передача EbuyDataContext в конструктор DataContextRepository. Я слегка изменил пример, чтобы ко мне не придрались из-за авторских прав, а оставил идею и реализацию.
public class AuctionsController : Controller
{
    public AuctionsController()
        : this(new DataContextRepository(new EbuyDataContext()))
    {

    }

    public AuctionsController(IRepository repository)
    {

    }
    // GET: Auctions
    public ActionResult Index()
    {
        return View();
    }
}
Посмотрите внимательно на то, как реализован конструктор по умолчанию. А теперь вопрос для читателей. Как тестировал с помощью unit-тестов использование данного контроллера автор книги? Думаю, вы догадались, что тестировался только конструктор со входящим параметром IRepository. Автору стоило бы почитать или описать, как это можно сделать через какой-либо IoC контейнер, а не писать такую реализацию.А заодно немного почитать о том, как подобное тестировать, например, в книге,  The Art of Unit Testing, тем более, автору это бы точно не помешало.
Хотя мне не по душе, когда ты читаешь книгу, видишь в ней явную ошибку и понимаешь, что пример не будет работать 100%. Затем смотришь в исходники и понимаешь, что код отличается. Мало того, что код отличается, так примеров кода очень во всей книге приведено мало, а если и приведены, то вырваны из контекста. Часть из того, что описал автор, не используется в самих исходных кодах по интернет-аукциону.
Мне также не понятно, зачем автор упомянул об использовании NuGet пакетов, учитывая тот факт, что пример, который он привел, не является рабочим. Отдельное слово хотелось бы сказать о развертывании сайтов, о которых рассказывается в книге. У меня вопрос больше к читателям. Как часто вам приходится развертывать сайты на одной и той же машине? Наверняка ответом будет "очень редко". Зато теперь вы сможете узнать, как это делать, прочитав целую главу книги.
Однако в книге есть и позитивные моменты. Некоторые главы вполне достойно расписаны и дают неплохое и компактное представление о том или ином аспекте. Например, мне лично понравилась глава о маршрутизации. 
Итак, прорезюмируем преимущества и недочеты данной книги.
Плюсы:
  • Много теоретической базы
  • Компактная подача материала.

Минусы:
  • Много ошибок в коде
  • Некоторые главы написаны так, что видно, что автор сам не разбирается в них. Например, некоторые главы с описанием архитектуры веб-приложений
  • Сложная для понимания. Часть глав написана с перескакиванием из главы в главу. Такой текст неудобно читать, а еще сложнее понять, что автор хотел этим сказать
  • Не достаточно полно расписаны некоторые примеры

Итоги

Соглашусь, пожалуй, с оценкой в 3 или 3.5 для данной книги. Эта книга уникальна в своем роде, потому что подобных я не встречал. Много теории, которая изложена лаконично, также придают свою изюминку книги. Но от книги с таким названием я ожидал увидеть совсем другое. Как минимум – больше примеров и пояснений, комментариев. Да и хотелось бы видеть меньше ошибок в примерах. Хотя, признаться честно, их все равно меньше, чем в книге MCSD Certification Toolkit (Exam 70-483): Programming in C#, которую мне довелось прочитать и на которую я дал отдельную рецензию. Как минимум, я считаю, что книга не стоит той суммы, которую за нее запрашивают, так как информации, которую вы найдете в книге, вам будет точно не достаточно, чтобы писать Real-World Web Applications.