t/README.md

   1 -----------------------------------------------------------------------------
   2 # Solgenomics Test Suite
   3 -----------------------------------------------------------------------------
   4
   5 This is the SGN test suite, which helps us verify that code is working as it should.
   6
   7 Active Testing:
   8
   9 perl t/test_fixture.pl t/unit/
  10 perl t/test_fixture.pl t/unit_fixture/
  11 perl t/test_fixture.pl t/selenium2/
  12
  13 -----------------------------------------------------------------------------
  14 #Active Tests
  15 -----------------------------------------------------------------------------
  16
  17 ## t/unit/Bio
  18
  19 Unit tests in the Bio::SecreTary::* namespace. These tests do not require a database to run.
  20
  21 ## t/unit/CXGN
  22
  23 Unit tests in the CXGN::* namespace. These tests do not require a database to run.
  24
  25 ## t/unit/pod
  26
  27 Tests related to POD documentation. These tests do not require a database to run.
  28
  29 ## t/unit_fixture/CXGN
  30
  31 Unit fixture tests in the CXGN::* namespace. These test run against the fixture database.
  32 These tests run directly against backend CXGN modules (most often Moose objects).
  33
  34 ## t/unit_fixture/SGN
  35
  36 Unit fixture tests in the SGN::* namespace. These test run against the fixture database.
  37 These tests run directly against backend SGN modules (most often Moose objects).
  38
  39 ## t/unit_fixture/Controller
  40
  41 Unit fixture tests in the SGN::Controller::* namespace. These test run against the fixture database.
  42 These tests run through URL requests to Catalyst::Controller modules.
  43
  44 ## t/unit_fixture/AJAX
  45
  46 Unit fixture tests in the SGN::Controller::AJAX::* namespace. These test run against the fixture database.
  47 These tests run through URL requests to Catalyst::Controller::REST modules.
  48
  49 ## t/unit_fixture/Static
  50
  51 These tests check that static files are accessible from web services.
  52
  53 ## t/selenium2
  54
  55 Integration tests, which use selenium2 to launch a web browser.
  56 These tests are useful for testing client side javascript, but use of these tests has fallen short lately because of the slowness of selenium.
  57
  58 ## t/live
  59
  60 Tests which run tests against live websites.
  61
  62
  63
  64 -----------------------------------------------------------------------------
  65 #Test Environment
  66 -----------------------------------------------------------------------------
  67
  68 ## t/test_fixture.pl
  69
  70 Used to launch a test server and to load the fixture database. Also useful for testing entire directories at once.
  71
  72 ## t/data/
  73
  74 Contains test data, such as test GFF3 files or test images. Used by the rest of the test suite.
  75
  76 ## t/lib/
  77
  78 Libraries written for and to be used by the test suite, such as SGN::Test::Data.
  79
  80
  81
  82 -----------------------------------------------------------------------------
  83 #Legacy Tests
  84 -----------------------------------------------------------------------------
  85
  86 ## t/SGN
  87
  88 Tests in the SGN::* namespace
  89
  90 ## t/CXGN
  91
  92 Tests in the CXGN::* namespace
  93
  94 ## t/legacy/integration/
  95
  96 This directory contains integration tests, which test how multiple peices of code interact,
  97 as opposed to unit tests, which usually test a small piece of code in isolation.
  98
  99 ## t/legacy/validate/
 100
 101 Validation tests, which run "html lint" tests to make sure our HTML validates, which is important
 102 for making the website render properly and quickly in many browsers.