Контроль версий в Subversion

Если не предполагается разработка с использованием SVN, то при включенном режиме разработки в файловой системе последовательность создания пакета ничем не отличается от обычного режима.

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

1. Создать пакет в приложении 

На вкладке [ Пакеты ] ([ Packages ]) раздела [ Конфигурация ] ([ Configuration ]) в контекстном меню выбрать действие [ Добавить ] ([ Add ])).

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

Карточка пакета

2. Выгрузить созданный пакет в файловую систему 

Выполнить действие [ Выгрузить пакеты в файловую систему ] ([ Download packages to file system ]).

В результате пустой пакет будет выгружен в каталог Путь к установленному приложению\Terrasoft.WebApp\Terrasoft.Configuration\Pkg\sdkPackageInFileSystem.

3. Создать необходимые каталоги для пакета в хранилище SVN 

Чтобы создать каталоги для пакета, используя клиентское приложение для работы с SVN (например, TortoiseSvn), необходимо перейти в репозиторий, указанный в карточке пакета. Затем в репозитории создать каталог, название которого совпадает с названием созданного в приложении пакета.

В созданном каталоге необходимо создать подкаталоги branches и tags, т.е. повторить плоскую структуру пакетов Creatio. В завершение в каталоге branches необходимо создать каталог, название которого совпадает с номером версии пакета — 7.10.0.

Плоская структура пакета в хранилище

4. Создать рабочую копию версионной ветки пакета 

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

Выгрузка из хранилища рабочей копии версионной ветки пакета

Подтверждение выгрузки в существующий каталог

В результате каталог пакета в файловой системе Путь к установленному приложению\Terrasoft.WebApp\Terrasoft.Configuration\Pkg\sdkPackageInFileSystem станет связанным с веткой версии 7.10.0 пакета в хранилище.

5. Зафиксировать в хранилище каталог пакета 

Чтобы зафиксировать каталог пакета необходимо добавить в хранилище все содержимое Путь к установленному приложению\Terrasoft.WebApp\Terrasoft.Configuration\Pkg\sdkPackageInFileSystem и выполнить фиксацию.

Добавление в хранилище

Фиксация в хранилище

Последовательность установки пакета из хранилища SVN в режиме разработки в файловой системе 

1. Установить пакет в файловую систему.
2. Установить пакет в приложение.
3. Выполнить генерацию исходных кодов.
4. Скомпилировать изменения.
5. Обновить структуру базы данных.
6. При необходимости установить SQL-сценарии и привязанные данные.

<add key="AutoUpdateOnCommit" value="true" />
<add key="AutoUpdateDBStructure" value="true" />
<add key="AutoInstallSqlScript" value="true" />
<add key="AutoInstallPackageData" value="true" />

Ключ AutoUpdateOnCommit отвечает за автоматическое обновление пакетов из SVN перед их заливкой. Если для этого ключа установлено значение false, то перед заливкой в SVN приложение предупредит пользователя о необходимости обновления в случае, если схемы пакета были изменены. Ключи AutoUpdateDBStructure, AutoInstallSqlScript, AutoInstallPackageData отвечают соответственно за автоматическое обновление структуры базы данных, автоматическую установку SQL-сценариев и установку привязанных данных.

После включения режима автоматического применения изменений выполнять шаги 3—6 нет необходимости. Включить этот режим необходимо до установки пакета.

http://svn-server:8050/SDKPackages/sdkCreateDetailWithEditableGrid/branches/7.8.0

Алгоритм реализации примера 

1. Установить пакет в файловую систему 

В каталоге приложения ...\Terrasoft.WebApp\Terrasoft.Configuration\Pkg, открытом в Проводнике, необходимо выполнить действие [ SVN Checkout ].

В открывшемся диалоговом окне необходимо указать адрес хранилища, по которому размещено содержимое пакета (1), и каталог для выгрузки содержимого пакета.

После успешной выгрузки в каталоге ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg будет создана рабочая копия пакета.

2. Установить пакет в приложение 

Для установки пакета из файловой системы в приложение в разделе [ Конфигурация ] ([ Configuration ]) необходимо выполнить действие [ Обновить пакеты из файловой системы ] ([ Update packages from file system) ].

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

Информационное окно статуса загрузки пакета в приложение

Пакет на вкладке [ Пакеты ] ([ Packages ])

3. Выполнить генерацию исходных кодов 

Для этого в разделе [ Конфигурация ] ([ Configuration ]) необходимо выполнить действие [ Сгенерировать для требующих генерации ] ([ Generate where it is needed ]).

4. Скомпилировать изменения 

Чтобы скомпилировать изменения, необходимо выполнить действие [ Компилировать измененное ] ([ Compile modified items ]).

5. Обновить структуру базы данных 

После компиляции изменений нужно обновить структуру базы данных действием [ Обновить для требующих обновления ] ([ Update where it is needed ]).

6. Установить SQL-сценарии и привязанные данные (при необходимости) 

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

После успешной установки в приложении станет доступной реализованная в пакете функциональность. В приведенном примере это функциональность детали с редактируемым реестром.

Последовательность привязки существующего пакета к хранилищу 

1. Перейти в режим разработки в файловой системе.
2. Выгрузить пакет в файловую систему.
3. Создать необходимые каталоги для пакета в хранилище SVN.
4. Создать рабочую копию версионной ветки пакета.
5. Зафиксировать в хранилище каталог пакета.

Альтернативный вариант привязки пакета к хранилищу — через прямой запрос в базу данных. Для этого необходимо:

1. В разделе [ Конфигурация ] добавить в приложение информацию о хранилище SVN.
2. Привязать хранилище к пакету. Для этого:
   • В таблице SysRepository считать идентификатор записи, содержащей адрес нужного хранилища SVN.
   • В таблице SysPackage в запись, содержащую имя не привязанного к хранилищу SVN пакета, в колонку [ SysRepositoryId ] добавить полученный идентификатор.

Пример. Привязать к хранилищу не связанный с SVN существующий пользовательский пакет UsrUnboundPackage.

URL для доступа к хранилищу SVN

Код скопирован

http://svn-server:8050/SDKPackages

Алгоритм реализации примера 

1. Перейти в режим разработки в файловой системе 

2. Выгрузить пакет в файловую систему 

В разделе [ Конфигурация ] ([ Configuration ]) выполнить действие [ Выгрузить пакеты в файловую систему ] ([ Download packages to file system ]).

В результате пакет будет выгружен в каталог ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg\UsrUnboundPackage.

3. Создать необходимые каталоги для пакета в хранилище SVN 

Чтобы создать каталоги для пакета, используя клиентское приложение для работы с SVN (например, TortoiseSvn), необходимо перейти в репозиторий и создать каталог, название которого совпадает с названием пакета.

В созданном каталоге необходимо создать подкаталоги branches и tags, т.е. повторить плоскую структуру пакетов Creatio. В завершение в каталоге branches необходимо создать каталог, название которого совпадает с номером версии пакета — 7.11.0.

4. Создать рабочую копию версионной ветки пакета 

Чтобы создать рабочую копию версионной ветки пакета, необходимо выгрузить из хранилища каталог, имя которого совпадает с номером версии пакета ([ SVN Checkout ]), в каталог пакета в файловой системе и подтвердить выгрузку в существующий каталог.

Команда [ SVN Checkout ]

Выгрузка из хранилища рабочей копии версионной ветки пакета

Подтверждение выгрузки в существующий каталог

В результате каталог пакета в файловой системе ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg\UsrUnboundPackage станет рабочей копией пакета версии 7.11.0 в хранилище.

5. Зафиксировать в хранилище каталог пакета 

Чтобы зафиксировать в хранилище все содержимое каталога пакета, необходимо выполнить команду [ Add... ] приложения TortoiseSVN, а затем выполнить команду [ SVN Commit... ].

Команда [ Add ]

Диалог выбора элементов для добавления в хранилище

Фиксация в хранилище

В результате все содержимое пакета будет привязано к хранилищу SVN.

Альтернативный вариант реализации примера 

1. В разделе [ Конфигурация ] добавить в приложение информацию о хранилище SVN 

Если информация о нужном хранилище не добавлена в разделе [ Конфигурация ] приложения, то необходимо:

1. Выполнить команду [ Открыть список хранилищ ] ([ Open list of repositories ]).
   
2. В открывшемся окне [ Список хранилищ ] ([ List of repositories ]) при помощи команды [ Добавить ] (1) добавить необходимый репозиторий (2). После этого информация о репозитории отобразится в окне [ Список хранилищ ] (3). Затем необходимо выделить строку с информацией о хранилище и выполнить аутентификацию (4).
   

2. Привязать хранилище к пакету 

Для этого необходимо выполнить SQL- запрос в базу данных приложения.

UPDATE SysPackage 
SET 
    [SysRepositoryId] = 
    (
        select top 1 Id from SysRepository
        where Name = 'SDKPackages'-- Название хранилища.
    )
where [Name]='UsrUnboundPackage'-- Название пользовательского пакета.

Здесь SDKPackages — название хранилища, а UsrUnboundPackage — название пользовательского пакета.

3. Выгрузить пакет в файловую систему 

В разделе [ Конфигурация ] ([ Configuration ]) выполнить действие [ Выгрузить пакеты в файловую систему ] ([ Download packages to file system ]). В результате привязанный к хранилищу пакет будет выгружен в каталог ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg\UsrUnboundPackage.

1. Обновить пакет из хранилища SVN 

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

Чтобы обновить пакет из хранилища SVN:

1. В каталоге ...\Terrasoft.WebApp\Terrasoft.Configuration\Pkg выберите необходимый пакет. В нашем примере это sdkPackageInFileSystem.
2. Обновите пакет (команда [ SVN Update ]).

   После выполнения команды будут обновлены дата редактирования пакета в файле дескриптора пакета descriptor.json и исходный код схемы типа [ Исходный код ] ([ Source code ]) UsrGreetingService.

   Схема UsrGreetingService

   Код скопирован

   namespace Terrasoft.Configuration
   {
       using System.ServiceModel;
       using System.ServiceModel.Activation;
       using System.ServiceModel.Web;
       [ServiceContract]
       [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Required)]
       public class UsrGreetingService : System.Web.SessionState.IReadOnlySessionState
       {
           [OperationContract]
           [WebInvoke(Method = "GET", UriTemplate = "Hello")]
           public string TestHello()
           {
               return "Hello!";
           }
       }
   }

3. Перейдите в дизайнер системы по кнопке .
4. В блоке [ Конфигурирование разработчиком ] ([ Admin area ]) перейдите по ссылке [ Управление конфигурацией ] ([ Advanced settings ]).
5. На панели инструментов в группе действий [ Разработка в файловой системе ] ([ File system development mode ]) выберите [ Обновить пакеты из файловой системы ] ([ Update packages from file system ]).
   
6. Если были изменены схемы объектов или схемы исходного кода, то для применения изменений также необходимо выполнить шаги 3—6 статьи Установить пакет из SVN в режиме разработки в файловой системе.

2. Изменить содержимое пакета 

Чтобы изменить содержимое пакета, добавьте в схему типа [ Исходный код ] ([ Source code ]) UsrGreetingServiceметод TestHelloWorld().

namespace Terrasoft.Configuration
{
    using System.ServiceModel;
    using System.ServiceModel.Activation;
    using System.ServiceModel.Web;
    [ServiceContract]
    [AspNetCompatibilityRequirements(RequirementsMode = AspNetCompatibilityRequirementsMode.Required)]
    public class UsrGreetingService : System.Web.SessionState.IReadOnlySessionState
    {
        [OperationContract]
        [WebInvoke(Method = "GET", UriTemplate = "Hello")]
        public string TestHello()
        {
            return "Hello!";
        }

        [OperationContract]
        [WebInvoke(Method = "GET", UriTemplate = "HelloWorld")]
        public string TestHelloWorld()
        {
            return "Hello world!";
        }
    }
}

3. Зафиксировать пакет в хранилище 

Чтобы зафиксировать пакет в хранилище:

1. В каталоге ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg выберите необходимый пакет. В нашем примере это sdkPackageInFileSystem.
2. Выполните фиксацию (команда SVN Commit) каталога в хранилище.
   

Последовательность создания пакета при переходе в режим разработки в файловой системе 

В режиме разработки в файловой системе после выполнения действия [ Выгрузить пакеты в файловую систему ] ([ Download packages to file system ]) все пользовательские пакеты будут выгружены в каталог ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg. При этом выгруженное в файловую систему содержимое пользовательского пакета не будет привязано к хранилищу SVN даже в том случае, если сам пакет был привязан к хранилищу в разделе [ Конфигурация ].

Если при создании пакета заполнить поле [ Хранилище системы контроля версий ] с помощью встроенных средств, то пакет будет привязан к хранилищу SVN. При этом в файловой системе будет создана рабочая копия пакета. Путь к каталогу, в котором создаются рабочие копии пакетов, задается настройкой defPackagesWorkingCopyPath в файле ConnectionStrings.config.

Эту особенность можно использовать для создания пакета, привязанного к SVN и предназначенного для разработки в файловой системе. Если в настройке defPackagesWorkingCopyPath указать путь к каталогу ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg, то после выгрузки пакета в файловую систему он будет автоматически привязан к нужному хранилищу SVN.

Общая последовательность действий:

1. В настройке defPackagesWorkingCopyPath указать путь к каталогу ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg.
2. В режиме разработки с помощью встроенных средств в разделе [ Конфигурация ] создать пакет, привязанный к хранилищу SVN.
3. В разделе [ Конфигурация ] выполнить фиксацию пакета в хранилище.
4. Перейти в режим разработки в файловой системе.
5. Выгрузить пакет в файловую систему.
6. Добавить новые элементы пакета в хранилище SVN.

Последовательность реализации примера 

1. Изменить настройку defPackagesWorkingCopyPath 

В файле ConnectionStrings.config в настройке defPackagesWorkingCopyPath необходимо указать полный путь к каталогу ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg.

<?xml version="1.0" encoding="utf-8"?>
<connectionStrings>
  ...
  <add name="defPackagesWorkingCopyPath" connectionString="C:\creatio\Terrasoft.WebApp\Terrasoft.Configuration\Pkg/>
  ...
</connectionStrings>

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

2. Создать пользовательский пакет 

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

3. Выполнить фиксацию пакета в хранилище 

Чтобы зафиксировать пакет в хранилище, необходимо выполнить действие [ Зафиксировать пакет в хранилище ] ([ Commit package to repository ]). В появившемся диалоговом окне нужно указать описание изменений (1), а затем нажать кнопку [ OK ]. После завершения фиксации появится соответствующее сообщение (3).

Действие [ Зафиксировать пакет в хранилище ]

Диалоговое окно свойств заливки

В результате пакет будет зафиксирован в SVN, а в каталоге ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg будет создана рабочая копия пакета.

4. Перейти в режим разработки в файловой системе 

Чтобы включить режим разработки конфигурации в файловой системе, необходимо в файле Web.config, который находится в корневом каталоге с установленным приложением, установить значение true для атрибута enabled элемента fileDesignMode.

<fileDesignMode enabled="true"/>

После включения режима разработки в файловой системе в разделе [ Конфигурация ] на вкладке [ Действия ] появятся две кнопки:

• [ Выгрузить пакеты в файловую систему ] ([ Download packages to file system ]) — выгружает пакеты из базы данных приложения в каталог ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg.
• [ Обновить пакеты из файловой системы ] ([ Update packages from file system ]) — загружает пакеты из каталога ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg в базу данных.

5. Выгрузить пакет в файловую систему 

Для выгрузки пакета в файловую систему необходимо выполнить действие [ Выгрузить пакеты в файловую систему ]. В результате все элементы пакета, измененные и созданные с помощью встроенных средств разработки в разделе [ Конфигурация ], будут выгружены в файловую систему в каталог ..\Terrasoft.WebApp\Terrasoft.Configuration\Pkg.

6. Добавить новые элементы пакета в хранилище SVN 

Чтобы в режиме разработки добавить новые элементы пакета в хранилище, необходимо в файловой системе выделить каталог рабочей копии пакета и выполнить команду [ Add... ] клиентского приложения для работы с хранилищем SVN, например, TortoiseSVN.

После этого появится диалоговое окно выбора добавляемых элементов. После выбора нужных элементов необходимо нажать на кнопку [ OK ], после чего отобразится информационное окно о завершении команды добавления новых элементов.

Добавленные элементы будут отмечены, как связанные с хранилищем SVN, но не зафиксированные в нем.

Для фиксации всех измененных и новых элементов пакета в хранилище необходимо выполнить команду [ SVN Commit... ].