Merge pull request #12 from ovcharenko-di/develop

v0.3.1

.github/workflows/qa.yml

@@ -2,7 +2,7 @@
 # Copyright (C) 2020 Tymko Oleg <[email protected]> and contributors
 # All rights reserved.
 
-name: Контроль качества
+name: qa
 # Любой пуш и pr в проекте но с фильтром по основному проекту
 on: [push, pull_request]
 

.github/workflows/testing.yml → .github/workflows/tests.yml

@@ -2,7 +2,7 @@
 # Copyright (C) 2020 Tymko Oleg <[email protected]> and contributors
 # All rights reserved.
 
-name: Тестирование
+name: tests
 # Любой пуш и pr в проекте
 on: [push, pull_request]
 

.gitignore

@@ -1,3 +1,4 @@
+/data
 /src/oscript_modules
 /src/data
 /out

Dockerfile

@@ -1,3 +1,8 @@
-FROM evilbeaver/oscript-web:0.7.0
+FROM evilbeaver/onescript:1.4.0
+
+COPY src /app
+WORKDIR /app
+RUN opm install opm && opm install -l
 
-COPY src /app
+FROM evilbeaver/oscript-web:0.7.0
+COPY --from=0 /app .

README.md

@@ -1,14 +1,18 @@
 # reperr
 
+[![quality gate](https://sonar.openbsl.ru/api/project_badges/measure?project=reperr&metric=alert_status)](https://sonar.openbsl.ru/dashboard?id=reperr)
+[![coverage](https://sonar.openbsl.ru/api/project_badges/measure?project=reperr&metric=coverage)](https://sonar.openbsl.ru/dashboard?id=reperr)
+
 Веб-приложение для автоматической обработки ошибок информационных баз, работающих на платформе 1С:Предприятие 8.3.17+
 
 ## Содержание
 
 - [Введение](#введение)
 - [Возможности](#возможности)
 - [Установка и запуск](#установка%20и%20запуск)
-- [Настройка](#настройка)
-- [Ограничения](#ограничения)
+- [Настройка приложения](#настройка%20приложения)
+- [Подключение информационных баз 1С](#подключение%20информационных%20баз%201С)
+- [Особенности и ограничения](#особенности%20и%20ограничения)
 - [Планы по развитию](#планы%20по%20развитию)
 - [Обратная связь и доработка](#обратная%20связь%20и%20доработка)
 - [Зависимости](#зависимости)
@@ -36,77 +40,54 @@
 ### Запуск в docker-контейнере
 
 - клонировать текущий репозиторий
-- внести изменения в `src/appsettings.json` [(подробнее)](#настройка)
-- перейти в каталог `src/` проекта
-- выполнить команду `opm install -l` для установки локальных зависимостей
-- перейти в каталог проекта в командной строке
-- выполнить команду `'docker build -t <tag> .'`, где:
-  - `<tag>` - метка образа, задается произвольно
-- выполнить команду `'docker run -d --name <name> -v <localPath>:<dockerPath> -p <port>:5000 <tag>'`, где:
-  - `<name>` - имя контейнера, задается произвольно
-  - `<localPath>` - локальный каталог, в котором будут храниться данные приложения
-  - `<dockerPath>` - каталог внутри контейнера, в который изначально записываются данные приложения (устанавливается в `appsettings.json`)
-  - `<port>` - локальный порт, на котором будет доступно приложение
-  - `<tag>` - метка образа, заданная на предыдущем шаге
+- внести изменения в `src/appsettings.json` [(подробнее)](#настройка%20приложения)
+- внести изменения в `docker-compose.yml`
+- выполнить команду `'docker-compose up -d'`
 - убедиться, что веб-интерфейс открывается в браузере
-- настроить информационные базы для работы с приложением [(подробнее)](#настройка)
-
-Пример:
-
-Фрагмент `appsettings.json`:
-
-```json
-"DataStorage":{
-            "file": {
-                "enabled": true,
-                "path": "data"
-            }
-        }
-```
-
-`docker build -t reperr .`
-
-`docker run --name reperr -v C:\Users\IIvanov\reperr-data:/app/data -p 1222:5000 reperr`
+- подключить информационные базы 1С [(подробнее)](#подключение%20информационных%20баз%201С)
 
 ### Ручная установка и запуск
 
 - распаковать [OneScript.Web](https://github.com/EvilBeaver/OneScript.Web/releases) в любой локальный каталог
 - клонировать текущий репозиторий
-- внести изменения в `src/appsettings.json` [(подробнее)](#настройка)
-- перейти в каталог `src/` проекта
-- выполнить команду `opm install -l` для установки локальных зависимостей
-- запустить `OneScript.WebHost.exe` (находится в каталоге, куда был распакован [OneScript.Web](http://web.oscript.io/))
+- внести изменения в `src/appsettings.json` [(подробнее)](#Настройка%20приложения)
+- в каталоге `src/` выполнить команду `opm install -l` для установки локальных зависимостей
+- из корневого каталоге проекта запустить `OneScript.WebHost.exe` (см. каталог, в который был распакован [OneScript.Web](http://web.oscript.io/) на первом шаге)
 - убедиться, что веб-интерфейс открывается в браузере
-- настроить информационные базы для работы с приложением [(подробнее)](#настройка)
+- подключить информационные базы 1С [(подробнее)](#подключение%20информационных%20баз%201С)
 
-## Настройка
+## Настройка приложения
 
 Все параметры приложения расположены в файле `src/appsettings.json`.
 
-URL, по которому доступно приложение, надо указать в информационных базах, которые планируется подключить к сервису (Функции для технического специалиста - Стандартные - Управление настройками обработки ошибок - Адрес сервиса регистрации ошибок).
+Подразделы `DataStorage` и `Integrations` содежат списки поддерживаемых хранилищ данных и баг-трекеров соответственно. Приложение считывает эти настройки в момент запуска и использует **первый** активированный способ (`"enabled": true`). Для того, чтобы изменения вступили в силу, достаточно просто перезапустить приложение / контейнер.
+
+## Подключение информационных баз 1С
 
-Раздел `reperrSettings` включает в себя все остальные настройки:
+URL, по которому доступно приложение, необходимо указать в информационных базах, которые требуется подключить к сервису.
 
-Подразделы `DataStorage` и `Integrations` содежат список поддерживаемых хранилищ данных и баг-трекеров соответственно. Приложение считывает эти настройки в момент запуска и использует **первый** активированный способ (`"enabled": true`).
+Расположение настроек:
+Функции для технического специалиста -> Стандартные -> Управление настройками обработки ошибок -> Адрес сервиса регистрации ошибок.
 
 ## Требования
 
 - [OneScript.Web](http://web.oscript.io/) 0.7.0 (на других версиях работоспособность не проверялась)
-- 1С:Предприятие 8.3.17+ (в более младших версиях отсутствуют необходимые [возможности](https://its.1c.ru/db/v8317doc#bookmark:dev:TI000002264) платформы)
+- 1С:Предприятие 8.3.17+ (в более младших версиях отсутствуют необходимые [возможности платформы](https://its.1c.ru/db/v8317doc#bookmark:dev:TI000002264))
 
-## Ограничения
+## Особенности и ограничения
 
+- настройки регистрации ошибок хранятся внутри информационной базы, поэтому может потребоваться ручное отключение регистрации ошибок в копиях информационных баз.
+- на данный момент механизм регистрации ошибок не предоставляет практически никакой информации об информационной базе, в которой произошла ошибка.
 - ошибки регистрируются в баг-трекере от имени владельца API-ключа, а не от лица пользователя информационной базы.
 - веб-интерфейс пока почти полностью состоит из заглушек.
 - какие-либо ограничения доступа на уровне веб-приложения отсутствуют. Любой, кто сможет открыть веб-интерфейс, сможет просматривать всю информацию.
-- на данный момент приложение опубликовано в статусе альфа версии. Обратная совместимость в последующих версиях не гарантируется.
 - отправка присоединенных файлов в точку обмена RabbitMQ пока не поддерживается.
 
 ## Планы по развитию
 
 - настройка приложения с нуля через веб-интерфейс
 - передача API-ключей для баг-трекеров через переменные окружения
-- поддержка СППР ред. 1 и 2 в качестве баг-трекера
+- поддержка YouTrack, СППР ред. 1 и 2 в качестве баг-трекера
 - гибкая настройка параметров регистрации ошибок
   - определение необходимости регистрации ошибки
   - кастомизация сообщения, которое выводится пользователю

docker-compose.yml

@@ -0,0 +1,8 @@
+reperr:
+  build: .
+  ports:
+    - 5000:5000
+  volumes:
+    - ./data:/app/data
+  environment:
+    ASPNETCORE_ENVIRONMENT: Production

src/packagedef

@@ -1,5 +1,5 @@
 Описание.Имя("reperr")
-	.Версия("0.3.0")
+	.Версия("0.3.1")
 	.ЗависитОт("fs")
 	.ЗависитОт("json")
 	.ЗависитОт("1connector")