Skip to content

testing.md

Latest commit

 

History

History
80 lines (67 loc) · 4.07 KB

testing.md

File metadata and controls

80 lines (67 loc) · 4.07 KB

#Testing All tests that relate to the kernel are automatically built with FLOK_ENV=DEBUG

##./spec layout The spec folder contains all tests with the exception of Driver tests (See below for information).

  • spec/
    • etc/ - All tests that do not fit any categories. -lib/ - Tests that pertain to the ./lib/flok ruby library
    • iface/
      • kern/ - All tests that only need the kernel (server) pipe.
      • driver/ - All tests that only need the driver (client) pipe.
      • all/ - All tests that need both the kernel and driver pipe.
    • kern/ - All tests for the kernel that do not need the pipe.
    • lib/ - A folder of useful subroutines.
    • env/ - Files that are automatically loaded at the beginning of each test that provide the environment.
      • kern.rb (for ./spec/kern/*_spec.rb)
      • iface.rb (for ./spec/iface/**/*_spec.rb)
      • etc.rb (for ./spec/etc/*_spec.rb)

For each _spec.rb file in the ./spec folder, make sure to change the directory root to the project root. For example, if your spec file was ./spec/iface/kern/pipe_spec.rb then you would put Dir.chdir File.join File.dirname(__FILE__), '../../../' at the top. RSpec needs to be able to execute anywhere.

##Drivers See the section on Spec in Drivers. Driver tests can be executed from the global rakefile by the convenience task rake spec:driver PLATFORM=$PLATFORM

##Kernel Kernel tests only operate on the kernel and should never include tests that can be accomplished through using the kernel's pipe interface. Kernel tests are given a pre-build V8 context that has the application.js loaded through therubyracer.

  • Running - rake spec:kern PLATFORM=$PLATFORM
  • Requires - ./spec/etc/kern.rb
  • Location - ./spec/kern/*_spec.rb
  • Environment
    • include_context "kern" - Access @ctx, a V8 runtime that has application.js preloaded. See therubyracer
    • mock(function_name, &block) - Override a function of @ctx with a ruby method
    • $PLATFORM - Current platform the application.js was built for.
    • $PWD - ./

##Interface Interface tests are used for things that can be tested through either only the kernel pipe, driver pipe, or both.

  • Running - rake spec:iface PLATFORM=$PLATFORM
  • Requires - ./spec/etc/iface.rb
  • Location
    • ./spec/iface/kern - Tests only need the server pipe
    • ./spec/iface/driver - Tests only need the client pipe
    • ./spec/iface/all - Tests need both pipes
  • Variables
    • @mods - The list of modules this driver suppotrs in DEBUG mode
  • Environment
  • include_context "iface:kern" - Access @pipe matching the description for kernel pipe Interactive
  • include_context "iface:driver" - Access @pipe matching the description for driver pipe Interactive
  • $PLATFORM - The name of the platform of the driver and the parameters for the kernel.
  • $PWD - ./

For each test, including both kern and driver, please use the module_dep(module_name) to prevent tests from running on unspported modules

##Etc Tests that do not fit into any of the categories (e.g. build output tests), should be placed in ./spec/etc These tests are runnable via rake spec:etc PLATFORM=$PLATFORM

  • Running - rake spec:etc PLATFORM=$PLATFORM
  • Requires - ./spec/etc/etc.rb
  • Location - ./spec/etc/
  • Environment
  • $PLATFORM - The name of the platform of the driver and the parameters for the kernel.
  • $PRODUCTS_PATH - Location of the application.js file and drivers folder.
  • $PWD - ./

##World & All

####World (Per platform) The rake spec:world PLATFORM=$PLATFORM executes the following tests:

  1. The etc tests
  2. The kernel tests
  3. The interface tests
  4. The drivers tests

####All (All platforms) The rake spec executes the same thing as rake spec:world PLATFORM=$PLATFORM but uses every platform automatically. This will test the kernel multiple times, but that is ok, as different platforms have different modules enabled for the kernel.