Merge branch 'test/basic' into develop

.babelrc

@@ -1,4 +1,9 @@
 {
+  "env": {
+    "test": {
+      "plugins": ["babel-plugin-transform-es2015-modules-commonjs"]
+    }
+  },
   "presets": [
     [
       "@babel/preset-env",

Makefile

@@ -5,6 +5,9 @@ build:
 	rm -rf dist
 	yarn build
 
+test:
+	yarn test
+
 upload-for-analytics:
 	# make sure sentry can retrieve current commit on remote
 	git push --tags
@@ -22,6 +25,7 @@ rename-compressed:
 
 release:
 	$(MAKE) build
+	$(MAKE) test
 	$(MAKE) upload-for-analytics
 	$(MAKE) compress
 	$(MAKE) rename-compressed

__tests__/cases/baseline.ts

@@ -0,0 +1,48 @@
+/**
+ * Make sure some basic behaviors of puppeteer assertions
+ */
+
+import { expectToFind, expectToNotFind } from '../utils'
+
+describe(`in random page`, () => {
+  beforeAll(() => page.goto('https://google.com'))
+
+  it('wait for hidden non-exist element should resolve null', async () => {
+    expect(
+      await page.waitForSelector('.non-exist-element', { hidden: true, timeout: 1000 }),
+    ).toBeNull()
+  })
+
+  it('wait for exist element', async () => {
+    expectToFind('*')
+  })
+
+  it('wait for exist element', async () => {
+    expectToNotFind('.non-exist-element')
+  })
+
+  it('wait for non-exist element reject should throw', async () => {
+    await expect(page.waitForSelector('.non-exist-element', { timeout: 1000 })).rejects.toThrow()
+  })
+
+  // Cases below are expected to fail to show how async test works
+
+  // // This is expected to fail!
+  // it('wait for non-exist element reject should not throw', async () => {
+  //   await expect(
+  //     page.waitForSelector('.non-exist-element', { timeout: 1000 }),
+  //   ).rejects.not.toThrow()
+  // })
+
+  // // This is expected to fail!
+  // it('wait for non-exist element should resolve throw', async () => {
+  //   await expect(page.waitForSelector('.non-exist-element', { timeout: 1000 })).resolves.toThrow()
+  // })
+
+  // // This is expected to fail!
+  // it('wait for non-exist element should resolve not throw', async () => {
+  //   await expect(
+  //     page.waitForSelector('.non-exist-element', { timeout: 1000 }),
+  //   ).resolves.not.toThrow()
+  // })
+})

__tests__/cases/homepage.not-render.ts

@@ -0,0 +1,9 @@
+import { expectToNotFind } from '../utils'
+
+describe(`in GitHub homepage`, () => {
+  beforeAll(() => page.goto('https://github.com'))
+
+  it('should not render Gitako', async () => {
+    expectToNotFind('.gitako-side-bar .gitako-position-wrapper')
+  })
+})

__tests__/cases/project-page.gitako.ts

@@ -0,0 +1,9 @@
+import { expectToFind } from '../utils'
+
+describe(`in Gitako project page`, () => {
+  beforeAll(() => page.goto('https://github.com/EnixCoda/Gitako'))
+
+  it('should render Gitako', async () => {
+    expectToFind('.gitako-side-bar .gitako-position-wrapper')
+  })
+})

__tests__/global.d.ts

@@ -0,0 +1 @@
+declare var page: Puppeteer.Page

__tests__/puppeteer.d.ts

@@ -0,0 +1,4 @@
+import * as Puppeteer from 'puppeteer'
+
+export as namespace Puppeteer
+export = Puppeteer

__tests__/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../tsconfig.json",
+  "include": ["."],
+  "compilerOptions": {
+    "target": "ES3",
+    "module": "CommonJS",
+    "baseUrl": null
+  }
+}

__tests__/utils.ts

@@ -0,0 +1,7 @@
+export async function expectToFind(selector: string) {
+  await expect(await page.waitForSelector(selector)).not.toBeNull()
+}
+
+export async function expectToNotFind(selector: string) {
+  await expect(page.waitForSelector(selector, { timeout: 1000 })).rejects.toThrow()
+}

jest-puppeteer.config.js

@@ -0,0 +1,10 @@
+const path = require('path')
+
+const CRX_PATH = path.resolve(__dirname, 'dist')
+
+module.exports = {
+  launch: {
+    headless: false, // required for extensions
+    args: [`--disable-extensions-except=${CRX_PATH}`, `--load-extension=${CRX_PATH}`],
+  },
+}

jest.config.js

@@ -0,0 +1,185 @@
+// 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/6j/kp9yt47x4872_k7d4gdjbwfm0000gn/T/jest_dx",
+
+  // Automatically clear mock calls and instances between every test
+  // clearMocks: false,
+
+  // 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: null,
+
+  // 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__/cases/*.ts?(x)', '**/?(*.)+(spec|test).ts?(x)'],
+
+  // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
+  testPathIgnorePatterns: ['/node_modules/', './*.d.ts'],
+
+  // 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",
+
+  testTimeout: 20000,
+
+  // 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

@@ -13,7 +13,8 @@
     "analyse-bundle": "ANALYSE= NODE_ENV=production webpack",
     "postinstall": "rm -rf node_modules/@types/react-native && node scripts/fix-pjax-api",
     "build": "VERSION=v$(node scripts/get-version.js) NODE_ENV=production webpack",
-    "roll": "make release"
+    "roll": "make release",
+    "test": "NODE_ENV=test jest"
   },
   "dependencies": {
     "@primer/components": "^19.1.1",
@@ -23,9 +24,11 @@
     "@types/firefox-webext-browser": "^70.0.1",
     "@types/history": "^4.7.5",
     "@types/ini": "^1.3.30",
+    "@types/jest": "^24.0.25",
     "@types/js-base64": "^2.3.1",
     "@types/node": "^11.10.4",
     "@types/nprogress": "^0.0.29",
+    "@types/puppeteer": "^2.0.0",
     "@types/react": "^16.8.24",
     "@types/react-dom": "^16.8.5",
     "@types/react-window": "^1.8.1",
@@ -55,13 +58,17 @@
     "@babel/preset-typescript": "^7.3.3",
     "@sentry/cli": "^1.51.0",
     "babel-loader": "^8.0.5",
+    "babel-plugin-transform-es2015-modules-commonjs": "^6.26.2",
     "copy-webpack-plugin": "^5.0.0",
     "css-loader": "^2.1.0",
     "dotenv-webpack": "^1.7.0",
     "file-loader": "^3.0.1",
     "fork-ts-checker-webpack-plugin": "^0.5.2",
+    "jest": "^24.9.0",
+    "jest-puppeteer": "^4.4.0",
     "json-loader": "^0.5.7",
     "mini-css-extract-plugin": "^0.9.0",
+    "puppeteer": "^2.0.0",
     "raw-loader": "^4.0.0",
     "sass": "^1.26.2",
     "sass-loader": "^8.0.2",