All files jiraUpdate.js

88.73% Statements 63/71
82.54% Branches 52/63
100% Functions 10/10
88.73% Lines 63/71

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 2123x 3x 3x     54x 54x               54x 54x 54x 1x       53x 53x 53x 53x       54x     54x 16x 16x     54x 7x 7x 7x                       53x               53x   53x                 54x 54x 54x   54x   54x         54x 54x     54x 108x     54x 162x     54x               16x         7x           54x 54x   54x     41x     54x     53x     54x 4x                                                             54x           54x 54x 54x   54x 54x             54x   3x   51x     12x 12x           39x               39x   4x 4x       35x     3x    
const core           = require( '@actions/core' )
const JiraClient     = require( 'jira-connector' )
const translateToADF = require( 'md-to-adf' )
 
async function handleJIRAUpdate( subtaskOrIssuetoChange, issueEventTriggered, DEBUG ) {
	try {
		const jiraSession = new JiraClient( {
												host:       core.getInput( 'JIRA_BASEURL' ),
												basic_auth: {
													email:     core.getInput( 'JIRA_USEREMAIL' ),
													api_token: core.getInput( 'JIRA_APITOKEN' ),
												},
											} )
		
		const changeToPush = listPrioritizedFieldsDifference( issueEventTriggered, subtaskOrIssuetoChange )
		DEBUG( changeToPush )
		if( Object.keys( changeToPush ).length <= 0 ) {
			console.log( `-- all fields are synced between issue #${ issueEventTriggered.details[ 'number' ] } ` +
						 `in GITHUB and issue ${ subtaskOrIssuetoChange.key } in JIRA` )
		}
		else {
			console.log( `Updating JIRA Issue: ${ JSON.stringify( subtaskOrIssuetoChange.key ) }` )
			const updateResult = await jiraUpdateIssue( jiraSession, subtaskOrIssuetoChange, changeToPush )
			Eif( updateResult ) {
				console.log( `--- updated with: ${ JSON.stringify( changeToPush ) }` )
			}
		}
		
		const stateTransition = await jiraListStateToTransitionTo( jiraSession,
																   subtaskOrIssuetoChange,
																   issueEventTriggered )
		if( stateTransition ) {
			await jiraPushIssueToTransition( jiraSession, subtaskOrIssuetoChange, stateTransition )
			console.log( `-- pushed ${ subtaskOrIssuetoChange.key } to transition` )
		}
		
		if( issueEventTriggered.event === 'deleted' ) {
			console.log( `Deleting JIRA Issue: ${ subtaskOrIssuetoChange.key }` )
			await jiraDeleteIssue( jiraSession, subtaskOrIssuetoChange )
			console.log( `-- deleted ${ subtaskOrIssuetoChange.key }` )
		}
	}
	catch( errorUpdate ) {
		DEBUG( `Error during update ${ errorUpdate }` )
		throw errorUpdate
	}
}
 
async function jiraUpdateIssue( jiraSession, subtaskOrIssueToUpdate, updateToApply ) {
	
	//we are forcing the v3 to allow for ADF description and not string
	var options = {
		uri:                jiraSession.buildURL( '/issue/' + subtaskOrIssueToUpdate.key, 3 ),
		method:             'PUT',
		json:               true,
		followAllRedirects: true,
		qs:                 null,
		body:               { fields: updateToApply },
	}
	console.log( `>>>>>Sending JIRA UPDATE \n----------------\n${ JSON.stringify( options ) } \n----------------\n` )
	
	return jiraSession.makeRequest( options, null, 'Issue Updated' )
	
	// return await jiraSession.issue.editIssue( {
	// 											  issueKey: subtaskOrIssueToUpdate.key,
	// 											  issue:    { fields: updateToApply },
	// 										  } )
}
 
async function jiraFindTransitions( jiraSession, subtaskOrIssueToUpdate ) {
	const nameTodoTransition 			= core.getInput( 'JIRA_STATE_TODO' )
	const nameInProgressTransition 		= core.getInput( 'JIRA_STATE_INPROGRESS' )
	const nameDoneTransition 			= core.getInput( 'JIRA_STATE_DONE' )
	
	const jiraTransitions = await jiraSession.issue.getTransitions( { issueKey: subtaskOrIssueToUpdate.key } )
	
	Iif( !jiraTransitions.transitions ||
		Object.keys( jiraTransitions.transitions ).length === 0 )
		return null
	
	
	const transitionTodo = jiraTransitions.transitions
										  .find( currentTransition => ( currentTransition.to
																		&& currentTransition.to
																		&& ( currentTransition.to.name === nameTodoTransition ) ) )
	const transitionInProgress = jiraTransitions.transitions
												.find( currentTransition => ( currentTransition.to
																			  && currentTransition.to
																			  && ( currentTransition.to.name === nameInProgressTransition ) ) )
	const transitionDone = jiraTransitions.transitions
										  .find( currentTransition => ( currentTransition.to
																		&& currentTransition.to
																		&& ( currentTransition.to.name === nameDoneTransition ) ) )
	return {
		"todo": 		transitionTodo ? transitionTodo.id : null,
		"inprogress":	transitionInProgress ? transitionInProgress.id : null,
		"done":			transitionDone ? transitionDone.id : null
	}
}
 
async function jiraPushIssueToTransition( jiraSession, subtaskOrIssueToUpdate, idTransitionToPushThrough ) {
	return await jiraSession.issue.transitionIssue( { 	issueKey: 		subtaskOrIssueToUpdate.key,
														transition: 	{ id: idTransitionToPushThrough } } )
}
 
async function jiraDeleteIssue( jiraSession, subtaskOrIssueToUpdate ) {
	await jiraSession.issue.deleteIssue( { issueKey: subtaskOrIssueToUpdate.key } )
}
 
function listPrioritizedFieldsDifference( issueChangeTriggered, subtaskOrIssueToChange ) {
	//TODO missing events to consider [ "assigned", "unassigned", "unlabeled", "milestoned", "demilestoned"]
	// we only sync summary and description for now
	const epicMode = core.getInput( 'EPIC_MODE' ) == 'true'
	const changes  = {}
	
	if( issueChangeTriggered.details.title
		&& subtaskOrIssueToChange.fields
		&& subtaskOrIssueToChange.fields.summary !== issueChangeTriggered.details.title ) {
		changes.summary = issueChangeTriggered.details.title
	}
	
	if( issueChangeTriggered.details.body
		&& subtaskOrIssueToChange.fields
		&& subtaskOrIssueToChange.fields.description !== issueChangeTriggered.details.body ) {
		changes.description = translateToADF( issueChangeTriggered.details.body )
	}
	
	if( epicMode && subtaskOrIssueToChange.fieldIDEpic && subtaskOrIssueToChange.keyEpicLinked ) {
		changes[ subtaskOrIssueToChange.fieldIDEpic ] = subtaskOrIssueToChange.keyEpicLinked
	}
	
	// if we want to sync the resolution status
	// if( reporterOn && subtaskOrIssueToChange.fields.resolution && subtaskOrIssueToChange.fields.resolution.id or
	// name ){ }
	
	
	// if we want to sync the workflow status
	// if( reporterOn && subtaskOrIssueToChange.fields.status && subtaskOrIssueToChange.fields.status.id or name ){
	//}
	
	// if we want to sync the assignee
	// if( reporterOn && subtaskOrIssueToChange.fields.assignee && subtaskOrIssueToChange.fields.assignee.emailAddress
	// ){ }
	
	// if we want to sync the creator
	// if( reporterOn && subtaskOrIssueToChange.fields.creator && subtaskOrIssueToChange.fields.creator.emailAddress ){
	//}
	
	// if we want to sync the reporter
	// if( reporterOn && subtaskOrIssueToChange.fields.reporter && subtaskOrIssueToChange.fields.reporter.emailAddress
	// ){ }
	
	// if we want to sync the comments
	// if( reporterOn && subtaskOrIssueToChange.fields.comment && subtaskOrIssueToChange.fields.comment.comments &&
	// 		subtaskOrIssueToChange.fields.comment.comments[ X ] .author
	// 				&& subtaskOrIssueToChange.fields.comment.comments[ X ] .author.emailAddress <= email not present
	// in GH, login is only accessible subtaskOrIssueToChange.fields.comment.comments[ X ] .body <= ADF of GH
	// body	){ //what to do with the updateAuthor? }
	
	return changes
}
 
async function jiraListStateToTransitionTo( jiraSession, subtaskOrIssueToUpdate, issueChangeTriggered ){
	//TODO missing events to consider [ "assigned", "unassigned", "unlabeled", "milestoned", "demilestoned"]
	//we try to sync the state only when they're different
	const nameTodoTransition 			= core.getInput( 'JIRA_STATE_TODO' )
	const nameInProgressTransition 		= core.getInput( 'JIRA_STATE_INPROGRESS' )
	const nameDoneTransition 			= core.getInput( 'JIRA_STATE_DONE' )
	
	const transitions = await jiraFindTransitions( jiraSession, subtaskOrIssueToUpdate )
	Iif( !transitions ){
		console.log( `--! no compatible transition with those configured` )
		return null
	}
	
	
	//we have to make sure to have a closed GITHUB issue has a DONE JIRA Issue
	if( issueChangeTriggered.details.state === 'closed'
		&& subtaskOrIssueToUpdate.fields.status.name === nameDoneTransition ){
		return null
	}
	else if( issueChangeTriggered.details.state === 'closed'
			 && ( subtaskOrIssueToUpdate.fields.status.name === nameTodoTransition
				  || subtaskOrIssueToUpdate.fields.status.name === nameInProgressTransition ) ){
		console.log( `Transitioning JIRA Issue ${ subtaskOrIssueToUpdate.key } to ${ nameDoneTransition }` )
		return transitions.done
	}
	
	//apparently Github Issue can on be closed or open, so lets skip this => if( issueChangeTriggered.details.state === 'open' ){
	
	//we have to make sure to have the JIRA Issue in something else than DONE
	Iif( issueChangeTriggered.details.assignee ){
		if( subtaskOrIssueToUpdate.fields.status.name === nameTodoTransition
			|| subtaskOrIssueToUpdate.fields.status.name === nameDoneTransition ){
			console.log( `Transitioning JIRA Issue ${ subtaskOrIssueToUpdate.key } to ${ nameInProgressTransition }` )
			return transitions.inprogress
		}
	}
	
	if( subtaskOrIssueToUpdate.fields.status.name === nameInProgressTransition
		|| subtaskOrIssueToUpdate.fields.status.name === nameDoneTransition ){
		console.log( `Transitioning JIRA Issue ${ subtaskOrIssueToUpdate.key } to ${ nameTodoTransition }` )
		return transitions.todo
	}
	
	//we ignore any other transition with names we don't know
	return null
}
 
module.exports.handleJIRAUpdate = handleJIRAUpdate