TDD заметки: как быстро начать разрабатывать через тестирование

Введение

Сегодня хочу рассказать о некоторых своих размышлениях по поводу TDD в этой небольшой заметке.

Первое, что такое TDD? Wiki говорит нам следующее(https://ru.wikipedia.org/wiki/%D0%A0%D0%B0%D0%B7%D1%80%D0%B0%D0%B1%D0%BE%D1%82%D0%BA%D0%B0_%D1%87%D0%B5%D1%80%D0%B5%D0%B7_%D1%82%D0%B5%D1%81%D1%82%D0%B8%D1%80%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5):

Разработка через тестирование (англ. test-driven development, TDD) — техника разработки программного обеспечения, которая основывается на повторении очень коротких циклов разработки: сначала пишется тест, покрывающий желаемое изменение, затем пишется код, который позволит пройти тест, и под конец проводится рефакторинг нового кода к соответствующим стандартам. Кент Бек, считающийся изобретателем этой техники, утверждал в 2003 году, что разработка через тестирование поощряет простой дизайн и внушает уверенность (англ. inspires confidence).

Кстати, рекомендую прочитать книгу о TDD самого Кента Бега(http://www.ozon.ru/context/detail/id/1501671/). О том для чего и когда использовать TDD я в этой заметке писать не буду, т.к. я думаю, что это достаточно очевидный момент и как правило вопрос возникает как к этому подходу разработки перейти и как его успешно внедрять.

Workflow

Ниже на рисунке представлен процесс разработки программы в стиле TDD.

tdd-flowchart
процесс разработки программы в стиле TDD

Начинается весь процесс всегда с написания тестов и далее двигаемся по стрелочке:

1. Написание теста, без написания логики программы, которую мы проверяем в тесте.

2. Запуск теста и проверка того, что тест красный, т.к. у нас нет реализации тестируемой части(если тесты зеленые – значит тесты ничего не проверяют и их нужно переписать)

3. Пишем код, который делает тесты зелеными(минимальный код, а точнее любой корректно  работающий код, который сделает тесты зелеными)

4. Запускаем тесты и проверяем, что они зеленые

5. Рефакторинг, мы переписываем наш "говнокод" для озеленения тестов, так, чтобы он был работающим и хорошо пахнущим не только для тестов, но и для нас.

Проблема первого теста

Исходя из собственной практики на первых этапах самое сложное это начать писать первый тест, до реализации тестируемого кода и здесь я вижу два приема:

1. Написать сначала интерфейс, затем переходить к тесту. Это позволит начать переход к TDD и при этом не слишком "тупить" над тем, что и как тестировать, т.к. часть кода вы уже будете писать до теста и в голове уже будет небольшое понимание того, что тестировать. Ну а как привыкните – начнете писать тесты сразу.

2. Это писать сначала самый короткий, т.е. минимальный и общий тест. Собственно это и есть праведный путь TDD. Таким образом дизайн программы будет строиться по циклу через тесты, с каждой итерацией вы будете добавлять тесты и код.

Проблема плохого дизайна

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

1. Писать проект заново, особенно если в пользу этого уже есть какие-нибудь и другие предпосылки.

2. Выделять из проекта отдельные компоненты и тестировать их. Этот вариант подходит для проектов с не слишком НЕудачным дизайном.

3. Использовать TDD только для новых изменений кода и со временем весь проект сможет перейти на TDD. Этот вариант на мой взгляд самый универсальный.

Заключение

В общем и в целом считаю, что TDD это хороший способ улучшить стабильность и надежность своего кода и даже при написании небольших приложений это позволяет снизить количество ошибок в приложении многократно. Как минимум это стоит попробовать.

 

 

Настройка Travis CI для Golang проекта с использованием Godep

В этом посте хочу поделиться тем как я настраивал Travis CI для своего небольшого проекта на Golang.

Что такое Travis CI?

Travis CI — распределённый веб-сервис для сборки и тестирования программного обеспечения, использующий GitHub в качестве хостинга исходного кода.

У этого сервиса есть неплохой раздел по поводу настройки проекта – https://docs.travis-ci.com/user/languages/go/#Dependency-Management , но как это часто бывает не все так гладко, как хотелось бы.

Проблема возникла с менеджером пакетов godep и импортом пакетов, у меня возникали такие ошибки:

// первый вариант
The command "eval go get -t -v ./... " failed. Retrying, 2 of 3.
// второй вариант
cannot find package "my_go_project/my_package" in any of:
 
Решение оказалось очень простым – заменить относительные пути импорта локальных пакетов на абсолютные, т.е. вместо import "my_go_project/my_package" написать import "github.com/username/my_go_project/my_package".
 
 
В итоге получился такой .travis.yml:
 

Путешествие в королевство улыбок Тайланд

Вот и закончилось наше недельное путешествие (09.12.2017-16.12.2017) в Тайланд на остров Пхукет.

Начну с самолета, летели мы десять часов из Москвы,выходя из самолета сразу же ощутили весь тропический климат(+30 и высокая влажность), далее нас везли в автобусе до минивэна,попутно гид от туркомпании, мешал нам спокойно ехать своими рассказами(на мой взгляд совершенно бессмысленными). Но до отеля мы все же добрались и было раннее утро 🙂

После приезда в отель мы немного прогулялисьи пошли на тайский массаж  и как дошли до отеля легли спать…Когда мы проснулись – был еще день и мы снове отправились на прогулку, первое, что мы хотели сделать в Тайланде – это попробовать настоящую тайскую кухню. Continue reading Путешествие в королевство улыбок Тайланд

3.5 года спустя

Недавно прошел открытый чемпионат Казани по каратэ киокусинкай, проведя 2 поединка и выйграв один из них я занял третье место. К моему удивления в этом году участников было немного.

Утро началось с того, что я начал сбрасывать вес(чтобы уместиться в весовую до 65кг), за 2 часая скинул более двух килограмм, но приехав на взвешивание узнал, что перевесил(65.560), в общем перекинули меня в весовую до 85кг и оштрафовали на 100 рублей. 🙂

Правда в итоге я участвовал в весе до 75кг 😀 В общем было весело, я опасался, что отсуствие спарингов за последние 3 года и нормальной тренировочной практики приведет меня к беззаговорочным поражением…но к моему великому удивлению я неплохо чувствовал себя в бою, правда кидал вес зря, можно было бы и лучший результат показать.

Нашел очень похожие фото с разницей в 5 лет

2012 год (Чемпионат Республики Татарстан)

h-26

2017 год (Открытый Чемпионат г.Казани)

mZC1rUqeO4c

 

Одна строка, которая сэкономит 99% RAM

В Golang как и во многих других языках работает сборщик мусора.

Но все же ресурсы высвобождать необходимо, особенно если вы работаете с http запросами и пакетом https://golang.org/pkg/net/http/.

В противном случае может случится так, что приложение в один прекрасный момент упадет и не факт, что об этом Вы узнаете первым. Из этого следует:

  1. нужно внимательно читать документацию;
  2. нужно всегда проверять приложение на прожорливость и работу с ресурсами;
  3. использовать инструментыдля мониторинга.

Само высвобожение ресурса тела запроса выглядит так:

 

Как проверить навыки кандидата на собеседовании?

Один из самых важных и основополагающих факторов успеха в работе является то, как хорошо будет набрана комманда. В свою очередь качество подобора сотрудников можно оценить по результатам их своместной работы, эффективности индидуальной и командной и сплоченности команды.

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

Основываясь на своем опыте  понял, что начинать в этой части собеседования лучше с распроса кандидата о  том, что он делал, какие задачи решал, с чем имел дело, какая его роль была, какой результат был достигнут и каким путем.

А вот далее желательно попросить написть немного кода для демонстрации, чтобы показать на самом ли деле он это умеет делать и еще можно попросить выполнить тестовое задание(если не боитесь, что кандидат отвалится).

+Отличным показателем являются аккаунт на github, активность в блогах, форумах и т.д.

О том как лучше спрашивать, мне понравилась вот эта статья – http://prohr2.ru/%D1%81%D0%BE%D1%86%D0%B8%D0%B0%D0%BB%D1%8C%D0%BD%D0%BE-%D0%B6%D0%B5%D0%BB%D0%B0%D0%B5%D0%BC%D1%8B%D0%B5-%D0%BE%D1%82%D0%B2%D0%B5%D1%82%D1%8B-%D0%B8-%D0%BA%D0%B0%D0%BA-%D1%81-%D0%BD%D0%B8%D0%BC%D0%B8/

 

 

 

Ruby On Rails GEMS – CRUD контроллер с decent_exposure

Решил я недавно вспомнить RubyOnRails на котором писал 3 года и было это 2 года назад, поэтому вспоминать пришлось многое, хотя и не все.

Рельсы и руби славятся тем, что с помощью них можно быстро писать код. При этом код еще и легко читается – в результате меньше ошибок, быстрее скорость разработки. Помимо красивого кода в рельсах богатый вспомогательный инструментарий, но не все ограничивается рельсами – существует много дополнительных компонентов, в терминологии рельсов это гемы(gems).

Об одном из них и этот пост, называется он decent_exposure, его задача упростить наисание CRUD контроллеров.

Подробно с этим компонентом можно ознакомиться перейдя на гитхаб проекта – https://github.com/hashrocket/decent_exposure

Ниже пример использования 🙂

 

Изучение английского языка

В общем я думаю многие в определенной степени понимают, что английский язык очень важен для специалиста в области информационных технологий, в частностидля разработчиков программного обеспечения, да для специалистом в общем.

И как я вижу основная проблема связана с тем, что наиболее прогрессивные, современные и интересные материалы доступны только на ангилийском языке. Другая проблема связана с уровнем дохода, не секрет владея английским языком можно значительно прибавить в заработке(работая в зарубежной компании над более интересными проектами). Из этого вытекает следующее – язык нужен не только технический и для чтения, но и разговорный, и желательно с пониманием особенностей делового общения и ведения переговоров.

У меня в школе и в ВУЗе янглийский преподавали слабо и безрезультатно, хотя у меня и четверка по этому предмету 🙂 К моменты начала официальной работы(не фриланса) я уже почитывал техническую литературу и вроде бы неплохо с этим справлялся, так и продолжалось довольно длительное время, иногда я даже читал какие то книги, но большого эффекта это не давало, хотя субъективно уровень владения и понимания улучшался.

Но случилось так, что я задумался об изучении английского языка, да так, чтобы наконец хоть как то уметь на нем разговаривать и понимать то, о чем говорит собеседник, а не только понимать прочитанное. Попробовав несколько онлайн сервисов и даже заплатив около 500 рублей за обучение в lingualeo, я понял, что нужно что то посерьезнее и начал искать языковую школу, выбор пал на English First.

Обучение в English First открало для меня ангийский язык по-настоящему, для меня их онлайн площадка это  наверное самый крутой и эффективный способ изучения английского языка, правда я не прошел курс полностью и не смог познать всю систему целиком, но это уже было прорывом для меня. Дело в том, что онлйн-платформа этой школы позволяла изучать язык со всех сторон(грамматика и чтение, слушание и говорение), я был в некотором учебном шоке “ну почему у нас в стране так не делают в школе и ВУЗе?”, а может бть где-нибудь и делают…но я об этом не знаю и не слышал 🙂 Из недостатков было одно – на мобильном это все не работает и нужен Adobe Flash со всеми вытекающими, и да еще был одн недостаток – цена, 70к за полгода…но я рискнул и несмотря на то, что прошел курс не полностью – мне понравилось и я понял как нужно учить язык 🙂

В последнии пару месяцевя снова начал задумываться о том как бы мне прокаать английский, но 70к у меня сейчас нет и я решил поискать альтернативные варианты. Нашел я один из таких вариантов абсолютно случайно и абсолютно бесплатно. И этот вариант это всемирно известный duolingo. Этот вервис меня поразил, он очень похож на English first, хоть и его упрощенную версию, но прокачивает все навыки и плюс помогает закрыть пробелы с самого низа.

А чем пользуетесь/пользовались вы для изучения английского языка?

Проектирование Web API

Одним из самых распространенных подходов при проектировании API является REST API, что такое REST API можно узнать здесь.

Я же хочу рассказать о тех принципах, которые помогут сделать ваш API удобным для других разработчиков, т.е. для ваших клиентов.

Перейдем к принципам, поскольку для REST используется протокол HTTP, то он силньо завязан на его особенностях и в частности на адресе URL.

URL

Чтобы ваш API было легче понимать уделите особое внимание идентификаторам ваших ресурсов(URI):

  1. делайте минимальными и понятными(краткое название ресурса);
  2. абстрактные ресурсы лучше заменить на конкретные(/videos вместо /items)
  3. не используйте в них глаголы, вместо них используйте HTTP методы (POST, PUT, GET, PATCH, DELETE);
  4. используйте в названии только множественное или только единственное число для ресурсов во всем проекте;
  5. используйте не более двух адресов на один ресурс (/videos и /videos/{id});
  6. для вложенных ресурсов используйте URL вида /videos/{id}/comments;
  7. используйте простые и прозрачные имена в параметрах запросов после знака “?”;

Ошибки

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

Версии

Всегда версионизируйте API, например с помощью префикса /v1 или в заголовках и поддерживайте как минимум две последнии версии. Это позволит вашим клиентам плавно и без проблем переходить на новые версии вашего API.

Пагинация и поля ответа

Испольуйте для пагинации параметры limit и offset, не забывайте возвращать в ответе общее количество доступных ресурсов.

Клиентам не всегда нужны все доступные поля, потому предусмотрите возможность кастомизации списка возвращаемых полей параметром fields.

Параметр fields может содержать одно и более названий полей, перечисленных через запятую, эта возможность бывает полезной для сложных ресурсов с большим количеством метаданных.

API субдомен

Выделите для вашего API отдельный субдомен(например api.example.com/v{version_id}) и сосредоточьте все ваше API в зоне этого субдомена.

Формат

Для передачи формата входных и получаемых данных указывайте формат в виде расширения файла(например /v1/videos.json) и обеспечьте поддержку нескольких форматов данных.

Интеграция и документация

Напишите SDK или библиотеки для платформ, которые используют ваши клиенты. Cопроводите это все качественными и подробными примерами использования вашего API и документацией по использованию ваших инструментов и API.

Golang: пакеты

По поводу пакетов в голанге есть множество статей и ресурсов, например – https://thenewstack.io/understanding-golang-packages/. Но лично у меня в самом начале изучения этого языка прграммирования возникли две проблемы:

  1. Как использовать пакеты внутри совего приложения для разделения кода(что-то вроде namespace в других языках);
  2. Ошибка цикличного импорта пакетов.

Первый вопрос снимается легко, допустим у нас в проекте с названием project7(директория /go/src/project7) есть модели и контроллеры в соответствующих директориях(models и controllers), тогда мы можем их использовать в нашем главном файле main.go вот так:


То есть, по сути мы просто используем их как локальный неймспейс, все очень просто.

Проблема циклических импортов возникает, когда вы ипортируете пакет, который импортирует пакет из которого вы производите импорт.

Т.е. получается, что вы попадаете в бесконечный цикл импорта, так как оба пакета импортируют друг друга.

Избежать этой проблемы легко – используйте интерфейсы.