Add e2e tests

KnpLabs · May 12, 2021 · 33b1d91 · 33b1d91
1 parent b9c462a
commit 33b1d91
Show file tree

Hide file tree

Showing 14 changed files with 2,540 additions and 68 deletions.
diff --git a/.env.dist → .env.dev.dist b/.env.dist → .env.dev.dist
@@ -1,5 +1,5 @@
 # Global configurations
-LOG_LEVEL=
+LOG_LEVEL=DEBUG
 
 # Queue configurations
 QUEUE_REDIS_DSN=redis://redis:6379

diff --git a/Dockerfile b/Dockerfile
@@ -1,3 +1,5 @@
+# @todo optimize the Docker image
+
 FROM node:slim as dev
 
 # Install latest chrome dev package and fonts to support major charsets (Chinese, Japanese, Arabic, Hebrew, Thai and a few others)
@@ -28,7 +30,7 @@ RUN yarn install
 USER 1000
 
 ENTRYPOINT ["dumb-init", "--"]
-CMD ["yarn", "dev"]
+CMD ["yarn", "start-dev"]
 
 ################################################################################
 

diff --git a/Makefile b/Makefile
@@ -1,13 +1,43 @@
+STAGE ?= dev
 IMAGE_NAME = knplabs/server-side-renderer
 
+.PHONY: start
+start: .cp-env
+	docker-compose -f docker-compose.${STAGE}.yaml build
+	docker-compose -f docker-compose.${STAGE}.yaml up -d
+	$(MAKE) .install-deps
+
+.PHONY: stop
+stop:
+	docker-compose -f docker-compose.${STAGE}.yaml stop
+
+.PHONY: test
+test:
+	docker run --rm -v $(PWD):/app:ro --network host knplabs/server-side-renderer:${STAGE} yarn test
+
 .PHONY: build
 build: .validate-tag
 	docker build -t ${IMAGE_NAME}:${IMAGE_TAG} .
 
-.PHONY: build
+.PHONY: push
 push: .validate-tag
 	docker push ${IMAGE_NAME}:${IMAGE_TAG}
 
+.PHONY: .cp-env
+.cp-env:
+ifeq ($(STAGE),dev)
+	cp -n .env.dev.dist .env
+endif
+
+.PHONY: .install-deps
+.install-deps:
+ifeq ($(STAGE),dev)
+	docker-compose -f docker-compose.dev.yaml run --rm app yarn install
+else
+	@echo "You can't install app dependencies on non-dev environments.\n"
+	@exit 1
+endif
+
 .PHONY: .validate-tag
 .validate-tag:
 ifeq ($(IMAGE_TAG),)

diff --git a/docker-compose.dev.yaml b/docker-compose.dev.yaml
@@ -0,0 +1,23 @@
+version: '3.8'
+
+services:
+  app:
+    image: knplabs/server-side-renderer:dev
+    build:
+      context: .
+      target: dev
+    depends_on:
+      - redis
+    env_file: .env
+    ports:
+      - "80:80"
+    volumes:
+      - ./:/app
+
+  redis:
+    image: redis:6.2.2-buster
+
+  nginx:
+    image: nginx:1.20.0
+    volumes:
+      - ./fixtures/nginx/html:/usr/share/nginx/html:ro
diff --git a/docker-compose.test.yaml b/docker-compose.test.yaml
@@ -0,0 +1,34 @@
+version: '3.8'
+
+services:
+  manager:
+    image: knplabs/server-side-renderer:test
+    build:
+      context: .
+      target: prod
+    depends_on:
+      - redis
+    environment:
+      - MANAGER_ENABLED=1
+      - QUEUE_REDIS_DSN=redis://redis:6379
+    ports:
+      - "80:80"
+
+  worker:
+    image: knplabs/server-side-renderer:test
+    build:
+      context: .
+      target: prod
+    depends_on:
+      - redis
+    environment:
+      - WORKER_ENABLED=1
+      - QUEUE_REDIS_DSN=redis://redis:6379
+
+  redis:
+    image: redis:6.2.2-buster
+
+  nginx:
+    image: nginx:1.20.0
+    volumes:
+      - ./fixtures/nginx/html:/usr/share/nginx/html:ro
diff --git a/docker-compose.yaml b/docker-compose.yaml
diff --git a/fixtures/nginx/html/dynamic.html b/fixtures/nginx/html/dynamic.html
@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8">
+        <title>A dynamic HTML page</title>
+    </head>
+    <body>
+        <h1>A dynamic HTML page</h1>
+        <script>
+            window.onload = event => {
+                fetch('/dynamic.json')
+                    .then(response => response.json())
+                    .then(data => {
+                        const newParagraph = document.createElement("p");
+                        const newContent = document.createTextNode(data.content);
+                        newParagraph.appendChild(newContent);
+
+                        document.body.append(newParagraph)
+                    });
+            };
+        </script>
+    </body>
+</html>
diff --git a/fixtures/nginx/html/dynamic.json b/fixtures/nginx/html/dynamic.json
@@ -0,0 +1,3 @@
+{
+    "content": "Some dynamic content."
+}
diff --git a/fixtures/nginx/html/static.html b/fixtures/nginx/html/static.html
@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta charset="utf-8">
+        <title>A static HTML page</title>
+    </head>
+    <body>
+        <h1>A static HTML page</h1>
+    </body>
+</html>
diff --git a/jest.config.js b/jest.config.js
@@ -0,0 +1,194 @@
+/*
+ * 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,
+
+  // The directory where Jest should store its cached dependency information
+  // cacheDirectory: "/tmp/jest_rs",
+
+  // 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: undefined,
+
+  // The directory where Jest should output its coverage files
+  // coverageDirectory: undefined,
+
+  // An array of regexp pattern strings used to skip coverage collection
+  // coveragePathIgnorePatterns: [
+  //   "/node_modules/"
+  // ],
+
+  // Indicates which provider should be used to instrument code for coverage
+  // coverageProvider: "babel",
+
+  // 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: undefined,
+
+  // A path to a custom dependency extractor
+  // dependencyExtractor: undefined,
+
+  // 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: undefined,
+
+  // A path to a module which exports an async function that is triggered once after all test suites
+  // globalTeardown: undefined,
+
+  // 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 or to arrays of 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: undefined,
+
+  // Run tests from one or more projects
+  // projects: undefined,
+
+  // 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: undefined,
+
+  // Automatically restore mock state between every test
+  // restoreMocks: false,
+
+  // The root directory that Jest should scan for tests and modules within
+  // rootDir: undefined,
+
+  // 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: [],
+
+  // The number of seconds after which a test is considered as slow and reported as such in the results.
+  // slowTestThreshold: 5,
+
+  // 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: undefined,
+
+  // 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: undefined,
+
+  // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
+  // transformIgnorePatterns: [
+  //   "/node_modules/",
+  //   "\\.pnp\\.[^\\/]+$"
+  // ],
+
+  // 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: undefined,
+
+  // 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,
+};
diff --git a/package.json b/package.json
@@ -16,12 +16,16 @@
     "@babel/core": "^7.14.0",
     "@babel/node": "^7.13.13",
     "@babel/preset-env": "^7.14.1",
+    "babel-jest": "^26.6.3",
+    "jest": "^26.6.3",
+    "node-fetch": "^2.6.1",
     "nodemon": "^2.0.7",
     "regenerator-runtime": "^0.13.7"
   },
   "scripts": {
-    "dev": "nodemon --watch src/ --exec babel-node src/index.js",
+    "start-dev": "nodemon --watch src/ --ignore 'src/**/*.test.js' --exec babel-node src/index.js",
     "build": "babel src/ -d build/ --ignore 'src/**/*.test.js'",
-    "start": "node build/index.js"
+    "start": "node build/index.js",
+    "test": "jest"
   }
 }