github.com/jenkins-x/test-infra@v0.0.7/scenarios/README.md (about)

     1  # DEPRECATION NOTICE
     2  
     3  *October 9, 2018* `scenarios/*.py` will be moved to become part of kubetest v2, so we are
     4  not taking PRs except for urgent bug fixes.
     5  
     6  Also please bump [bootstrap image](/images/bootstrap) and 
     7  [kubekins image](/images/kubekins-e2e) to take in any future changes.
     8  
     9  # Test scenarios
    10  
    11  Place scripts to run test scenarios inside this location.
    12  
    13  Test jobs are composed of two things:
    14  1) A scenario to test
    15  2) Configuration options for the scenario.
    16  
    17  Three example scenarios are:
    18  
    19  * Unit tests
    20  * Node e2e tests
    21  * e2e tests
    22  
    23  Example configurations are:
    24  
    25  * Parallel tests on gce
    26  * Build all platforms
    27  
    28  The assumption is that each scenario will be called a variety of times with
    29  different configuration options. For example at the time of this writing there
    30  are over 300 e2e jobs, each run with a slightly different set of options.
    31  
    32  ## Contract
    33  
    34  The scenario assumes the calling process (bootstrap.py) has setup all
    35  prerequisites, such as checking out the right repository, setting pwd,
    36  activating service accounts, etc.
    37  
    38  The scenario also assumes that the calling process will handle all post-job
    39  works, such as recording log output, copying logs to gcs, etc.
    40  
    41  The scenario should exit 0 if and only on success.
    42  
    43  The calling process can configure the scenario by calling the scenario
    44  with different arguments. For example: `kubernetes\_build.py --fast`
    45  configures the scenario to do a fast build (one platform) and/or
    46  `kubernetes\_build.py --federation=random-project` configures the scenario
    47  to do a federation build using the random-project.
    48  
    49  Call the scenario with `-h` to see configuration options.