Docker fix (#981)

* fixed formatting in changelog

* fixed usage of docker image

* fixes to circle ci to run docker images:

* build and run separated

* fixed unit tests

* fixed build sh permissions

* install npm before building images

* fixing npm install in build

* fix puppeteer installing

* fixed puppeteer install

* fixed tests

* fixed wd tests

* removed event handlers from config

* fixed events location

* added data dir

* fixed retries

* fixed retries

* increased timeout

* increased timeout

* fixed loading events

* moved node modules to root

* fixed loading events

* fixed event test

* fixed events

Author: DavertMik

.circleci/build.sh

@@ -1,18 +1,4 @@
-#!/usr/bin/env bash
-
-set -e
-
 cd test
 
-docker-compose build \
-  --build-arg NODE_VERSION=$NODE_VERSION \
-  test-unit \
-  test-helpers \
-  test-acceptance.webdriverio \
-  test-acceptance.nightmare \
-  test-acceptance.puppeteer \
-  json_server
-
-docker-compose pull \
-  php \
-  selenium.chrome
+docker-compose build
+docker-compose pull php selenium.chrome

.circleci/config.yml

@@ -10,12 +10,7 @@ defaults: &defaults
     - run: .circleci/test.sh
 
 jobs:
-  node 8.9.1:
-    <<: *defaults
-    environment:
-      - NODE_VERSION: 8.9.1
-
-  node 9.2.0:
+  docker:
     <<: *defaults
     environment:
       - NODE_VERSION: 9.2.0
@@ -25,5 +20,4 @@ workflows:
 
   test_all:
     jobs:
-      - node 8.9.1
-      - node 9.2.0
+      - docker

.circleci/test.sh

@@ -5,8 +5,7 @@ set -e
 cd test
 
 docker-compose run --rm test-unit
-docker-compose run --rm test-helpers test/helper
-docker-compose run --rm test-helpers test/rest
+docker-compose run --rm test-rest
 docker-compose run --rm test-acceptance.webdriverio
 docker-compose run --rm test-acceptance.nightmare
 docker-compose run --rm test-acceptance.puppeteer

.dockerignore

@@ -0,0 +1,2 @@
+**/node_modules
+test

.travis.yml

@@ -29,8 +29,6 @@ before_script:
 - sh -e /etc/init.d/xvfb start
 - chmod -R 777 test/data
 - php -S 127.0.0.1:8000 -t test/data/app >/dev/null 2>&1 &
-- npm run json-server &
-- sleep 10
 script:
 - npm test
 - './node_modules/.bin/mocha test/helper/${HELPER}_test.js'

CHANGELOG.md

@@ -9,13 +9,13 @@
 * [Puppeteer] Added `waitForEnabled`, `waitForValue` and `waitNumberOfVisibleElements` methods by @reubenmiller
 * [WebDriverIO] Fixed `grabNumberOfVisibleElements` to return 0 when no visible elements are on page. By @michaltrunek
 * Helpers API improvements (by @reubenmiller)
-  * `_passed` hook runs after a test passed successfully
-  * `_failed` hook runs on a failed test
+    * `_passed` hook runs after a test passed successfully
+    * `_failed` hook runs on a failed test
 * Hooks API. New events added by @reubenmiller:
-  * `event.all.before` - executed before all tests
-  * `event.all.after` - executed after all tests
-  * `event.multiple.before` - executed before all processes in run-multiple
-  * `event.multiple.after` - executed after all processes in run-multiple
+    * `event.all.before` - executed before all tests
+    * `event.all.after` - executed after all tests
+    * `event.multiple.before` - executed before all processes in run-multiple
+    * `event.multiple.after` - executed after all processes in run-multiple
 * Multiple execution
 * Allow `AfterSuite` and `After` test hooks to be defined after the first Scenario. By @reubenmiller
 * [Nightmare] Prevent `I.amOnpage` navigation if the browser is already at the given url

Dockerfile

@@ -28,30 +28,24 @@ RUN apt-get update && apt-get install -y wget --no-install-recommends \
 #     browser.launch({executablePath: 'google-chrome-unstable'})
 # ENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD true
 
-# Install puppeteer so it's available in the container.
-RUN yarn add puppeteer
 
 # Add pptr user.
 RUN groupadd -r pptruser && useradd -r -g pptruser -G audio,video pptruser \
     && mkdir -p /home/pptruser/Downloads \
     && chown -R pptruser:pptruser /home/pptruser \
-    && chown -R pptruser:pptruser /home/pptruser \
-    && chown -R pptruser:pptruser /node_modules
-
-RUN mkdir /codecept && chown -R pptruser:pptruser /codecept
+    && chown -R pptruser:pptruser /home/pptruser
 
-WORKDIR /tmp
-COPY package.json /tmp/
-
-# Install packages
-RUN npm install --loglevel=warn
 
 #RUN mkdir /home/codecept
-WORKDIR /codecept
 
 COPY . /codecept
 
-RUN cp -a /tmp/node_modules /codecept/
+RUN chown -R pptruser:pptruser /codecept
+RUN runuser -l pptruser -c 'npm install --loglevel=warn --prefix /codecept'
+
+RUN ln -s /codecept/bin/codecept.js /usr/local/bin/codeceptjs
+RUN mkdir /tests
+WORKDIR /tests
 
 # Allow to pass argument to codecept run via env variable
 ENV CODECEPT_ARGS=""
@@ -63,7 +57,7 @@ ENV HOST=selenium
 # USER pptruser
 
 # Set the entrypoint for Nightmare
-ENTRYPOINT ["docker/entrypoint"]
+ENTRYPOINT ["/codecept/docker/entrypoint"]
 
 # Run tests
-CMD ["bash", "docker/run.sh"]
+CMD ["bash", "/codecept/docker/run.sh"]

docker/README.md

@@ -1,6 +1,6 @@
 # Codeceptjs Docker
 
-CodeceptJS packed into container with the Nightmare, Protractor, and WebDriverIO drivers.
+CodeceptJS packed into container with the Nightmare, Protractor, Puppeteer, and WebDriverIO drivers.
 
 ## How to Use
 
@@ -9,15 +9,26 @@ Mount in your CodeceptJS config directory into the `/tests` directory in the doc
 
 Sample mount: `-v path/to/codecept.json:/tests`
 
+CodeceptJS runner is available inside container as `codeceptjs`.
+
 ### Locally
 
-You can execute CodeceptJS with Nightmare locally with no extra configuration.
+You can execute CodeceptJS with Puppeteer or Nightmare locally with no extra configuration.
 
 ```sh
 docker run --net=host -v $PWD:/tests codeception/codeceptjs
 ```
 
-Nightmare helper must be enabled in codecept.json config.
+To customize execution call `codeceptjs` command:
+
+```sh
+# run tests with steps
+docker run --net=host -v $PWD:/tests codeception/codeceptjs codeceptjs run --steps
+
+# run tests with @user in a name
+docker run --net=host -v $PWD:/tests codeception/codeceptjs codeceptjs run --grep "@user"
+```
+
 
 ### Docker Compose
 
@@ -79,18 +90,28 @@ To build this image:
 docker build -t codeception/codeceptjs .
 ```
 
-### Debugging
-To pass arguments to `codecept run` command inside docker image you can set
-`CODECEPT_ARGS` environment variable. For example to run your tests with debug
-and steps output:
+* this directory will be added as `/codecept` insde container
+* tests directory is expected to be mounted as `/tests`
+* `codeceptjs` is a synlink to `/codecept/bin/codecept.js`
+
+### Passing Options
+
+Options can be passed by calling `codeceptjs`:
+
+```
+docker run -v $PWD:/tests codeception/codeceptjs codeceptjs run --debug
+```
+
+Alternatively arguments to `codecept run` command can be passed via `CODECEPT_ARGS` environment variable. For example to run your tests with debug
+output:
 
 ```yaml
 version: '2'
 services:
   codeceptjs:
     image: codeception/codeceptjs
     environment:
-      - CODECEPT_ARGS=--debug --steps
+      - CODECEPT_ARGS=--debug
     volumes:
       - .:/tests
 ```

docker/run.sh

@@ -1,14 +1,14 @@
 #!/usr/bin/env bash
 
-source docker/help.sh
+source /codecept/docker/help.sh
 
 # Check if tests are correctly mounted
 if [[ -d "/tests/" ]]; then
 		echo "CodeceptJS directory has been found."
 
 		# Run the tests
 		cd /tests/
-		node /codecept/bin/codecept.js run $CODECEPT_ARGS
+		codeceptjs run $CODECEPT_ARGS
 	else
 		display_usage
 fi

lib/hooks.js

@@ -4,8 +4,12 @@ const fileExists = require('./utils').fileExists;
 
 module.exports = function (hook, done, stage) {
   stage = stage || 'bootstrap';
-  if (typeof hook === 'string' && fileExists(fsPath.join(global.codecept_dir, hook))) {
-    const callable = require(fsPath.join(global.codecept_dir, hook));
+  if (typeof hook === 'string') {
+    const pluginFile = fsPath.join(global.codecept_dir, hook);
+    if (!fileExists(pluginFile)) {
+      throw new Error(`Hook ${pluginFile} doesn't exist`);
+    }
+    const callable = require(pluginFile);
     if (typeof callable === 'function') {
       callSync(callable, done);
       return;

test/acceptance/codecept.Nightmare.js

@@ -1,5 +1,4 @@
 const TestHelper = require('../support/TestHelper');
-const eventHandlers = require('../data/sandbox/eventHandlers');
 
 module.exports.config = {
   tests: './*_test.js',

test/acceptance/codecept.Puppeteer.js

@@ -1,5 +1,4 @@
 const TestHelper = require('../support/TestHelper');
-const eventHandlers = require('../data/sandbox/eventHandlers');
 
 module.exports.config = {
   tests: './*_test.js',

test/acceptance/codecept.WebDriverIO.js

@@ -1,5 +1,4 @@
 const TestHelper = require('../support/TestHelper');
-const eventHandlers = require('../data/sandbox/eventHandlers');
 
 module.exports.config = {
   tests: './*_test.js',

test/acceptance/event_test.js

@@ -1,15 +1,20 @@
-const event = require('../../lib').event;
+let event;
+try {
+  require.resolve('../../lib');
+  event = require('../../lib').event;
+} catch (err) {
+  event = require('/codecept/lib').event; // eslint-disable-line
+}
 const assert = require('assert');
 const expect = require('chai').expect;
 const eventHandlers = require('../data/sandbox/eventHandlers');
 
 const expectedEvents = [];
 
-Feature('Events', { retries: 0 });
+Feature('Events');
 
 BeforeSuite((I) => {
   expectedEvents.push(...[
-    event.all.before,
     event.suite.before,
   ]);
   expect(eventHandlers.events).to.deep.equal(expectedEvents);

test/data/rest/db.json

@@ -1 +1 @@
-{"comments":[],"posts":[{"id":1,"title":"json-server","author":"davert"}]}
+{"posts":[{"id":1,"title":"json-server","author":"davert"}],"user":{"name":"davert"}}

test/data/sandbox/eventHandlers.js

@@ -1,4 +1,10 @@
-const event = require('../../../lib').event;
+let event;
+try {
+  require.resolve('../../../lib');
+  event = require('../../../lib').event;
+} catch (err) {
+  event = require('/codecept/lib').event; // eslint-disable-line
+}
 
 const eventTypes = [
   // All Events

test/docker-compose.yml

@@ -2,31 +2,20 @@ version: '3'
 services:
   test-unit:
     build: ..
-    entrypoint: docker/entrypoint node_modules/.bin/mocha
+    entrypoint: /codecept/node_modules/.bin/mocha
     command: test/unit
     working_dir: /codecept
     volumes:
       - ..:/codecept
       - node_modules:/codecept/node_modules
 
-  test-runner:
+  test-rest:
     build: ..
-    entrypoint: docker/entrypoint node_modules/.bin/mocha
-    command: test/runner
-    working_dir: /codecept
-    volumes:
-      - ..:/codecept
-      - node_modules:/codecept/node_modules
-
-  test-helpers:
-    build: ..
-    entrypoint: docker/entrypoint node_modules/.bin/mocha --invert --fgrep Appium
-    command: test/helper
+    entrypoint: /codecept/node_modules/.bin/mocha
+    command: test/rest
     working_dir: /codecept
     env_file: .env
     depends_on:
-      - selenium.chrome
-      - php
       - json_server
     volumes:
       - ..:/codecept
@@ -36,14 +25,15 @@ services:
     build: ..
     env_file: .env
     environment:
-      - CODECEPT_ARGS=-c codecept.WebDriverIO.js --grep @WebDriverIO
+      - CODECEPT_ARGS=-c codecept.WebDriverIO.js --grep @WebDriverIO --verbose
     depends_on:
       - php
       - selenium.chrome
     volumes:
       - ./acceptance:/tests
+      - ./data:/data
       - ./support:/support
-      - node_modules:/codecept/node_modules
+      - node_modules:/node_modules
 
   test-acceptance.nightmare:
     build: ..
@@ -55,8 +45,9 @@ services:
       - selenium.chrome
     volumes:
       - ./acceptance:/tests
+      - ./data:/data
       - ./support:/support
-      - node_modules:/codecept/node_modules
+      - node_modules:/node_modules
 
   test-acceptance.puppeteer:
     build: ..
@@ -67,8 +58,9 @@ services:
       - php
     volumes:
       - ./acceptance:/tests
+      - ./data:/data
       - ./support:/support
-      - node_modules:/codecept/node_modules
+      - node_modules:/node_modules
 
   selenium.chrome:
     image: selenium/standalone-chrome:3.9.1-actinium

test/rest/ApiDataFactory_test.js

@@ -22,7 +22,9 @@ const data = {
 
 const getDataFromFile = () => JSON.parse(fs.readFileSync(dbFile));
 
-describe('ApiDataFactory', () => {
+describe('ApiDataFactory', function () {
+  this.timeout(20000);
+
   before(() => {
     I = new ApiDataFactory({
       endpoint: api_url,
@@ -42,14 +44,13 @@ describe('ApiDataFactory', () => {
     } catch (err) {
       // continue regardless of error
     }
-    setTimeout(done, 500);
+    setTimeout(done, 5000);
   });
 
   afterEach(() => I._after());
 
   describe('create and cleanup records', function () {
-    this.retries(1);
-    this.timeout(20000);
+    this.retries(2);
 
     it('should create a new post', async () => {
       await I.have('post');