Skip to content

Commit 5146d05

Browse files
update: result messages
Update result message when config file not present
1 parent 433c10a commit 5146d05

File tree

5 files changed

+82
-85
lines changed

5 files changed

+82
-85
lines changed

.gitignore

+4-1
Original file line numberDiff line numberDiff line change
@@ -93,4 +93,7 @@ typings/
9393

9494
### Serverless ###
9595
# Ignore build directory
96-
.serverless
96+
.serverless
97+
98+
##Apple
99+
.DS_store

controllers/pullRequest.js

+26-8
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,10 @@ module.exports.commitAndTitleValidator = async (app, context) => {
4444
* check Messages Format
4545
* @param {String} pullRequestTitle
4646
* @param {Array} commits
47-
* @param {Object} prTitle
48-
* @param {Object} commitMsg
47+
* @param {Object} prTitleRegex
48+
* @param {Object} commitMsgRegex
4949
*/
50-
function checkMessagesFormat(pullRequestTitle, commits, prTitle, commitMsg) {
50+
function checkMessagesFormat(pullRequestTitle, commits, prTitleRegex, commitMsgRegex) {
5151
try {
5252
let result = {};
5353
let commitIds = [];
@@ -60,12 +60,13 @@ function checkMessagesFormat(pullRequestTitle, commits, prTitle, commitMsg) {
6060
let commitMsgStatus = true;
6161
let commitMsgStatusMsg = messages.valid_commit_message;
6262
let outputTitle = outputTitleFail;
63+
let output = {};
6364
/**
6465
* pull Request Title check : starts
6566
*/
6667
// pull request title format
6768
let mergePattern = /^(Merge pull request)/;
68-
if (checkRegex(pullRequestTitle, prTitle)) {
69+
if (checkRegex(pullRequestTitle, prTitleRegex)) {
6970
pullReqTitleStatus = true;
7071
pullReqTitleStatusMsg = messages.valid_pull_request_message;
7172
} else {
@@ -86,7 +87,7 @@ function checkMessagesFormat(pullRequestTitle, commits, prTitle, commitMsg) {
8687
const element = commits[index];
8788
const commitMessage = element.commit.message;
8889
commitIds.push(commits[index].sha);
89-
if (!checkRegex(commitMessage, commitMsg) && !checkRegex(commitMessage, mergePattern)) {
90+
if (!checkRegex(commitMessage, commitMsgRegex) && !checkRegex(commitMessage, mergePattern)) {
9091
invalidCommitsCount++;
9192
commitMsgStatus = false;
9293
commitMsgStatusMsg = messages.invalid_commit_message;
@@ -114,11 +115,28 @@ function checkMessagesFormat(pullRequestTitle, commits, prTitle, commitMsg) {
114115
/**
115116
* set check run status
116117
*/
117-
let status = checkRunStatusCompleted;
118-
let output = {
118+
output = {
119119
title: outputTitle,
120-
summary: `${pullReqTitleStatusMsg}<br/>${commitMsgStatusMsg}<br/>${invalidCommits}<br/>${invalidCommitsCount} ${otherInvalidCommitMessages}`
120+
summary: `${pullReqTitleStatusMsg}<br/>${commitMsgStatusMsg}<br/>${invalidCommits}<br/>`
121121
};
122+
let status = checkRunStatusCompleted;
123+
if ((!prTitleRegex || !prTitleRegex.regexPattern) && (!commitMsgRegex || !commitMsgRegex.regexPattern)) {
124+
// pull request and commit message configration regex not set
125+
output.title = `${messages.pr_and_commit_message_configuration_not_set}`;
126+
output.summary = `${messages.pr_and_commit_message_configuration_not_set}<br/>`;
127+
} else if (!commitMsgRegex || !commitMsgRegex.regexPattern) {
128+
// commit message configration regex not set
129+
output.title = `${messages.commit_message_configuration_not_set}`;
130+
output.summary = `${pullReqTitleStatusMsg}<br/>${messages.commit_message_configuration_not_set}<br/>`;
131+
} else if (!prTitleRegex || !prTitleRegex.regexPattern) {
132+
// pull request configration regex not set
133+
output.title = `${messages.pr_configuration_not_set}`;
134+
output.summary = `${messages.pr_configuration_not_set}<br/>${commitMsgStatusMsg}<br/>${invalidCommits}<br/>`;
135+
}
136+
// set invalid commit messages and count
137+
if (invalidCommitsCount && invalidCommitsCount >= defaultJson.INVALID_COMMIT_LIMIT) {
138+
output.summary += `${invalidCommitsCount} ${otherInvalidCommitMessages}`;
139+
}
122140
result = {
123141
commitIds,
124142
status,

default.json

+4-3
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,17 @@
1313
"valid_pull_request_message": "Pull request title is valid",
1414
"invalid_pull_request_message": "Pull request title is invalid",
1515
"multiple_other_invalid_message": "other messages are invalid",
16-
"single_other_invalid_message": "other message is invalid"
16+
"single_other_invalid_message": "other message is invalid",
17+
"pr_configuration_not_set": "Pull request title format is not configured",
18+
"commit_message_configuration_not_set": "Commit message format is not configured",
19+
"pr_and_commit_message_configuration_not_set": "Pull request title and commit message format are not configured"
1720
},
1821
"CHECK_RUN_STATUS_COMPLETED": "completed",
1922
"CHECK_RUN_NAME": "commit message validator",
2023
"output_title_success": "Message validation passed!!!",
2124
"output_title_fail": "Message validation failed!!!",
22-
"output_summary": "",
2325
"INVALID_COMMIT_LIMIT": 3,
2426
"USER_AGENT": "commit-message-validator-app",
25-
"CONFIG_FILENAME": "validationconfig",
2627
"invalid_commit_list": {
2728
"commit_id": "sha:",
2829
"commit_message": "message:"

helpers/config.js

+2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ module.exports.getConfigData = async (app, owner, repository, fileName) => {
1616
let fileUrl = '';
1717
let fileDataString = '';
1818
searchFileResult = await searchFileInRepository(fileName, owner, repository);
19+
app.log(searchFileResult);
1920
// files found
2021
if (searchFileResult && searchFileResult.items && Array.isArray(searchFileResult.items)) {
2122
for (let index = 0; index < searchFileResult.items.length; index++) {
@@ -49,6 +50,7 @@ module.exports.getRegexFromConfig = async (app, owner, repository, fileName) =>
4950
commitMsg: ''
5051
};
5152
let fileDataString = await exportObject.getConfigData(app, owner, repository, fileName);
53+
app.log(fileDataString);
5254
let fileDataArray = fileDataString.split('\n');
5355
for (let index = 0; index < fileDataArray.length; index++) {
5456
const element = fileDataArray[index];

0 commit comments

Comments
 (0)