@soft-artel/ci 1.2.13 → 1.3.15

package/libs/Gitlab.ts

@@ -0,0 +1,86 @@
+import axios from 'axios';
+
+import { Exception } from '../libs/Exception';
+import { checkVarsExisting } from '../libs/helpers';
+
+// ------------------------
+
+class Gitlab {
+
+	privateToken: string;
+	configVarName: string;
+	projectId: number;
+	url: string;
+
+	constructor(privateToken: string, projectId: number, configGitlabUrl = 'https://gitlab.soft-artel.com', configVarName = 'CONFIG') {
+		this.privateToken = privateToken;
+		this.projectId = projectId;
+		this.configVarName = configVarName;
+
+		this.url = `${ configGitlabUrl }/api/v4/projects/${ this.projectId }/variables/${ configVarName }`;
+	}
+
+	async downloadConfig() {
+
+		try{
+			const resp = await axios({
+				method:'GET', timeout: 600, url: this.url, headers:{ 'PRIVATE-TOKEN': this.privateToken },
+			});
+			return JSON.parse(resp.data.value);
+		} catch(e){
+      
+			const errTitle = `CONFIG ERR: GitLab project [id:${ this.projectId }] has not`;
+
+			if(e.response && (e.response.status === 401 || e.response.status === 403)){
+				const err = new Exception(`${ errTitle } access, HTTP-401`);
+				err.params =  e.config;
+				throw err;
+			}
+
+			if(e.response && e.response.status === 404){
+				const err = new Exception(`${ errTitle } CI VARIABLE: '${ this.configVarName }'`);
+				err.params =  e.config;
+				throw err;
+			}
+
+			e.request = '...';
+			e.connection = '...';
+
+			throw e;
+		}
+	}
+
+	async uploadConfig(config: Record<string, any>) {
+		const resp = await axios({
+			method:'PUT', timeout: 600, url: this.url,
+			headers:{ 'PRIVATE-TOKEN': this.privateToken },
+			data:{ value: JSON.stringify(config, null, 3) },
+		});
+    
+		if(resp.status !== 200){
+			// eslint-disable-next-line no-console
+			console.error(resp);
+			throw new Error('CONFIG ERR: GitLab update VAR - HTTP'+resp.status);
+		}
+	}
+}
+
+// Export and check
+
+const ENV = process.env;
+
+const privateToken = ENV.GITLAB_PASS;
+const projectId = ENV.CI_PROJECT_ID;
+
+checkVarsExisting([{
+	field: privateToken,
+	exceptionMessage: 'GITLAB_PASS must be provided',
+}, {
+	field: projectId,
+	exceptionMessage: 'CI_PROJECT_ID must be provided',
+}]);
+
+const configGitlabUrl = ENV.CONFIG_GITLAB_URL;
+const configVarName = ENV.CONFIG_VAR_NAME;
+
+export default new Gitlab(privateToken!, Number(projectId), configGitlabUrl, configVarName);

package/libs/Jira.ts

@@ -0,0 +1,239 @@
+import axios from 'axios';
+
+import { log, stripTags } from './helpers';
+import git from './Git';
+import { Project } from './Project';
+
+const ENV = process.env;
+
+// Can be redefined in ENV
+// ------------------------
+
+const RELEASE_BO_URL   = ENV.RELEASE_BO_URL   || 'https://bo.soft-artel.com/ci/jira';
+const RELEASE_BO_TOKEN = ENV.RELEASE_BO_TOKEN || ENV.GITLAB_PASS;
+
+const RELEASE_JIRA_URL = ENV.RELEASE_JIRA_URL || 'https://jira.soft-artel.com';
+
+export interface ReleaseInfo{
+	components: string[];
+	bugs: Issue[];
+	tasks: Issue[];
+	changelog: string;
+}
+
+// ===========================================
+
+async function resolve(prj: Project, head = true): Promise<ReleaseInfo>{
+
+	if(RELEASE_BO_TOKEN === undefined){
+		throw new Error('NO RELEASE_BO_TOKEN!');
+	}
+
+	const release: ReleaseInfo = {
+		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,
+	});
+
+	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': RELEASE_BO_TOKEN },
+			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===============');
+	log.info('RELEASE:', 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 = 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 }[]){
+	
+	if(RELEASE_BO_TOKEN === undefined){
+		throw new Error('NO RELEASE_BO_TOKEN!');
+	}
+
+	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': RELEASE_BO_TOKEN },
+		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/libs/Project.ts

@@ -0,0 +1,215 @@
+import axios from 'axios';
+import { promises as fsAsync } from 'fs';
+
+import { Exception } from './Exception';
+import { log, capitalizeFirstLetter, htmlToMd, resolvePath } from './helpers';
+import Shell from './Shell';
+
+const ENV = process.env;
+
+export type Stage = keyof typeof ALLOW_STAGES;
+const ALLOW_STAGES: Record<string, string> = {
+	dev: 'dev',
+	alpha: 'alpha',
+	rc:'rc',
+	hotfix:'hotfix',
+	prod:'prod',
+};
+
+export class Project {
+
+	// ENV FROM GitLab Runner  ---------------
+	isRunner = ENV.CI_JOB_ID !== undefined;
+
+	id = (Number(ENV.CI_PROJECT_ID as unknown as number || 0));
+	path = ENV.CI_PROJECT_PATH || '';       // <group>/<project>
+	url  = ENV.CI_PROJECT_URL || '';         // http://<gitlab>/<group>/<project>
+
+	name = ENV.CI_PROJECT_NAME || '';
+	group = ENV.CI_PROJECT_NAMESPACE || '';
+
+	// Common proporties ---------------
+	rootPath: string = '';
+
+	build = 0;
+	version = '0.0.0';
+	stage: Stage = 'dev';
+
+
+	$stages: Stage[] = ['dev'];
+	$stagesVersions: Record<string, string> = { dev: '0.0.0' };
+	
+	job = {
+
+		id: ENV.CI_JOB_ID,
+		name: ENV.CI_JOB_NAME || 'No Job',
+		step: ENV.CI_JOB_STAGE || 'build',
+		branch: ENV.CI_COMMIT_REF_NAME || 'dev',
+    
+		url: ENV.CI_JOB_URL || '',
+		pipline: ENV.CI_PIPELINE_URL || '',
+    
+		user: {
+			ID: ENV.GITLAB_USER_ID || '',
+			login: ENV.GITLAB_USER_LOGIN || '',
+			name: ENV.GITLAB_USER_NAME 	 || '',
+			email: ENV.GITLAB_USER_EMAIL || '',
+		},
+	};
+
+	// --------------
+
+	constructor(workdir: string | undefined, stage?: Stage){
+		this.rootPath = resolvePath(workdir || ENV.CI_PROJECT_DIR || Shell.pwd().toString());
+		const branch = ENV.CI_COMMIT_REF_NAME || 'dev';
+		this.stage = stage || ALLOW_STAGES[ branch ]  || 'dev';
+
+		try{
+			this.$stages = JSON.parse(ENV.CI_STAGES || '[dev]');
+			log.dbg('Allowed stages:', this.$stages);
+		}catch(e){
+			log.dbg('CI VARIABLE: CI_STAGES is invalid!');
+		}
+
+		try{
+			this.$stagesVersions = JSON.parse(ENV.VERSIONS || '{}');
+			log.dbg('stagesVersions:', this.$stagesVersions);
+		}catch(e){
+			log.dbg('CI VARIABLE:VERSIONS is invalid!');
+		}
+
+		this.build   =  Number(ENV.LAST_BUILD) || 0;
+
+
+		this.version =  '0.0.' + this.build; // Mast init later! [ depends fom platform]
+
+		Shell.cd(this.rootPath);
+		log.dbg(`[${this.stage}, ${this.version}] `+this.rootPath);
+	}
+
+	// --------------
+
+	get shortVersion(){
+		return this.version.split('.').splice(0, 2).join('.');
+	}
+
+	get prevVersion(){
+		const pV = this.$stagesVersions[ this.stage ];
+		return pV !== '0.0.0' ? pV : undefined;
+	}
+
+	// --------------
+
+	incrementBuild(newBuild?: number){
+		if (newBuild) {
+			this.build = newBuild;
+		} else {
+			this.build += 1;
+		}
+		this.version = `${ this.shortVersion }.${ this.build}`;
+	}
+	
+	// --------------
+	
+	async saveGitLabBuild(){
+		await saveGitLabVariable(this, 'LAST_BUILD', this.build);
+	}
+
+	// ----------------
+	
+	async saveGitLabStagesVersions(){
+		this.$stagesVersions[ this.stage ] = this.version;
+		await saveGitLabVariable(this, 'VERSIONS', JSON.stringify(this.$stagesVersions, null, 3));
+	}
+	
+	// --------------
+
+	async updateChangeLog(whatsNewHtml: string, filename = 'CHANGELOG.md') {
+
+		const filePath = `${ this.rootPath}/${ filename }`;
+
+		let title = `# ${ capitalizeFirstLetter(this.group) }: **${ this.name.toUpperCase() }**`;
+
+		log.info(`Update ${filename}:\n${title}`);
+
+		let changeLog = await Shell.cat(filePath, {silent:true, ignoreError:true}) || '';
+		const lines = changeLog.split('\n');
+
+		if(Array.isArray(lines) && lines.length > 1){
+			title = lines.shift() || title;
+			changeLog = lines.join('\n');
+		}
+                  
+		const dateTime = new Date().toLocaleString('ru-RU', {
+			weekday: 'long',
+			year: 'numeric',
+			month: 'short',
+			day: 'numeric',
+			timeZone: 'Europe/Moscow',
+			hour12: false,
+			hour: 'numeric',
+			minute: 'numeric',
+		});
+
+		const whatsNewMd = htmlToMd(whatsNewHtml);
+
+		changeLog = `${ title }
+## **${ this.version }**
+${ capitalizeFirstLetter(dateTime) }
+
+${ whatsNewMd }
+ 
+ 
+ 
+ 
+${ changeLog }
+`;
+
+		await fsAsync.writeFile(filePath, changeLog, { encoding: 'utf8', flag: 'w+'});
+	}
+
+}
+
+
+// ==================================
+// GitLab Helpers
+
+async function saveGitLabVariable(prj: Project, name: string, value: any) {
+
+	try{
+		const resp = await axios({
+			method:'PUT',
+			timeout: 6000,
+			url: `${ ENV.CONFIG_GITLAB_URL || 'https://gitlab.soft-artel.com' }/api/v4/projects/${ prj.id }/variables/${ name }`,
+			headers:{ 'PRIVATE-TOKEN': ENV.GITLAB_API_TOKEN || '' },
+			data:{
+				value,
+			},
+		});
+
+		log.dbg(resp.data);
+		return JSON.parse(resp.data.value);
+
+	} catch(e){
+		
+		const errTitle = `GitLab project [${ prj.id }] has not`;
+
+		if(e.response && (e.response.status === 401 || e.response.status === 403)){
+			const err = new Exception(`${ errTitle } access, HTTP-401`);
+			err.params =  e.config;
+			throw err;
+		}
+
+		if(e.response && e.response.status === 404){
+			const err = new Exception(`${ errTitle } CI VARIABLE: ${ name }`);
+			err.params =  e.config;
+			throw err;
+		}
+
+		e.request = '...';
+		e.connection = '...';
+
+		throw e;
+	}
+	
+}

package/libs/Reporter.ts

@@ -0,0 +1,181 @@
+
+const ENV = process.env;
+ENV.NTBA_FIX_319='true';
+
+import './prototype';
+
+import TelegramBot from 'node-telegram-bot-api';
+
+import { log } from '../libs/helpers';
+import { Project } from './Project';
+
+// ------------
+
+type PipelineTypes = 'build' | 'deploy' | 'setup';
+
+// ------------------------
+
+export interface ReporterOptions {
+	chat_id: number;
+	chat_rel?: number;
+
+	token: string;
+	
+	showGroup?: boolean;
+	shortVersion?: boolean;
+	showBuild?: boolean;
+	
+	preTitle?: string;
+	postTitle?: string;
+}
+
+// ------------------------
+
+export class Reporter {
+
+	$bot;
+	$chat_id = 0;
+	$message_id = 0;
+	$message_text = '';
+
+	title = '';
+	stage: string | undefined;
+	
+	$prj: Project;
+	$chat_rel = 0;
+	$opt: ReporterOptions;
+	$ver = '';
+
+	// --------------
+
+	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;
+		}
+		this.updateTitle();
+	}
+
+	// --------------
+	updateTitle(){
+
+		this.title = this.$opt.preTitle ? this.$opt.preTitle + ' ' : '';
+
+		this.title += this.$opt.showGroup ? this.$prj.group.toUpperCase() + ': ': '';
+		this.title += this.$prj.name.toUpperCase();
+
+		this.title += this.$opt.postTitle ? ' ' + this.$opt.postTitle : '';
+
+		if(this.$opt.shortVersion){
+			this.$ver= `v${ this.$prj.shortVersion } #${ this.$prj.build }`;
+		}else{
+			this.$ver= `v${ this.$prj.version }`;
+		}
+
+		this.title += ' ' + this.$ver;
+	}
+	// --------------
+
+	async startBuild(){
+		this.updateTitle();
+		await this.send(`📦 ${ this.title } <a href="${ this.$prj.job.url }">BUILD</a> [${this.$prj.job.user.name}]`);
+	}
+
+	async startDeploy(to: string){
+		await this.send(`🚀 ${ this.title } <a href="${ this.$prj.job.url }">DEPLOY</a>: <b>${ to.toUpperCase() }</b> [${this.$prj.job.user.name}]`);
+	}
+
+	async deploy(to: string){
+		await this.send(`\n\n🚀 <a href="${ this.$prj.job.url }">DEPLOY</a>: <b>${ to.toUpperCase() }</b>`);
+	}
+
+	// --------------
+
+	async fail(err: Error){
+		let msg = '\n';
+		if(this.$message_id === 0){
+			msg = `${ this.$prj.group.toUpperCase() }: <b>${ this.$prj.name.toUpperCase() } v${ this.$prj.version }</b>\n`;
+		}
+		msg += `‼️ <b><a href="${ this.$prj.job.url }">FAIL</a></b>\n${ htmlEntities(err.stack || err.message) }`;
+		await this.send(msg, ' ');
+	}
+    
+	// --------------
+
+	async release(changelog: string){
+		await this.send(`\n✅ RELEASED: <b>${ this.$ver }</b> ${ this.stage ? `to ${ this.stage }` : '' }`, ' ');
+
+
+		let msg = `🎉 ${ this.title }  ${ this.stage ? ` [ ${ this.stage } ]` : `` }`;
+
+		if(changelog.length > 0){
+	   msg += `
+---------------------
+${ changelog }`;
+		}
+
+		if(this.$chat_rel !== 0){
+			// Дублируем сообщение в другой чат если указан
+			await this.send(msg, '', this.$chat_rel);
+		} else if(changelog.length > 0){
+			await this.send(msg, '', this.$chat_id);
+		}
+		      
+	}
+
+	// --------------
+
+	async send(text: string, appendExist = '...', chat_id_opt = this.$chat_id){
+
+		const chat_id = chat_id_opt;
+		const message_id = this.$message_id;
+    
+		try {
+			if(message_id && message_id !== 0 && appendExist){
+      
+				let fullMsg = this.$message_text + '\n' + text;
+				fullMsg = fullMsg.length < 4090 ? fullMsg : fullMsg.slice(0, 4090);
+              
+				await this.$bot.editMessageText(fullMsg + '\n' + appendExist, {
+					chat_id, message_id, parse_mode:'HTML', disable_web_page_preview: true,
+				});
+      
+				this.$message_text = fullMsg;
+				return this.$message_id;
+			}
+            
+			text = text.length < 4090 ? text : text.slice(0, 4090);
+
+			const res = await this.$bot.sendMessage(chat_id, appendExist && appendExist.length > 0 ? text + '\n' + appendExist : text, { parse_mode: 'HTML', disable_web_page_preview: true });
+    
+			if(appendExist){
+				this.$message_id = res.message_id;
+				this.$message_text = text;
+			}
+
+			return res.message_id;
+            
+		} catch (err) {
+			err.message = 'ERROR Sending message\n' + err.message;
+			log.error(err.message);
+			log.error(err, { chat_id, message_id, text });
+			return 0;
+		}
+
+	}
+	
+}
+
+// -------------
+// Helpers:
+
+function htmlEntities(rawStr: string){
+	return rawStr.replace(/[\u00A0-\u9999<>\&]/g, function(i) {
+		return '&#'+i.charCodeAt(0)+';';
+	});
+}