![Реализация
• Покрыто ли тестами?
• Качество тестов
• Соблюдение DRY/KISS/etc
• Как следствие,
•
o простота
o расширяемость
Соответствие [де-факто] стандартам](https://image.slidesharecdn.com/2014-02-0102-140208032654-phpapp02/85/2014-02-01-02-10-320.jpg)
2014-02-01 02 Дмитрий Малиновский. Почему нужно читать исходный код инструментов
- 1. Почему нужно читать исходный код инструментов Малиновский Дмитрий Студент 5 курса ОмГУ, ИМИТ DevOps Engineer в Thumbtack
- 2. Идеальный код? • Проектирование • Документирование (sphinx, readthedocs) • Статические анализаторы (flake8) • Анализаторы цикломатической сложности (radon) • Автоматические проверки (git hooks, :w, etc.) • Тестирование (unittest, doctest, etc.) • Continuous Integration (Travis, Jenkins, etc.)
- 3. Анатомия инструментов Внутренняя кухня _RSAobj LocalClient ListServers • • • Магия Магия Магия Внешний интерфейс RSA.new salt * test.ping couchbase-cli server-list • • •
- 5. Примеры: • server-add myserver # OK • server-remove myserver # FAIL: ‘myserver’ is not • • a valid IPv4 address salt v0.17.2: pkgrepo.managed # OK salt v0.17.4: pkgrepo.managed # FAIL
- 7. Опыт ● Существуют причины, по которым это сделано так, а не иначе ● Разработчики не могли предусмотреть всё ● Pull request
- 8. Опыт Pull request: Not merged - недостаточно опыта/понимания Merged - удовлетворение, признание ● Contribution • •
- 9. Понимание • Реализует все контракты • • o raise NotImplementedError Движется в нужном направлении o интеграция с puppet при сломанном yum api o преждевременная монетизация Production-ready?
- 10. Реализация • Покрыто ли тестами? • Качество тестов • Соблюдение DRY/KISS/etc • Как следствие, • o простота o расширяемость Соответствие [де-факто] стандартам
- 11. Комментарии • long john; // silver • // Я посвящаю весь свой код, • // всю работу своей жене Дарлин, которой // придётся содержать меня, // наших троих детей и собаку, когда // это пойдет в паблик. long long ago; /* in a galaxy far far away */
- 13. Как выбираются инструменты “Первая ссылка в гугле”, обзор фич
- 15. Как выбираются инструменты Наличие удобного GUI
- 16. Как выбираются инструменты Наличие удобного CLI
- 17. Как выбираются инструменты Наличие удобного API urllib2 urllib2.HTTPPasswordMgrWithDefaultRealm urllib2.HTTPDigestAuthHandler urllib2.AbstractBasicAuthHandler
- 18. Подводные камни 1. Обзор фич - маркетинг 2. Сравнение фич - платные, поверхностные обзоры 3. Удобный GUI - возможно, единственный грамотно написанный компонент 4. Удобный CLI - неконсистентный ввод/вывод, опции (--verbose vs --log verbose) 5. Удобный API - отсутствие высокоуровневых абстракций, отсутствие логики взаимодействия
- 19. Вопросы, которые нужно задать Могу ли я пользоваться инструментом, который: не реализует маркетинговые обещания? не имеет внутренней логики? не имеет тестов? имеет мало тестов? имеет бессмысленные тесты? развивается от “левой пятки”? • • • • • •
- 20. Не реализует обещания Значит вместо можно увидеть
- 21. Не имеет внутренней логики Значит код придется писать так
- 22. Имеет проблемы с тестами Значит что-то где-то упадет
- 23. Развивается от левой пятки Значит, придется тратить ресурсы на реализацию необходимых фич и костыли
- 24. Читайте исходный код и помните, что баги библиотек, которыми вы пользуетесь, становятся багами вашего проекта
- 25. Вопросы?