5 Групова розробка програмного забезпечення за допомогою системи контролю версій sourcejammer

5.1 Мета роботи

Одержати навички роботи з системою контролю версій SourceJammer; навчитись розробляти структуру архіву, розподілювати привілеї доступу, отримати навички праці з файлами за допомогою систем контролю версій.

5.2 Методичні вказівки з організації самостійної роботи студентів

5.2.1 Основи методології використання систем контролю версій на прикладі SourceJammer

Виконання робіт за допомогою системи контролю версій SourceJammer складається, як правило, з таких кроків:

1. Створення архіву на сервері.

2. Підключення до серверу, створення користувачів та надання їм привілеїв, необхідних для виконання їх функціональних обов’язків.

3. Створення базової версії програмного продукту, визначення файлів та каталогів, які необхідно додати до архіву на сервері, та додання цих файлів та каталогів до архіву. При цьому структура каталогів в архіві на сервері та на локальному комп’ютері можуть відрізнятися.

4. Проектування структури архіву сервера: розробка структури каталогів, позначення файлів, які мають використовуватися в різних каталогах архіву, але не повинні створювати дублювання коду тощо.

Наступна робота розробників з створеним архівом складається з наступних кроків:

1. Підключення до SourceJammer архіву.

2. Отримання проекту та встановлення необхідних локальних каталогів для серверних директорій (якщо архів вперше використовується на даному комп’ютері або даним користувачем).

3. Відкриття каталогу, необхідного для праці.

4. Аналіз стану файлів каталогу.

5. Отримання останніх версій файлів з серверу.

6. Позначення файлів, які користувач буде змінювати, таким чином, щоб інші користувачі, що працюють з даним архівом, не мали змоги вносити зміни (check-out).

7. Виконання роботи.

8. Позначення файла як такого, що можна змінювати, та відправка останніх змін на сервер (check-in).

5.2.2 Структура та основні операції клієнтської частини системи контролю версій SourceJammer

Клієнтська частина системи SourceJammer має такі складові: головне меню, яке відображає усі операції, що можуть бути здійснені в даній системі контролю версій; панелі інструментів, які маю кнопки для виклику найпоширеніших операцій; робоча область.

Робоча область в свою чергу складається з двох частин. Частина зліва призначена для відображення деревоподобної структури каталогів в архіві серверу. Ім’я найвищого каталогу в цьому дереві відповідає імені архіву на сервері. Зверніть увагу, що це дерево будується за допомогою алгоритму «лінивої побудови», тому напроти каталогів, що не мають підкаталогів, також відображається символ +.

Частина справа призначена для відображення списку файлів та їх атрибутів у обраному каталозі та порівняння цих даних з даними аналогічного каталогу в архіві на сервері.

5.2.3 Створення та настройка архіву на SourceJammer-сервері

Після отримання у викладача імені користувача, пароль та адреси (надалі URL) розміщення SourceJammer-серверу необхідно виконати створення нового архіву. Для цього виконайте команду “Archive->Make Archive” з головного меню клієнтської частини програми. Вкажіть ім’я для архіву, URL розміщення серверу SourceJammer, який має вигляд http://www.mysourcejammersite.com/ sourcejammer/servlet/rpcrouter, а також ім’я користувача та пароль, який надав викладач (після установки серверу існує користувач admin з паролем admin).

Після створення архіву виконують створення запису про підключення до нього. Для цього виберіть команду “Connection->Connect->New” головного меню, вкажіть ім’я, яке буде позначати архів на вашому комп’ютері (alias), URL розміщення серверу SourceJammer, а також ім’я архіву, який вже існує на сервері.

Після того як підключення створене, воно зберігається клієнтською частиною системи і використовується надалі для встановлення фізичного з’єднання з сервером.

Надалі необхідно встановити з’єднання з архівом на сервері та розмістити першу базову версію програми на сервері, настроїти відображення файлів (за принципом дії ярлика; відображення файлів конфігурується на сервері, його результати мають силу для всіх користувачів, що працюють з системою), настроїти відображення серверних каталогів на локальні каталоги комп’ютера (конфігурується локально для кожного користувача).

Для встановлення локального каталогу архіву виберіть ім’я архіву у списку зліва, викличте контекстне меню та виберіть пункт “Set Default Directory”. Усі підкаталоги у архіві будуть наслідувати настройку локального каталогу, додаючи до неї своє ім’я. Якщо для будь-якого підкаталогу встановити цю опцію вручну, то наслідування зверху буде відмінене.

Після встановлення локального каталогу список у правій частині вікна клієнтської частини буде відображати ситуацію в каталозі: червоним будуть помічені файли, що існують лише в локальному каталозі, синім – лише в архіві, зеленим – випадки, якщо версії файлів в каталозі і архіві не співпадають.

Додати файли до архіву можна, виділивши файли, що помічені червоним, та обрати пункт “Add File(s)” з контекстного меню, або використовуючи пункт “Add File(s)” з контекстного меню каталогу, що є активним. При доданні файлів можна додати їх короткий опис, який надалі можна подивитися чи змінити за допомогою пункту “Change File Description” з контекстного меню файла.

Увага!При роботі в операційній системі Windows необхідно внести деякі зміни в конфігурацію клієнтського додатка SourceJammer. Для цього оберіть пункт “View->Preferences…” головного меню вікна, перейдіть на вкладку “Advanced” та встановіть значення “attrib –r” для поля “Make file writable command for your OS”. Змінення цієї настройки може викликати зміну зовнішнього вигляду (skin) клієнтського додатка SourceJammer. Для настроювання зовнішнього вигляду використовуйте вкладу “View” того самого вікна та оберіть варіант зовнішнього вигляду в пункті “Select look and feel”. Рекомендується обирати варіант “Kunststoff”.

В рамках настроювання серверного архіву можна виконати операції створення підкаталогів на сервері (пункт “Make Folder” з контекстного меню батьківського каталогу) та настроювання відображення файлів.

Для настроювання відображення файлів використовуються пункти “Share File(s)”, “Branch File(s)”, “Remove File Share” з контекстного меню файлів. Для створення відображення файла використовується пункт “Share File(s)”. Далі необхідно обрати каталог, в який буде відображений файл. Отже, повинен існувати ще один каталог окрім того, в якому знаходиться файл. При цьому файл залишається єдиним, а на нього лише створюється посилання. Пункт “Remove File Share” використовується для відміни відображення файла. Пункт “Branch File(s)” дозволяє розірвати взаємозв’язок між первинним файлом та його відображенням та перетворити відображення на копію файла.

5.2.4 Робота з програмним проектом в системі контролю версій проектів SourceJammer

Для роботи із системою контролю версій проектів SourceJammer необхідно встановити з’єднання із сервером встановленим шляхом. Далі необхідно задати локальний каталог для відображення структури каталогів серверу для всього архіву (якщо користувач, який виконував з’єднання, на даному комп’ютері ще не робив цього), та для підкаталогів, якщо це потрібно (використання наслідування для цих каталогів не відповідає вимогам користувача).

Список в правій частині вікна клієнтського додатка системи SourceJammer буде відображати перелік файлів, їх стан (порівняння клієнтського та серверного каталогів), дату створення, кількість версій, розмір, ім’я користувача, що позначив файл як недосяжний для модифікації, та дату цієї дії.

Надалі при роботі з системою контролю версій користувач зазвичай одержує останні версії файлів, яких немає в його локальному каталозі (позначені синім), та версії файлів, що змінилися з моменту останньої роботи користувача (позначені зеленим). Ця дія виконується за допомогою пункту “Get Folder” з контекстного меню каталогу, або пункту “Get File(s)” з контекстного меню файла. При використанні пункту “Get Folder” можна вказати такі додаткові параметри, як дозвіл на отримання підкаталогів (прапорець “Recursive” в діалоговому вікні) та дозволяння на створення підкаталогів у разі необхідності, якщо вони не існують (прапорець “Build sib-directories” в діалоговому вікні). В деяких випадках система SourceJammer не виконує автоматичне поновлення списку файлів та їх стану – використовуйте для цього пункт “Refresh” з контекстного меню каталогу.

Після отримання всіх необхідних файлів та виконання операції поновлення ці файли повинні втратити синє або зелене позначення.

Надалі користувач обирає файли, з якими він буде працювати, та позначає їх як недосяжні для модифікації (якщо, звичайно, ці файли не зайняті іншими користувачами) – пункт “Check Out File(s)” з контекстного меню файлів. Далі користувач виконує необхідну роботу, а потім звільняє файли та додає виконані зміни до архіву на сервері) – пункт “Check In File(s)” з контекстного меню файлів. Виконання цих операцій змінюють іконки файлів у списку. Якщо цього не відбулося, використовуйте операцію поновлення.

При виконанні операції звільнення файла можна додати коментар для створюваної версії. Надалі його можна перевірити за допомогою діалогового вікна “File Details”, що викликається за допомогою пункту “Details…” контекстного меню файла. Це вікно складається з трьох закладок, що відображають інформацію про версії файла, загальну інформацію про файл та його описання, що було задано при першому доданні файла до архіву, та інформацію про створення відображень та копій файла відповідно.

Найважливіша вкладка цього вікна – вкладка “History”. Вона дозволяє не лише переглядати інформацію, але і здійснювати управління версіями файла (за наявності достатніх привілеїв). За допомогою цього вікна можна подивитися коментарій до кожної із версій файла (коментар задається в ході виконання операції звільнення файла). Для цього необхідно виділити відповідну версію та нажати кнопку “View Comment”. Кнопка “Get Version” дозволяє отримати відповідну версію файла в локальний каталог, проте ніяких змін на сервері не відбувається. Кнопка “View Differences” дозволяє викликати стандартне для SourceJammer діалогове вікно для виконання порівняння файлів. Для використання цієї операції необхідно виділити дві версії. Кнопка “Rollback” дозволяє повернутися до будь-якої версії, ця версія додається заново та стає активною. Всі наступні зміни цього файла в архіві будуть відбуватися на базі цієї версії. Конфігурування версій відбувається на сервері та вимагає наявності достатніх привілеїв.

5.3 Опис програмного продукту, який використовується для виконання лабораторної роботи

Для виконання лабораторної роботи використовується система контролю версій проектів SourceJammer 2.1.0.0.