Управляй качеством кода 1С с помощью SonarQube

08.07.2019 93 Comments

Практика программирования, Разработка

, ,





    518.png
    image29.jpg
    image23.png
    image3.png
    image31.png

Управляй техническом долгом проектов 1С с помощью SonarQube. В статье рассматривается пример применения SonarQube при разработке.

Оглавление

 

Введение

 

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

Нельзя просто так взять и не оставить после себя технический долг

Что такое технический долг? Технический долг — это метафора программной инженерии, обозначающая накопленные в программном коде или архитектуре проблемы, связанные с пренебрежением к качеству при разработке программного обеспечения и вызывающие дополнительные затраты труда в будущем (Wikipedia).

Причины возникновения могут быть разными:

  • Недостаточная компетентность кадров;

  • Давление со стороны бизнеса;

  • Плохо спроектированная архитектура и отсутствие документации;

  • Отсутствие процессов review и refactoring;

  • Отсутствует тестирование;

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

 

Управление техническим долгом

 

Технический долг

Управлять техническим долгом можно следующим подходами:

  • Внешний аудит — привлечение сторонней компании. Затратно, на результат может влиять человеческий фактор.

  • Внутренний аудит — визуальная проверка кода (code review).  Опять же на результат влияет человеческий фактор и иногда необъективность.

  • Автоматизированная проверка кода — применяются статические анализаторы. В мире 1С используется конфигурация 1С: АПК.

Существует еще один подход, который я считаю наиболее эффективным — непрерывная проверка кода (continuous code inspection). Более подробно можно изучить подход в статье Управление техническим долгом — Концепция Continuous Inspection. Мой выбор пал на SonarQube.

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

На рынке существует как минимум два плагина для поддержки языка 1С в SonarQube.

В статье используется плагин SonarQube 1C (BSL) Community Plugin, т.к. он бесплатен. Плагин основан на проекте BSL Language Server — реализации протокола language server protocol для языка 1С: Предприятие 8 и OneScript. 

 

Быстрый старт

 

Быстрый старт

 

В рамках базового примера мы развернем SonarQube, подготовим рабочий каталог проекта 1С, загрузим результаты проверки кода на сервис. В примере будет использоваться операционная система Windows. Повторить то же самое для unix / macos систем возможно, но с небольшими изменениями. Все скрипты будем выполнять в консоли CMD или Powershell (не имеет значения).

Мною заранее был заготовлен шаблон рабочего окружения. Скачиваем его по ссылке.

 

 Кто используют Git

Клонируем на компьютер с помощью консоли:

git clone https://github.com/otymko/article-sonar-for-infostart.git

Визуально проект выглядит:

Подготовленный шаблон

В его состав входят:

  • project1c — рабочий каталог с проектом для анализа.

    • src — каталог для исходных кодов 1С

    • check.bat — скрипт запуска проверки кода

    • sonar-project.properties — файл настроек проекта для SonarQube

 

Первый этап

 

Развернем сервис SonarQube версии 7.9. Будем рассматривать простую установку, с использованием внутренней базы данных. По умолчанию SonarQube использует базу данных H2. В дальнейшем, если вы хотите использовать сервис постоянно, обновлять его  — нужно использовать внешнюю базу данных, например PostgreSQL.

 

Для SonarQube требуется Java 11+. Скачиваем OpenJDK 11 https://jdk.java.net/archive/ и распаковываем в каталог C:openjdk11.

 

Далее скачиваем архив с SonarQube по ссылке https://www.sonarqube.org/downloads/. Распаковываем в каталог C:sonarqube.

 

Теперь нужно выставить базовые настройки. Для этого отредактируем файл конфигурации C:sonarqubeconfsonar.properties:

sonar.web.javaOpts=-server -Xmx2g -Xms1g -XX:+HeapDumpOnOutOfMemoryError
sonar.ce.javaOpts=-Xmx6g -Xms4g -XX:+HeapDumpOnOutOfMemoryError
sonar.search.javaOpts=-Xms5g -Xmx6g -XX:+HeapDumpOnOutOfMemoryError

 

Указываем путь к java 11 (если ранее не было установлено и прописано в path). В файле C:sonarqubeconfwrapper.conf отредактируем строку:

wrapper.java.command=java

Меняем на:

wrapper.java.command=C:openjdkjdk-11.0.2injava

Сервис можно запустить вручную из консоли или создать службу windows. Для ручного запуска в консоли запускаем скрипт:

C:sonarqubeinwindows-x86-64StartSonar.bat

Дожидаемся завершение развертки сервиса. В консоли должно быть выведено:

 

Более подробно развертку SonarQube на Windows можно изучить здесь.

Скачиваем и копируем плагин для SonarQube в каталог C:sonarqubeextensionsdownloads:

 

 

 Кто хочет использовать Docker

 

SonarQube будет доступен по адресу http://localhost:9000. По умолчанию в SonarQube создается пользователь admin / admin  — логин / пароль соответственно.

Теперь на сервисе SonarQube нужно:

  • Если используется внешняя база данных для SonarQube, то нужно сгенерировать token доступа пользователя для запуска анализа проекта.

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

 

Генерация token (необязательно)

 

Переходим на настройки пользователя admin http://localhost:9000/account/security/, указываем название token и нажимаем Generate. Копируем полученный token, он вам понадобится в дальнейшем.

 

 

Добавление новых пользователей

 

Создаем новых пользователей. Для этого переходим на страницу http://localhost:9000/admin/users и нажимаем Create user. Обязательно заполняем все поля:

 

 

Если используется проект Git то создаем пользователей для каждого пользователя Git.

 

Интерфейс на Русском языке

 

Сменим язык интерфейса сервиса на Русский. Для этого переходим на страницу http://localhost:9000/admin/marketplace, находим плагин локализации Russian Pack и устанавливаем, используя кнопку Install.

 

Внимание: для смены языка интерфейса на русский нужно будет перезапустить сервис SonarQube. Для этого нажимаем на той же странице Restart Server:

 

Подготовка каталога проекта SonarQube

 

В каталоге project1c/src должны находиться исходные коды 1С конфигурации. Рассмотрим ручной вариант экспорта в этот каталог.

 

Ручная выгрузка через конфигуратор

 

Если Git проект не используется, делаем ручную выгрузку проекта через конфигуратор. Для этого в конфигураторе 1С нажимаем Конфигурация -> Выгрузить конфигурацию в файлы…

 

 

Указываем путь к каталогу project/src и нажимаем выполнить.

 

 

После завершения каталог исходных кодов должен выглядеть примерно так:

 

 

 

 Для тех кто использует Git

 Клонируем проект git в каталог project1c/src. Выполняем команду:

git clone url_your_project_1c /path/to/project1c/src

Каталог должен выглядеть примерно вот так:

 

 

Второй этап

 

Для второго этапа потребуется консольное приложение для запуска анализа проекта sonar scanner. Скачиваем сканер со страницы https://docs.sonarqube.org/latest/analysis/scan/sonarscanner/. В нашем случае нужна версия для Windows x64:

 

 

Скачиваем по ссылке https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.0.0.1744-windows.zip. После распаковки архива копируем полный путь к скрипту sonar-scanner.bat. Скрипт расположен в каталог bin.

 

 

Теперь нужно изменить скрипт запуска анализа проекта. Редактируем файл project1c/check.bat.

 

 

Заменяем в нем путь к sonar-scanner и значение token (необязательно).

Без токена:

../sonar-scanner-cli-4.0.0.1744-windows/sonar-scanner-4.0.0.1744-windows/bin/sonar-scanner.bat

 С токеном:

../sonar-scanner-cli-4.0.0.1744-windows/sonar-scanner-4.0.0.1744-windows/bin/sonar-scanner.bat -D"sonar.login=1952877e4d61d69c766eb8d9ca1d39ac48a4254f"

Последнее, что потребуется  — это проверка настроек проекта SonarQube. Откроем файл настроек project1c/sonar-project.properties.

 

 

В этом конфигурационном файле меняем, если нужно:

  • sonar.projectKey — ключ проекта

  • sonar.projectName — имя проекта

  • sonar.projectVersion — версию проекта

 

 Для тех, кто использует проект Git

Нужно раскоментировать строки:

  • sonar.projectBaseDir=src

  • sonar.scm.enabled=true

  • sonar.scm.provider=git

Изменить строку:

sonar.sources=src на sonar.sources=./

 

P.S. в конфигурационном файле sonar нельзя указывать значения параметров в кириллице.

Неправильно:

sonar.projectName=МойЛучшийПроект

Правильно:

sonar.projectName=u041Cu043Eu0439u041Bu0443u0447u0448u0438u0439u041Fu0440u043Eu0435u043Au0442

Для кодировки кириллицы используем сервис https://www.online-toolz.com/tools/text-unicode-entities-convertor.php. После кодировки нужно будет заменить символы % на .

 

Последний этап

 

Запускаем анализ проекта через скрипт project1c/check.bat. Дожидаемся сообщения в консоли:

 

 

Проблемные ситуации

 

У вас может не хватить памяти, выделенной под JAVA во время запуска sonar-scanner. В логах появится ошибка

ERROR: Error during SonarQube Scanner execution
ERROR: null
ERROR: Caused by: GC overhead limit exceeded

 

 

Проблему можно решить с помощью Java Memory Settings. Нужно указать в переменной среды или в скрипте check.bat значение SONAR_SCANNER_OPTS. Например, для выделения 4 ГБ оперативной памяти указываем:

set SONAR_SCANNER_OPTS=-Xmx4g

 

Анализ проекта

 

Переходим на главную страницу сервиса sonarqube http://localhost:9000/projects. При первом анализе нужно дождаться его завершения на сервисе (выполняется фоновое задание загрузки результатов анализа).

 

 

Фоновое задание:

 

 

После завершения загрузки страница списка проектов будет выглядеть:

 

 

Переходим в проект MyConf. На странице метрик проекта видим:

  • Количество ошибок

  • Количество уязвимостей

  • Время на исправление технического долга

  • Количество дефектов кода (code smells)

  • Процент и количество дублирующегося кода.

 

 

На закладке Замечания увидим ошибки и дефекты кода. Используя фильтры на панели слева, можно отфильтровать замечания, например, по правилам проверок:

 

 

Отфильтровываем замечания. Получаем:

 

 

Переходим в первое замечание:

 

 

Для тех, кто использует проект Git, будут доступны фильтры по авторам (если заведены пользователи на сервисе, то они будут отображаться сразу в замечании).

 

 

Возвращаемся на страницу метрик проекта. Переходим в дублирование кода и выбираем любое дублирование:

 

 

Список дублирования в коде:

 

 

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

 

 

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

 

 

В области New code, выводится информация  о новых результатах проверок. На примере Дефектов кода можно увидеть динамику изменения показателей:

 

 

График изменений:

 

 

P.S. Хотите больше диагностик кода? Вы можете предложить, реализовать их в проекте https://github.com/1c-syntax/bsl-language-server.

 

Расширенный пример

 

Компания 1C-ИжТиСи разработала конфигурацию 1С: Автоматизированная проверка конфигураций (https://v8.1c.ru/acc/). 

 

Решение позволяет проверять конфигурации в автоматическом режиме на соответствие стандартам разработки 1С. Конфигурация имеет большое количество проверок кода 1С, но, к сожалению, отсутствует функционал анализа изменения качества кода. Используя проект acc-export из 1С: АПК, можно выгрузить результат анализа кода в SonarQube.

 

В рамках этой главы нужно установить:

Конфигурацию 1С: АПК нужно развернуть на компьютере, создать новый проект и выполнить первоначальную проверку. Более подробно можно почитать в статье Автоматизированная проверка конфигураций… и пара слов о стандартах разработки.

 

После установки OneScript потребуется установить библиотеку vanessa-runner (https://github.com/oscript-library/vanessa-runner). Выполняем в консоли:

opm install vanessa-runner

 

Скачиваем обработку экспорта  https://github.com/otymko/acc-export/releases/download/1.1.0/acc-export.epf в каталог project1c.

 

Подготовка каталога проекта

 

В каталоге project1c создадим acc.properties — файл настроек экспорта из АПК.

 

 

  • acc.projectKey — наименование конфигурации в АПК. 

  • acc.catalog — каталог проекта (не к src) 

  • acc.sources — путь / каталог исходных кодов, например, src. 

  • acc.check — запуск проверки конфигурации. Настройки будут взяты с параметров запуска по расписанию. 

  • acc.format — формат экспорта из АПК (reportjson или genericissue). По умолчанию reportjson. Можно не указывать. 

  • acc.titleError — представление вывода ошибки при экспорте. Может принимать значения: code (только код ошибки), name (только наименование ошибки), codeName (код и наименование ошибки). По умолчанию codeName.

 

Отредактируем файл sonar-project.properties и добавим настройку:

sonar.bsl.languageserver.reportPaths=acc-json.json

Создадим скрипт acc.bat запуска экспорта проверок АПК.

 

 

@chcp 65001
@set RUNNER_IBNAME=/FC:Sonaracc
@set RUNNER_DBUSER=Администратор
@call runner run --command "acc.propertiesPaths=./acc.properties;" --execute "./acc-export.epf" --ordinaryapp=1

 

Выгрузка результат

 

Запускаем скрипт acc.bat, затем check.bat и дожидаемся завершения:

 

 

Когда SonarQube обработает результат проверки, нам будут доступны новые данные для аналитики.

 

 

На закладке замечания список правил проверки расширился:

 

 

В итоге, мы имеем загруженные результаты проверки 1С: АПК в SonarQube для дальнейшей аналитики.

 

Подведем итоги

 

В результате проверки кода и загрузки результатов в SonarQube, мы получаем метрики, наглядно показывающие текущее состояние качества проекта.

Что теперь с этим делать?

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

 

Дальнейшее развитие темы

 

  • Автоматический запуск проверки качества кода. Автоматизируем запуск проверки качества, используя, например, Jenkins или GitLabCI. 
  • Исключение из проверки объектов конфигурации, которые находятся на поддержке.  В этом может помочь проект edt-export-bugs. Также с его помощью можно автоматизировать получение проверок из EDT. Более подробно можно почитать здесь (https://github.com/Stepa86/edt-export-bugs).
  • Рассылка результатов проверки кода ответственным / виновникам замечаний.

 

Благодарности

 

Хочу выразить огромную благодарность за инструменты и помощь при создании статьи:

Мой жене за чтение технической статьи. А так же читателям статьи, кто дотянул до конца =)

 

Ссылки

 

Related Posts

93 Comments

  1. capitan

    Как скучно я живу )

    Reply ↓
  2. Xershi

    Раз используется апк, то зачем весь этот зоопарк?

    Reply ↓
  3. omut

    На практике или дописываю типовую конфу, или делаю свою на базе БСП. В обоих случаях собственного кода в общем объеме не так и много. Можно ли анализировать только отличия от типовой? Зачем мне знать качество кода других программистов, раз на них никак не влияю…

    Reply ↓
  4. Niki_Pro

    О, спасибо! Как раз начал знакомство с SonarQube. Супер

    Reply ↓
  5. olegtymko

    (3)автоматизированно в контуре ci проводить анализ состояния системы и с помощью sonarqube видеть общий тренд изменения качества решений. Так же, на мой взгляд, одна из самых главных «плюшек» сонара — привязка результатов диагностик к пользователям через git blame. Для меня ещё полезным показалось дублирование кода — этого соответственно нет в АПК.

    Reply ↓
  6. olegtymko

    (1) всегда должно быть место для хобби=)

    Reply ↓
  7. olegtymko

    (6) старался преподнести материал в самом простом виде, чтобы на старте можно было «пощупать» функционал.

    Reply ↓
  8. kuzyara

    Поставил сонар на допиленную ут10, выдал 3 тысячи ошибок и 39 тыс. предупреждений.

    И что дальше? Как качеством управлять то?

    Reply ↓
  9. olegtymko

    (10)

    И что дальше? Как качеством управлять то?

    «Предупреждён — значит вооружён». Теперь мы понимаем что у нас есть 2 тыс. критических проблем и 44 уязвимости. Их нужно устранять, чтобы сделать решение более стабильным. Так же нужно учитывать, что большая часть кода — это код на поддержке. Его нужно исключить. Для этого можно использовать проект https://github.com/Stepa86/edt-export-bugs. Далее используя анализ на продолжительном периоде, можно отслеживать новые ошибки / дефекты с помощью отбора по дате создания замечания. (см. приложенный файл)

    Еще вопрос: т.к. используются обычные формы, перед анализом, были ли они извлечены? Например через gitsync. Я для этого использую скрипт https://github.com/otymko/acc-export/blob/master/run.os.

    Reply ↓
  10. kuzyara

    (11) gitsync

    На вашем проекте, судя по скриншотам, >800 ошибок и 23 тыс. дефектов?

    Покажите, пожалуйста, тренд количества ошибок или что-нибудь отображающее профит.

    Очень уж любопытно, продвинулись ли Вы куда-нибудь дальше «понимания».

    Reply ↓
  11. fenixnow

    Все это прикольно, но на текущем этапе развития, это просто некая игрушка, нежели чем инструмент. 🙂 Как правильно сказал Олег — хобби

    Reply ↓
  12. fenixnow

    Плюсик поставил за труды

    Reply ↓
  13. Labotamy

    (3) Еще возможность использовать «внешние» анализаторы, а отчет смотреть сводный.

    Reply ↓
  14. nixel

    (15) АПК — игрушка? Или SonarQube как платформа с десятилетней историей?

    Или их связка, которая успешно работает уже более трех лет?

    Reply ↓
  15. Labotamy

    (10) Гоняешь перед выпуском релиза и в секции «New code» не должно быть новых утечек.

    Reply ↓
  16. Labotamy

    (15)Какая обоснованная критика =)

    Reply ↓
  17. fenixnow

    (18) Связка АПК — Сонар, да еще минимальный набор проверок в сонаровском плагине.

    Reply ↓
  18. fenixnow

    (20) Алексей, все в курсе всего, обсуждалось в телеграмме… 🙂 Надеюсь, вы не обнуляетесь за выходные? 🙂

    Reply ↓
  19. Labotamy

    (2) Упароваться надо чтобы такого, случайно не было.

    Reply ↓
  20. Labotamy

    (21) Я там скрин наверху оставил, с результатом «минимального набора». На текущий момент мне известно 4ре анализатора, их результаты можно импортить в сонар. На 3 есть отсылы в статье.

    Reply ↓
  21. Labotamy

    (22)Формулировки «игрушка» не припомню. А вот ваш, не сильно обоснованный скепсис припоминаю.

    Reply ↓
  22. azhilichev

    Коллеги, знаю, что бесплатный сонар позволяет анализировать одну ветку. В примере из статьи — это master. По вот этому workflow содержимое ветки master — это то, что находится в боевой системе. Получается, что контроль качества выполняется после публикации изменений? Или я что-то неправильно понял? Пробуем использовать инструменты контроля качества. И пока не получается запустить инструмент так, чтобы он проверял изменения каждого разработчика перед публикацией.

    Reply ↓
  23. Labotamy

    (26)В природе есть комьюнити бранч плагин. Но это все, что я онем знаю.

    Reply ↓
  24. Stepa86

    (26) Можно под разные ветки завести разные проекты прост. Типа «ВажныйПроект_master», «ВажныйПроект_dev», «ВажныйПроект_ПесочницаДляСтажеров»

    Reply ↓
  25. olegtymko

    (26)Не попробуете — не узнаете. Вот бесплатный плагин веток для SonarQube CE -> Sonarqube Community Branch Plugin

    Reply ↓
  26. nixel

    (26) если работаете в EDT, то можно доустановить плагин от Александра Капралова, который будет показывать диагностики из BSL LS прямо в EDT.

    А так да, выше дали ссылку на комьюнити бранч-плагин, лично проверял его работу на 4 серверах от 7.4 до 7.8.

    Недавно вышел релиз плагина под свежий LST релиз SonarQube, конкретно его я еще не проверял, но в комментариях пишут, что работает.

    Reply ↓
  27. olegtymko

    (31) Никогда не поздно, никогда не рано начать отслеживать качество кода =)

    Reply ↓
  28. Labotamy

    (31) Реклама чего?

    Reply ↓
  29. Dach

    (11)

    Скажите пожалуйста, получается то есть, если проект на обычных формах — каждый раз, перед выгрузкой файлов конфигурации в project/src (ну или перед выгрузкой этих же файлов git) — их нужно разобрать? И код из ссылки это все корректно делает?

    За статью — спасибо, очень большая и ценная работа проделана

    Reply ↓
  30. olegtymko

    (35) Да, придется их разобрать. Иначе все обычные формы будут в файлах bin, и проверки bsl ls их не увидят. Так же АПК не увидит файлов, на которые можно повешать замечания.

    Этим скриптом пользуюсь я сам. Тоже самое можно с помощью gitsync сделать.

    Reply ↓
  31. vvp117

    (23) Ну допустим вы это нашли. В типовой. На поддержке. И что будем делать с этим?

    Reply ↓
  32. Labotamy

    (37) Например фиксить расширением, и слать вендору.

    Reply ↓
  33. Kosstikk

    (34) радует, что не все комьюнити с менталитетом кодера «сказали-делаю, а вот это все остальное — для меня сложно» чем прогрессивнее будет комьюнити, тем лучше со временем станут условия для 1с разработчиков не как добывателей денег, а как специалистов.

    Reply ↓
  34. Rustig

    (34) три минуса на сообщение, и токсичность исчезнет — растворится как туман… 🙂

    Reply ↓
  35. Rustig

    (38) фантазия… хотя думаю, стажеров можно на это посадить…

    Reply ↓
  36. Labotamy

    (41) Так оно наверняка у вас не работает, и вы уже тратите ресурсы на поиск этой ошибки. Если это в «не используемом» функционале, то конечно фиг бы с ней. Это если про вендорный код. А в своем в принципе сразу видите «ой тут наверное что то не так» и исправляете.

    Reply ↓
  37. nvv1970

    (37) В 1С в некоторых отделах, на некоторых продуктах работают весьма отзывчивые люди. Присланный им на партнерке или в саппорт репорт внезапно не отфутболивается, баг или недоработка берется в работу и исправляется, а сами сотрудники тебе благодарны за помощь.

    Такое случается не везде, но если случается, то вселяет веру в людей и надежду что наше дело — «правое».

    Reply ↓
  38. Rustig

    (42) согласен, крутая штука. Автор молодец!

    Reply ↓
  39. nvv1970

    (34) https://ru.wikipedia.org/wiki/Менталитет_краба

    Наверно не любят тех, кто выбрался из ведра ))

    Reply ↓
  40. for_sale

    (37)

    Ну, допустим, вы это нашли в вашем коде. «Ну его, этот сонаркуб, а то ещё окажется, что я не такой великий программист, как я о себе думал»?)

    Reply ↓
  41. for_sale

    Статья отличная, спасибо!

    Вопрос не в тему, но по скриншоту из темы — почему «Если ИначеЕсли» должна обязательно содержать Иначе?

    КолвоОчков = 10;

Если Ничья Тогда
КолвоОчков = КолвоОчков + 1;

ИначеЕсли Победа Тогда
КолвоОчков = КолвоОчков + 3;

КонецЕсли;

ЗаписатьВТурнирнуюТаблицу(КолвоОчков);

    Показать

    Зачем сюда Иначе пихать, если Иначе ничего не нужно?

    Reply ↓
  42. tsukanov

    (47) Это холиварная проверка. Согласны — используйте. Не согласны — отключите.

    Все просто

    Reply ↓
  43. nixel

    (47) это проверка из разряда «защитного программирования». Нужно на 100% быть уверенным, что это не «иначе» продолбали, а просто предварительную инициализацию сделали. Плюс не во всех ветках бывает такой простой инкремент, где-то могут вызываться функции с побочным эффектом.

    Уверены, что в данном случае все в порядке? ставьте на конкретное срабатывание статус won’t fix.

    Уверены, что всегда все ок или вас эта проверка раздражает — выключайте проверку в настройках «Quality Profile» или в конфигурационном файле BSL Language Server (в зависимости от режима запуска)

    Reply ↓
  44. Labotamy

    (47)Формально у вас еще и копипаста в подсчете очков.

    КолвоОчков = 10;

Если Ничья Тогда
Инкремент = 1;
ИначеЕсли Победа Тогда
Инкремент = 3
ИначеЕсли ФикирБылПьян Тогда
Инкремент = 10;
Иначе
Инкремент = 0;
КонецЕсли;

КолвоОчков = КолвоОчков + Инкремент;

ЗаписатьВТурнирнуюТаблицу(КолвоОчков);

    Показать

    Reply ↓
  45. for_sale

    (50)

    Копипаста — звучит как что-то плохое) Я бы в данном контексте его не использовал. Потому что у меня нет Иначе, а без него мне не нужен Инкремент, он в конце ошибку даст. Потому что формально в вашем примере добавлено одно ненужное действие, которое может выполняться, например, в цикле, например, миллион раз — и вот уже у нас миллион ненужных действий. Если же Инкремент вынести за Если, то тогда у нас миллион ненужных присваиваний переменных.

    Reply ↓
  46. for_sale

    (48)

    А чё, так можно было? Ок, спасибо)

    Reply ↓
  47. for_sale

    (49)

    Ок, если можно настраивать, тогда вообще класс

    Reply ↓
  48. Labotamy

    Да, вы правы, я продолбал инициализацию.

    Reply ↓
  49. for_sale

    (54)

    И миллион ненужных действий) Чтобы формально следовать какому-то «правилу»)

    Reply ↓
  50. olegtymko

    (47) Холиварная тема. У меня в коде больше таких условий:

    КолвоОчков = 10;

Если Ничья Тогда
КолвоОчков = КолвоОчков + 1;
ИначеЕсли Победа Тогда
КолвоОчков = КолвоОчков + 3;
Иначе
ВызватьИсключение(«Никогда такого не было и вот опять»);
КонецЕсли;

ЗаписатьВТурнирнуюТаблицу(КолвоОчков);

    Показать

    Reply ↓
  51. vvp117

    (46) Ооо нет, что вы) сонаркуб это чудесно. Просто где бы взять время на настройку и понимание всей этой инфраструктуры? Если куча свободного времени и осталось только причесать код по указке сонаркуба — тогда я вам завидую 🙂 вы молодец

    Reply ↓
  52. for_sale

    (57)

    Я ни на что не намекаю, но очень часто бывает так, что свободного времени нет именно потому, что код — говно, и на поддержку его уходит всё свободное время 🙂

    Reply ↓
  53. Labotamy

    (55) Все зависит от цены. Да, и тут вы тоже правы, миллион действий что-то стоит. Дальше обычно идет болтовня о компромиссе между производительностью и поддерживаемостью.

    1. 836мс

    2. 984мс

    P.S. мерил в оскрипте

    Reply ↓
  54. Labotamy

    (56) Вот Олег попался в ловушку отсутствия какого-то указания на то, что при проигрыше КоличествоОчков не увеличивается и случайно все сломал. Это и называется поддерживаемость =)

    Reply ↓
  55. olegtymko

    (53) и поэтому при тестировании все бы сломалось.,т.к. проигрыш идёт в эксепшэн)

    Reply ↓
  56. SmileDDD

    Подскажите пожалуйста. Все ли ошибки выгружаются из АПК? Которые не в модулях тоже?

    Reply ↓
  57. olegtymko

    (62) На данный момент не все, но в планах добавить. Ну и самое главное — это OpenSource проект. Можно создать issues c идеями / проблемами, можно самому доработать проект.

    Reply ↓
  58. for_sale

    (60)

    Тут я могу только начать реальный холивар, заявив, что это не функция кода — объяснять бизнес-логику, что для этого должно быть ТЗ, документация и комментарии:

    КолвоОчков = 10;

Если Ничья Тогда
КолвоОчков = КолвоОчков + 1;

ИначеЕсли Победа Тогда
КолвоОчков = КолвоОчков + 3;

// проигрыш — кол-во не меняется,
// никаких других ситуаций не бывает

КонецЕсли;

ЗаписатьВТурнирнуюТаблицу(КолвоОчков);

    Показать

    Причём, не отменяя нужность документации, думаю, важнее всего как раз такое писать в комментарии, потому что он ближе всего к программисту.

    Reply ↓
  59. Stepa86

    (64) Вот именно в Иначе и нужно вставить этот комментарий, чтоб всем остальным было очевидно, что здесь не продолбали вариант с проигрышем. А еще лучше, чтоб волшебные цифры 0, 1 и 3 были инкапсулированы

    Если Ничья Тогда
выигрыш = КоличествоОчковПриНичьей();
ИначеЕсли Победа Тогда
выигрыш = КоличествоОчковПриПобеде();
Иначе
выигрыш = КоличествоОчковПриПоражении();
КонецЕсли;

КолвоОчков = КолвоОчков + выигрыш;

ЗаписатьВТурнирнуюТаблицу(КолвоОчков);

    Показать

    Reply ↓
  60. Scorpion4eg

    Добрый день. Словил ошибку

    java.lang.IllegalArgumentException: Start pointer [line=3313, lineOffset=0] should be before end pointer [line=3313, lineOffset=0]

    Reply ↓
  61. Labotamy

    (66)зарегистрируйте, пожалуйста ишуз на гитхабе.

    Reply ↓
  62. nixel

    (66) добрый день.

    Дайте чуть больше логов, пожалуйста.

    Reply ↓
  63. Stepa86

    (66) +(67) Вот тут регистрировать https://github.com/1c-syntax/bsl-language-server/issues/

    Reply ↓
  64. Scorpion4eg

    (69) И можно было на ты) Чай не чужие люди.

    Reply ↓
  65. for_sale

    (65)

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

    Reply ↓
  66. Labotamy

    (70)Ой, не признал с мобилы =)

    Reply ↓
  67. Stepa86

    (71) Этот пример в итоге показал, что затраты на Иначе окупились бы. Эта проверка на тех. долг. А тех. долг влияет на сопровождаемость — то есть насколько легко этот код смогут доработать другие программисты. Пример Олега показал, что именно в этом месте этот тех.долг выстрелил в ногу, а значит сонар очень даже правильно диагностировал проблему.

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

    Reply ↓
  68. for_sale

    (73)

    Этот пример в итоге показал, что затраты на Иначе окупились бы.

    Каким образом? Вы показали будущему программисту логику через Иначе (т.е. ещё одну команду и даже вызов функции), я — комментарием. Информация та же, вызовов меньше.

    (73)

    И я очень удивился, когда у меня тесты отвалились.

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

    Reply ↓
  69. Stepa86

    (74)

    > Вы показали будущему программисту логику через Иначе

    И комментарий и логика используют ветку Иначе и поэтому стало понятнее и сложнее совершить ошибку. Можно обойтись и комментарием. Главный посыл в том, что ветка Иначе тут нужна.

    > Возможно, нужно внимательнее подходить к разработке.

    Да-да, нужно. Нужно писать без ошибок. У меня не получается. Поэтому я использую всякие вспомогательные костыли, типа статистического анализа кода, код-ревью, тесты и прочую ненужную вещь, чтобы снизить количество ошибок. Исключение в блоке иначе, в который никогда не должны бы заходить работает значительно лучше, чем отсутствие такого блока в принципе, потому что мы посчитали, что сюда не должны бы зайти.

    Reply ↓
  70. olegtymko

    (70)

    не чужие люди.

    Конспирация

    Reply ↓
  71. Labotamy

    (64)Нас же предупреждали, что это диагностика холиварная. На примерах разобрали, что придумана не из воздуха. В планах есть добавить настройку, что бы она срабатывала только на СелектКейсах.

    Использовать ее на своих проектах или нет, решаете вы сами.

    P.S. У некоторых диагностик есть параметры. Например, можно увеличить ограничение на длину строки (Стандарт глосит: 120. Имхо: 140).

    Reply ↓
  72. caponid

    (65) хм… разве это защитное программирование?

    вот мой вариант:

    РезультатПартии = 0;
Если СтатусПартии = Статусы().Ничья Тогда
РезультатПартии = 1;
ИначеЕсли СтатусПартии = Статусы().Победа Тогда
РезультатПартии = 3;
ИначеЕсли СтатусПартии = Статусы().Поражение Тогда
РезультатПартии = 0;
Иначе
//ВызватьИсключение(«Некорректный статус партии: » + СтатусПартии);
// или не вызывать….
СтатусПартии = Статусы().Дисквалификация;
КолвоОчков = 0;
КонецЕсли;

КолвоОчков = КолвоОчков + РезультатПартии;
ЗаписатьВТурнирнуюТаблицу(КолвоОчков);

    Показать

    ведь может что то сломаться — и партия будет незавершенная…

    Reply ↓
  73. gubanoff

    (14)

    — разделить ошибки на legacy и привнесённые в новом коде, старый код не трогать, а сосредоточиться на исправлении новых косяков;

    В последних версиях АПК появился режим «поместить все ошибки в исключения» как раз для первоначального занесения всех ошибок в исключения в старом коде.

    Reply ↓
  74. vlad.frost

    (85)

    В последних версиях АПК появился режим «поместить все ошибки в исключения» как раз для первоначального занесения всех ошибок в исключения в старом коде.

    Этот сценарий я рассматриваю как потенциально опасный, т.к. маскирует потенциальные ошибки.

    Пример:у меня эпизодически проявляется ошибка «Операция не может быть выполнена из-за несоответствия версии или отсутствия записи базы данных (возможно, запись была изменена или удалена)!»

    Я открываю SonarQube, ставлю фильтр на каталог по имени модуля и вижу там ошибку «Отсутствует исключительная управляемая блокировка на записываемые (удаляемые) данные.» — эта ошибка унаследованная, привнесена была год назад, но благодаря связке АПК+SonarQube я могу определить причину и исправить ошибку.

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

    Reply ↓
  75. for_sale

    (75)

    потому что мы посчитали, что сюда не должны бы зайти

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

    И повторюсь — исключениями вы неправильную логику не почините. Исключения в Иначе могут быть полезны на этапе разработки, чтобы было понятно, что за данные идут и что делать. После понимания, исправления и т.п. эти Исключения, которые остались невызванными, нужно удалить, туда же можно удалить и Иначе, которые останутся пустыми.

    Правила нужны для того, чтобы облегчать жизнь. Если правилам следуют просто формально, то это, видимо, неправильные или неправильно понятые правила. За добрый десяток постов мне так и не показали, где в моём абстрактном примере мне понадобится Иначе. А пихать его просто потому, что где-то кто-то сказал, что Иначе должно быть — не знаю почему, но не хочется)

    Reply ↓
  76. Stepa86

    (89) Не всем повезло с умением писать сразу код без ошибок, который в последствии не требует сопровождения и доработок.

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

    Чем проще система, чем меньше программистов участвует в разработке и чем меньше ущерб от ошибок в ней — тем меньше можно заморачиватся с внутренним качеством.

    Reply ↓
  77. Niki_Pro

    (9) Итак, получилось развернуть, но обо всем по порядку:

    До этого разворачивал SonarQube 7.7 на стандартном порте 9000 — особо не успел разобраться, но он работал.

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

    Оказалось дело в jdk 11, странно что он без нее работал (но как-то криво)

    Так что про jdk не забываем 🙂

    Из статьи не понятен был момент — нужно ли создавать проект с ключем в SonarQube или он автоматом сам создастся?

    Я создал проект, и в файле настроек указал параметры проекта.

    И я в итоге сделал вот так

    …/sonar-scanner.bat -D»project.settings=../sonar-project.properties»

    а дальше в sonar-project.properties указал путь к проекту:

    ***

    sonar.projectBaseDir=С:/myrepos/myprjkt

    ***

    Кстати не забываем что слэш должен быть в файлике настроек именно «/» — а то пару раз косякнул с этим

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

    «Без токена:

    ../sonar-scanner-cli-4.0.0.1744-windowssonar-scanner-4.0.0.1744-windows/bin/sonar-scanner.bat

    С токеном:

    ../sonar-scanner-cli-4.0.0.1744-windowssonar-scanner-4.0.0.1744-windows/bin/sonar-scanner.bat -D»sonar.login=1952877e4d61d69c766eb8d9ca1d39ac48a4254f»

    «

    Reply ↓
  78. olegtymko

    (91) версия 7.9 сонара работает теперь только на java 11, как и последний sonar scanner. Опечатки поправлю, спасибо за внимательность)

    Reply ↓
  79. olegtymko

    (91) по поводу ключей и каталогов — мною специально был заготовлен шаблон проекта и если следовать указаниям, не нужно будет прописывать отдельно путь к настройкам сонар проекта и к рабочему каталогу.

    Reply ↓
  80. Niki_Pro

    (93)

    Протестировал на маленькой базе — все нормально отработало.

    Запустил аналогично на большой базе — 4 часа скрипт работал, и самое что странное ругнулся в самом конце

    ERROR Caused by: GC overhead limit exceded

    что еще странно что процент выполнения проверки файлов тормозиться по экспоненте. И последние 10 файлов проверялись 1 час.

    Попробовал дописать исключение в файл настроек конкретного проекта —

    sonar.exclusions= …. (кстати было бы круто если бы статье был пример шаблонных исключений)

    Но ничего не поменялось.

    Пишут в интернетах про SONAR_SCANER_OPTS — но я не пойму, это переменная среды? Если нет, то где ее надо указать? Где можно посмотреть сколько памяти используется фактически?

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

    Reply ↓
  81. Stepa86

    (101) Сканеру не хватило памяти. У меня такое было при анализе УХи. Переварить регл. отчетность помогло только выдача сканеру 20 гигов оперативы. Вот пример батника

    chcp 65001
@set SONAR_SCANNER_OPTS=-Xmx20g
C:Sonarsonar-scannerinsonar-scanner
    Reply ↓
  82. Stepa86

    (101) в статье как раз эта ситуация описана в разделе проблемы https://infostart.ru/public/1089670/#%D0%9F%D1%80%D0%BE%D0%B1%D0%BB%D0%B5%D0%BC%D0%BD%D1%8B%D0%B5­%20%D1%81%D0%B8%D1%82%D1%83%D0%B0%D1%86%D0%B8%D0%B8

    Reply ↓
  83. Niki_Pro

    (103) спасибо! Проверю:)

    Да в статье описано, но у меня «Parsing files» не застряло где-то, а прошло все 100% и дальше стопорнулось.

    SONAR_SCANNER_OPTS — по идее я эту настройку ранее уже выставил, просто связи с реальностью пока не увидел, возможно где-то очепятался, буду тестировать 🙂

    Reply ↓
  84. Niki_Pro

    (103)

    Проверил. Если ставлю 14Гб, то parsing files стопорится на 82%

    При этом память используется на 98%

    Если ставлю 8Гб, то Parsing files доходит почти до конца, но на 10-20 последних файлах все валится.

    Какие решения вижу я — попробовать исключить ряд 1С-

    модулей оригинальной конфы. Но решение так себе.

    Конечно, увеличив мощность сервака, наверное все сработает, но может есть другой вариант?

    Второй вариант — разбить на два проекта, по принципу — в первом проекте только справочники, во второй только документы.

    Есть еще идеи? Может еще что то можно подкрутить?

    Reply ↓
  85. olegtymko

    (111) типовая конфигурация? мб исключить регламентированные отчёты.

    Reply ↓
  86. CMblCL

    (11) А какую версию v8unpack используете? Пытаюсь парсить обычные формы при помощи вашего скрипта получаю исключение:

    «Внешнее исключение System.Reflection.TargetInvocationException): Адресат вызова создал исключение.»

    Reply ↓
  87. olegtymko

    (122) попробуйте все тоже самое, но на версии OneScript 1.0.21

    Reply ↓
  88. CMblCL

    (123) Помогло, спасибо

    Reply ↓
  89. roman_1379

    (11)

    (123)

    Добрый день.

    Пытаюсь использовать скрипт https://github.com/otymko/acc-export/blob/master/run.os под Windows но где взять библиотеку v8unpack? Не дадите ссылку? В инете нахожу только для unix или исполняемый exe файл

    (123)

    Reply ↓
  90. GreenDragon

    (25) Пропустил диспут в телеге, но вот с термина «игрушка» приорал знатно. Особенно когда в курсе цен на эту игрушку и затрат, которые несутся без неё.

    Reply ↓
  91. olegtymko

    (173) Иногда такие «игрушки» спасают много жизней в продакшене. =)

    Reply ↓
  92. GreenDragon

    (174) Именно. Я буквально из под палки заставляю коллег код-ревью делать. И им каждый раз «некогда», несмотря на 6-7 значные суммы убытков из-за простоя базы дольше 15 минут. А с сонаром хотя бы часть ошибок не окажется в продакшене. Соответственно меньше претензий к нашему отделу со стороны руководства.

    Reply ↓
  93. GreenDragon

    (33) реклама качественного кода. Только вот непонятно — каким образом к этому «малолетки» привязаны. Мне вот 39, а я «повёлся» на статью.

    Reply ↓

Leave a Comment

Ваш адрес email не будет опубликован. Обязательные поля помечены *