test: add tests and actions

Author: andrewhughes101

.github/workflows/test.yml

@@ -0,0 +1,27 @@
+name: Test dependents
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [10.x, 12.x, 14.x]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm ci
+    - run: npm test
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,3 +1,10 @@
 node_modules
 package-lock.json
 .env
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output

test/fixtures/config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  args: {
+    package: 'express',
+    number: 20,
+    sort: 'forks',
+    total: 20
+  }
+}

test/index.js

@@ -0,0 +1,58 @@
+require('dotenv').config()
+const assert = require('assert')
+const { suite, test } = require('mocha')
+const getDependents = require('../lib/getDependents')
+const pkg = require('../package.json')
+const config = require('./fixtures/config')
+
+assert(process.env.GITHUB_TOKEN, `
+Tests require you to have a GitHub personal token called GITHUB_TOKEN
+For more information about GitHub tokens
+https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line
+`)
+
+suite(pkg.name, async function () {
+  this.timeout(0)
+  test('Dependents object created', async function () {
+    const deps = await getDependents(config.args)
+    for (const i in deps) {
+      for (const key in deps[i]) {
+        const subObj = deps[i][key]
+        assert.strictEqual(Object.prototype.hasOwnProperty.call(subObj, 'downloads'), true)
+        assert.strictEqual(Object.prototype.hasOwnProperty.call(subObj, 'forks'), true)
+        assert.strictEqual(Object.prototype.hasOwnProperty.call(subObj, 'stars'), true)
+        assert.strictEqual(Object.prototype.hasOwnProperty.call(subObj, 'watchers'), true)
+        assert.strictEqual(Object.prototype.hasOwnProperty.call(subObj, 'url'), true)
+      }
+    }
+  })
+  test('GitHub attributes zero when URL is undefined', async function () {
+    const deps = await getDependents(config.args)
+    for (const i in deps) {
+      for (const key in deps[i]) {
+        const subObj = deps[i][key]
+        if (subObj.url === 'undefined') {
+          assert.strictEqual(subObj.forks, 0)
+          assert.strictEqual(subObj.stars, 0)
+          assert.strictEqual(subObj.watchers, 0)
+        }
+      }
+    }
+  })
+  test('Dependents sorted correctly', async function () {
+    const deps = await getDependents(config.args)
+    let key, previousKey
+    for (const i in deps) {
+      for (const k in deps[i]) {
+        previousKey = key
+        key = k
+      }
+      if (i !== '0') {
+        const j = String(parseInt(i) - 1)
+        const previous = deps[j][previousKey][config.args.sort]
+        const current = deps[i][key][config.args.sort]
+        assert.strictEqual(previous >= current, true)
+      }
+    }
+  })
+})