Skip to content

Commit

Permalink
Release 2.1.1 - Fix PR updates
Browse files Browse the repository at this point in the history 
Update PR checks in case any new commits are added in an existing PR
  • Loading branch information
@sumits-systango
sumits-systango committed Aug 14, 2019
1 parent 2546865 commit e8ed648
Show file tree
Hide file tree
Showing 4 changed files with 102 additions and 43 deletions.
16 changes: 16 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@

# Commit Message Lint
Github app to validate commit message and pull request title on a pull request

Expand Down Expand Up @@ -25,6 +26,21 @@ COMMIT_MESSAGE_REGEX: <Commit Message Regex>
## Usage
Go to the `checks` section on your PR to see the result of the check run performed by the app. It will show you the result as well as the commit messages which failed.

## Local setup
Step 1. Clone the application.
Step 2. Run `npm install`
Step 3. Create `.env` file in the root directory and set the following environment variables in `.env` file :
```
APP_ID - Github app id (get from app settings page)
WEBHOOK_PROXY_URL - URL of the hosted application, use ngrok for local
WEBHOOK_SECRET - webhook secret for security, same as the one set in github app settings
PRIVATE_KEY - Get from github app settings page
LOG_LEVEL - Log level
REGEX_CONFIG_FILE_NAME - config file which contains repo config, keep it as config.yml
GITHUB_BASE_PATH - Github API path, keep it as https://api.github.com
```
Step 4. Run `npm start` to start the application

## Contributors
[Anshul Soni](https://www.linkedin.com/in/anshul-soni-3903a2101/)

Expand Down
3 changes: 2 additions & 1 deletion constants.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ module.exports = {
events: {
PULL_REQUEST_OPEN: 'pull_request.opened',
CHECK_RUN_REREQUESTED: 'check_run.rerequested',
CHECK_SUITE_REREQUESTED: 'check_suite.rerequested'
CHECK_SUITE_REREQUESTED: 'check_suite.rerequested',
CHECK_SUITE_REQUESTED: 'check_suite.requested'
}
};
109 changes: 70 additions & 39 deletions controllers/pullRequest.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,28 +21,38 @@ const outputTitleFail = constants.output_title_fail;

/**
* Commit messages and PR title Validator
* @param {Object} app
* @param {Object} context
* @param {Object} configuration
* @param {Boolean} updateCheckRunFlag
* @param {Object} app Probot app object
* @param {Object} context Github event context
* @param {Object} configuration Contains data (i.e regex for PR and Commits) from config.yml file
* @param {Boolean} updateCheckRunFlag Update existing check run
* @param {Boolean} createCheckRunFlag Create existing check run
*/
module.exports.commitAndTitleValidator = async (app, context, configuration, updateCheckRunFlag) => {
module.exports.commitAndTitleValidator = async (app, context, configuration, updateCheckRunFlag, createCheckRunFlag) => {
try {
let { prTitleRegex, commitTitleRegex } = regexExtractor(configuration);
let { owner, repository, pullRequestTitle, pullNumber } = prDetailsExtractor(context);
// find commits
/**
* Find all commits for a pull request
*/
let commits = await listCommitsOfPullRequest(context, owner, repository, pullNumber);
if(updateCheckRunFlag) {
/**
* If `PR title` is not present in `context`
*/
if (!pullRequestTitle) {
/**
* In case of check re-run and check suite re-run or Re-run all checks, get pull request data
* In case of new check suite requested, check re-run and check suite re-run or Re-run all checks, get
* pull request data
*/
const pullRequestDetails = await getPullRequest(context, owner, repository, pullNumber);
if(pullRequestDetails && pullRequestDetails.data && pullRequestDetails.data.title) {
/**
* Get PR title
*/
if (pullRequestDetails && pullRequestDetails.data && pullRequestDetails.data.title) {
pullRequestTitle = pullRequestDetails.data.title;
}
}
let result = checkMessagesFormat(pullRequestTitle, commits.data, prTitleRegex, commitTitleRegex);
await createOrUpdateCheckRun(context, owner, repository, result, updateCheckRunFlag);
await createOrUpdateCheckRun(context, owner, repository, result, updateCheckRunFlag, createCheckRunFlag);
} catch (error) {
app.log(error);
}
Expand Down Expand Up @@ -70,7 +80,9 @@ function checkMessagesFormat(pullRequestTitle, commits, prTitleRegex, commitMsgR
};
checkPrTitle(pullRequestTitle, prTitleRegex, flags);
if (commits && Array.isArray(commits) && commits.length) {
// check all commit messages
/**
* Check all commit messages
*/
checkCommitMessages(commits, commitIds, commitMsgRegex, mergeCommitRegex, flags);
result = concludeCheckRunParams(prTitleRegex, commitMsgRegex, commitIds, flags);
}
Expand All @@ -87,12 +99,16 @@ function checkMessagesFormat(pullRequestTitle, commits, prTitleRegex, commitMsgR
* @param {Object} flags
*/
function checkPrTitle(pullRequestTitle, prTitleRegex, flags) {
// pull request title format
/**
* Check pull request title format
*/
if (checkRegex(pullRequestTitle, prTitleRegex)) {
flags.pullReqTitleStatus = true;
flags.pullReqTitleStatusMsg = messages.valid_pull_request_message;
} else {
// invalid pull Request title
/**
* Invalid pull Request title
*/
flags.pullReqTitleStatus = false;
flags.pullReqTitleStatusMsg = messages.invalid_pull_request_message;
}
Expand All @@ -107,7 +123,9 @@ function checkPrTitle(pullRequestTitle, prTitleRegex, flags) {
* @param {Object} flags
*/
function checkCommitMessages(commits, commitIds, commitMsgRegex, mergeCommitRegex, flags) {
// check all commit messages
/**
* Check all commit messages
*/
for (let index = 0; index < commits.length; index++) {
const element = commits[index];
const commitMessage = element.commit.message;
Expand Down Expand Up @@ -157,19 +175,27 @@ function concludeCheckRunParams(prTitleRegex, commitMsgRegex, commitIds, flags)
};
let status = checkRunStatusCompleted;
if (!prTitleRegex && !commitMsgRegex) {
// pull request and commit message configration regex not set
/**
* Pull request and commit message configration regex not set
*/
output.title = `${messages.pr_and_commit_message_configuration_not_set}`;
output.summary = `${messages.pr_and_commit_message_configuration_not_set}<br/>`;
} else if (!commitMsgRegex) {
// commit message configration regex not set
/**
* Commit message configration regex not set
*/
output.title = `${messages.commit_message_configuration_not_set}`;
output.summary = `${flags.pullReqTitleStatusMsg}<br/>${messages.commit_message_configuration_not_set}<br/>`;
} else if (!prTitleRegex) {
// pull request configration regex not set
/**
* Pull request configration regex not set
*/
output.title = `${messages.pr_configuration_not_set}`;
output.summary = `${messages.pr_configuration_not_set}<br/>${flags.commitMsgStatusMsg}<br/>${flags.invalidCommits}<br/>`;
}
// set invalid commit messages and count
/**
* Set invalid commit messages and count
*/
if (flags.invalidCommitsCount && flags.invalidCommitsCount >= constants.INVALID_COMMIT_LIMIT) {
output.summary += `${flags.invalidCommitsCount} ${flags.otherInvalidCommitMessages}`;
}
Expand All @@ -194,29 +220,29 @@ function prDetailsExtractor(context) {
pullRequestTitle: '',
pullNumber: 0
};
if(context.payload) {
if (context.payload) {
/**
* Extract repository details
*/
if(context.payload.repository) {
if(context.payload.repository.owner && context.payload.repository.owner.login) {
if (context.payload.repository) {
if (context.payload.repository.owner && context.payload.repository.owner.login) {
result.owner = context.payload.repository.owner.login;
}
if(context.payload.repository.name) {
if (context.payload.repository.name) {
result.repository = context.payload.repository.name;
}
}
/**
* Extract pr title and pull number
* Extract PR title and pull number
*/
if(context.payload.pull_request && context.payload.pull_request.title) {
if (context.payload.pull_request && context.payload.pull_request.title) {
result.pullRequestTitle = context.payload.pull_request.title;
}
if(context.payload.number) {
if (context.payload.number) {
result.pullNumber = context.payload.number;
} else if(context.payload.check_run && context.payload.check_run.check_suite && context.payload.check_run.check_suite.pull_requests && context.payload.check_run.check_suite.pull_requests.length && context.payload.check_run.check_suite.pull_requests[0].number) {
} else if (context.payload.check_run && context.payload.check_run.check_suite && context.payload.check_run.check_suite.pull_requests && context.payload.check_run.check_suite.pull_requests.length && context.payload.check_run.check_suite.pull_requests[0].number) {
result.pullNumber = context.payload.check_run.check_suite.pull_requests[0].number;
} else if(context.payload.check_suite && context.payload.check_suite.pull_requests.length && context.payload.check_suite.pull_requests[0].number) {
} else if (context.payload.check_suite && context.payload.check_suite.pull_requests.length && context.payload.check_suite.pull_requests[0].number) {
result.pullNumber = context.payload.check_suite.pull_requests[0].number;
}
}
Expand All @@ -232,7 +258,7 @@ function regexExtractor(configuration) {
prTitleRegex: '',
commitTitleRegex: ''
};
result.prTitleRegex = (configuration && configuration.PR_TITLE_REGEX) ? configuration.PR_TITLE_REGEX: '';
result.prTitleRegex = (configuration && configuration.PR_TITLE_REGEX) ? configuration.PR_TITLE_REGEX : '';
result.commitTitleRegex = (configuration && configuration.COMMIT_MESSAGE_REGEX) ? configuration.COMMIT_MESSAGE_REGEX : '';
return result;
}
Expand All @@ -243,32 +269,37 @@ function regexExtractor(configuration) {
* @param {String} owner
* @param {String} repository
* @param {Object} result
* @param {boolean} updateCheckRunFlag
* @param {boolean} updateCheckRunFlag
* @param {boolean} createCheckRunFlag
*/
async function createOrUpdateCheckRun(context, owner, repository, result, updateCheckRunFlag) {
async function createOrUpdateCheckRun(context, owner, repository, result, updateCheckRunFlag, createCheckRunFlag) {
if (result && result.commitIds && Array.isArray(result.commitIds) && result.commitIds.length) {
for (let index = 0; index < result.commitIds.length; index++) {
const commitId = result.commitIds[index];
if(updateCheckRunFlag) {
if (updateCheckRunFlag) {
/**
* Update existing check run
*/
const checkRunId = context.payload.check_run.id;
await updateCheckRun(context, owner, repository, commitId, result.status, result.conclusion, result.output, checkRunId);
} else {
} else if (createCheckRunFlag) {
/**
* Create check new run
*/
/**
* check if checkSuite exists or not for the commit
*/
let checkSuiteList = await listCheckSuite(context, owner, repository, commitId);
if (!checkSuiteList || (checkSuiteList && checkSuiteList.data && checkSuiteList.data.total_count && checkSuiteList.data.total_count === 0)) {
// create check suite for a particular commit
await createCheckSuite(context, owner, repository, commitId);
}
// create check run
await createCheckRun(context, owner, repository, commitId, result.status, result.checkRunName, result.conclusion, result.output);
let checkSuiteList = await listCheckSuite(context, owner, repository, commitId);
if (!checkSuiteList || (checkSuiteList && checkSuiteList.data && checkSuiteList.data.total_count && checkSuiteList.data.total_count === 0)) {
/**
* create check suite for a particular commit
*/
await createCheckSuite(context, owner, repository, commitId);
}
/**
* create check run
*/
await createCheckRun(context, owner, repository, commitId, result.status, result.checkRunName, result.conclusion, result.output);
}
}
}
Expand Down
17 changes: 14 additions & 3 deletions index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ module.exports = async app => {
app.on(events.PULL_REQUEST_OPEN, async (context) => {
try {
const configuration = await context.config(configFileName);
await commitAndTitleValidator(app, context, configuration, false);
await commitAndTitleValidator(app, context, configuration, false, true);
} catch (error) {
app.log(error);
}
Expand All @@ -39,7 +39,7 @@ module.exports = async app => {
app.on(events.CHECK_RUN_REREQUESTED, async (context) => {
try {
const configuration = await context.config(configFileName);
await commitAndTitleValidator(app, context, configuration, true);
await commitAndTitleValidator(app, context, configuration, true, false);
} catch (error) {
app.log(error);
}
Expand All @@ -54,7 +54,18 @@ module.exports = async app => {
id: listOfCheckRuns.data.check_runs[0].id
};
const configuration = await context.config(configFileName);
await commitAndTitleValidator(app, context, configuration, true);
await commitAndTitleValidator(app, context, configuration, true, false);
} catch (error) {
app.log(error);
}
});
/**
* Run all checks (Check Suite Requested) event listener
*/
app.on(events.CHECK_SUITE_REQUESTED, async (context) => {
try {
const configuration = await context.config(configFileName);
await commitAndTitleValidator(app, context, configuration, false, true);
} catch (error) {
app.log(error);
}
Expand Down

0 comments on commit e8ed648

Please sign in to comment.