Анализ вашего кода с помощью SonarQube, запущенного через образ Docker

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

Предпосылки

• Любые базовые знания языков программирования.
• Понимание основных концепций ООП

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

Цели обучения

• Как выполнять анализ SonarQube с помощью образа Docker
• Как анализировать приложение C# с помощью образа Docker

Начало работы

Запуск SonarQube на локальном компьютере иногда может быть обременительным из-за сложных требований к настройке, но Docker может упростить этот процесс. Docker — это платформа для создания, доставки и запуска контейнерных приложений. Docker предоставляет простой в использовании интерфейс для управления и развертывания приложений и может использоваться для запуска SonarQube.

В этой статье мы рассмотрим шаги для запуска SonarQube через образ Docker:

Шаг 1. Установите Docker

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

Шаг 2. Извлеките изображение SonarQube

После установки Docker следующим шагом будет извлечение образа SonarQube из Docker Hub. Вы можете сделать это, выполнив в терминале следующую команду:

docker pull sonarqube

Эта команда загрузит последний образ SonarQube из Docker Hub.

Шаг 3. Запустите контейнер SonarQube

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

docker run -d --name sonarqube -p 9000:9000 sonarqube

Эта команда запустит контейнер SonarQube и откроет порт 9000 на хост-компьютере. Вы можете получить доступ к веб-интерфейсу SonarQube, открыв веб-браузер и перейдя по адресу http://localhost:9000.

Шаг 4. Анализ кода с помощью SonarQube

Запустив и запустив контейнер SonarQube, вы можете проанализировать свой код, выполнив следующие действия:

1. Создайте аналитический отчет SonarQube для своей кодовой базы.
2. Скопируйте отчет в контейнер SonarQube.
3. Запустите анализ SonarQube, выполнив следующую команду:

docker exec sonarqube /opt/sonar-scanner/bin/sonar-scanner 
   -Dsonar.projectKey=<project_key> 
   -Dsonar.sources=<path_to_code> 
   -Dsonar.host.url=http://localhost:9000 
   -Dsonar.login=<token>

Анализ приложения C# с помощью SonarQube через образ Docker

Шаг 1. Добавьте сканер SonarQube для MSBuild в свой проект

SonarScanner для MSBuild — это инструмент .NET Core, который помогает интегрировать анализ SonarQube в процесс MSBuild. Вы можете добавить SonarScanner для MSBuild в свой проект, выполнив в терминале следующую команду:

dotnet tool install --global dotnet-sonarscanner

Шаг 2. Создайте аналитический отчет SonarQube

После установки SonarScanner для MSBuild следующим шагом будет создание аналитического отчета SonarQube для вашего проекта C#. Вы можете сделать это, выполнив в терминале следующую команду:

dotnet sonarscanner begin /k:"<project_key>" /d:sonar.host.url="http://localhost:9000" /d:sonar.login="<token>"

Замените <project_key> уникальным идентификатором вашего проекта и <token> маркером аутентификации для вашего экземпляра SonarQube.

Эта команда начнет анализ SonarQube и создаст отчет для вашего проекта C#.

Шаг 3. Создайте проект C#

Затем создайте проект C# с помощью следующей команды:

dotnet build

Эта команда скомпилирует ваш код C# и создаст двоичный исполняемый файл.

Шаг 4. Проанализируйте свой проект C# с помощью SonarQube

После сборки проекта C# вы можете проанализировать его с помощью SonarQube, выполнив следующую команду:

dotnet sonarscanner end /d:sonar.login="<token>"

Эта команда завершит анализ SonarQube и загрузит отчет в ваш экземпляр SonarQube.

Шаг 5. Просмотр результатов анализа SonarQube

Теперь, когда анализ завершен, вы можете просмотреть результаты в веб-интерфейсе SonarQube, перейдя по адресу http://localhost:9000. В интерфейсе SonarQube вы можете увидеть информацию о качестве кода, охвате кода и других показателях вашего проекта C#.

Заключение

Вот оно! Следуя этим шагам, вы сможете быстро проанализировать свое приложение C# с помощью SonarQube через образ Docker. SonarQube может помочь вам выявить проблемы с качеством кода и улучшить общую ремонтопригодность вашей кодовой базы.

:::информация Также опубликовано здесь.

:::