Disclaimer
Искренне считаю, что нужно измерять работу программиста. Но мерить ее только по количеству строк кода - порочная практика.
Информации о количестве измененных строк разработчиком может быть недостаточно, чтобы составить представление о его работе.
Прекрасная байка про Петра Капицу:
Рассказывают, будто был такой случай, когда знаменитая фирма, кажется, «Сименс и Шуккерт», попросила у Капицы консультации — почему не работает электродвигатель очень важной машины. Сумма за консультацию была назначена весьма солидная — 10 000 марок. Пётр Леонидович осмотрел машину, потом взял молоток и ударил по коренному подшипнику: двигатель заработал.
Фирме стало обидно платить такие деньги, и она попросила учёного составить нечто вроде письменной калькуляции. Он составил: «Один удар молотком — 1 марка, 9999 марок — за то, что знал куда ударить».
Задача
Собрать информацию о количестве измененных строк кода по каждому разработчику и объекту.
Учесть, что некоторые подсистемы не нужно включать в статистику, чтобы исключить библиотечные объекты.
Красиво вывести получившуюся информацию.
Решение
Собрать информацию об изменениях в коде можно в репозитории git.
В репозитории хранится вся информация о добавлении и изменении файлов по каждому коммиту.
Получить информацию по репозиторию можно с помощью команды:
git log
Результат:
Команда имеет много дополнительных параметров и с помощью нее можно построить даже вот такой красивый граф по коммитам прямо в консоли:
git log --graph --oneline --all
Результат:
Для нашей задачи помимо автора и файла нужна еще и информация по изменениям.
Для этого может подойти вот такая команда:
git log --pretty=format:"%h - %an" --stat
Результат:
Остается эту информацию собрать и красиво вывести в целом по репозиторию.
Автоматизация
Для автоматизации сбора информации подготовил скрипт на Python, который:
- Строит дерево подсистем конфигурации
- Разбирает файлы коммита на составляющие: Тип, Объект, Элемент (форма, модуль и т.д.)
- Суммирует информацию по объектам, чтобы составить картинку в целом о конфигурации
- Добавляет отбор по подсистемам
- Выводит информацию в файлы
Информация по подсистемам
В разработке конфигураций, как правило, свои изменения помещаются в отдельную подсистему. Это упрощает обновление конфигурации.
Поэтому если вся разработка ведется в отдельной подсистеме, то нам нужно собирать такую информацию.
При этом, если это самостоятельная конфигурация на основе БСП, то может потребоваться исключать библиотеку вендора.
Так как если библиотеку обновить, то будет много изменений, которые по факту выполнены вендором, и их можно не учитывать.
Поэтому важно добавить отборы по подсистемам, которые следует включить или исключить при сборе информации.
Информация о подсистемах хранится в файле Configuration.mdo:
Здесь хранится информация о подсистемах верхнего уровня.
В директории с самой подсистемой уже можно посмотреть подчиненные объекты.
Непосредственно в файле подсистемы хранится информация по входящим в нее объектам.
Например:
Этой информации нам достаточно, чтобы построить дерево конфигурации.
Данные по объектам:
Изменения собираем из коммитов с помощью обхода репозитория.
Вот так выглядит измененный файл в коммите:
GitConverter/src/CommonModules/КонвертацияХранилища/Module.bsl
Отсюда уже легко разложить информацию по типу и объекту. Например:
- GitConverter/src - это путь к исходным файлам репозитория
- CommonModules - это тип объекта. В данном случае - это Общий модуль
- КонвертацияХранилища - это сам объект - КонвертацияХранилища.
- Module.bsl - это элемент объекта - непосредственно текст модуля. С формами может быть немного сложнее, так как там большая вложенность.
Собранную информацию мы уже можем легко сопоставить с деревом конфигурации и подсистемами.
Следующий шаг - суммирование информации.
Суммирование информации
При обходе репозитория собираем информацию в многоуровневую структуру - Тип - Объект - Элементы - Автор - Добавил - Удалил
Для этого наполняем один большой массив со всей нужной нам информацией.
Так как коммитов может быть много, то добавляем отбор по дате, чтобы сделать отсечку.
Настройка даты хранится в файле src/settings.py:
После этого уже можем пройтись по готовому массиву и просуммировать информацию по нужным нам измерениям.
В итоге получим информацию об изменениях в целом по конфигурации и по-каждому объекту конфигурации.
Результат работы скрипта
Результат выводим в 3 разных форматах (см бесплатные файлы-примеры в публикации):
- MarkDown для просмотра в вебе result/stats.md
- HTML для просмотра на своем месте result/stats.html
- Excel для добавления отборов result/stats.xlsx
MarkDown
В формате MarkDown выводится файл для просмотра прямо в удаленном репозитории.
Если открывать на своем компьютере, то может потребоваться специальное ПО.
Пример:
HTML
В формате HTML выводится файл для просмотра на своем компьютере.
Такой файл не требует дополнительных усилий по открытию и отображению.
Пример:
Excel
В формате Excel выводится файл для детального изучения наложения дополнительных отборов.
Можно настроить отборы по автору или объекту конфигурации, чтобы собрать детальную статистику.
Пример:
По этому файлу уже можно построить свои красивые отборы и графики.
Примеры:
К публикации приложены примеры, с собранной информацией по публичным репозитория фирмы 1С.
Можете посмотреть, что получается и в каком виде будет выводится информация.
Как собрать информацию по своей конфигурации
Важное условие:
- Необходим репозиторий конфигурации в формате EDT.
Если вы до сих пор разрабатываете в хранилище, то рассмотрите возможность использовать ГитКонвертер для гибридной разработки.
Ссылка на ГитКонвертер. - Необходим установленный python - https://www.python.org
Не требуется дополнительных знаний по этому языку
Инструкция через GitHub
Ссылка на GitHub - 1Codemeter
1. Клонируем репозиторий из GitHub. В консоли (bash или powershell) пишем:
git clone https://github.com/Oxotka/1Codemeter.git
2. Переходим в репозиторий и устанавливаем зависимости. В консоли (bash или powershell) пишем:
python3 -m pip install -r requirements.txt
3. С помощью любого текстового редактора вносим данные о своей конфигурации 1С в файл src/settings.py:
- Путь до локального репозитория в
path_to_repo() - Относительный путь до src внутри репо в
name_of_src()
4. Запускаем на исполнение файл main.py. В консоли (bash или powershell) пишем:
python3 main.py
5. Готово. Проверяем папку 1Codemeter/result.
В ней должно быть 3 файла с результатом.
Через Infostart:
1. Распаковываем архив из публикации и переходим в получившуюся папку
2. Устанавливаем зависимости. В консоли (bash или powershell) пишем:
python3 -m pip install -r requirements.txt
3. С помощью любого текстового редактора вносим данные о своей конфигурации 1С в файл src/settings.py:
- Путь до локального репозитория в
path_to_repo() - Относительный путь до src внутри репо в
name_of_src()
4. Запускаем на исполнение файл main.py. В консоли (bash или powershell) пишем:
python3 main.py
5. Готово. Проверяем папку 1Codemeter/result.
В ней должно быть 3 файла с результатом.
Видео инструкция:
Если что-то не получается - задавайте вопросы в комментариях - постараюсь оперативно ответить!
Просьба к Вам!
- Поставьте плюс этой публикации, пожалуйста
- Поставьте звездочку репозиторию на GitHub, пожалуйста
- Поделитесь своей статистикой и обратной связью в комментариях, пожалуйста
Спасибо и хорошего настроения!
