4 Commits

Author SHA1 Message Date
3754638793 WIP 2018-10-17 15:56:11 -07:00
cc7c5968cb feat: add history tracking 2018-10-17 15:08:30 -07:00
5a1d666dae chore: check in data dir 2018-10-17 15:08:11 -07:00
bf7159ec33 chore: add dotenv, ocktkat 2018-10-17 11:11:31 -07:00
16 changed files with 148 additions and 294 deletions

View File

@@ -1,3 +0,0 @@
### Authors
- joe fleming ([w33ble](https://github.com/w33ble))

View File

@@ -1,35 +0,0 @@
### Changelog
#### [v1.3.0](https://git.w33ble.com/w33ble/gh-action-bot/compare/v1.2.1...v1.3.0) (23 October 2018)
- feat: add a clean command [`e8e252f`](https://git.w33ble.com/w33ble/gh-action-bot/commit/e8e252f73c315663a6cc79336c914615bdfe1ad5)
- chroe: user logger on force errors [`41d7905`](https://git.w33ble.com/w33ble/gh-action-bot/commit/41d79051f8550f428ea41505ab4740caa0509e93)
- docs: add clean script to readme [`a8800d1`](https://git.w33ble.com/w33ble/gh-action-bot/commit/a8800d1593f5cbd4fb5a90a895bcc88aa004e892)
#### [v1.2.1](https://git.w33ble.com/w33ble/gh-action-bot/compare/v1.2.0...v1.2.1) (23 October 2018)
- feat: add more debugging output [`3db973f`](https://git.w33ble.com/w33ble/gh-action-bot/commit/3db973febc5387605279f7855976a4ec431f0362)
- fix: correctly handle errors in logger.error [`c70e8e4`](https://git.w33ble.com/w33ble/gh-action-bot/commit/c70e8e49ecb9041b22a8f4b92398339d45871ca1)
- fix: correctly check for pr author [`f4c3e02`](https://git.w33ble.com/w33ble/gh-action-bot/commit/f4c3e02c1a31aea89a565f5685dd3b879bd38b14)
#### [v1.2.0](https://git.w33ble.com/w33ble/gh-action-bot/compare/v1.1.0...v1.2.0) (23 October 2018)
- feat: add debugging output to script [`0dce327`](https://git.w33ble.com/w33ble/gh-action-bot/commit/0dce32781b0f8c138d7f8b28382289d67be730dd)
- feat: debug logging and better timestamps [`08799b4`](https://git.w33ble.com/w33ble/gh-action-bot/commit/08799b48d74d12266d5ebb85811f5d3fa046b086)
- docs: add note about using DEBUG=1 output [`872d9c7`](https://git.w33ble.com/w33ble/gh-action-bot/commit/872d9c790fc723f1b255536225be60f547cf5196)
#### [v1.1.0](https://git.w33ble.com/w33ble/gh-action-bot/compare/v1.0.1...v1.1.0) (22 October 2018)
- feat: add timestamp to log output [`725638e`](https://git.w33ble.com/w33ble/gh-action-bot/commit/725638ee6b7fbb816518239f5524f6c37056da2e)
#### [v1.0.1](https://git.w33ble.com/w33ble/gh-action-bot/compare/v1.0.0...v1.0.1) (22 October 2018)
- feat: add a force retest script [`def91e3`](https://git.w33ble.com/w33ble/gh-action-bot/commit/def91e35d3c8028b7f78772049b0e93c3c8d677e)
- fix: add error handling code [`3b44968`](https://git.w33ble.com/w33ble/gh-action-bot/commit/3b4496864b0e9bd248e6d4ea12f2608dd41c0374)
- docs: add info about force script [`eb4666c`](https://git.w33ble.com/w33ble/gh-action-bot/commit/eb4666c3df312a9b5d8eb8ff5cf58027d794b417)
- docs: add token info to readme [`4794c6b`](https://git.w33ble.com/w33ble/gh-action-bot/commit/4794c6be2673402d5a76d8c61974ba3f9c936977)
### [v1.0.0](https://git.w33ble.com/w33ble/gh-action-bot/compare/v0.1.0...v1.0.0) (18 October 2018)
- feat: allow filtering by pr author [`68cccb7`](https://git.w33ble.com/w33ble/gh-action-bot/commit/68cccb72a9801c502003c7b913844fc01721a6e3)
#### v0.1.0 (18 October 2018)
- docs: update readme, add sample env [`a28d6a2`](https://git.w33ble.com/w33ble/gh-action-bot/commit/a28d6a25096efb9c8acea3e8d26e7f7f50dfd6b5)
- feat: add retest comment, delete it [`ced41f4`](https://git.w33ble.com/w33ble/gh-action-bot/commit/ced41f4a495823205e5769e4531f923a982d29b4)
- feat: process 2 pages of events [`c117cb8`](https://git.w33ble.com/w33ble/gh-action-bot/commit/c117cb847d5cb7a6b57b705e0c192cc725c0d646)
- feat: fetch data for prs that need retest [`d1cfd7c`](https://git.w33ble.com/w33ble/gh-action-bot/commit/d1cfd7c20b17802f2de1b9153ae9a8392ed1bc44)
- feat: add history tracking [`b6b5c27`](https://git.w33ble.com/w33ble/gh-action-bot/commit/b6b5c27ffc43ff2e1c1ccf041958021cf7c8c4d4)

View File

@@ -1,27 +1,10 @@
# gh-action-bot
Action bot for Github. Checks a repo's event stream and leaves a ghost comment when your criteria is met.
Action bot for Github.
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/w33ble/gh-action-bot/master/LICENSE)
[![Project Status](https://img.shields.io/badge/status-stable-green.svg)](https://nodejs.org/api/documentation.html#documentation_stability_index)
## Usage
`yarn start owner/repo`: watch the event stream and handle matches
`yarn run force owner/repo pr_number`: force a comment on a specific pr, by number
`yanr run clean owner/repo pr_number`: removed any comments that match the owner and body requirements
You'll need to set some environment flags. Check `sample-env` for what is available, and you can copy the file to `.env` in the root and add your settings there as well.
### Personal Access Token
You will need to provide a Github [Personal Access Token](https://github.com/settings/tokens/new). It will need `write:org` access in order to create comments.
### Debugging
If the script isn't doing what you expect, you can get more output from it by prepending the script with `DEBUG=1`.
[![npm](https://img.shields.io/npm/v/gh-action-bot.svg)](https://www.npmjs.com/package/gh-action-bot)
[![Project Status](https://img.shields.io/badge/status-experimental-orange.svg)](https://nodejs.org/api/documentation.html#documentation_stability_index)
#### License

View File

@@ -1,7 +1,6 @@
{
"name": "gh-action-bot",
"version": "1.3.0",
"private": true,
"version": "0.0.0",
"description": "Action bot for Github",
"main": "index",
"module": "index.mjs",
@@ -9,9 +8,7 @@
"lint": "eslint \"*.{js,mjs}\" \"src/**/*.{js,mjs}\"",
"precommit": "lint-staged",
"version": "auto-changelog -p && auto-authors && git add CHANGELOG.md AUTHORS.md",
"start": "node .",
"force": "node -r esm src/force.mjs",
"clean": "node -r esm src/clean.mjs"
"start": "node ."
},
"repository": {
"type": "git",

View File

@@ -1,7 +0,0 @@
GITHUB_ACCESS_TOKEN=xxx
COMMENT_ACTOR=username
COMMENT_BODY_REGEXP=build failed
COMMENT_BODY_REGEXP_FLAGS=i
PULL_LABEL_FILTER=
PULL_AUTHOR_FILTER=
PULL_RETEST_BODY=retest

View File

@@ -1,30 +0,0 @@
import dotenv from 'dotenv';
import logger from './lib/logger.mjs';
import createRepo from './lib/create_repo.mjs';
import getPullComments from './lib/get_pull_comments.mjs';
import { deleteComment } from './lib/comments.mjs';
dotenv.config();
async function forceRetest() {
const [ownerRepo, prNumber] = process.argv.splice(2);
const { COMMENT_BODY_REGEXP, COMMENT_BODY_REGEXP_FLAGS, COMMENT_ACTOR } = process.env;
if (!ownerRepo || !prNumber) {
throw new Error('You must specify an owner/repo combo and a pull request number');
}
const repo = createRepo(ownerRepo);
const comments = await getPullComments(repo, prNumber);
const bodyRegexp = new RegExp(COMMENT_BODY_REGEXP, COMMENT_BODY_REGEXP_FLAGS);
comments
.filter(comment => bodyRegexp.test(comment.body) && comment.owner === COMMENT_ACTOR)
.forEach(async comment => {
const res = await deleteComment(repo, comment.id);
if (res) logger.debug(`Comment ${comment.id} deleted`);
else logger.error(new Error(`Failed to remove comment ${comment.id}`));
});
}
forceRetest().catch(err => logger.error(err));

View File

@@ -1,23 +0,0 @@
import dotenv from 'dotenv';
import logger from './lib/logger.mjs';
import createRepo from './lib/create_repo.mjs';
import { createComment, deleteComment } from './lib/comments.mjs';
dotenv.config();
async function forceRetest() {
const [ownerRepo, prNumber] = process.argv.splice(2);
const { PULL_RETEST_BODY } = process.env;
if (!ownerRepo || !prNumber) {
throw new Error('You must specify an owner/repo combo and a pull request number');
}
const repo = createRepo(ownerRepo);
const comment = await createComment(repo, prNumber, PULL_RETEST_BODY);
const res = await deleteComment(repo, comment.id);
if (res) logger.debug(`Comment ${comment.id} deleted`);
else logger.error(new Error(`Failed to remove comment ${comment.id}`));
}
forceRetest().catch(err => logger.error(err));

View File

@@ -1,92 +1,79 @@
import dotenv from 'dotenv';
import logger from './lib/logger.mjs';
import createRepo from './lib/create_repo.mjs';
import getComments from './lib/get_comments.mjs';
import getPull from './lib/get_pull.mjs';
import getCommits from './lib/get_commits.mjs';
import getCommitStatus from './lib/get_commit_status.mjs';
import { createComment, deleteComment } from './lib/comments.mjs';
import History from './lib/history.mjs';
// load env vars from .env file
dotenv.config();
async function ghActionBot() {
export default async function() {
// parse repo name from cli and create repo instance
const repo = createRepo(process.argv.splice(2)[0]);
const {
COMMENT_BODY_REGEXP,
COMMENT_BODY_REGEXP_FLAGS,
COMMENT_ACTOR,
PULL_LABEL_FILTER,
PULL_AUTHOR_FILTER,
PULL_RETEST_BODY,
} = process.env;
// load the history module
const history = new History();
// fetch comment info from event stream, filter for only new comments
const comments = (await getComments(repo, {
body: new RegExp(COMMENT_BODY_REGEXP, COMMENT_BODY_REGEXP_FLAGS),
actor: COMMENT_ACTOR,
})).filter(comment => !history.get(comment.id));
body: /build failed/i,
actor: 'elasticmachine',
})).filter(comment => true /*!history.get(comment.id)*/);
// read pull data
console.log(
comments
.map(comment => {
history.add(comment); // temp
return comment.number;
})
.join(',')
);
// read pull data, filter out any closed pulls
const pulls = (await Promise.all(
comments.map(async comment => {
const pull = await getPull(repo, comment.number);
if (pull.state !== 'open') {
logger.debug(`SKIP #${pull.number}: state is ${pull.state}`);
return false; // filter out any closed pulls
}
if (PULL_AUTHOR_FILTER && pull.owner !== PULL_AUTHOR_FILTER) {
logger.debug(`SKIP #${pull.number}: author is ${pull.owner}`);
return false; // filter on owner
}
if (PULL_LABEL_FILTER && !pull.labels.includes(PULL_LABEL_FILTER)) {
logger.debug(`SKIP #${pull.number}: labels are ${pull.labels.join(',')}`);
return false; // filter on label
}
if (pull.state !== 'open') return false;
return { comment, pull };
})
)).filter(Boolean);
const records = (await Promise.all(
pulls.map(async ({ pull, comment }) => {
const commit = await getCommits(repo, pull.number, true);
const buildStatus = await getCommitStatus(repo, commit.sha);
// do nothing if the build has not started, or is pending or successful
if (!buildStatus || buildStatus.state === 'pending' || buildStatus.state === 'success') {
logger.debug(`SKIP #${pull.number}: build status is ${buildStatus.state}`);
return false;
}
return { comment, pull, commit, buildStatus };
const commits = await Promise.all(pulls.map(pull => getCommits(repo, pull.number, true)));
const buildStatus = await getCommitStatus(repo, commits[1].sha);
console.log(buildStatus);
process.exit();
Promise.resolve()
.then(commit =>
// get the status of the commit
repo.commits(commit.sha).statuses.fetch()
)
.then(statuses => {
if (statuses.lastPage) return statuses.lastPage.fetch();
return statuses;
})
)).filter(Boolean);
if (records.length) {
logger.log(`Found ${records.length} outstanding failures`);
} else {
logger.debug(`Found ${records.length} outstanding failures`);
}
await Promise.all(
records.map(async record => {
logger.log(`Re-testing PR #${record.pull.number}`);
const comment = await createComment(repo, records[0].pull.number, PULL_RETEST_BODY);
logger.debug(`Created comment id ${comment.id}`);
await deleteComment(repo, comment.id);
.then(({ items }) => {
const buildStatus = items.find(item => item.context === 'kibana-ci');
// status will be one of: error, failure, pending, success
// we should skip the retest if the state is pending or success
console.log(`PR state: ${buildStatus.state}`);
return buildStatus;
})
);
}
.catch(err => console.error(err));
export default function() {
return ghActionBot().catch(err => {
logger.error(err);
return process.exit(1);
});
/*
TODO:
- [ ] keep track of seen comment ids, only process new ones
- [x] check the pr's status and only retest if no longer "Pending"
- [ ] add a retest comment
- POST /repos/:owner/:repo/issues/:number/comments
- [ ] delete the build comment
- DELETE /repos/:owner/:repo/issues/comments/:comment_id
- [ ] delete ALL build failure comments
- [ ] delete the retest comment
*/
}

View File

@@ -1,7 +0,0 @@
export async function createComment(repo, issueId, body) {
return repo.issues(issueId).comments.create({ body });
}
export async function deleteComment(repo, commentId) {
return repo.issues.comments(commentId).remove();
}

View File

@@ -8,11 +8,8 @@ function usageError() {
export default function(repo) {
if (typeof repo !== 'string' || repo.length === 0) usageError();
const settings = {
token: process.env.GITHUB_ACCESS_TOKEN,
};
const octo = new Octokat(settings);
const octo = new Octokat();
const [owner, name] = repo.split('/');
if (!owner || !name) usageError();

View File

@@ -1,44 +1,14 @@
import logger from './logger.mjs';
export default async function getEvents(repo, { body, actor } = {}) {
const events = await repo.events.fetch();
return cache;
const { items: events } = await repo.events.fetch();
const items = await (async () => {
// process 2 pages of events
if (events.nextPage) {
const moreEvents = await events.nextPage.fetch();
return [...events.items, ...moreEvents.items];
}
return events.items;
})();
return items
return events
.map(comment => {
let skip = false;
const isComment = comment.type === 'IssueCommentEvent';
const bodyMatch = isComment && (!body || body.test(comment.payload.comment.body));
const isActor = comment.actor.login === actor;
// skip events that don't match the criteria
if (!isComment) skip = true;
if (comment.payload.action !== 'created') skip = true;
if (!isActor) skip = true;
if (isComment && !bodyMatch) skip = true;
if (skip) {
if (isActor) {
logger.debug(
`SKIP EVENT ${isComment ? `#${comment.payload.issue.number}` : comment.id}: ${
comment.type
} ${comment.payload.action} by ${comment.actor.login}`,
isComment && !bodyMatch && `(${comment.payload.comment.body.slice(0, 30)})`
);
}
return false;
}
logger.debug(`PROCESS #${comment.payload.issue.number}`);
// only comments created by specific user
if (comment.type !== 'IssueCommentEvent') return false;
if (comment.payload.action !== 'created') return false;
if (comment.actor.login !== actor) return false;
if (body && !body.test(comment.payload.comment.body)) return false;
return {
id: comment.id,
@@ -52,3 +22,67 @@ export default async function getEvents(repo, { body, actor } = {}) {
})
.filter(Boolean);
}
const cache = [ { id: '8438445273',
number: 23819,
owner: 'mattapperson',
labels: [ ':Beats', 'beats-cm' ],
comment_id: 430790622,
comment_author: 'elasticmachine',
comment_body: '## :broken_heart: Build Failed\n* [continuous-integration/kibana-ci/pull-request](https://kibana-ci.elastic.co/job/elastic-kibana-pull-request/5174/)\n\n' },
{ id: '8438364880',
number: 24158,
owner: 'joshdover',
labels: [],
comment_id: 430786140,
comment_author: 'elasticmachine',
comment_body: '## :broken_heart: Build Failed\n* [continuous-integration/kibana-ci/pull-request](https://kibana-ci.elastic.co/job/elastic-kibana-pull-request/5153/)\n\n' },
{ id: '8438241644',
number: 24104,
owner: 'graphaelli',
labels: [],
comment_id: 430777985,
comment_author: 'elasticmachine',
comment_body: '## :broken_heart: Build Failed\n* [continuous-integration/kibana-ci/pull-request](https://kibana-ci.elastic.co/job/elastic-kibana-pull-request/5150/)\n\n' },
{ id: '8438206753',
number: 24158,
owner: 'joshdover',
labels: [],
comment_id: 430775791,
comment_author: 'elasticmachine',
comment_body: '## :broken_heart: Build Failed\n* [continuous-integration/kibana-ci/pull-request](https://kibana-ci.elastic.co/job/elastic-kibana-pull-request/5147/)\n\n' },
{ id: '8438199856',
number: 23819,
owner: 'mattapperson',
labels: [ ':Beats', 'beats-cm' ],
comment_id: 430775402,
comment_author: 'elasticmachine',
comment_body: '## :broken_heart: Build Failed\n* [continuous-integration/kibana-ci/pull-request](https://kibana-ci.elastic.co/job/elastic-kibana-pull-request/5165/)\n\n' },
{ id: '8438188563',
number: 23648,
owner: 'jbudz',
labels: [ ':Operations' ],
comment_id: 430774756,
comment_author: 'elasticmachine',
comment_body: '## :broken_heart: Build Failed\n* [continuous-integration/kibana-ci/pull-request](https://kibana-ci.elastic.co/job/elastic-kibana-pull-request/5144/)\n\n' },
{ id: '8438183173',
number: 24038,
owner: 'cqliu1',
labels: [ ':Canvas', ':Home', 'review', 'v6.5.0', 'v7.0.0' ],
comment_id: 430774424,
comment_author: 'elasticmachine',
comment_body: '## :broken_heart: Build Failed\n* [continuous-integration/kibana-ci/pull-request](https://kibana-ci.elastic.co/job/elastic-kibana-pull-request/5145/)\n\n' },
{ id: '8438163617',
number: 24100,
owner: 'jakelandis',
labels: [ 'v6.5.0', 'v7.0.0' ],
comment_id: 430773251,
comment_author: 'elasticmachine',
comment_body: '## :broken_heart: Build Failed\n* [continuous-integration/kibana-ci/pull-request](https://kibana-ci.elastic.co/job/elastic-kibana-pull-request/5142/)\n\n' },
{ id: '8438139342',
number: 24153,
owner: 'cchaos',
labels: [ 'backport' ],
comment_id: 430771841,
comment_author: 'elasticmachine',
comment_body: '## :broken_heart: Build Failed\n* [continuous-integration/kibana-ci/pull-request](https://kibana-ci.elastic.co/job/elastic-kibana-pull-request/5143/)\n\n' } ];

View File

@@ -9,6 +9,7 @@ function getBuildStatus({ items: statuses }) {
}
export default async function getCommitStatus(repo, sha) {
return cache
const statuses = await repo.commits(sha).statuses.fetch();
const buildStatus = await (async stats => {
@@ -20,3 +21,7 @@ export default async function getCommitStatus(repo, sha) {
return buildStatus;
}
const cache = { id: 5666338700,
url: 'https://api.github.com/repos/elastic/kibana/statuses/5f948924cc4fe34c7b9399e685927e93a18d7450',
state: 'pending' };

View File

@@ -3,7 +3,7 @@ function formatCommit(commit) {
sha: commit.sha,
owner: commit.committer.login,
message: commit.commit.message,
};
}
}
function formatCommits(commits, lastOnly) {
@@ -12,6 +12,7 @@ function formatCommits(commits, lastOnly) {
}
export default async function getCommits(repo, id, lastOnly = true) {
return cache;
const commits = await repo.pulls(id).commits.fetch();
if (commits.lastPage) {
@@ -21,3 +22,7 @@ export default async function getCommits(repo, id, lastOnly = true) {
return formatCommits(commits.items, lastOnly);
}
const cache = { sha: '5f948924cc4fe34c7b9399e685927e93a18d7450',
owner: 'mattapperson',
message: 'Merge branch \'feature/x-pack/management/beats\' of github.com:elastic/kibana into feature/x-pack/management/beats' };

View File

@@ -1,12 +1,15 @@
export default async function getPull(repo, id) {
return cache;
const pull = await repo.pulls(id).fetch();
return {
id: pull.id,
url: pull.url,
number: pull.number,
owner: pull.user.login,
state: pull.state,
title: pull.title,
labels: pull.labels.map(label => label.name),
};
}
const cache = { id: 220387229,
url: 'https://api.github.com/repos/elastic/kibana/pulls/23819',
number: 23819,
state: 'open' };

View File

@@ -1,9 +0,0 @@
export default async function getPull(repo, id) {
const { items } = await repo.issues(id).comments.fetch();
return items.map(item => ({
id: item.id,
owner: item.user.login,
body: item.body,
}));
}

View File

@@ -1,43 +0,0 @@
/* eslint no-console: 0 */
const zeroPad = (str, len) => {
let output = `${str}`;
if (!len || len <= output.length) return str;
while (output.length < len) {
output = `0${output}`;
}
return output;
};
const getTimestamp = () => {
const d = new Date();
return `${[d.getFullYear(), zeroPad(d.getMonth(), 2), zeroPad(d.getDate(), 2)].join('/')} ${[
zeroPad(d.getHours(), 2),
zeroPad(d.getMinutes(), 2),
zeroPad(d.getSeconds(), 2),
].join(':')}`;
};
const wrapMessage = msg => `[${getTimestamp()}]: ${msg.join(' ')}`;
const logger = {
log(...args) {
console.log(wrapMessage(args));
},
warn(...args) {
console.warn(wrapMessage(args));
},
error(...args) {
if (args[0] instanceof Error) {
console.error(getTimestamp(), args[0].stack);
return;
}
console.error(wrapMessage(args));
},
debug(...args) {
if (!process.env.DEBUG) return;
console.log(wrapMessage(args));
},
};
export default logger;