@soft-artel/ci 1.2.15 → 1.3.15

package/k8s/Node.ts

@@ -0,0 +1,119 @@
+import '../libs/prototype';
+
+import yaml from 'js-yaml';
+
+import Shell, { ExecOptions } from '../libs/Shell';
+import { log, resolvePath } from '../libs/helpers';
+import { Stage } from '../libs/Project';
+import { Exception } from '../libs/Exception';
+import { Reporter } from '../libs/Reporter';
+
+const ENV = process.env;
+
+
+// ================================================================================================
+
+export class Node{
+
+	configFile = '';
+	namespace = '';
+
+	// ----------
+
+	constructor(stage: Stage){
+		this.namespace  = stage;
+
+		const configKey = `K8S_${ stage.toUpperCase() }_CONFIG`;
+		let   configFile = ENV[ configKey ];
+
+		if(stage !== 'prod' && !configFile){
+			configFile = ENV.K8S_STAGES_CONFIG;
+		}
+
+		if(!configFile){
+			throw new Exception(`K8s config file not found: ${ configKey }`);
+		}
+
+		this.configFile = resolvePath(configFile) ;
+	}
+
+	// ----------
+
+	async applyObject(manifestObj: Record<string, any>){
+		const manifestYaml = yaml.dump(manifestObj);
+		await this.exec(`apply -f -\n${ manifestYaml }`, {silent: false}, 'cat <<EOF | ');
+	}
+
+	// ----------
+
+	async apply(manifestFile: string, appName: string): Promise<{valid: boolean; msg: string}>{
+
+		let status: string;
+
+		try{
+			await this.exec(`apply -f ${ manifestFile } --dry-run=server --validate`);
+			status = (await Shell.exec(`cat ${ manifestFile } | grep 'image:'`)).replace('image: ', '').replace(ENV.CI_REGISTRY_IMAGE+'/', '').trim();
+		}catch(e){
+			log.error(e);
+			log.error('!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!');
+			log.error(`VALIDATE FAIL: ${appName} at ${manifestFile}`);
+			log.error(e.message);
+			log.error(`${ await Shell.cat(manifestFile) }`);
+			log.error('!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!');
+
+			return { valid:false, msg: e.message };
+		}
+
+		try{
+			status = await this.exec(`apply -f ${ manifestFile }`);
+			await this.exec(`rollout status deploy/${ appName } --watch=true --timeout=300s`);
+
+			log.info('+++++++++++++++++++++++++++++');
+			log.info(`DEPLOYED: ${appName}`);
+			log.info(await this.exec(`get pods --no-headers -l app=${appName} -o wide`, { ignoreError:true, silent:true }));
+			log.info('+++++++++++++++++++++++++++++');
+
+			return { valid:true, msg: status };
+
+		} catch(error){
+			log.error('!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!');
+			log.error(`DEPLOY FAIL: ${appName}`);
+			log.error('!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!');
+			log.error(await this.exec(`get pods --no-headers -l app=${appName} -o wide`, { ignoreError:true, silent:true }));
+			throw error;
+		}
+
+	}
+
+	// ----------
+
+	async status(reporter: Reporter | undefined = undefined, appsOnly: boolean = true): Promise<string[]>{
+
+		const cmd = `get pods -o=jsonpath='{range .items[*]}{"\\n"}{"<b>"}{.metadata.labels.app}{"</b>   "}{range .spec.containers[*]}{.image}{end}{"    "}{.metadata.labels.pod-template-hash}{" "}{.status.phase}{end}'`;
+		const statusArr = (await this.exec(cmd)).split('\n');
+    
+		const result: string[] = [];
+		for (const row of statusArr) {
+			if(row.length < 4 || (appsOnly && (RegExp((ENV.CI_REGISTRY_IMAGE || '')).exec(row)) === null)){
+				continue;
+			}
+			result.push(row.replace(ENV.CI_REGISTRY_IMAGE+'/', ''));
+		}
+    
+		log.info(`K8S Node: ${ this.namespace.toUpperCase() }`, result);
+
+		if(reporter){
+			const msg = `\n<b>${ this.namespace.toUpperCase() }</b> Pods:\n-----------------\n ` + result.join('\n-----------------\n ');
+			await reporter.send(msg, '');
+		}
+
+		return result;
+	}
+
+	// ----------
+
+	async exec(cmd: string, opt: ExecOptions | undefined = undefined, cmdPrefix = ''): Promise<string>{
+		return Shell.exec(`${cmdPrefix}kubectl --kubeconfig ${ this.configFile } -n ${ this.namespace } ${ cmd }`, opt);
+	}
+
+}

package/k8s-build.ts

@@ -0,0 +1,175 @@
+#!/usr/bin/env node
+import './libs/prototype';
+
+import {program, OptionValues} from 'commander';
+
+import Shell from './libs/Shell';
+import { Jira } from './libs/Jira';
+import Git from './libs/Git';
+import { Project } from './libs/Project';
+import { Reporter } from './libs/Reporter';
+import { log, checkEnvVars } from './libs/helpers';
+import { DockerImage } from './k8s/DockerImage';
+import { Config, getApps } from './k8s/App';
+
+const ENV = process.env;
+
+// ========================================================
+
+
+async function main() {
+
+	program
+		.option('--path <project dir>',  'Path to project directory [default - current]')
+
+		.option('--no-prebuild', 'Skip prebuild phase')
+
+		.option('--no-changelog', 'Skip create gitlog')
+		.option('--no-gittag', 'Skip create and push new git tag')
+		.action(
+			async () => {
+
+				let reporter: Reporter | undefined;
+
+				try {
+
+					// ------------------
+					// Инициализируемся
+					checkEnvVars(['CI_STAGES', 'REPORTER']);
+
+					const opts = program.opts() || {};
+					const prj = new Project(opts.path);
+
+					const reporterOpts = JSON.parse(ENV.REPORTER!);
+					reporterOpts.postTitle = opts.scheme;
+
+					const pkg = JSON.parse(await Shell.cat(prj.rootPath +'/package.json') || 'no package.json file!');
+					const pkgBuild =  Number(pkg.version.split('.')[2]);
+				
+					prj.build = prj.build < pkgBuild ? pkgBuild : prj.build;
+					prj.version = `${ pkg.version.split('.').splice(0, 2).join('.') }.${ prj.build }`;
+				
+					if(!pkg.ci){
+						throw new Error('No ci config in package.json file!');
+					}
+									
+					reporter = new Reporter(prj, reporterOpts);
+
+					const config: Config = pkg.ci;
+
+					// Запускаем команду
+					await run(prj, reporter, opts, config);
+
+				} catch(e){
+
+					log.error(e);
+
+					if(reporter){
+						try {
+							await reporter.fail(e);
+						} catch(e2){
+							log.error(e2);
+						}
+				
+					}
+
+					process.exit(1);
+				}
+			}
+		);
+
+	await program.parseAsync(process.argv);
+}
+main();
+
+// ============================================
+
+async function run(prj: Project, reporter: Reporter, opts: OptionValues, config: Config) {
+
+	// ------------------
+	// Инициализируемся
+
+	const release = opts.changelog ? await Jira.resolve(prj) : { tasks:[], bugs:[], changelog:''};
+
+	// --build: Build and push docker image to registry
+	Shell.cd(prj.rootPath);
+
+	// -----------------------------
+	// 1. Start
+	prj.incrementBuild();
+	await reporter.startBuild();
+	log.info(`1. build ${ prj.stage }`);
+
+	// -----------------------------
+	// 2. Chek updated apps
+	await reporter.send(` + Load apps and check updated`);
+	log.info(`2. Load apps and check updated`);
+
+	const updateFiles =  await Git.getDiffFiles();
+	log.info(`\n\nUPDATED FILES:\n$`, updateFiles);
+
+	const { apps, updated } = await getApps(prj, config, updateFiles);
+
+	if(!updated){
+		log.info('SKIP BUILD: NO Apps to update!');
+		await reporter.send(`⏩ SKIP - no apps to update\n ${ updateFiles.join('\n    ')}`, ' ');
+		process.exit(0);
+	}
+
+	await reporter.send(`   ~ <b>${ updated.join('</b>\n   ~ <b>') }</b>`);
+
+	// -----------------------------
+	// 4. write k8s manifests!
+	await reporter.send(` + Write K8s manifests`);
+	log.info(`3. Write K8s manifests`);
+	
+	const image = new DockerImage(prj.rootPath, prj.shortVersion, prj.build);
+	log.dbg(`DockerImage`, image);
+
+	for (const appName of updated) {
+		await apps[ appName ]?.writeManifest(prj, image);
+	}
+
+	// -----------------------------
+	// 5. Build
+	if(opts.prebuild){
+		await reporter.send(` + Test and distrib`);
+		log.dbg(`4. Pre build`);
+		await image.prebuild();
+	}
+
+	await reporter.send(` + Build docker image: ${ image.tag }`);
+	log.dbg(`5. Build`);
+	await image.build();
+
+	await reporter.send(` + Push docker image to registry`);
+	log.dbg(`6. Docker push`);
+	await image.push();
+
+	// -----------------------------
+	// 5. Save new build to GitLab CI Variable
+
+	await reporter.send(` + Save current build: ${ prj.build }`);
+	log.dbg(`7. Put current build:${ prj.build } to GitLab`);
+	await prj.saveGitLabBuild();
+
+	// -----------------------
+
+	
+	if(opts.changelog){
+		await prj.updateChangeLog(release.changelog);
+		await reporter.send(` + Update <a href=\"${ prj.url }/-/blob/${ ENV.CI_COMMIT_REF_NAME || 'dev' }/CHANGELOG.md\">changelog</a>.`);
+	}
+
+	await Git.setOrigin();
+	await Shell.exec(`git add -A`, { ignoreError: true, silent: false });
+	await Shell.exec(`git commit -a -m "v${ prj.version }"`, { ignoreError: true, silent: false });
+	await Git.push(ENV.CI_COMMIT_REF_NAME || 'dev');
+
+	if(opts.gittag){
+		await reporter.send(` + Git tag new version`);
+		await Git.makeTag(prj.version);
+	}
+
+	await reporter.send(`\n✅ <b>${ reporter.title }</b> builded!`, ' ');
+}

package/k8s-deploy.ts

@@ -0,0 +1,174 @@
+#!/usr/bin/env node
+import './libs/prototype';
+
+import {program, OptionValues} from 'commander';
+
+import Shell from './libs/Shell';
+import { Jira } from './libs/Jira';
+import Git from './libs/Git';
+import { Project, Stage } from './libs/Project';
+import { Reporter } from './libs/Reporter';
+import { log, checkEnvVars } from './libs/helpers';
+import { DockerImage } from './k8s/DockerImage';
+import { Node } from './k8s/Node';
+import { App, Config, getApps } from './k8s/App';
+
+const ENV = process.env;
+
+// ========================================================
+
+
+async function main() {
+
+	program
+		.option('--path <project dir>',  'Path to project directory [default - current]')
+		.option('--stage <stage>', 'Deploy manifests to K8s <stage>')
+
+		.option('--no-changelog', 'Skip create gitlog')
+		.option('--no-gitpush', 'Skip pushing to stage branch after deploy')
+
+		.option('--debug', 'Output extra debugging info')
+		.action(
+			async () => {
+
+				let reporter: Reporter | undefined;
+
+				try {
+
+					// ------------------
+					// Инициализируемся
+					checkEnvVars(['CI_STAGES', 'REPORTER']);
+
+					const opts = program.opts() || {};
+					const prj = new Project(opts.path);
+
+					const reporterOpts = JSON.parse(ENV.REPORTER!);
+					reporterOpts.postTitle = opts.scheme;
+
+					const pkg = JSON.parse(await Shell.cat(prj.rootPath +'/package.json') || 'no package.json file!');
+					const pkgBuild =  Number(pkg.version.split('.')[2]);
+				
+					prj.build = prj.build < pkgBuild ? pkgBuild : prj.build;
+					prj.version = `${ pkg.version.split('.').splice(0, 2).join('.') }.${ prj.build }`;
+				
+					if(!pkg.ci){
+						throw new Error('No ci config in package.json file!');
+					}
+									
+					reporter = new Reporter(prj, reporterOpts);
+
+					const config: Config = pkg.ci;
+
+					// Запускаем команду
+					await run(prj, reporter, opts, config);
+
+				} catch(e){
+
+					log.error(e);
+
+					if(reporter){
+						try {
+							await reporter.fail(e);
+						} catch(e2){
+							log.error(e2);
+						}
+				
+					}
+
+					process.exit(1);
+				}
+			}
+		);
+
+	await program.parseAsync(process.argv);
+}
+main();
+
+// ============================================
+
+async function run(prj: Project, reporter: Reporter, opts: OptionValues) {
+
+	// ------------------
+	// Инициализируемся
+
+	const release = opts.changelog ? await Jira.resolve(prj) : { tasks:[], bugs:[], changelog:''};
+
+	// 1. Меняем стейдж на новый, потому что деплоим в него!
+	const stage = opts.stage;
+
+	prj.stage = stage;
+	await reporter.startDeploy(stage);
+
+	const node = new Node(stage);
+
+	// 2. Получаем путь
+	const k8s_dir = `${ prj.rootPath }/_k8s/${stage}/`;
+	Shell.cd(k8s_dir);
+
+	// 3. Обходим ВСЕ файлы - те что не поменялись не применятся
+	const deployedApps: Record<string, string> = {};
+	const k8s_files = await Shell.ls(k8s_dir);
+
+	try{
+		
+		// Деплоим все(!) аппы - те что не поменялись не применятся
+		for (const k8s_file of k8s_files) {
+
+			const appName = k8s_file.replace('.yml', '');
+			const status = await node.apply(`${ k8s_dir }/${k8s_file}`, appName);
+
+			let msg = '';
+			if(status.valid){
+				deployedApps[ appName ] = status.msg;
+				msg = ` + <b>${appName}</b>`;
+				await reporter.send(msg);
+			} else {
+				msg = ` ❌ <b>${appName}</b> yaml is invalid!\n${ status.msg }`;
+				await reporter.send(msg);
+				throw new Error(`FAIL: Deployment app: ${appName}`);
+			}
+
+		}
+
+		await node.status(reporter);
+
+	} catch(error){
+
+		// Деплой сфейлился - надо откатыватся
+		if(Object.keys(deployedApps).length > 0){
+
+			log.error('FAIL: Deployments to rollout', Object.keys(deployedApps));
+			await reporter.send(` 🚫 <b>APPLAY FAIL</b>: Rollout all deployed apps`);
+	
+			for (const appName of Object.keys(deployedApps)) {
+				await node.exec(`rollout undo deployment/${ appName }`);
+			}
+	
+		}
+
+		await node.status(reporter);
+		throw error;
+	}
+
+	// deploy succsess, push changes to stage brunch
+	if(opts.gitpush){
+		await Git.push( stage );
+	}
+
+	await reporter.send(` + Save ${ prj.stage} -> ${ prj.version} to GitLab`);
+	await prj.saveGitLabStagesVersions();
+
+	if(opts.changelog){
+		await reporter.send(` + Resolved tasks:${ release.tasks.length }, bugs: ${ release.bugs.length }`);
+
+		const bugsDeployed = await Jira.moveBugsAsDeployed(release.bugs);
+		if(bugsDeployed.length > 0){
+			await reporter.send(` + Deployed ${ bugsDeployed.length } bugs.`);
+		} else {
+			await reporter.send(` - Deploy bugs. [SKIPED]`);
+		}
+	}
+	
+	await reporter.release(release.changelog);
+	
+}

package/libs/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/libs/Git.ts

@@ -0,0 +1,199 @@
+import Shell from './Shell';
+
+const ENV = process.env;
+
+
+// Can be redifined in ENV
+// ------------------------
+
+const GITLAB_PASS = ENV.GITLAB_PASS;
+
+// ===========================================
+
+class Commit{
+
+	date  = new Date(ENV.CI_COMMIT_TIMESTAMP || 0  * 1);
+	sha   = ENV.CI_COMMIT_SHA || '';
+	msg   = ENV.CI_COMMIT_MESSAGE || '';
+	name  = ENV.GITLAB_USER_NAME || '';
+	email = ENV.CI_COMMIT_AUTHOR || '';
+
+	constructor(row: string, delimetr: string){
+		if(!row || !delimetr){
+			return;
+		}
+
+		const cols = row.split(delimetr);
+
+		this.date = new Date(Date.parse(cols[3]));
+		this.sha = cols[0];
+		this.email = cols[2];
+		this.name = cols[1];
+		this.msg  = cols[4];
+	}
+
+	get issuesKeys(){
+		const matchedIssues = this.msg.match(/[A-Z0-9]+-\d+/g);
+		return !matchedIssues || matchedIssues.length === 0 ? [] : matchedIssues;
+	}
+
+}
+
+
+// ----------------------
+
+async function setOrigin(opts: { url?: string; jobId?: number} = {}){
+	if(!opts.jobId && !ENV.CI_JOB_ID){
+		// setOrigin ONLY in GitLab CI Jobs runner, as they are detached!
+		return;
+	}
+
+	let url = opts.url || ENV.CI_PROJECT_URL || '';
+
+	url = url.replace('https://', `https://'gitlab':${ GITLAB_PASS }@`);
+	await Shell.exec(`git remote set-url --push origin ${ url }.git`);
+	await Shell.exec(`git remote set-url origin ${ url }.git`);
+
+}
+
+// -----------------------------------------
+
+async function push(branch: string){
+	await Shell.exec(`git pull --ff origin ${ branch }`);
+	await Shell.execRepeat(`git push origin HEAD:${ branch }`);
+}
+
+// ----------------------
+
+async function makeTag(version: string){
+	const tag = `v${version}`;
+	await Shell.exec(`git tag --force "${ tag }"`);
+	await Shell.execRepeat(`git push --force origin ${ tag }`);
+}
+
+// ----------------------
+
+async function getTags(limit = 1000, mask = /v[\d]+\.[\d]+\.[\d]+$/){
+	await Shell.exec(`git fetch -t`, { ignoreError: true });
+        
+	const tagsStr  = await Shell.exec('git tag | sort --version-sort', {silent: true, ignoreError:true});
+            
+	let list = tagsStr.split('\n').filter((f)=>f.length > 2);
+	list = list.length > 0 ? list.reverse() : [tagsStr];
+
+	const tags = [];
+
+	let i = 1;
+	for (const tag of list) {
+		if(tag === '' || mask && (mask.exec(tag))=== null){
+			continue;
+		}
+		tags.push(tag);
+		i++;
+		if(i >= limit){
+			break;
+		}
+	}
+
+	return tags;
+}
+
+// -----------------------------------------
+
+async function lastTag(){
+	const list = await getTags(1);
+	if(list && Array.isArray(list) && list.length > 0){
+		return list[0];
+	}
+	return undefined;
+}
+
+// -----------------------------------------
+
+async function existTag(version: string){
+	const list = await getTags(100);
+
+	if(list && Array.isArray(list) && list.includes(`v${ version }`)){
+		return `v${ version }`;
+	}
+    
+	return undefined;
+}
+
+// -----------------------------------------
+
+async function getCommitsAndIssues(opt: { onlyJira?: boolean; limit?: number; fromTag: string; toTag: string}){
+
+	opt.onlyJira = opt.onlyJira ?? true;
+	opt.limit = opt.limit ?? 10;
+
+	const result: { commits: Record<string, any>; issues: Record<string, any> } = { commits: {}, issues: {} };
+
+	const d = '#!|!#';
+
+	const from = opt.fromTag;
+	const to   = opt.toTag   || '';
+
+	const par = `${from}..${ from !== '' && to === '' ? 'HEAD' : to }`;
+
+	const commits = await Shell.exec(`git log ${ par !== '..' ? par : '' } --pretty='format:%H${d}%cN${d}%cE${d}%ci${d}%s' --max-count=${ opt.limit }`, { silent: true });
+
+	if(!commits || commits.includes(d) === false){
+		return result;
+	}
+
+	let arr = commits.split('\n');
+	if(arr.length === 0){
+		arr = [commits];
+	}
+
+	for (const row of arr) {
+        
+		const commit = new Commit(row, d);
+		const issuesKeys = commit.issuesKeys;
+
+		if(opt.onlyJira && issuesKeys.length === 0){
+			continue;
+		}
+
+		result.commits[ commit.sha ] = commit;
+
+		for (const key of issuesKeys) {
+			const issue = result.issues[ key ] || [];
+			issue.push(commit.sha);
+			result.issues[ key ] = issue;
+		}
+	}
+
+	return result;
+}
+
+// -----------------------------------------
+
+async function getDiffFiles(fromTag?: string, opt = { silent: true, ignoreError: true }){
+
+	const from = fromTag || await lastTag();
+	const diffCmd = from && from !== '' ? `git diff --name-only HEAD ${ from }` : "find . -not -path '*/_*' -not -path '*/\.*' -not -path '*/node_modules*' -type d -maxdepth 2";
+	const diffStr = await Shell.exec(diffCmd, opt) || '';
+    
+	let arr = diffStr.split('\n');
+	if(arr.length === 0){
+		arr = [diffStr];
+	}
+
+	return arr.filter((f)=>f !== '').sort();
+}
+
+// ------------------------
+
+export default {
+	Commit,
+	setOrigin,
+	push,
+	makeTag,
+	lastTag,
+	existTag,
+	getTags,
+	getCommitsAndIssues,
+	getDiffFiles,
+};