Настройка Allure для Gitlab (self-hosted)

# save it as /etc/gitlab/nginx-tweaks-map.conf
# and in /etc/gitlab/gitlab.rb edit
# nginx['custom_nginx_config'] = "include /etc/gitlab/nginx-tweaks-map.conf;"
# this loads to http-section of nginx.conf
# this config file is required for nginx-tweaks.conf

map $uri $file_extension {
  default "";
  ~\.([0-9a-z]+)$ $1;
}

map $file_extension $new_content_type {
  default 'text/plain';
  css 'text/css';
  csv 'text/csv';
  html 'text/html';
  ico 'image/vnd.microsoft.icon';
  js 'text/javascript';
  jpg 'image/jpeg';
  jpeg 'image/jpeg';
  json 'application/json';
  md 'text/markdown';
  png 'image/png';
  txt 'text/plain';
}

# save it as /etc/gitlab/nginx-tweaks.conf
# and in /etc/gitlab/gitlab.rb edit
# nginx['custom_gitlab_server_config'] = "include /etc/gitlab/nginx-tweaks.conf;"
# this loads to server-section of nginx.conf
# this conf depends on nginx-tweaks-map.conf

location ~ /artifacts/file/.*\.(css|csv|html|ico|js|jpg|jpeg|json|md|png|txt)$ {
  rewrite ^(.*)/file/(.*)$ $1/raw/$2 last;
  return 500;
}

location ~ /artifacts/raw/.*\.(css|csv|html|ico|js|jpg|jpeg|json|md|png|txt)$ {
  proxy_cache off;
  proxy_pass http://gitlab-workhorse;
  proxy_hide_header Content-Disposition;
  add_header Content-Disposition 'inline;';
  proxy_hide_header Content-Type;
  add_header Content-Type $new_content_type;
}

{
"name": "Gitlab",
"type": "gitlab",
"url": "https://gitlab.site",
"buildOrder": "123",
"buildName": "group/project-branch #123",
"buildUrl": "https://gitlab.site/group/project/-/pipelines/123",
"reportUrl": "https://gitlab.site/group/project/-/jobs/1234/artifacts/file/out/allure-report/index.html",
"reportName": "Allure report #123 28.11.2023"
}

// Генерирует файл ../executor/executor.json c информацией о текущем запуске
// Файл будет использован в следующем скрипте после генерации отчета Allure

#Использовать 1connector
#Использовать cmdline
#Использовать logos

Функция ПолныйПуть(Знач Путь, Знач КаталогПроекта = "")
	Перем ФайлПуть;
	Если ПустаяСтрока(Путь) Тогда
		Возврат Путь;
	КонецЕсли;
	Если ПустаяСтрока(КаталогПроекта) Тогда
		КаталогПроекта = ".";
	КонецЕсли;
	Если Лев(Путь, 1) = "." И КаталогПроекта <> Путь Тогда
		Путь = ОбъединитьПути(КаталогПроекта, Путь);
	КонецЕсли;
	ФайлПуть = Новый Файл(Путь);
	Возврат ФайлПуть.ПолноеИмя;
КонецФункции // ПолныйПуть()

СписокИсполнителей = Новый Массив;
СтатусУспех = "SUCCESS";
buildUrl = "https://gitlab.chel/%1/-/pipelines/%2";
reportUrl = "https://gitlab.chel/%1/-/jobs/%2/artifacts/file/%3/index.html";
reportName = "Allure report #%1 %2";
ВсегоЗаписей = 5;

Лог = Логирование.ПолучитьЛог("doc.executors.generation");
Лог.УстановитьУровень(УровниЛога.Ошибка);

Парсер = Новый ПарсерАргументовКоманднойСтроки();
Парсер.ДобавитьИменованныйПараметр("--result-folder"); // Папка с файлом executor.json
Парсер.ДобавитьИменованныйПараметр("--report-folder"); // Папка с готовым отчетом
Парсер.ДобавитьИменованныйПараметр("--project-path"); // Имя проекта например dp/doc
Парсер.ДобавитьИменованныйПараметр("--ref-name"); // Имя ветки разработки, например develop
Парсер.ДобавитьИменованныйПараметр("--pipeline-id");
Парсер.ДобавитьИменованныйПараметр("--job-id");
Параметры = Парсер.Разобрать(АргументыКоманднойСтроки);

pipeline_id = Параметры["--pipeline-id"];
job_id = Параметры["--job-id"];

Исполнитель = Новый Структура("name,type,url", "Gitlab", "gitlab", "https://gitlab.chel");
Исполнитель.Вставить("buildOrder", pipeline_id);
Исполнитель.Вставить("buildName", СтрШаблон("%1-%2 #%3", Параметры["--project-path"], Параметры["--ref-name"], pipeline_id));
Исполнитель.Вставить("buildUrl", СтрШаблон(buildUrl, Параметры["--project-path"], pipeline_id));
Исполнитель.Вставить("reportUrl", СтрШаблон(reportUrl, Параметры["--project-path"], job_id, Параметры["--report-folder"]));
Исполнитель.Вставить("reportName", СтрШаблон(reportName, pipeline_id, Формат(ТекущаяДата(), "ДЛФ=Д")));

Каталог = Новый Файл(ПолныйПуть(Параметры["--result-folder"]));
Если Не Каталог.Существует() Тогда
	СоздатьКаталог(Каталог.ПолноеИмя);
КонецЕсли;

ПутьКФайлу = ПолныйПуть(Параметры["--result-folder"]) + "/executor.json";
ЗаписьJSON = Новый ЗаписьJSON();
ЗаписьJSON.ОткрытьФайл(ПутьКФайлу);
ЗаписатьJSON(ЗаписьJSON, Исполнитель);
ЗаписьJSON.Закрыть();

// Генерирует файл /widgets/executors.json
// Данные берутся из последних пайплайнов текущиего проекта\ветки.
// К ним добавляется файл executor.json, который описывает текущий Job,
// который не попадёт в выборку из-за статуса RUNNING, а не SUCCESS.

#Использовать 1connector
#Использовать cmdline
#Использовать logos

Функция ПолныйПуть(Знач Путь, Знач КаталогПроекта = "")
	Перем ФайлПуть;
	Если ПустаяСтрока(Путь) Тогда
		Возврат Путь;
	КонецЕсли;
	Если ПустаяСтрока(КаталогПроекта) Тогда
		КаталогПроекта = ".";
	КонецЕсли;
	Если Лев(Путь, 1) = "." И КаталогПроекта <> Путь Тогда
		Путь = ОбъединитьПути(КаталогПроекта, Путь);
	КонецЕсли;
	ФайлПуть = Новый Файл(Путь);
	Возврат ФайлПуть.ПолноеИмя;
КонецФункции // ПолныйПуть()

СписокИсполнителей = Новый Массив;
СтатусУспех = "SUCCESS";
buildUrl = "https://gitlab.chel/%1/-/pipelines/%2";
reportUrl = "https://gitlab.chel/%1/-/jobs/%2/artifacts/file/%3/index.html";
reportName = "Allure report #%1 %2";
ВсегоЗаписей = 5;
ЗаписейВЗапросе = 15;

Лог = Логирование.ПолучитьЛог("doc.executors.generation");
Лог.УстановитьУровень(УровниЛога.Ошибка);

Парсер = Новый ПарсерАргументовКоманднойСтроки();
Парсер.ДобавитьИменованныйПараметр("--result-folder"); // Папка с файлом executor.json
Парсер.ДобавитьИменованныйПараметр("--report-folder"); // Папка с готовым отчетом
Парсер.ДобавитьИменованныйПараметр("--project-path"); // Имя проекта например dp/doc
Парсер.ДобавитьИменованныйПараметр("--ref-name"); // Имя ветки разработки, например develop
Парсер.ДобавитьИменованныйПараметр("--job-name"); // Имя Job как в .gitlab-ci.yml, например Allure
Парсер.ДобавитьИменованныйПараметр("--query_amount"); // Количество получаемых Pipeline-ов, с запасом, т.к. фильтровать нельзя...
Парсер.ДобавитьИменованныйПараметр("--token"); // Токен доступа
Парсер.ДобавитьИменованныйПараметр("--executors_amount"); // Количество выводимых записей в виджете Executors
Параметры = Парсер.Разобрать(АргументыКоманднойСтроки);

Если Параметры["--executors_amount"] <> Неопределено Тогда
	ВсегоЗаписей = Число(Параметры["--executors_amount"]);
КонецЕсли;

Если Параметры["--query_amount"] <> Неопределено Тогда
	ЗаписейВЗапросе = Параметры["--query_amount"];
КонецЕсли; 

// Чтобы потом долго не вспоминать, если понадобится пагинация, например получать пайплайны после текущего, если этот не последний, оставлю запрос с cursor.
// ШаблонЗапроса = "{""query"": ""query {project(fullPath:\""%1\""){pipelines(ref:\""%2\"",status:SUCCESS,first:%3) {edges{node{id,job(name:\""%4\""){id,status,finishedAt}},cursor}}}}""}";
ШаблонЗапроса = "{""query"": ""query {project(fullPath:\""%1\""){pipelines(ref:\""%2\"",status:SUCCESS,first:%3){nodes{id,job(name:\""%4\""){id,status,finishedAt}}}}}""}";

Заголовки = Новый Соответствие;
Заголовки.Вставить("Content-Type", "application/json");
Заголовки.Вставить("Accept-Encoding", "gzip, deflate, br");
Заголовки.Вставить("Authorization", СтрШаблон("Bearer %1", Параметры["--token"]));

ТелоЗапроса = СтрШаблон(ШаблонЗапроса, Параметры["--project-path"], Параметры["--ref-name"], ЗаписейВЗапросе, Параметры["--job-name"]);
Лог.Информация(ТелоЗапроса);

ПараметрыЗапроса = Новый Структура("Заголовки", Заголовки);

Попытка
	Ответ = КоннекторHTTP.Post("https://gitlab.chel/api/graphql", ТелоЗапроса, , ПараметрыЗапроса);
	ОтветКакТекст = Ответ.Текст();
	Если Ответ.КодСостояния <> 200 Тогда
		Лог.Ошибка(ОтветКакТекст);
		ВызватьИсключение ОтветКакТекст;
	Иначе
		Лог.Информация(ОтветКакТекст);
	КонецЕсли;
Исключение
	ИнфоОбОшибке = ИнформацияОбОшибке();
	Лог.Ошибка(ПодробноеПредставлениеОшибки(ИнфоОбОшибке));
	ВызватьИсключение КраткоеПредставлениеОшибки(ИнфоОбОшибке);
КонецПопытки;

// Текущий Job не попадёт в выборку, потому что он ещё не завершился
// Поэтому информацию о нём возьмём из другого файла:
// out/allure/executor/executor.json, который сформирован другим скриптом
ПутьКФайлуТекущегоЗадания = ПолныйПуть(Параметры["--result-folder"]) + "/executor.json";
Файл = Новый Файл(ПутьКФайлуТекущегоЗадания);
Если Файл.Существует() Тогда
	ЧтениеJSON = Новый ЧтениеJSON();
	ЧтениеJSON.ОткрытьФайл(ПутьКФайлуТекущегоЗадания);
	ТекущийИсполнитель = ПрочитатьJSON(ЧтениеJSON);
	ЧтениеJSON.Закрыть();
	СписокИсполнителей.Вставить(0, ТекущийИсполнитель);
КонецЕсли;

Данные = Ответ.Json();

ПоследниеЗадания = Данные["data"]["project"]["pipelines"]["nodes"];

Для Каждого ДанныеЗадания Из ПоследниеЗадания Цикл
	Если СписокИсполнителей.Количество() = ВсегоЗаписей Тогда 
		Прервать;
	КонецЕсли;
	Если ДанныеЗадания["job"] = Неопределено Или ДанныеЗадания["job"]["status"] <> СтатусУспех Тогда
		Продолжить;
	КонецЕсли;

	pipeline_id = СтрЗаменить(ДанныеЗадания["id"], "gid://gitlab/Ci::Pipeline/", "");
	job_id = СтрЗаменить(ДанныеЗадания["job"]["id"], "gid://gitlab/Ci::Build/", "");

	Исполнитель = Новый Структура("name,type,url", "Gitlab", "gitlab", "https://gitlab.chel");
	Исполнитель.Вставить("buildOrder", pipeline_id);
	Исполнитель.Вставить("buildName", СтрШаблон("%1-%2 #%3", Параметры["--project-path"], Параметры["--ref-name"], pipeline_id));
	Исполнитель.Вставить("buildUrl", СтрШаблон(buildUrl, Параметры["--project-path"], pipeline_id));
	Исполнитель.Вставить("reportUrl", СтрШаблон(reportUrl, Параметры["--project-path"], job_id, Параметры["--report-folder"]));
	Исполнитель.Вставить("reportName", СтрШаблон(reportName, pipeline_id, Формат(ДанныеЗадания["job"]["finishedAt"], "ДЛФ=Д")));
	СписокИсполнителей.Добавить(Исполнитель);
КонецЦикла;

ПутьКФайлу = ПолныйПуть(Параметры["--report-folder"]) + "/widgets/executors.json";
ЗаписьJSON = Новый ЗаписьJSON();
ЗаписьJSON.ОткрытьФайл(ПутьКФайлу, , , Новый ПараметрыЗаписиJSON(Ложь));
ЗаписатьJSON(ЗаписьJSON, СписокИсполнителей);
ЗаписьJSON.Закрыть();

1C:Enterprise=8.3.22.1750
gitsync=3.4.0
vanessa-add=6.9.5
vanessa-automation=1.2.041.1

Allure:
  stage: allure
  rules:
    - if: '$CI_COMMIT_BRANCH != "main" && $CI_PIPELINE_SOURCE != "schedule"'
  when: on_success
  variables:
    GIT_STRATEGY: none
    ALLURE_HISTORY: ${CI_ALLURE_HISTORY}/${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME}/${CI_COMMIT_REF_NAME}
    ALLURE_EXECUTOR: out/allure/executor
    ALLURE_REPORT: out/allure-report
    ALLURE_SYNTAX: out/allure/syntax-check
    ALLURE_SMOKE: out/allure/smoke
    ALLURE_VANESSA: out/allure/vanessa
  tags:
    - WIN
  before_script:
    - CHCP 65001
  script:
    - oscript tools/generate-single-executor.os --result-folder ${ALLURE_EXECUTOR} --report-folder ${ALLURE_REPORT} --project-path ${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME} --ref-name ${CI_COMMIT_REF_NAME} --pipeline-id ${CI_PIPELINE_ID} --job-id ${CI_JOB_ID}
    - allure generate ${ALLURE_HISTORY} ${ALLURE_EXECUTOR} ${ALLURE_SYNTAX} ${ALLURE_SMOKE} ${ALLURE_VANESSA} -c -o ${ALLURE_REPORT}
    - oscript tools/generate-all-executors.os --result-folder ${ALLURE_EXECUTOR} --report-folder ${ALLURE_REPORT} --project-path ${CI_PROJECT_NAMESPACE}/${CI_PROJECT_NAME} --ref-name ${CI_COMMIT_REF_NAME} --query_amount 15 --executors_amount 5 --job-name Allure --token ${READ_API_TOKEN}
    - copy ${ALLURE_REPORT}/history ${ALLURE_HISTORY} -force -recurse
  artifacts:
    paths:
      - out/allure-report