Ensure GitHub token (#161)

* feat: add ensureGithubToken utility to validate GitHub token presence

* feat: add tests to validate GITHUB_TOKEN presence in commands

Author: bjohansebas

lib/clean.js

@@ -4,6 +4,7 @@ const context = require('./context')
 const github = require('./github')
 const gitURLParse = require('git-url-parse')
 const logger = require('./logger')
+const { ensureGithubToken } = require('./utils')
 
 // setup logger namespace
 const cleanCommandNamespace = 'wiby:clean'
@@ -13,6 +14,8 @@ module.exports = async ({ dependents }, { all, dryRun }) => {
   // enable log output for clean command without DEBUG env
   logger.enableLogs(cleanCommandNamespace)
 
+  ensureGithubToken()
+
   const parentPkgJSON = await context.getLocalPackageJSON()
   const parentPkgInfo = gitURLParse(parentPkgJSON.repository.url)
   debug(`Parent module: ${parentPkgInfo.owner}/${parentPkgJSON.name}`)

lib/closePR.js

@@ -4,10 +4,13 @@ const github = require('../lib/github')
 const logger = require('./logger')
 const context = require('./context')
 const gitURLParse = require('git-url-parse')
+const { ensureGithubToken } = require('./utils')
 
 const debug = logger('wiby:closepr')
 
 module.exports = async ({ dependents }) => {
+  ensureGithubToken()
+
   const closedPrs = []
   for (const { repository: url, pullRequest } of dependents) {
     if (pullRequest) {

lib/result.js

@@ -4,6 +4,7 @@ const context = require('./context')
 const github = require('./github')
 const gitURLParse = require('git-url-parse')
 const logger = require('./logger')
+const { ensureGithubToken } = require('./utils')
 
 const debug = logger('wiby:result')
 
@@ -27,6 +28,8 @@ module.exports = async function ({ dependents }) {
   const output = { status: pipelineStatusesEnum.PENDING, results: [] }
   const allDependentsChecks = []
 
+  ensureGithubToken()
+
   debug(`Parent module: ${parentPkgInfo.owner}/${parentPkgJSON.name}`)
   for (const { repository: url, sha } of dependents) {
     const dependentPkgInfo = gitURLParse(url)

lib/test.js

@@ -4,6 +4,7 @@ const context = require('./context')
 const github = require('./github')
 const gitURLParse = require('git-url-parse')
 const logger = require('./logger')
+const { ensureGithubToken } = require('./utils')
 
 // setup logger namespace
 const testCommandNamespace = 'wiby:test'
@@ -13,6 +14,7 @@ module.exports = async function ({ dependents }) {
   // enable log output for test command without DEBUG env
   logger.enableLogs(testCommandNamespace)
 
+  ensureGithubToken()
   const parentPkgJSON = await context.getLocalPackageJSON()
   const parentRepositoryInfo = gitURLParse(parentPkgJSON.repository.url)
   const parentBranchName = await context.getParentBranchName()

lib/utils/index.js

@@ -0,0 +1,11 @@
+'use strict'
+
+const ensureGithubToken = () => {
+  if (!process.env.GITHUB_TOKEN) {
+    throw new Error('GITHUB_TOKEN is required')
+  }
+}
+
+module.exports = {
+  ensureGithubToken
+}

test/clean.js

@@ -11,6 +11,7 @@ const wiby = require('..')
 
 tap.test('wiby.clean()', async (tap) => {
   tap.beforeEach(async () => {
+    process.env.GITHUB_TOKEN = 'ghp_123_abc'
     nock.disableNetConnect()
     gitFixture.init()
   })

test/cli/clean.js

@@ -11,9 +11,22 @@ const fixturesPath = path.resolve(path.join(__dirname, '..', 'fixtures'))
 
 tap.test('clean command', async (tap) => {
   tap.beforeEach(async () => {
+    process.env.GITHUB_TOKEN = 'ghp_123_abc'
     gitFixture.init()
   })
 
+  tap.test('clean command should fail when github token is not set', async (tap) => {
+    process.env.GITHUB_TOKEN = ''
+    gitFixture.init()
+
+    try {
+      childProcess.execSync(`${wibyCommand} clean`).toString()
+      tap.fail()
+    } catch (err) {
+      tap.equal(true, err.message.includes('GITHUB_TOKEN is required'))
+    }
+  })
+
   tap.test('should delete test branch in all configured test modules', async (tap) => {
     const result = childProcess.execSync(`${wibyCommand} clean`, {
       env: {

test/cli/closePR.js

@@ -10,10 +10,23 @@ const fixturesPath = path.resolve(path.join(__dirname, '..', 'fixtures'))
 
 tap.test('closePRs command', async (t) => {
   t.beforeEach(async () => {
+    process.env.GITHUB_TOKEN = 'ghp_123_abc'
     nock.disableNetConnect()
     gitFixture.init()
   })
 
+  tap.test('close-pr command should fail when github token is not set', async (tap) => {
+    process.env.GITHUB_TOKEN = ''
+    gitFixture.init()
+
+    try {
+      childProcess.execSync(`${wibyCommand} close-pr`).toString()
+      tap.fail()
+    } catch (err) {
+      tap.equal(true, err.message.includes('GITHUB_TOKEN is required'))
+    }
+  })
+
   t.test('close-pr should fail if config and dependent provided', async (t) => {
     try {
       childProcess.execSync(`${wibyCommand} close-pr --config=.wiby.json --dependent="https://github.com/wiby-test/fakeRepo"`)

test/cli/result.js

@@ -16,9 +16,22 @@ const PENDING_RESULT_EXIT_CODE = 64
 
 tap.test('result command', async (tap) => {
   tap.beforeEach(async () => {
+    process.env.GITHUB_TOKEN = 'ghp_123_abc'
     gitFixture.init()
   })
 
+  tap.test('result command should fail when github token is not set', async (tap) => {
+    process.env.GITHUB_TOKEN = ''
+    gitFixture.init()
+
+    try {
+      childProcess.execSync(`${wibyCommand} result`).toString()
+      tap.fail()
+    } catch (err) {
+      tap.equal(true, err.message.includes('GITHUB_TOKEN is required'))
+    }
+  })
+
   tap.test('result command should fail when config and dependent provided', async (tap) => {
     try {
       childProcess.execSync(`${wibyCommand} result --config=.wiby.json --dependent="https://github.com/wiby-test/fakeRepo"`)

test/cli/test.js

@@ -10,6 +10,22 @@ const wibyCommand = path.join(__dirname, '..', '..', 'bin', 'wiby')
 const fixturesPath = path.resolve(path.join(__dirname, '..', 'fixtures'))
 
 tap.test('test command', async (tap) => {
+  tap.beforeEach(async () => {
+    process.env.GITHUB_TOKEN = 'ghp_123_abc'
+  })
+
+  tap.test('test command should fail when github token is not set', async (tap) => {
+    process.env.GITHUB_TOKEN = ''
+    gitFixture.init()
+
+    try {
+      childProcess.execSync(`${wibyCommand} test`).toString()
+      tap.fail()
+    } catch (err) {
+      tap.equal(true, err.message.includes('GITHUB_TOKEN is required'))
+    }
+  })
+
   tap.test('test command should fail when config and dependent provided', async (tap) => {
     gitFixture.init()