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 To launch tests: perl t/test_fixture.pl t/selenium2
   8
   9
  10
  11 -----------------------------------------------------------------------------
  12 #Active Tests
  13 -----------------------------------------------------------------------------
  14
  15 ## t/unit/Bio
  16
  17 Unit tests in the Bio::SecreTary::* namespace. These tests do not require a database to run.
  18
  19 ## t/unit/CXGN
  20
  21 Unit tests in the CXGN::* namespace. These tests do not require a database to run.
  22
  23 ## t/unit_fixture/CXGN
  24
  25 Unit fixture tests in the CXGN::* namespace. These test run against the fixture database.
  26
  27 ## t/selenium2
  28
  29 Integration tests, which use selenium2 to launch a web browser.
  30
  31 ## t/live
  32
  33 Tests which run tests against live websites.
  34
  35 ## t/pod
  36
  37 Tests related to POD documentation.
  38
  39
  40
  41 -----------------------------------------------------------------------------
  42 #Test Environment
  43 -----------------------------------------------------------------------------
  44
  45 ## t/test_fixture.pl
  46
  47 Used to launch a test server and to load the fixture database. Also useful for testing entire directories at once.
  48
  49 ## t/data/
  50
  51 Contains test data, such as test GFF3 files or test images. Used by the rest of the test suite.
  52
  53 ## t/lib/
  54
  55 Libraries written for and to be used by the test suite, such as SGN::Test::Data.
  56
  57
  58
  59 -----------------------------------------------------------------------------
  60 #Legacy Tests
  61 -----------------------------------------------------------------------------
  62
  63 ## t/SGN
  64
  65 Tests in the SGN::* namespace
  66
  67 ## t/CXGN
  68
  69 Tests in the CXGN::* namespace
  70
  71 ## t/legacy/integration/
  72
  73 This directory contains integration tests, which test how multiple peices of code interact,
  74 as opposed to unit tests, which usually test a small piece of code in isolation.
  75
  76 ## t/legacy/validate/
  77
  78 Validation tests, which run "html lint" tests to make sure our HTML validates, which is important
  79 for making the website render properly and quickly in many browsers.