add tests

Author: kwhsiung

.eslintrc.js

@@ -1,3 +1,7 @@
 module.exports = {
-  'extends': 'standard'
+  extends: [
+    'standard',
+    'plugin:jest/recommended'
+  ],
+  plugins: [ 'jest' ]
 }

jest.config.js

@@ -0,0 +1,187 @@
+// 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/b0/rz6wn4bn1kd4k0fvddhsp4c00000gq/T/jest_dz",
+
+  // 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: 'jest-puppeteer',
+
+  // 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/*.test.js'
+  ]
+
+  // 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,
+}

package.json

@@ -8,7 +8,9 @@
     "cron": "node src/cron.js",
     "dev": "cross-env NODE_ENV=development node src/punchMembers out",
     "lint": "eslint --ext .js --ignore-path .gitignore --ignore-pattern !.eslintrc.js --max-warnings 0",
-    "lintfix": "eslint --ext .js --ignore-path .gitignore --ignore-pattern !.eslintrc.js . --fix"
+    "lintall": "eslint --ext .js --ignore-path .gitignore --ignore-pattern !.eslintrc.js --max-warnings 0 .",
+    "lintfix": "eslint --ext .js --ignore-path .gitignore --ignore-pattern !.eslintrc.js . --fix",
+    "test": "jest --watch"
   },
   "husky": {
     "hooks": {
@@ -44,10 +46,13 @@
     "eslint": "^6.0.1",
     "eslint-config-standard": "^12.0.0",
     "eslint-plugin-import": "^2.18.0",
+    "eslint-plugin-jest": "^23.0.4",
     "eslint-plugin-node": "^9.1.0",
     "eslint-plugin-promise": "^4.2.1",
     "eslint-plugin-standard": "^4.0.0",
     "husky": "^2.7.0",
+    "jest": "^24.9.0",
+    "jest-puppeteer": "^4.3.0",
     "lint-staged": "^8.2.1"
   }
 }

src/member.js

@@ -0,0 +1,50 @@
+const puppeteer = require('puppeteer')
+const { urls } = require('../config')
+
+class Member {
+  constructor ({ id = '', password = '' }) {
+    const isIdInvalid = typeof id !== 'string' || id === ''
+    const isPasswordInvalid = typeof password !== 'string' || password === ''
+    if (isIdInvalid || isPasswordInvalid) {
+      throw new Error(
+        `Please provide required id/password, some of your id: "${id}" or password: "${password}" is invalide`
+      )
+    }
+
+    this.id = id
+    this.password = password
+    this._browser = null
+  }
+
+  get browser () {
+    if (this._browser === null || this._browser.constructor.name !== 'Browser') {
+      throw new Error('Browser was not been launched yet')
+    }
+    return this._browser
+  }
+  set browser (browser) {
+    this._browser = browser
+  }
+
+  async lunchBrowser () {
+    const browser = await puppeteer.launch()
+    this.browser = browser
+  }
+
+  async login () {
+    await this.lunchBrowser()
+    const pageLogin = await this.browser.newPage()
+    await pageLogin.goto(urls.pageLogin, { timeout: 0 })
+    // await pageLogin.type(selectors.login.user, id)
+    // await pageLogin.type(selectors.login.password, password)
+    // const loginBtn = await pageLogin.$(selectors.login.submit)
+    // await loginBtn.click()
+  }
+}
+
+// const theMember = new Member({ id: 'test', password: 'test' })
+// theMember.login()
+// // theMember.punch('in')
+// // theMember.punch('out')
+
+module.exports = Member

tests/index.test.js

@@ -0,0 +1,56 @@
+const Member = require('../src/member')
+
+const testMember = {
+  id: 'testId',
+  password: 'testPassword'
+}
+const testMemberMissingId = {
+  password: 'testPassword'
+}
+const testMemberMissingPassword = {
+  id: 'testId'
+}
+const testMemberInvalidId = {
+  id: {},
+  password: 'testPassword'
+}
+const testMemberInvalidPassword = {
+  id: 'testId',
+  password: {}
+}
+
+describe('constructor validation', () => {
+  it('should be initialize with proper member info', () => {
+    const member = new Member(testMember)
+    expect(member.id).toBe('testId')
+    expect(member.password).toBe('testPassword')
+  })
+  it('should throw error if id is missing', () => {
+    expect(() => new Member(testMemberMissingId))
+      .toThrow()
+  })
+  it('should throw error if password is missing', () => {
+    expect(() => new Member(testMemberMissingPassword))
+      .toThrow()
+  })
+  it('should throw error if id is not string', () => {
+    expect(() => new Member(testMemberInvalidId))
+      .toThrow()
+  })
+  it('should throw error if password is not string', () => {
+    expect(() => new Member(testMemberInvalidPassword))
+      .toThrow()
+  })
+})
+
+describe('browser handling', () => {
+  it('should throw error when getting the browser if we not launch manually yet', () => {
+    const member = new Member(testMember)
+    expect(() => member.browser).toThrow()
+  })
+  it('should return "Browser" if we access browser launched before', async () => {
+    const member = new Member(testMember)
+    await member.lunchBrowser()
+    expect(member.browser.constructor.name).toBe('Browser')
+  })
+})