Merge pull request #1 from sixoverground/part2

unit + integration tests

Author: craigphares

app.js

@@ -0,0 +1,31 @@
+const bodyParser = require('body-parser')
+const express = require('express')
+const knex = require('knex')
+const methodOverride = require('method-override')
+const { Model } = require('objection')
+const knexConfig = require('./knexfile')
+const router = require('./routes')
+
+const app = express()
+
+const db = knex(knexConfig[process.env.NODE_ENV || 'development'])
+Model.knex(db)
+
+app.set('view engine', 'pug')
+
+app.use(bodyParser.urlencoded({ extended: false }))
+
+app.use(methodOverride((req, res) => {
+  if (req.body && typeof req.body === 'object' && '_method' in req.body) {
+    var method = req.body._method
+    delete req.body._method
+    return method
+  }
+}))
+
+app.use('/', router)
+
+module.exports = {
+  app,
+  db
+}

index.js

@@ -1,29 +1,5 @@
-const bodyParser = require('body-parser')
-const express = require('express')
-const knex = require('knex')
-const methodOverride = require('method-override')
-const { Model } = require('objection')
-const knexConfig = require('./knexfile')
-const router = require('./routes')
-
-const app = express()
+const { app } = require('./app')
+ 
 const port = 3000
 
-const db = knex(knexConfig[process.env.NODE_ENV || 'development'])
-Model.knex(db)
-
-app.set('view engine', 'pug')
-
-app.use(bodyParser.urlencoded({ extended: false }))
-
-app.use(methodOverride((req, res) => {
-  if (req.body && typeof req.body === 'object' && '_method' in req.body) {
-    var method = req.body._method
-    delete req.body._method
-    return method
-  }
-}))
-
-app.use('/', router)
-
-app.listen(port, () => console.log(`My blog is listening on port ${port}!`))
+app.listen(port, () => console.log(`My blog is listening on port ${port}!`))

jest.config.js

@@ -0,0 +1,188 @@
+// For a detailed explanation regarding each configuration property, visit:
+// https://jestjs.io/docs/en/configuration.html
+
+module.exports = {
+  // All imported modules in your tests should be mocked automatically
+  // automock: false,
+
+  // Stop running tests after `n` failures
+  // bail: 0,
+
+  // Respect "browser" field in package.json when resolving modules
+  // browser: false,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/private/var/folders/f7/9_bh8fl93w5gpjd2z7b87ksh0000gn/T/jest_dx",
+
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  // collectCoverage: false,
+
+  // An array of glob patterns indicating a set of files for which coverage information should be collected
+  // collectCoverageFrom: null,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: "coverage",
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // A list of reporter names that Jest uses when writing coverage reports
+  // coverageReporters: [
+  //   "json",
+  //   "text",
+  //   "lcov",
+  //   "clover"
+  // ],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  // coverageThreshold: null,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: null,
+
+  // Make calling deprecated APIs throw helpful error messages
+  // errorOnDeprecated: false,
+
+  // Force coverage collection from ignored files using an array of glob patterns
+  // forceCoverageMatch: [],
+
+  // A path to a module which exports an async function that is triggered once before all test suites
+  // globalSetup: null,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: null,
+
+  // A set of global variables that need to be available in all test environments
+  // globals: {},
+
+  // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
+  // maxWorkers: "50%",
+
+  // An array of directory names to be searched recursively up from the requiring module's location
+  // moduleDirectories: [
+  //   "node_modules"
+  // ],
+
+  // An array of file extensions your modules use
+  // moduleFileExtensions: [
+  //   "js",
+  //   "json",
+  //   "jsx",
+  //   "ts",
+  //   "tsx",
+  //   "node"
+  // ],
+
+  // A map from regular expressions to module names that allow to stub out resources with a single module
+  // moduleNameMapper: {},
+
+  // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
+  // modulePathIgnorePatterns: [],
+
+  // Activates notifications for test results
+  // notify: false,
+
+  // An enum that specifies notification mode. Requires { notify: true }
+  // notifyMode: "failure-change",
+
+  // A preset that is used as a base for Jest's configuration
+  // preset: null,
+
+  // Run tests from one or more projects
+  // projects: null,
+
+  // Use this configuration option to add custom reporters to Jest
+  // reporters: undefined,
+
+  // Automatically reset mock state between every test
+  // resetMocks: false,
+
+  // Reset the module registry before running each individual test
+  // resetModules: false,
+
+  // A path to a custom resolver
+  // resolver: null,
+
+  // Automatically restore mock state between every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: null,
+
+  // A list of paths to directories that Jest should use to search for files in
+  // roots: [
+  //   "<rootDir>"
+  // ],
+
+  // Allows you to use a custom runner instead of Jest's default test runner
+  // runner: "jest-runner",
+
+  // The paths to modules that run some code to configure or set up the testing environment before each test
+  // setupFiles: [],
+
+  // A list of paths to modules that run some code to configure or set up the testing framework before each test
+  // setupFilesAfterEnv: [],
+
+  // A list of paths to snapshot serializer modules Jest should use for snapshot testing
+  // snapshotSerializers: [],
+
+  // The test environment that will be used for testing
+  testEnvironment: "node",
+
+  // Options that will be passed to the testEnvironment
+  // testEnvironmentOptions: {},
+
+  // Adds a location field to test results
+  // testLocationInResults: false,
+
+  // The glob patterns Jest uses to detect test files
+  // testMatch: [
+  //   "**/__tests__/**/*.[jt]s?(x)",
+  //   "**/?(*.)+(spec|test).[tj]s?(x)"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  // testPathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // The regexp pattern or array of patterns that Jest uses to detect test files
+  // testRegex: [],
+
+  // This option allows the use of a custom results processor
+  // testResultsProcessor: null,
+
+  // This option allows use of a custom test runner
+  // testRunner: "jasmine2",
+
+  // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
+  // testURL: "http://localhost",
+
+  // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
+  // timers: "real",
+
+  // A map from regular expressions to paths to transformers
+  // transform: null,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
+  // unmockedModulePathPatterns: undefined,
+
+  // Indicates whether each individual test should be reported during the run
+  // verbose: null,
+
+  // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
+  // watchPathIgnorePatterns: [],
+
+  // Whether to use watchman for file crawling
+  // watchman: true,
+};

knexfile.js

@@ -3,6 +3,18 @@ module.exports = {
     client: 'pg',
     connection: {
       database: 'blog_development'
+    },
+    seeds: {
+      directory: './seeds/development'
+    }
+  },
+  test: {
+    client: 'pg',
+    connection: {
+      database: 'blog_test'
+    },
+    seeds: {
+      directory: './seeds/test'
     }
   }
 }

models/Article.js

@@ -4,6 +4,18 @@ class Article extends BaseModel {
   static get tableName() {
     return 'articles'
   }
+
+  static get jsonSchema() {
+    return {
+      type: 'object',
+      required: ['title'],
+      properties: {
+        id: { type: 'integer' },
+        title: { type: 'string', minLength: 1, maxLength: 255 },
+        text: { type: 'string' }
+      }
+    }
+  }
 }
 
 module.exports = Article

package.json

@@ -4,7 +4,8 @@
   "main": "index.js",
   "license": "MIT",
   "scripts": {
-    "start": "node index.js"
+    "start": "node index.js",
+    "test": "jest --runInBand --detectOpenHandles --coverage"
   },
   "dependencies": {
     "body-parser": "^1.19.0",
@@ -14,5 +15,9 @@
     "objection": "^1.6.9",
     "pg": "^7.11.0",
     "pug": "^2.0.3"
+  },
+  "devDependencies": {
+    "jest": "^24.9.0",
+    "supertest": "^4.0.2"
   }
 }

seeds/test/seed.js

@@ -0,0 +1,7 @@
+
+exports.seed = async (knex) => {
+  await knex('articles').del()
+  await knex('articles').insert([
+    { title: 'First Article!', text: 'This is my first article.' },
+  ])
+}

test/integration/articles.test.js

@@ -0,0 +1,35 @@
+const request = require('supertest')
+const { app, db } = require('../../app')
+const Article = require('../../models/Article')
+
+describe('/articles', () => {
+  beforeEach(async () => {
+    await db.migrate.rollback()
+    await db.migrate.latest()
+    await db.seed.run()
+  })
+
+  afterEach(async () => {
+    await db.migrate.rollback()
+  })
+
+  describe('GET /articles/new', () => {
+    test('can enter a new article', async () => {
+      const response = await request(app)
+        .get('/articles/new')
+      expect(response.status).toBe(200)
+    })
+  })
+
+  describe('POST /articles', () => {
+    test('can create an article', async () => {
+      const response = await request(app)
+        .post('/articles')
+        .send('title=Can Create&body=Article successfully.')
+      expect(response.status).toBe(302)
+      const articles = await Article.query().orderBy('id')
+      const article = articles[articles.length - 1]
+      expect(response.header.location).toBe(`/articles/${article.id}`)
+    })
+  })
+})

test/models/Article.test.js

@@ -0,0 +1,35 @@
+const knex = require('knex')
+const { Model } = require('objection')
+const knexConfig = require('../../knexfile')
+const Article = require('../../models/Article')
+
+const db = knex(knexConfig[process.env.NODE_ENV || 'test'])
+Model.knex(db)
+
+describe('Article', () => {
+  let article
+
+  beforeEach(async () => {
+    await db.migrate.rollback()
+    await db.migrate.latest()
+    await db.seed.run()
+
+    article = await Article.query().findOne({ title: 'First Article!' })
+  })
+
+  afterEach(async () => {
+    await db.migrate.rollback()
+  })
+
+  test('has a valid seed', async () => {
+    expect(article).toBeDefined()
+  })
+
+  test('titles are required', async () => {
+    article.title = undefined
+    expect(() => {
+      article.$validate()
+    }).toThrow()
+  })
+
+})