ISBLScan ViewCode — просмотр ISBL-кода для IS-Builder 5, IS-Builder 7

Один из универсальных советов по совершенствованию навыков разработки на любом языке, который был прочитан в книгах Криса Касперски (недословно):

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

Когда-то, работая на проекте DIRECTUM в группе тестирования прикладных решений, сделал инструмент isblTest. Инструмент помог следовать совету, навигация по ISBL-коду стала простым занятием, знаний прибавилось, ошибки находились. Потом была задача сертификации технического решения («Акелон: Управление проектами»), добавил в утилиту механизм поиска, и быстро решил задачу. Найдя ошибку в одном месте, можно было легко найти похожие участки кода. Но больше не приходилось работать с ISBL, инструмент не использовался и не поддерживался несколько лет. А программное обеспечение без поддержки умирает.

Сейчас настало время расчехлить запасы живой воды и оживить проект. ISBLScan ViewCode — переписанная версия проекта isblTest. Не изменилось назначение инструмента. А структуры данных, алгоритмы, компоненты были реализованы без оглядки на старую версию. Проект создал в течение трёх недель в свободное от работы время, три дня без сна и недели неспешного рефакторинга. Лицензия — New BSD (шаблон: The BSD 3-Clause License).

ISBLScan ViewCode выглядит так:

Возможности инструмента:

1. Аутентификация на SQL Server по паролю, поддержка Windows-аутентификации.
2. Отображение элементов разработки в виде дерева (как дерево элементов проекта).
3. Загрузка исходного кода основных элементов разработки на IS-Builder 7 и IS-Builder 5 из базы данных.
4. Поиск элементов дерева разработки, содержащих в тексте нужные слова (слова из поля Search Text).
5. Выделение ключевых слов, по которым выполнялся поиск в исходном тексте (желтый текст, золотой фон).
6. Фильтрация элементов дерева разработки по наименованию (поле фильтрации расположено над деревом проекта).
7. Выделение результатов поиска в дереве разработки (узлы соответствующие поисковому запросу остаются черными, узлы не соответствующие поисковому запросу становятся серыми).

Реализуемые с помощью ISBLScan ViewCode потребности:

1. Получение выгод.
2. Оптимизация рисков.
3. Оптимизация ресурсов.

Получение выгод

• лучшие продукты делаются лучшими инструментами ((с) Наиль Ахмеджанов, руководитель группы разработки Synerdocs). Вы сможете сделать вашу разработку быстрее и качественней, что отразится на доверии заказчиков и финансовой выгоде;
• возможность изучения исходных кодов на ISBL, повышение компетенций разработчика и финансовой составляющей работы.

Оптимизация рисков

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

Оптимизация ресурсов

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

Примеры использования инструмента

1. Использовал ISBLScan ViewCode (isblTest) для целей обучения разработке на ISBL, выполнения задач тестирования прикладной разработки (это уже история, обросшая легендами, не все из которых правда).
2. Первый пользователь, который когда-то высказал пожелания — Пётр Федотов. Первый пользователь, точно использующий инструмент, для решения задач разработки и инспекции кода — Иван Чурбаков.
3. Также есть компания-партнёр, использующая инструмент, но от них не было обратной связи.

Вариант развития проекта

1. ViewCode:
   1. Расширить состав загружаемых элементов разработки:
      • типовые маршруты;
      • блоки типовых маршрутов;
      • вычисления из специальных справочников Prestima (например, OLAP кубы данных);
   2. Добавить навигацию типичную для IDE:
      • Find all reference (найти все ссылки);
      • Go to definition (перейти к определению).
   3. Улучшить подсветку синтаксиса.
   4. Загрузка разработки как из пакета разработки так и из базы данных.
2. InspectCode:
   1. Реализовать поддержку ручной инспекции кода.
   2. Возможность оставлять примечания к коду.
   3. Совместное редактирование примечаний.
   4. Связь с системой учёта дефектов.
   5. Пометка участков кода тегами:
      • Bug;
      • Good work;
      • Needs work;
      • With comment.
3. CheckCode:
   1. Метрики кода.
   2. Поиск дублирующего кода.
   3. Реализовать автоматическую проверку синтаксиса.
   4. Поиск кода, содержащего недостатки по шаблонам поиска.
   5. Анализ потока данных и автоматическое выявление SQL и ISBL-инъекций.
4. EditCode:
   1. Сохранение кода в базу данных.
   2. Сохранение кода в пакет разработки.
   3. Помощь при написании кода (автоподстановка, всплывающие подсказки по параметрам).
5. ReviewCode:
   1. Сохранение кода в систему контроля версий.
   2. Загрузка кода из системы контроля версий.
   3. Сравнение кода из разных веток.

Когда инструмент разовьётся до ReviewCode, это будет весело.

(фото с http://www.zuskin.com/coding_habits.htm)

Системные требования:

• Windows (проверялось в Windows Server 2008 R2), .NET 2.0;
• Linux (проверялось в Linux Mint 14), Mono 2.10.8.1;
  • особенности:
    • не проверялась работа windows-аутентификации, так как нет опыта интеграции Open LDAP с Active Directory;
    • на малом размере шрифта в исходном коде не отображаются нижние подчеркивания, для увеличения размера шрифта можно нажать клавишу Ctrl и прокрутить колесо мыши вверх.

Лицензионное соглашение

1. Лицензия ISBLScan ViewCode — New BSD (вариант лицензии BSD, свободной от рекламного упоминания университета Беркли в тексте соглашения). Оставляю за собой право изменить лицензию в дальнейшем. Условия лицензии позволяют это сделать.
2. Лицензия компонента ICSharpCode.TextEditor — LGPL 2.1 (вариант свободной лицензии GPL для библиотек, позволяющий использовать продуктам с любой лицензией динамическое подключение библиотеки, если разрешить «модификации для внутреннего использования потребителем и обратную разработку для отладки таких модификаций», а лицензия New BSD допускает такие модификации и отладку).

Ссылки и контакты:

• пример сборки:

  • ISBLScan.ViewCode.zip (160,36 Кб) (лучше брать свежую версию);

• репозиторий (https://bitbucket.org/owasp/isblscan/):
  • скачивайте последние изменения, улучшайте проект, присылайте pull request;
• оформление пожеланий и регистрация замечаний (https://bitbucket.org/owasp/isblscan/issues):
  • пишите обо всём, о подсветке синтаксиса, загрузке чего-либо, удобстве работы, аналогах, о поисковых фразах;
• темы на форуме club.directum.ru:
  • Какие конструкции языка ISBL можно считать потенциально небезопасными? — инспекция кода с целью поиска уязвимостей признана ненужной;
  • Аудит(документирование) кода — проявлен интерес к аудиту кода;
• пишите письма:
  • 426011, г. Ижевск, пер. Северный, д.61, 8-й этаж, ООО ДИРЕКТУМ, группа разработки Synerdocs, Смирнов Вячеслав Александрович.

Благодарности. Спасибо всем, кто осилил.

Update:

• 2014-11-19. Перенёс разработку на github https://github.com/polarnik/isblScan, так как запутался с настройкой рабочего места при обновлении SSH-ключей на bitbucket.