Code Monkey home page Code Monkey logo

embedded-acceptance-tests's Introduction

Embedded Acceptance Testing with Karma and Jasmine

This demo is comprised of five javascript bundlers each configured to run the tests. The Bootstrap single page application retains functionality among the bundlers with only minor code change. The javascript framework used is Canjs and instrumentation is done with Gulp and Karma. So you can pick your poison, Stealjs, Webpack, Browserify, Fusebox or Rollup.

Note; the demo was not developed to compare software, rather simply to demonstrate how one might embed test code as part of the build process. And the configuration also shows how to develop using hot module reload and test driven development.

Installation

Desktop:

clone the repository or download the .zip

Install Assumptions:

  1. OS Linux and Windows(Tested on Windows10)
  2. Node and npm
  3. Gulp
  4. Google Chrome
  5. Firefox

Server:

cd to top level directory <install>/acceptance-tests

  npm install

This will install a small Node/Express setup to view the results of a production build.

cd <install>/acceptance-tests/public

  npm install

To install all required dependencies.

Client:

Test builds will generate bundles in 'dist_test' and production in the 'dist' directory at the root level, 'public'.

Production Build

To generate a build "cd to public/<bundler>/build and type gulp, e.g.

  cd public/fusebox/build
  gulp

If the tests succeed then the build should complete.

To run the production application:

  1. cd <install>/acceptance_tests
  2. npm start - This should start a Node Server with port 3080.
  3. Start a browser and enter localhost:3080/dist/<bundler>/appl/testapp.html

You can repeat the procedure with "webpack", "browserify", "stealjs" or "rollup". Output from the build can be logged by setting the environment variable USE_LOGFILE=true.

Normally you can also run the test bundles(dist_test) from the node express server. However, when switching between development karma testing and running the test(dist_test) application, some resources are not found because of the "base/dist_test" URL. To fix this run gulp rebuild from the <bundler>/build directory.

Note; There was a Production build problem with Rollup, ES6, can-component and two-way binding. The problem was fixed by re-coding the tools page selection element with a Bootstrap Dropdown Component. Therefore, the toolstest.js specs were also modified.

Test Build

The test build simply runs the tests in headless mode. The default browsers are ChromeHeadless and FirefoxHeadless. To change the default you can set an environment variable; e.g.

  export USE_BROWSERS=ChromeHeadless,Opera

to remove FirefoxHeadless from the browser list and add Opera. You can also set this environment variable for a production build.

To run the tests "cd to public/<bundler>/build and type gulp test, e.g.

  cd public/webpack/build
  gulp test

A test result might look like;

  Suite for Unit Tests
    ✔ Verify that browser supports Promises
    ✔ ES6 Support
    ✔ blockStrip to remove Canjs block of code
  Unit Tests - Suite 2
    ✔ Is Karma active
    ✔ Verify NaN
  Popper Defined - required for Bootstrap
    ✔ is JQuery defined
    ✔ is Popper defined
  Application Unit test suite - AppTest
    ✔ Is Welcome Page Loaded
    ✔ Is Tools Table Loaded
    Test Router: table/tools
      ✔ controller set: table
      ✔ action set: tools
      ✔ dispatch called: table
    ✔ Is Pdf Loaded
    Test Router: pdf/test
      ✔ controller set: pdf
      ✔ action set: test
      ✔ dispatch called: pdf
    Load new tools page
      ✔ setup and change event executed.
      ✔ new page loaded on change.
    Contact Form Validation
      ✔ Contact form - verify required fields
      ✔ Contact form - validate populated fields, email mismatch.
      ✔ Contact form - validate email with valid email address.
      ✔ Contact form - validate form submission.
    Popup Login Form
      ✔ Login form - verify modal with login loaded
      ✔ Login form - verify cancel and removed from DOM

Finished in 13.883 secs / 9.677 secs @ 13:26:11 GMT-0800 (PST)

SUMMARY:
✔ 48 tests completed

Development

Note; When modifying project assets(.stache, .html, etc.) you can execute gulp copy from the public/<bundler>/build directory to preview changes. This is not required for StealJs.

A word on developing tests; You can write and execute tests quicker by using the rebuild process of a given bundler and running the acceptance gulp task after the auto-rebuild, e.g. with Rollup you can;

  • cd public/rollup/build
  • gulp watch
  • Develop or modify a test.
  • In another window execute gulp acceptance from the build directory to view the modified or new test results.

I. Browserify

1. Development Server Window -

  • cd public/browserify/build
  • gulp server

Browsersync will start a browser tab(default Chrome) with localhost:3080/dist_test/browserify/appl/testapp_dev.html. Any changes to the source code(*.js files) should be reflected in the browser auto reload.

2. Hot Module Reload(HMR) Window -

  • cd public/browserify/build
  • gulp hmr

The watchify plugin will remain active to rebuild the bundle on code change.

3. Test Driven Development(tdd) Window -

  • cd public/browserify/build
  • gulp tdd

Tests will rerun as source code(*.js) is changed. Note, tests can be added or removed as code is developed. Both Chrome and Firefox are the default browsers. This can be overridden with an environment variable, export USE_BROWSERS=Opera. Note, you do not need hmr active for tdd. Also, tdd can be run with a headless browser.

II. Fusebox

1. Hot Module Reload(HMR) Server Window -

  • cd public/fusebox/build
  • fuse hmr

At this point you can start a browser and enter localhost:3080/fusebox/appl/testapp_dev.html or localhost:3080/dist_test/fusebox/appl/testapp_dev.html. Any changes to the source code(*.js files) should be reflected in the browser auto reload.

Alternatively, you can start up the HMR server with the gulp command gulp hmr, however, you will not see any output.

2. Test Driven Development(tdd) Window -

  • cd public/fusebox/build
  • gulp tdd

The HMR Server must be running if you want tests to rerun as source code(*.js) is changed. Note, tests can be added or removed as code is developed. Both Chrome and Firefox are the default browsers. This can be overridden with an environment variable, export USE_BROWSERS=Opera. A warning is issued under tdd(404: /dist_test/fusebox/resources) since hmr requires a non-karma build, this can be ignored.

Additionally, Fusebox likes Typescript, so to run HMR, the index.js script needed to be converted to index.ts. If you want to modify the index module modify the index.ts file. Also, the entire application is dynamically transpiled to Typescript in Development. Production is pure javascript so that the block development code removals will work.

Note; You can upgrade Fuse-Box to version 3 without changes to the configuration, however, you must be using Nodejs 8+.

III. Rollup

1. Development Server Window -

  • cd public/rollup/build
  • gulp watch

The Rollup Development Server, Watch(auto-rebuild) and Page Reload functions are started together. Simply use one of the following URLs in any browser; localhost:3080/rollup/appl/testapp_dev.html or localhost:3080/dist_test/rollup/appl/testapp_dev.html.

Currently Rollup an ES6 bundler has an issue with can-view-stache and can-component. The dropdown component on the table view page was changed to a Bootstrap component. The event handling is done with can-control. See app.js and table.js. With a modification to the toolstest.js module tests are satisfied and the production build should finish.

2. Test Driven Development(tdd) Window -

  • cd public/rollup/build
  • gulp tdd

Tests will rerun as source code(*.js) is changed. Note, tests can be added or removed as code is developed. Both Chrome and Firefox are the default browsers. This can be overridden with an environment variable, export USE_BROWSERS=Opera.

IV. Stealjs

1. Development Server Window -

  • cd public/stealjs/build
  • gulp server

2. Live-Reload(HMR) Window -

  • cd public/stealjs/build
  • gulp hmr

At this point you can start a browser and enter localhost:3080/stealjs/appl/testapp_dev.html(please note that dist_test is not in the URL). Any changes to the source code(*.js files) should be reflected in the browser auto reload. The gulp hmr by default builds a vendor bundle for faster reload. When you are not modifying the node_modules directory, subsequent executions of gulp hmr do not need the vendor bundle build. You can disable by setting an environment variable, export USE_VENDOR_BUILD=false.

Stealjs does not require a dist_test build. It runs development directly from the source(nice!). However, when starting hmr a vendor bundle is produced at public/dev-bundle.js for hmr performance. The bundle is accessed from the testapp_dev.html page, via a deps-bundle attribute.

Finally, because there are five bundlers using the package.json file, a main is not specified. Stealjs hmr dependency bundler needs to know the application entry point. Since main is not available it looks for index.js in the root directory. So a soft link was made to index.js. If not included in the git clone or zip download, you must execute the link, e.g.

  • cd application-tests/public
  • ln -s stealjs/appl/js/index.js index.js

3. Test Driven Development(tdd) Window -

  • cd public/steal/build
  • gulp tdd

Tests will rerun as source code(*.js) is changed. Note, tests can be added or removed as code is developed. Both Chrome and Firefox are the default browsers. This can be overridden with an environment variable, export USE_BROWSERS=Opera.

V. Webpack

1. Development HMR Server Window -

  • cd public/webpack/build
  • gulp hmr

2. Hot Module Reload(Watch) Window -

  • cd public/webpack/build
  • gulp watch

At this point you can start a browser and enter localhost:3080/dist_test/webpack/appl/testapp_dev.html. Any changes to the source code(*.js files) should be reflected in the browser auto reload. Running the application from the source directory should also work, e.g., localhost:3080/webpack/appl/testapp_dev.html.

3. Test Driven Development(tdd) Window -

  • cd public/webpack/build
  • gulp tdd

Tests will rerun as source code(*.js) is changed. Note, tests can be added or removed as code is developed. Both Chrome and Firefox are the default browsers. This can be overridden with an environment variable, export USE_BROWSERS=Opera.

embedded-acceptance-tests's People

Contributors

daveo-home avatar

Stargazers

Roman Sapezhko avatar

Watchers

James Cloos avatar Mikita Melnikau avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.