@soft-artel/ci 2.3.86 → 2.3.87

package/src/services/Jira.ts

@@ -0,0 +1,228 @@
+import axios from 'axios';
+
+import { log } from '../utils/Logger';
+import { htmlEntities, stripTags } from '../utils/helpers';
+import git from './Git';
+import { Project } from '../Project';
+
+const ENV = process.env;
+
+const RELEASE_BO_URL   = ENV.RELEASE_BO_URL   || 'https://bo.soft-artel.com/ci/jira';
+const RELEASE_JIRA_URL = ENV.RELEASE_JIRA_URL || 'https://jira.soft-artel.com';
+
+export interface ReleaseInfo{
+	commits: Record<string, any>[];
+	components: string[];
+	bugs: Issue[];
+	tasks: Issue[];
+	changelog: string;
+}
+
+// ===========================================
+
+async function resolve(prj: Project, head = true): Promise<ReleaseInfo>{
+
+	const release: ReleaseInfo = {
+		commits:[], components: [], bugs:[], tasks:[], changelog: 'No issues found in git commits!',
+	};
+
+	// 1. Получаем информацию из гита - по тому какие коммиты были
+
+	const fromTag = prj.prevVersion ? await git.existTag(prj.prevVersion) : await git.lastTag();
+	const toTag   = head ? undefined : `v${prj.version}`;
+
+	const gitLog = await git.getCommitsAndIssues({
+		fromTag: fromTag ?? '', toTag: toTag ?? '', onlyJira: true, limit: 1000,
+	});
+
+	release.commits = Object.values(gitLog.commits)
+
+	const issuesKeys = Object.keys(gitLog.issues);
+
+	if(issuesKeys.length === 0){
+		// если никто не комитил с ключами - выходим!!!
+		log.info('No issues found in git log!');
+		return release;
+	}
+
+	// 2. Резолвим задачи - получаем названия и компоненты
+
+	try{
+
+		const resp = await axios({
+			method:'POST',
+			url: `${ RELEASE_BO_URL }/resolve`,
+			headers:{ 'PRIVATE-TOKEN': ENV.RELEASE_BO_TOKEN || ENV.GITLAB_PASS || '' },
+			data: { issues: issuesKeys },
+		});
+
+		if(resp?.data?.data?.bugs && Array.isArray(resp.data.data.bugs)){
+			for (const fields of resp.data.data.bugs) {
+				const issue = new Issue(fields);
+				if(issue.key !== ''){
+					release.bugs.push(issue);
+				}
+			}
+		}
+
+		if(resp?.data?.data?.tasks && Array.isArray(resp.data.data.tasks)){
+			for (const fields of resp.data.data.tasks) {
+				const issue = new Issue(fields);
+				if(issue.key !== ''){
+					release.tasks.push(issue);
+				}
+			}
+		}
+
+		if(resp?.data?.data?.components){
+			release.components = Object.values<string>(resp.data.data.components).sort();
+		}
+
+	} catch(err){
+		err.request = '...';
+		err.connection = '...';
+		err.message = 'JIRA RESOLVE ERR: ' + err.message;
+
+		throw err;
+	}
+
+
+	// 3. Формируем ченж лог
+
+	log.info(`\n\n===============\nRELEASE: ${ prj.group }/${ prj.name }/v${ prj.version }`,'', `pev:${ fromTag }`);
+
+	// let changelog = `🎉 ${ prj.group.toUpperCase() }: <b>${ prj.name.toUpperCase() }  v${ prj.version }</b>  [ ${ stage.toUpperCase() } ] \n\n`
+
+	let msg = '';
+
+	if(release.components.length > 0){
+		msg += '<b>Components:</b>\n';
+		for (const comp of release.components) {
+			msg += `- ${ comp }\n`;
+		}
+		msg += '\n';
+	}
+
+	if(release.tasks.length > 0){
+		msg += '<b>Done:</b>\n';
+		for (const issue of release.tasks) {
+			msg += `- 🛠 <b><a href="${ RELEASE_JIRA_URL }/browse/${ issue.key }">${ issue.key }</a></b>: ${issue.summary}\n`;
+		}
+		msg += '\n';
+	}
+
+	if(release.bugs.length > 0){
+		msg += '<b>BugFixes:</b>\n';
+		for (const issue of release.bugs) {
+			msg += `- 🐞 <b><a href="${ RELEASE_JIRA_URL }/browse/${ issue.key }">${ issue.key }</a></b>: ${issue.summary}\n`;
+		}
+		msg += '\n';
+	}
+
+	release.changelog = msg;
+
+	log.info('changelog', msg);
+	log.info('text', stripTags(msg));
+
+	return release;
+}
+
+// ------------------------
+
+export class Issue{
+
+	key = '';
+	updated   = new Date();
+
+	type = '';
+	status = '';
+	summary = '';
+	assignee = { name: '', email: '', login: '' };
+	components: string[] = [];
+
+	constructor(fields: Record<string, any>){
+		this.key = fields.key;
+		this.updated = new Date(Date.parse(fields.updated));
+		this.type = fields.type;
+		this.status = fields.status;
+		this.summary = htmlEntities(fields.summary);
+		if(fields.assignee && typeof fields.assignee === 'object'){
+			this.assignee.name = fields.assignee.name;
+			this.assignee.email = fields.assignee.email;
+			this.assignee.login = fields.assignee.login;
+		}
+		this.components = Array.isArray(fields.components) ? fields.components : [];
+	}
+}
+
+// --------------------
+
+async function moveBugsAsDeployed(bugs: { key: string }[]){
+	const issuesKeys = [];
+
+	for (const bug of bugs) {
+		issuesKeys.push(bug.key);
+	}
+
+	if(issuesKeys.length === 0){
+		return [];
+	}
+
+	const resp = await axios({
+		method:'POST',
+		url: `${ RELEASE_BO_URL }/deployed`,
+		headers:{ 'PRIVATE-TOKEN': ENV.RELEASE_BO_TOKEN || ENV.GITLAB_PASS || '' },
+		data: { issues: issuesKeys },
+	});
+
+	if(resp?.data?.data?.deployed && Array.isArray(resp.data.data.deployed)){
+		return resp.data.data.deployed;
+	}
+
+	return [];
+}
+
+
+// ------------------------
+
+export const Jira = {
+	resolve,
+	moveBugsAsDeployed,
+};
+
+
+// let msg = `## **${ prj.version }**
+// ${ new Date().toLocaleString('ru-RU', {
+// 	weekday: 'long',
+// 	year: 'numeric',
+// 	month: 'short',
+// 	day: 'numeric',
+// 	timeZone: 'Europe/Moscow',
+// 	hour12: false,
+// 	hour: 'numeric',
+// 	minute: 'numeric',
+// 	}) }`
+
+// if( release.components.length > 0 ){
+// 	msg += '**Components:**\n'
+// 	for (const comp of release.components) {
+// 		msg += `- **${ comp }**\n`
+// 	}
+// 	msg += '\n\n'
+// }
+
+// if( release.tasks.length > 0 ){
+// 	msg += '**Done:**\n'
+// 	for (const issue of release.tasks) {
+// 		msg += `- 🛠 **[${ issue.key }](${ RELEASE_JIRA_URL }/browse/${ issue.key })**: ${issue.summary}, _by [${ issue.assignee.name }](${ RELEASE_JIRA_URL }/issues/?jql=assignee%20in%20(${issue.assignee.login}))_\n`
+// 	}
+// 	msg += '\n\n'
+// }
+
+// if( release.bugs.length > 0 ){
+// 	msg += '**BugFixes:**\n'
+// 	for (const issue of release.bugs) {
+// 		msg += `- 🐞 **[${ issue.key }](${ RELEASE_JIRA_URL }/browse/${ issue.key })**: ${issue.summary}, _by [${ issue.assignee.name }](${ RELEASE_JIRA_URL }/issues/?jql=assignee%20in%20(${issue.assignee.login}))_\n`
+// 	}
+// 	msg += '\n'
+// }

package/src/services/Reporter.ts

@@ -0,0 +1,230 @@
+import { htmlEntities } from "../utils/helpers";
+
+const ENV = process.env;
+ENV.NTBA_FIX_319='true';
+
+import '../utils/prototype';
+
+import TelegramBot from 'node-telegram-bot-api';
+
+import { log } from '../utils/Logger';
+import { Project } from '../Project';
+import { ReleaseInfo } from './Jira';
+
+// ------------------------
+
+export interface ReporterOptions {
+	chat_id: number;
+	chat_rel?: Record<string, number>;
+
+	token: string;
+
+	showGroup?: boolean;
+	shortVersion?: boolean;
+	showBuild?: boolean;
+
+	preTitle?: string;
+	postTitle?: string;
+}
+
+// ------------------------
+
+export class Reporter {
+
+	$bot;
+	$prj: Project;
+	$opt: ReporterOptions;
+
+	// --------------
+
+	$chat_id = 0;
+	$chat_rel: Record<string, number> = {};
+
+	$message_id = 0;
+
+	$message_title_prefix = '▶️';
+	$message_title_icon = '';
+	$message_title_postfix = '';
+
+	$message_body = '';
+
+	$message_footer_hr = '---------------';
+
+	$message_footer_changes_from = '';
+	$message_footer_changes_to = '';
+
+	// --------------
+
+	constructor(prj: Project,	opt: ReporterOptions){
+		this.$prj = prj;
+		this.$chat_id = opt.chat_id;
+		this.$opt = opt;
+
+		this.$bot = new TelegramBot(opt.token);
+
+		if(opt.chat_rel){
+			this.$chat_rel = opt.chat_rel;
+		}
+
+		log.dbg('options', opt);
+
+	}
+
+	// --------------
+
+	get messageParts(){
+		let title = `${ this.$message_title_prefix } ${ this.$message_title_icon} `;
+		title    += `${this.$prj.group.toUpperCase()} / <b>${ this.$prj.name.toUpperCase() }  `;
+		title    += this.$opt.shortVersion ? `v${ this.$prj.shortVersion } #${ this.$prj.build }` : `v${ this.$prj.version }`;
+		title    += `</b>${ this.$message_title_postfix }`;
+
+		const job = this.$prj.job;
+
+		let footer = this.$message_footer_hr + '\n';
+		footer += `job: <a href="${ job.url }">${ job.id }</a>  `;
+		footer += `by: <a href="${ job.commit.url }">${ job.user.name }</a>  `;
+
+		// const cmpUrl = `${ENV.CI_PROJECT_URL}/-/compare/${ this.$message_footer_changes_from }...${ this.$message_footer_changes_to }?from_project_id=${this.$prj.id}`
+		// footer += `diff: <a href="${ cmpUrl }">${ this.$message_footer_changes_from } - ${ this.$message_footer_changes_to }</a> `;
+
+		return { title, footer };
+	}
+
+	// --------------
+
+	async startBuild(){
+		this.$message_title_prefix = '▶️';
+		this.$message_title_icon = '📦';
+
+		await this.append(`${this.$prj.job.commit.title}\n${this.$prj.job.commit.author.name}\n${ this.$message_footer_hr }`);
+	}
+
+	// --------------
+
+	async startDeploy(to: string){
+		this.$message_title_prefix = '▶️';
+		this.$message_title_icon = '🚀';
+
+		this.$message_title_postfix = `-> ${ to.toUpperCase() }`;
+
+		await this.append(`${ this.$message_footer_hr }`);
+	}
+
+	// --------------
+
+	async appendDeploy(to: string){
+		this.$message_title_prefix = '▶️';
+		this.$message_title_icon = '🚀';
+
+		this.$message_title_postfix = `-> ${ to.toUpperCase() }`;
+
+		await this.append(`\n${ this.$message_footer_hr }\nDEPLOY:`);
+	}
+
+	// --------------
+
+	async fail(err: Error){
+		this.$message_title_prefix = '❌';
+
+		let msg = `${ this.$message_footer_hr }\n`;
+		msg += `‼️ <a href="${ this.$prj.job.url }">ERROR</a>:\n`;
+		// msg += htmlEntities(err.message);
+		msg += htmlEntities(err.stack || err.message);
+
+		await this.append(msg, '');
+	}
+
+	// --------------
+
+	async succses(release: ReleaseInfo | undefined = undefined){
+		this.$message_title_prefix = '✅';
+		// this.$message_body = '';
+
+		if(release === undefined || release.changelog === 'No issues found in git commits!'){
+			await this.append(release ? `commits:${ release.commits.length } done:${ release.tasks.length }, bugs: ${ release.bugs.length }` : '', '');
+			return;
+		}
+
+		let msg = this.$message_footer_hr + '\n';
+		msg += `🎉  WHATS NEW in <b>${ this.$opt.shortVersion ? `v${ this.$prj.shortVersion } #${ this.$prj.build }` : `v${ this.$prj.version }` }</b>:\n\n`;
+		msg += release.changelog;
+		await this.append(msg, ' ');
+
+		const chat_rel = Number(this.$chat_rel[this.$prj.stage]);
+		if(chat_rel && chat_rel !== 0){
+			// Дублируем сообщение в другой чат если указан
+			msg = `${this.$prj.group.toUpperCase()} / <b>${ this.$prj.name.toUpperCase() }</b>\n` + msg;
+			await this.send(msg, chat_rel);
+		}
+
+	}
+
+	// --------------
+
+	async skip(msg: string = ''){
+		this.$message_title_prefix = '⏩';
+		this.$message_body = '';
+		msg = `${this.$prj.job.commit.title}\n${this.$prj.job.commit.author.name}\n${this.$message_footer_hr}\n${ msg }`;
+		await this.append(msg, '');
+	}
+	// --------------
+
+	async append(text: string, message_postfix = '...'){
+
+		// 1. build message:
+		const { title, footer} = this.messageParts;
+
+
+		let message = this.$message_body.length > 0 ? this.$message_body + '\n' : '';
+		message += text.length > 0 ? text : '';
+		this.$message_body = message;
+
+		if(message.length > 3000){
+			message = message.slice(0, 3000);
+		}
+
+		message += message_postfix.length > 0 ? '\n' + message_postfix : '';
+
+		message = `${title}\n${message}\n${footer}`;
+
+		// log.dbg(message);
+
+		if(this.$message_id === 0){
+			this.$message_id = await this.send(message);
+			return;
+		}
+
+		try {
+			await this.$bot.editMessageText(message, {
+				chat_id: this.$chat_id, message_id: this.$message_id, parse_mode:'HTML', disable_web_page_preview: true,
+			});
+
+		} catch (err) {
+			log.fail('ERROR editMessageText:\n' + err.message);
+			log.fail(message);
+			return 0;
+		}
+
+	}
+
+	// --------------
+
+	async send(message: string, chat_id_opt = this.$chat_id){
+
+		const chat_id = chat_id_opt;
+
+		try {
+
+			message = message.length < 4090 ? message : message.slice(0, 4090);
+			const res = await this.$bot.sendMessage(chat_id, message, { parse_mode: 'HTML', disable_web_page_preview: true });
+			return res.message_id;
+
+		} catch (err) {
+			log.fail('ERROR sendMessage\n' + err.message);
+			log.fail(message);
+			return 0;
+		}
+
+	}
+
+}

package/src/utils/Exception.ts

@@ -0,0 +1,19 @@
+export class Exception extends Error {
+	params?: Record<string, any>;
+
+	// -------------
+
+	constructor(
+		message: string,
+		params?: Record<string, any>) {
+		super();
+
+		this.message = message;
+		this.params = params;
+
+		/**
+		 * @see https://github.com/Microsoft/TypeScript-wiki/blob/master/Breaking-Changes.md#extending-built-ins-like-error-array-and-map-may-no-longer-work
+		 */
+		Object.setPrototypeOf(this, Exception.prototype);
+	}
+}

package/src/utils/Logger.ts

@@ -0,0 +1,85 @@
+/* eslint-disable @typescript-eslint/member-ordering */
+import chalk from 'chalk';
+
+import '../utils/prototype';
+import { Exception } from './Exception';
+
+const ENV = process.env;
+
+export const log = {
+
+	isDebug: true,
+
+	dbg: (title: string, params?: any, note?: string ) => {
+		console.log( logString( 'dim', { title, params, note }))
+	},
+
+	info: (title: string, params?: any, note?: string ) => {
+		console.log( logString( 'cyan', { title, params, note }))
+	},
+
+	fail: (title: string, params?: any, note?: string ) => {
+		console.log( logString( 'red', { title, params, note }))
+	},
+
+	sucses: (title: string, params?: any, note?: string ) => {
+		console.log( logString( 'green', { title, params, note }))
+	},
+
+	error: ( error: Exception | Error , params?: any ) => {
+		console.error( logString( 'red', { 
+			title: error?.message || JSON.stringify( error ), 
+			params: params || (error as Exception).params,
+			note: error.stack
+		 }))
+	}
+
+}
+
+
+// --------------------------------------------------------------------------------
+
+function logString( color: 'dim' | 'cyan' | 'red' | 'green',  logData: { title?: string, note?: string, params?: any } = {} ): string {
+
+	const { title, note, params } = logData;
+
+  let logStr = ''
+
+	if( title ){
+		logStr += title + '\n'
+	}
+
+	if( note ){
+		logStr += chalk.dim( note ) + '\n'
+	}
+
+	if( params ){
+		logStr += chalk.dim( getParams( params ) ) + '\n'
+	}
+	// return chalk.dim(``)
+
+	logStr = logStr.slice(0, -1)
+
+	return chalk[ color ]( logStr )
+
+}
+
+// --------------------------------------------------------------------------------
+
+function getParams(params: any): string {
+
+	if( typeof params === 'string' ){
+		return params
+	}
+
+	if( typeof params === 'number' ){
+		return `${ params }`
+	}
+
+	try {
+		return JSON.stringify( params, undefined, 3 );
+	} catch (e) {
+		console.error( e );
+		return ''
+	}
+}

package/src/utils/Shell.ts

@@ -0,0 +1,120 @@
+import shelljs from 'shelljs';
+
+import { log } from '../utils/Logger';
+import { resolvePath, asyncSleep } from '../utils/helpers';
+
+// ===========================================
+
+function exec(cmd: string, opt: ExecOptions = { silent: !log.isDebug, ignoreError: false }): Promise<string>{
+	return new Promise((resolve, reject) => {
+  
+		if(opt.silent === undefined){
+			opt.silent = true;
+		}
+  
+		if(opt.silent === false){
+			log.dbg(cmd);
+		}
+  
+		shelljs.exec(cmd, opt, (code, stdout, stderr) => {
+			if(code === 0){
+				resolve(stdout.trim());
+				return;
+			}
+  
+			if(code !== 0 && opt.ignoreError){
+				resolve('');
+				return;
+			}
+  
+			const e = new Error();
+			e.message = cmd+'\n'+ (stderr.length > 0 ? stderr : stdout);
+			e.name = String(code);
+			reject(e);
+  
+		}
+		);
+	});
+}
+  
+// -------------
+  
+async function execRepeat(cmd: string, repeats = 10, sleep = 10, opt = { silent: !log.isDebug, ignoreError: false }){
+  
+	let tryCount = repeats;
+	let e = new Error();
+  
+	while(tryCount > 0) {
+		tryCount -= 1;
+		try{
+  
+			return await exec(cmd, { silent: opt.silent, ignoreError: false });
+  
+		} catch(err){
+			e = err;
+			log.fail(`Exec Repeats [${tryCount + 1}] FAIL: ${ cmd }`);
+			log.error(err);
+			await asyncSleep(sleep);
+		}
+	}
+  
+	if(opt.ignoreError){
+		return e.message;
+	}
+  
+	throw e;
+  
+}
+  
+// -------------
+  
+async function mkdir(dir: string, opt?: ExecOptions){
+	return exec(`mkdir -p ${ resolvePath(dir) }`, opt);
+}
+  
+async function cat(file: string, opt = { silent: true, ignoreError: false }){
+	const filePath = resolvePath(file);
+	if(shelljs.test('-e', filePath) === false && opt && opt.ignoreError === true){
+		return undefined;
+	}
+	return exec('cat '+filePath, opt);
+}
+  
+async function find(where: string, filename = '', maxdepth = 3, ignore: string[] = [], pars = '', opt = { silent: true, ignoreError: false }){
+
+	let cmd = `find ${ where } ${pars}`;
+
+	for (const path of ignore) {
+		cmd += ` -not -path '${path}'`;
+	}
+
+	cmd += ` -maxdepth ${maxdepth}`;
+	cmd += ` -name ${filename}`;
+
+	return (await exec(cmd, opt)).split('\n').filter((f)=>f.length > 2);
+}
+  
+async function ls(where: string, pars = '', opt = { silent: true, ignoreError: false }){
+	return (await exec(`ls ${ where } ${ pars }`, opt)).split('\n').filter((f)=>f.length > 2);
+}
+  
+export interface ExecOptions {
+	silent?: boolean;
+	ignoreError?: boolean;
+}
+
+export default {
+	cd: shelljs.cd,
+	chmod: shelljs.chmod,
+	grep: shelljs.grep,
+	pwd: shelljs.pwd,
+	sed: shelljs.sed,
+	test: shelljs.test,
+
+	exec,
+	execRepeat,
+	mkdir,
+	cat,
+	find,
+	ls,
+};