Improve test coverage (#22)

* Add sinon

* Add coverage badge to README

* Add tests for github module

* Add tests for the main function

* Suppress logger messages

* Build the action

README.md

@@ -1,6 +1,7 @@
 # Auto Request Review
 
 ![CI](https://github.com/necojackarc/auto-request-review/workflows/CI/badge.svg)
+[![Coverage Status](https://coveralls.io/repos/github/necojackarc/auto-request-review/badge.svg?branch=master)](https://coveralls.io/github/necojackarc/auto-request-review?branch=master)
 
 A GitHub Action automatically requests review of a pull request based on files changes and/or groups the author belongs to 🤖
 

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "request-review-based-on-files",
+  "name": "auto-request-review",
   "version": "0.1.2",
   "description": "GitHub Action that automatically requests review of a pull request based on files changed",
   "main": "index.js",
@@ -23,7 +23,8 @@
     "chai": "^4.2.0",
     "eslint": "^7.7.0",
     "mocha": "^8.1.2",
-    "nyc": "^15.1.0"
+    "nyc": "^15.1.0",
+    "sinon": "^9.0.3"
   },
   "nyc": {
     "include": [

src/github.js

@@ -116,9 +116,17 @@ function get_octokit() {
   return octokit_cache = github.getOctokit(token);
 }
 
+function clear_cache() {
+  context_cache = undefined;
+  token_cache = undefined;
+  config_path_cache = undefined;
+  octokit_cache = undefined;
+}
+
 module.exports = {
   get_pull_request,
   fetch_config,
   fetch_changed_files,
   assign_reviewers,
+  clear_cache,
 };

src/index.js

@@ -1,13 +1,7 @@
 'use strict';
 
 const core = require('@actions/core');
-
-const {
-  get_pull_request,
-  fetch_config,
-  fetch_changed_files,
-  assign_reviewers,
-} = require('./github');
+const github = require('./github'); // Don't destructure this object to stub with sinon in tests
 
 const {
   fetch_other_group_members,
@@ -21,7 +15,7 @@ async function run() {
   let config;
 
   try {
-    config = await fetch_config();
+    config = await github.fetch_config();
   } catch (error) {
     if (error.status === 404) {
       core.warning('No configuration file is found in the base branch; terminating the process');
@@ -30,15 +24,15 @@ async function run() {
     throw error;
   }
 
-  const { title, is_draft, author } = get_pull_request();
+  const { title, is_draft, author } = github.get_pull_request();
 
   if (!should_request_review({ title, is_draft, config })) {
     core.info('Matched the ignoring rules; terminating the process');
     return;
   }
 
   core.info('Fetching changed files in the pull request');
-  const changed_files = await fetch_changed_files();
+  const changed_files = await github.fetch_changed_files();
 
   core.info('Identifying reviewers based on the changed files and the configuration');
   const reviewers_based_on_files = identify_reviewers({ config, changed_files, excludes: [ author ] });
@@ -54,7 +48,11 @@ async function run() {
   }
 
   core.info(`Requesting review to ${reviewers.join(', ')}`);
-  await assign_reviewers(reviewers);
+  await github.assign_reviewers(reviewers);
 }
 
 run().catch((error) => core.setFailed(error));
+
+module.exports = {
+  run,
+};

test/common.js

@@ -0,0 +1,15 @@
+'use strict';
+
+const core = require('@actions/core');
+const sinon = require('sinon');
+
+before(function() {
+  // Don't show logs in tests
+  sinon.stub(core, 'info');
+  sinon.stub(core, 'warning');
+});
+
+after(function() {
+  core.info.restore();
+  core.warning.restore();
+});