Практикум

Как автоматически выполнять анализ кода при помощи Team Build

Область применения

• Microsoft® Visual Studio® 2005 Team Foundation Server (TFS) .
• Microsoft Visual Studio Team System.

Описание

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

Содержание

• Задача.
• Обзор.
• Порядок операций.
• Прежде всего.
• Шаг 1 - тестирование сборки.
• Шаг 2 - включение анализа кода в сборку.
• Шаг 3 - тестирование анализа кода.
• Дополнительные ресурсы.

Задача

• Выполнить анализ кода в составе сборки с целью контроля ее качества.

Обзор

Visual Studio Team System Team Build позволяет определять для проекта типы сборки, благодаря которым сервер способен компилировать приложение и предоставлять его для доступа на общем сетевом ресурсе. Если в сценарий сборки включен анализ кода, он будет автоматически выполняться при каждой сборке, а отчет о его результатах будет выкладываться на странице отчетов о результатах сборки. В этой статье подробно разбирается процесс настройки сценария сборки и включения в него этапа анализа кода.

Порядок операций

• Шаг 1 - тестирование сборки.
• Шаг 2 - включение анализа кода в сборку.
• Шаг 3 - тестирование анализа кода.

Прежде всего

Прежде чем включить анализ кода в сценарий сборки, необходимо убедиться в следующем:

• Ваш пользовательский идентификатор Team Foundation обладает разрешением на администрирование сборки. Уточните у администратора, обладаете ли вы таким разрешением.
• Сценарий сборки для вашего проекта уже существует. Проверить это можно, посмотрев на содержимое узла Team Build в Visual Studio Team Explorer.

Шаг 1 - тестирование сборки

Перед включением анализа кода протестируйте сценарий сборки, чтобы убедиться в отсутствии проблем. Это делается следующим образом:

1. В Visual Studio откройте Team Explorer.
2. Разверните узел своего командного проекта.
3. Разверните узел Team Builds.
4. Щелкните правой кнопкой мыши существующий сценарий сборки и выберите Build Team Project.
5. Убедитесь в успешном выполнении сборки. Если сборка выполнена со сбоем или вовсе не завершена, исправьте ошибки, прежде чем переходить к следующему этапу.

Шаг 2 - включение анализа кода в сборку

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

1. Откройте Source Control Explorer.
2. Разверните папку своего командного проекта.
3. Разверните папку TeamBuildTypes.
4. Выберите папку типа сборки, в который хотите включить анализ кода.
5. Извлеките версию файла TFSBuild.proj из системы управления исходным кодом для редактирования. Возможно, сначала вам понадобиться выполнить операцию Get Latest Version.
6. Откройте файл TFSBuild.Proj, дважды щелкнув его в Source Control Explorer.
7. Если требуется выполнять анализ кода для всех проектов независимо от их настроек, присвойте тегу <RunCodeAnalysis> значение Always.
8. Если вы хотите выполнять анализ кода в зависимости от настроек проекта, присвойте тегу <RunCodeAnalysis> значение Default.
9. При использовании индивидуальных настроек для каждого проекта анализ кода для проекта включается следующим образом:
   • Откройте решение в Visual Studio.
   • В Solution Explorer щелкните проект правой кнопкой мыши.
   • Выберите команду Properties.
   • Щелкните Code Analysis.
   • Установите флажок Enable Code Analysis.
   • Извлеките файл проекта .csproj из системы управления исходным кодом для редактирования.
   • Сохраните файл, щелкнув значок Save на панели инструментов при открытом окне свойств.
   • Верните файл .csproj в систему управления исходным кодом.
10. Сохраните TFSBuild.proj и верните его в систему управления исходным кодом.

Шаг 3 - тестирование анализа кода

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

1. В Team Explorer щелкните правой кнопкой мыши тип сборки и выберите команду Build Team Project.
2. По завершении сборки щелкните ссылку на ее журнал.
3. Просмотрите предупреждения анализа кода, приведенные в конце журнала сборки. Их идентификаторы начинаются с "CA" , как в следующих примерах:
   • MSBUILD : warning : CA2209 : Microsoft.Usage : No valid permission requests were found for assembly 'HelloWorldTest'. Yo u should always specify the minimum security permissions using SecurityAction. RequestMinimum.
   • MSBUILD : warning : CA2210 : Microsoft.Design : Sign 'HelloWorldTest' with a strong name key.
   • MSBUILD : warning : CA1014 : Microsoft.Design : 'HelloWorldTest' should be marked with CLSCompliantAttribute and its value should be true.

Дополнительные ресурсы

• Дополнительную информацию об инструментах анализа кода вы найдете в статье "Guidelines for Using Code Analysis Tools" по адресу http://msdn2. microsoft.com/en-us/library/ms182023(VS.80).aspx.
• Типы сборки подробно рассматриваются в статье "Overview of Team Foundation Build" по адресу http://msdn2.microsoft.com/en-us/library/ ms181710(VS.80).aspx.