Cборка проекта требует от разработчика кучи утомительных операций. Когда менеджеру нужно отчитаться перед заказчиком о ходе работы, разработчик тратит время на выкачивание репозитория, подтягивание библиотек, установку сертификатов, сборку, проверку, выкладывание сборки на сервер и прочие промежуточные этапы. Но на Земле становится всё меньше рутинных действий, которые не подверглись бы автоматизации. Прогрессивная часть девелоперской среды практикует методику непрерывной интеграции (CI), и iOS-отдел компании Лайв Тайпинг решил к ней примкнуть, развернув сервер для сборок на платформе Jenkins. С тех пор началась совсем другая жизнь.

Что мы получили в итоге:

1. Сервер начинает сборку:
   
   1. по веб-хуку в случае push’а в master-ветку;
   2. по команде в чате slack с указанием нужной ветки и доп. параметров.
2. Выполняет Unit и UI-тесты.
3. Получает следующие метрики:
   
   1. покрытие кода тестами;
   2. количество строк кода;
   3. дублирование кода;
   4. цикломатическая сложность кода.
4. Архивирует проект в ipa, далее отправляет его на сервер сборок (собственной разработки) и отправляет в slack ссылку на сборку.

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

Для начала ознакомьтесь со следующими оговорками и поймите, сопоставим ли наш гайд с вашими задачами:

1. сервер разворачивался под нужды iOS-разработки;
2. установка большинства вспомогательных программ через homebrew, включая и сам Jenkins (быстрые обновления и удобство использования);
3. использование xcodebuilder для всех задач сборки-тестирования (отказались от использования xctool из-за невозможности запуска UI-тестов);
4. в качестве репозитория у нас используется GitLab;
5. для хранения сборок мы используем сервер собственной разработки. Для каждой сборки генерируется уникальный URL, и далее достаточно открыть ссылку с мобильного устройства в браузере и нажать «Установить» — благодаря аккаунту Enterprise любой может установить приложение на телефон. Из-за специфичности действий, связанных с отправкой файлов на наш сервер, этот этап в статье не описывается;
6. все наши проекты используют систему управления зависимостями СocoaPods.

Руководство получилось довольно громоздким, и мы решили разбить его на две части. Эта часть посвящена базовой установке и настройке Jenkins.

Что необходимо:

1. Mac c установленным OS X и Xcode (В нашем случае MacBook Pro 2011 года с OS X 10.11.4);
2. несколько часов свободного времени.

1. Создание пользователя Jenkins и его настройка

Пользователя можно создать как через консоль, так и используя GUI. Вряд ли во втором варианте возникнут сложности, поэтому мы лучше рассмотрим первый (источник):

#Создание группы ‘Applications’
dseditgroup -o create -n . -u username -p -r ‘Applications’ applications
#Получение идентификатора для группы
sudo dscl . -read /Groups/applications
#Получение списка идентификаторов для пользователей (будет нужен уникальный идентификатор для пользователя)
sudo dscl . -list /Users UniqueID
#Создание пользователя (значения идентификаторов должны быть уникальными)
sudo dscl . -create /Users/jenkins
sudo dscl . -create /Users/jenkins PrimaryGroupID 777
sudo dscl . -create /Users/jenkins UniqueID 1777
sudo dscl . -create /Users/jenkins UserShell /bin/bash
sudo ddcl . -create /Users/jenkins RealName "Jenkins"
sudo dscl . -create /Users/jenkins NFSHomeDirectory /Users/jenkins
sudo dscl . -passwd /Users/jenkins
#Создание домашней директории и установка прав на неё
sudo mkdir /Users/jenkins
sudo chown -R jenkins /Users/jenkins

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

sudo -u jenkins -i

Внимание: все дальнейшие действия мы совершаем под пользователем Jenkins.

2. Установка необходимых программ

Для установки Jenkins воспользуемся системой управления пакетами Homebrew. В дальнейшем это также упростит процесс установки и обновления дополнительных пакетов, которые мы будем использовать для получения метрик кода.

1. Установка Homebrew
   

   	/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
   

2. Установка jenkins:
   

   	brew install jenkins
   

3. Установка системы управления зависимостями cocoapods:
   

   	sudo gem install -n /usr/local/bin cocoapods
   

Чтобы наш сервер автоматически запускался при старте системы, нам необходимо настроить запуск соответствующей задачи для launchd. У нас есть выбор: сделать это через LaunchAgents или LaunchDaemon. Мы воспользуемся именно LaunchAgents, т.к. это упростит* дальнейшую работу с Jenkins. Достаточно посмотреть на таблицу ниже, чтобы понять это:

	Daemon	Agent
Launch Time	System start	User login
User Type	Non-login	Login
Home Folder	No	Yes
Login Keychain	No	Yes
iOS Simulator	No	Yes
Provisioning Profiles	No	Yes

*Главная проблема запуска через Daemon заключается в том, что нельзя выполнить тестирование, не запустив iOS Simulator (подробнее про разницу использования демона и агента можно прочитать здесь)

Однако из-за выбора LaunchAgents нам нужно решить проблему отсутствия залогиненного пользователя при запуске системы. Для этого необходимо настроить autologin. Мне известен только один способ это сделать: через GUI (Системные настройки -> Пользователи и группы -> Параметры входа -> Автоматический вход). Если кто-то знает, как это сделать через shell — пожалуйста, отпишитесь в комментариях!

Для настройки запуска через LaunchAgents выполним следующие шаги:

1. выгрузим демона (был создан автоматически при установки Jenkins):
   

   sudo launchctl unload /Library/LaunchDaemons/homebrew.mxcl.jenkins.plist
   

2. удалим демона:
   

   sudo rm /Library/LaunchDaemons/homebrew.mxcl.jenkins.plist
   

3. создадим агента:
   

   cd /Users/jenkins/Library/LaunchAgents
   tap homebrew.mxcl.jenkins.plist
   

4. настроим агента, используя vim-редактор:
   

   vim homebrew.mxcl.jenkins.plist
   

Пример содержимого файла plist:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
  <dict>
    <key>Label</key>
    <string>homebrew.mxcl.jenkins</string>
    <key>ProgramArguments</key>
    <array>
      <string>/usr/bin/java</string>
      <string>-Dmail.smtp.starttls.enable=true</string>
      <string>-jar</string>
      <string>/usr/local/opt/jenkins/libexec/jenkins.war</string>
      <string>—httpListenAddress=0.0.0.0</string>
      <string>--httpPort=8080</string>
    </array>
    <key>RunAtLoad</key>
    <true/>
    <key>UserName</key>
    <string>jenkins</string>
  </dict>
</plist>

Здесь стоит обратить внимание на поле httpListenAddress со значением 0.0.0.0 и поле httpPort со значением 8080 — так сервер будет «прослушивать» любые ip-адреса по указанному порту.

Напомню: для закрытия и сохранения файла в редакторе vim вводим :wq
После установки Jenkins доступен по умолчанию по адресу 127.0.0.1 (localhost).
Для доступа из внешней сети можно пробросить порты на маршрутизаторе: 8080 для веб-интерфейса Jenkins и 22 для доступа по ssh.

3. Установка плагинов для Jenkins

Заходим на сервер Jenkins -> Настроить Jenkins -> Управление плагинами. Во вкладке «Доступные» находим и устанавливаем следующие плагины:

1. Role-based Authorization Strategy — обеспечение безопасности. Даёт возможность создания групп пользователей с распределением прав;
2. GitLab Plugin и Gitlab Hook Plugin— плагины для работы с gitlab;
3. Xcode integration — интеграция с Xcode;
4. Keychains and Provisioning Profiles Management — облегчает работу с provisioning profile.

4. Базовая настройка Jenkins

Через веб-интерфейс Jenkins`а заходим в «Настройки», а затем в раздел «Конфигурирование системы». На что здесь стоит обратить внимание:
4.1. Настройки Xcode Builder. Если вы устанавливали Xcode в стандартную директорию, то настройки менять не нужно. В противном же случае необходимо задать путь для указанных компонентов. Учитывая, что мы запустили сервер с использованием LaunchAgents, то Xcode будет иметь доступ к login.keychain. Но если вы хотите подстраховаться, то можете в этом разделе добавить keychain, как указано на скриншоте.



Теперь мы можем загрузить необходимые сертификаты через GUI или через shell в login.keychain, а Xcode будет автоматически подтягивать нужные ему во время сборки.

4.2. Для настройки доступа по ssh делаем так:

1. генерируем shh-ключ, если его нет (инструкцию для примера можно найти здесь);
2. добавляем ключ в разделе CVS;
   
   
   
   
3. для доступа к GitLab перейдём в раздел Credentials на главной странице веб-интерфейса Jenkins. Здесь необходимо добавить закрытый ключ для нашего пользователя (Jenkins в данном случае пользователь, зарегистрированный в GitLab). Вы можете вставить его непосредственно, как показано на примере ниже, или же указать путь к нему:
   
   
   
   
4. в настройках самого GitLab необходимо указать соответствующий открытый ключ:
   
   
   

4.3. Для настройки безопасности воспользуемся плагином Role-based Authorization Strategy. Перейдём в настройки через веб-интерфейс Jenkins, а далее в раздел Manage and Assign Roles. Здесь мы сможем создать различные роли, которые назначаются для пользователей и групп, и определить для них права на те или иные операции. Здесь каждый всё делает на своё усмотрение. Но, если вы настроили внешний доступ к серверу, настоятельно рекомендую убрать все права для пользователя «гость».

5. Создание job’а и настройка сборки проекта

5.1. На главной странице веб-интерфейса Jenkins выбираем «Создать Item». Далее выбираем пункт «Создать задачу со свободной конфигурацией» и вводим название проекта;
5.2. на странице настройки job’а первое, что мы сделаем — это перейдём во вкладку «Управление исходным кодом» и настроим загрузку проекта с GitLab. Здесь нам нужно ввести адрес репозитория нашего проекта, указать, с помощью каких полномочий (credentials) сервер получит доступ к GitLab и какую ветку проекта необходимо собрать:



5.3. Далее переходим в раздел «Сборка». Если вы используете систему управления зависимостями CocoaPods и не добавляете Pod файлы в git, нужно добавить шаг сборки «Выполнить команду shell», в которой запустить установку подов:

#!/bin/bash -l
export LANG=UTF-8
pod install

Тут можно обернуть установку условием, чтобы не устанавливать поды каждый раз. Пример (если файл обновился за последние 60 секунд, то выполнить...):

if [ $(( $(date +"%s") - $(stat -f %m Podfile) )) -le 60 ]; then
        pod install
fi

5.4. Добавляем шаг сборки: Xcode. Если вы используете систему управления зависимостями CocoaPods, то вам не следует указывать значение в поле Target, а в разделе Advanced Xcode build options указать название исполняемой схемы и файла .xcworkspace. Пример минимальной конфигурации показан на скриншотах ниже:




Стоит отметить, что в настройках вашего проекта исполняемая схема должна быть отмечена как shared (контейнер может быть как workspace, так и project):

6. Работа с сертификатами и provisioning profile

Благодаря плагину Keychains and Provisioning Profiles Management можно значительно упростить работу с установкой provisioning profile.

Добавление provisioning profile:

1. переходим в настройки Jenkins;
2. в списке выбираем Keychains and Provisioning Profiles Management;
3. нажимаем кнопку «Выберите файл», находим свой provisioning profile и нажимаем Upload.

Чтобы указать конкретный Provisioning Profile, если это необходимо, то в настройках job’a в разделе «Cреда сборки» нужно установить флаг Mobile Provisioning Profiles и выбрать один из загруженных профайлов:



Затем в настройках Xcode нужно установить custom xcodebuild arguments, как на скриншоте:



Для загрузки сертификата в связку ключей login.keychain можно воспользоваться GUI (просто кликнуть по сертификату), но такая возможность есть не всегда. Поэтому мы рассмотрим чуть более сложный вариант — добавление через ssh:

1. скачиваем нужный сертификат на свой Mac и устанавливаем в локальный keychain access двойным кликом;
2. заходим в keychain access, находим нужный сертификат и экспортируем ключ в формат .p12;
3. передаём сертификат на сервер:
   

   scp certificate.crt jenkins@server:/Users/jenkins
   

   certificate — название сертификата;
   jenkins — имя пользователя;
   server — адрес сервера;
   :/Users/jenkins — путь сохраняемого файла;
   (Можно использовать параметр для указания нужного порта в формате: scp -P 20 certificate.crt jenkins@server:/Users/jenkins)
   
4. передаём ключ на сервер:

   scp privatekey.p12 jenkins@server:/Users/jenkins
   

5. подключаемся к серверу по ssh:
   

   ssh jenkins@server
   

6. Открываем доступ к связке ключей:
   

   security unlock-keychain -p password /Users/jenkins/Library/Keychains/login.keychain
   

7. Устанавливаем сертификат:
   

   security add-certificates ./certificate.crt
   

8. копируем ключ:
   

   security import privatekey.p12 -k /Users/jenkins/Library/Keychains/login.keychain -P password -A
   

Подробнее о команде security можно прочитать здесь.

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

7. Перед запуском

Теперь мы готовы нажать на кнопку Built Now на главной странице веб-интерфейса Jenkins или на странице самого проекта. Жмём и переходим в раздел Console Output начавшейся сборки. Здесь в логах можно найти много полезной информации, включая ошибки.
Если вы всё сделали правильно, то по окончанию сборки в конце лога будет указано: Finished: SUCCESS, а на главной странице Jenkins рядом с названием сборки будет гореть синий индикатор УСПЕХА.
Вот и всё, начальный этап пройден! Скоро появится продолжение статьи, где будет описано, как получить основные метрики кода, заархивировать проект в .ipa и настроить взаимодействие со slack.

Пишите свои вопросы и замечания в комментариях!
Если будет много вопросов касательно какого-либо аспекта, то мы дополним статью!