Test Dependency

Note

This feature is subject to change

Buildtest can support test dependencies which allows one to specify condition before running a test. Let’s take a look at this next example, we have a buildspec with three tests jobA, jobB, and jobC. The test jobA will run immediately but now we introduce a new keyword needs which is a list of test names as dependency. We want test jobB to run after jobA is complete, and jobC to run once jobA and jobB is complete.

buildspecs:
  jobA:
    type: script
    executor: generic.local.bash
    description: no job dependency
    run: |
      echo "This job has no dependency"
      sleep 5

  jobB:
    type: script
    executor: generic.local.bash
    description: job dependency on jobA
    needs: [jobA]
    run: |
      echo "This job depends on jobA"
      sleep 2

  jobC:
    type: script
    executor: generic.local.bash
    description: job dependency on jobA and jobB
    needs: [jobA, jobB]
    run: |
      echo "This job depends on jobA and jobB"
      sleep 2

The needs property expects a list of strings, and values must match name of test. If you specify an invalid test name in needs property then buildtest will ignore the value. If multiple tests are specified in needs property then all test must finish prior to running test.

Let’s run this test, and take a note that buildtest will run test jobA, followed by jobB then jobC.

buildtest build -b tutorials/job_dependency/ex1.yml
$ buildtest build -b tutorials/job_dependency/ex1.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│                                                                              │
│ User:               docs                                                     │
│ Hostname:           build-24413851-project-280831-buildtest                  │
│ Platform:           Linux                                                    │
│ Current Time:       2024/05/17 18:01:26                                      │
│ buildtest path:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version:  2.0                                                      │
│ python path:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version:     3.9.18                                                   │
│ Configuration File: /tmp/tmp75qnqx26/config.yml                              │
│ Test Directory:     /tmp/tmp75qnqx26/var/tests                               │
│ Report File:        /tmp/tmp75qnqx26/var/report.json                         │
│ Command:            /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯
───────────────────────────  Discovering Buildspecs ────────────────────────────
                             Discovered buildspecs                              
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec                                                                    ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/latest/ ║
║ tutorials/job_dependency/ex1.yml                                             ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ Total: 1                                                                     ║
╚══════════════════════════════════════════════════════════════════════════════╝


Total Discovered Buildspecs:  1
Total Excluded Buildspecs:  0
Detected Buildspecs after exclusion:  1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/latest/tutorials/job_dependency/ex1.yml: VALID
Total builder objects created: 3
                            Builders by type=script                             
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃          ┃        ┃          ┃          ┃       ┃       ┃ descript ┃ buildsp ┃
┃ builder  ┃ type   ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ ion      ┃ ecs     ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ jobA/694 │ script │ generic. │ None     │ None  │ None  │ no job   │ /home/d │
│ 89e8a    │        │ local.ba │          │       │       │ dependen │ ocs/che │
│          │        │ sh       │          │       │       │ cy       │ ckouts/ │
│          │        │          │          │       │       │          │ readthe │
│          │        │          │          │       │       │          │ docs.or │
│          │        │          │          │       │       │          │ g/user_ │
│          │        │          │          │       │       │          │ builds/ │
│          │        │          │          │       │       │          │ buildte │
│          │        │          │          │       │       │          │ st/chec │
│          │        │          │          │       │       │          │ kouts/l │
│          │        │          │          │       │       │          │ atest/t │
│          │        │          │          │       │       │          │ utorial │
│          │        │          │          │       │       │          │ s/job_d │
│          │        │          │          │       │       │          │ ependen │
│          │        │          │          │       │       │          │ cy/ex1. │
│          │        │          │          │       │       │          │ yml     │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ jobB/3a2 │ script │ generic. │ None     │ None  │ None  │ job      │ /home/d │
│ 46d56    │        │ local.ba │          │       │       │ dependen │ ocs/che │
│          │        │ sh       │          │       │       │ cy on    │ ckouts/ │
│          │        │          │          │       │       │ jobA     │ readthe │
│          │        │          │          │       │       │          │ docs.or │
│          │        │          │          │       │       │          │ g/user_ │
│          │        │          │          │       │       │          │ builds/ │
│          │        │          │          │       │       │          │ buildte │
│          │        │          │          │       │       │          │ st/chec │
│          │        │          │          │       │       │          │ kouts/l │
│          │        │          │          │       │       │          │ atest/t │
│          │        │          │          │       │       │          │ utorial │
│          │        │          │          │       │       │          │ s/job_d │
│          │        │          │          │       │       │          │ ependen │
│          │        │          │          │       │       │          │ cy/ex1. │
│          │        │          │          │       │       │          │ yml     │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ jobC/ff9 │ script │ generic. │ None     │ None  │ None  │ job      │ /home/d │
│ 8c4e5    │        │ local.ba │          │       │       │ dependen │ ocs/che │
│          │        │ sh       │          │       │       │ cy on    │ ckouts/ │
│          │        │          │          │       │       │ jobA and │ readthe │
│          │        │          │          │       │       │ jobB     │ docs.or │
│          │        │          │          │       │       │          │ g/user_ │
│          │        │          │          │       │       │          │ builds/ │
│          │        │          │          │       │       │          │ buildte │
│          │        │          │          │       │       │          │ st/chec │
│          │        │          │          │       │       │          │ kouts/l │
│          │        │          │          │       │       │          │ atest/t │
│          │        │          │          │       │       │          │ utorial │
│          │        │          │          │       │       │          │ s/job_d │
│          │        │          │          │       │       │          │ ependen │
│          │        │          │          │       │       │          │ cy/ex1. │
│          │        │          │          │       │       │          │ yml     │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
jobA/69489e8a: Creating Test Directory: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex1/jobA/69489e8a
jobB/3a246d56: Creating Test Directory: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex1/jobB/3a246d56
jobC/ff98c4e5: Creating Test Directory: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex1/jobC/ff98c4e5
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
jobA/69489e8a does not have any dependencies adding test to queue
jobC/ff98c4e5 Skipping job because it has job dependency on jobA/69489e8a which is in state PENDING
jobB/3a246d56 Skipping job because it has job dependency on jobA/69489e8a which is in state PENDING
Builders Eligible to Run
┏━━━━━━━━━━━━━━━┓
┃ Builder       ┃
┡━━━━━━━━━━━━━━━┩
│ jobA/69489e8a │
└───────────────┘
jobA/69489e8a: Current Working Directory : /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex1/jobA/69489e8a/stage
jobA/69489e8a: Running Test via command: bash jobA_build.sh
─────────────────────── Output Message for jobA/69489e8a ───────────────────────
This job has no dependency

jobA/69489e8a: Test completed in 5.009278 seconds with returncode: 0
jobA/69489e8a: Writing output file -  /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex1/jobA/69489e8a/jobA.out
jobA/69489e8a: Writing error file - /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex1/jobA/69489e8a/jobA.err
jobA/69489e8a: Running Post Run Script: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex1/jobA/69489e8a/stage/jobA_postrun.sh
jobA/69489e8a: Post run script exit code: 1
──────────────────── jobA/69489e8a: Post Run Script Output ─────────────────────

───────────────────── jobA/69489e8a: Post Run Script Error ─────────────────────
/tmp/tmp75qnqx26/var/tests/generic.local.bash/ex1/jobA/69489e8a/stage/jobA_postrun.sh not found.
───────────────────────────────── Iteration 2 ──────────────────────────────────
jobC/ff98c4e5 Skipping job because it has job dependency on jobB/3a246d56 which is in state PENDING
Builders Eligible to Run
┏━━━━━━━━━━━━━━━┓
┃ Builder       ┃
┡━━━━━━━━━━━━━━━┩
│ jobB/3a246d56 │
└───────────────┘
jobB/3a246d56: Current Working Directory : /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex1/jobB/3a246d56/stage
jobB/3a246d56: Running Test via command: bash jobB_build.sh
─────────────────────── Output Message for jobB/3a246d56 ───────────────────────
This job depends on jobA

jobB/3a246d56: Test completed in 2.009215 seconds with returncode: 0
jobB/3a246d56: Writing output file -  /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex1/jobB/3a246d56/jobB.out
jobB/3a246d56: Writing error file - /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex1/jobB/3a246d56/jobB.err
jobB/3a246d56: Running Post Run Script: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex1/jobB/3a246d56/stage/jobB_postrun.sh
jobB/3a246d56: Post run script exit code: 1
──────────────────── jobB/3a246d56: Post Run Script Output ─────────────────────

───────────────────── jobB/3a246d56: Post Run Script Error ─────────────────────
/tmp/tmp75qnqx26/var/tests/generic.local.bash/ex1/jobB/3a246d56/stage/jobB_postrun.sh not found.
───────────────────────────────── Iteration 3 ──────────────────────────────────
Builders Eligible to Run
┏━━━━━━━━━━━━━━━┓
┃ Builder       ┃
┡━━━━━━━━━━━━━━━┩
│ jobC/ff98c4e5 │
└───────────────┘
jobC/ff98c4e5: Current Working Directory : /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex1/jobC/ff98c4e5/stage
jobC/ff98c4e5: Running Test via command: bash jobC_build.sh
─────────────────────── Output Message for jobC/ff98c4e5 ───────────────────────
This job depends on jobA and jobB

jobC/ff98c4e5: Test completed in 2.00968 seconds with returncode: 0
jobC/ff98c4e5: Writing output file -  /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex1/jobC/ff98c4e5/jobC.out
jobC/ff98c4e5: Writing error file - /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex1/jobC/ff98c4e5/jobC.err
jobC/ff98c4e5: Running Post Run Script: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex1/jobC/ff98c4e5/stage/jobC_postrun.sh
jobC/ff98c4e5: Post run script exit code: 1
──────────────────── jobC/ff98c4e5: Post Run Script Output ─────────────────────

───────────────────── jobC/ff98c4e5: Post Run Script Error ─────────────────────
/tmp/tmp75qnqx26/var/tests/generic.local.bash/ex1/jobC/ff98c4e5/stage/jobC_postrun.sh not found.
                             Test Summary                             
┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━┓
┃ builder       ┃ executor           ┃ status ┃ returncode ┃ runtime ┃
┡━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━┩
│ jobA/69489e8a │ generic.local.bash │ PASS   │ 0          │ 5.009   │
├───────────────┼────────────────────┼────────┼────────────┼─────────┤
│ jobC/ff98c4e5 │ generic.local.bash │ PASS   │ 0          │ 2.010   │
├───────────────┼────────────────────┼────────┼────────────┼─────────┤
│ jobB/3a246d56 │ generic.local.bash │ PASS   │ 0          │ 2.009   │
└───────────────┴────────────────────┴────────┴────────────┴─────────┘



Passed Tests: 3/3 Percentage: 100.000%
Failed Tests: 0/3 Percentage: 0.000%


Adding 3 test results to report file: /tmp/tmp75qnqx26/var/report.json
Writing Logfile to /tmp/tmp75qnqx26/var/logs/buildtest_a883sq83.log

Test Dependency by returncode

In this next example, we can control behavior of job dependency based on returncode for a given test. This test has three tests: test1, test2 and test3. The first test will exit with returncode 1 but this test will pass because we have set state: PASS to override the status check. The next test test2 requires test1 to have a returncode of 1 in order to satisfy dependency. The returncode property expects a valid returncode and it can be a list of returncode similar to how one specify returncode under the status property see returncode: Return Code Matching. The needs property can support multiple test with returncode, in test3 we require test1 to have returncode 1 while test2 has a returncode of 2. We expect test2 to return a returncode of 2 because of exit 2 statement so we expect all three tests to run.

buildspecs:
  test1:
    type: script
    executor: generic.local.bash
    description: This test will pass with exit 1
    run: exit 1
    status:
      state: PASS

  test2:
    type: script
    executor: generic.local.bash
    description: This test will run if test1 has returncode 1
    run: exit 2
    status:
      state: PASS
    needs:
      - test1:
          returncode: 1

  test3:
    type: script
    executor: generic.local.bash
    description: This test will run if test1 has returncode 1 and test2 has returncode 2
    run: exit 1
    status:
      state: PASS
    needs:
      - test1:
          returncode: 1
      - test2:
          returncode: 2

Let’s build this test and take note of execution order of test.

buildtest build -b tutorials/job_dependency/ex2.yml
$ buildtest build -b tutorials/job_dependency/ex2.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│                                                                              │
│ User:               docs                                                     │
│ Hostname:           build-24413851-project-280831-buildtest                  │
│ Platform:           Linux                                                    │
│ Current Time:       2024/05/17 18:01:35                                      │
│ buildtest path:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version:  2.0                                                      │
│ python path:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version:     3.9.18                                                   │
│ Configuration File: /tmp/tmp75qnqx26/config.yml                              │
│ Test Directory:     /tmp/tmp75qnqx26/var/tests                               │
│ Report File:        /tmp/tmp75qnqx26/var/report.json                         │
│ Command:            /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯
───────────────────────────  Discovering Buildspecs ────────────────────────────
                             Discovered buildspecs                              
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec                                                                    ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/latest/ ║
║ tutorials/job_dependency/ex2.yml                                             ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ Total: 1                                                                     ║
╚══════════════════════════════════════════════════════════════════════════════╝


Total Discovered Buildspecs:  1
Total Excluded Buildspecs:  0
Detected Buildspecs after exclusion:  1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/latest/tutorials/job_dependency/ex2.yml: VALID
Total builder objects created: 3
                            Builders by type=script                             
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃          ┃        ┃          ┃          ┃       ┃       ┃ descript ┃ buildsp ┃
┃ builder  ┃ type   ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ ion      ┃ ecs     ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ test1/63 │ script │ generic. │ None     │ None  │ None  │ This     │ /home/d │
│ a18909   │        │ local.ba │          │       │       │ test     │ ocs/che │
│          │        │ sh       │          │       │       │ will     │ ckouts/ │
│          │        │          │          │       │       │ pass     │ readthe │
│          │        │          │          │       │       │ with     │ docs.or │
│          │        │          │          │       │       │ exit 1   │ g/user_ │
│          │        │          │          │       │       │          │ builds/ │
│          │        │          │          │       │       │          │ buildte │
│          │        │          │          │       │       │          │ st/chec │
│          │        │          │          │       │       │          │ kouts/l │
│          │        │          │          │       │       │          │ atest/t │
│          │        │          │          │       │       │          │ utorial │
│          │        │          │          │       │       │          │ s/job_d │
│          │        │          │          │       │       │          │ ependen │
│          │        │          │          │       │       │          │ cy/ex2. │
│          │        │          │          │       │       │          │ yml     │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ test2/25 │ script │ generic. │ None     │ None  │ None  │ This     │ /home/d │
│ 6816ee   │        │ local.ba │          │       │       │ test     │ ocs/che │
│          │        │ sh       │          │       │       │ will run │ ckouts/ │
│          │        │          │          │       │       │ if test1 │ readthe │
│          │        │          │          │       │       │ has      │ docs.or │
│          │        │          │          │       │       │ returnco │ g/user_ │
│          │        │          │          │       │       │ de 1     │ builds/ │
│          │        │          │          │       │       │          │ buildte │
│          │        │          │          │       │       │          │ st/chec │
│          │        │          │          │       │       │          │ kouts/l │
│          │        │          │          │       │       │          │ atest/t │
│          │        │          │          │       │       │          │ utorial │
│          │        │          │          │       │       │          │ s/job_d │
│          │        │          │          │       │       │          │ ependen │
│          │        │          │          │       │       │          │ cy/ex2. │
│          │        │          │          │       │       │          │ yml     │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ test3/e2 │ script │ generic. │ None     │ None  │ None  │ This     │ /home/d │
│ c6a13e   │        │ local.ba │          │       │       │ test     │ ocs/che │
│          │        │ sh       │          │       │       │ will run │ ckouts/ │
│          │        │          │          │       │       │ if test1 │ readthe │
│          │        │          │          │       │       │ has      │ docs.or │
│          │        │          │          │       │       │ returnco │ g/user_ │
│          │        │          │          │       │       │ de 1 and │ builds/ │
│          │        │          │          │       │       │ test2    │ buildte │
│          │        │          │          │       │       │ has      │ st/chec │
│          │        │          │          │       │       │ returnco │ kouts/l │
│          │        │          │          │       │       │ de 2     │ atest/t │
│          │        │          │          │       │       │          │ utorial │
│          │        │          │          │       │       │          │ s/job_d │
│          │        │          │          │       │       │          │ ependen │
│          │        │          │          │       │       │          │ cy/ex2. │
│          │        │          │          │       │       │          │ yml     │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
test1/63a18909: Creating Test Directory: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex2/test1/63a18909
test2/256816ee: Creating Test Directory: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex2/test2/256816ee
test3/e2c6a13e: Creating Test Directory: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex2/test3/e2c6a13e
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
test3/e2c6a13e Skipping job because it has job dependency on test1/63a18909 
test2/256816ee Skipping job because it has job dependency on test1/63a18909 
test1/63a18909 does not have any dependencies adding test to queue
Builders Eligible to Run
┏━━━━━━━━━━━━━━━━┓
┃ Builder        ┃
┡━━━━━━━━━━━━━━━━┩
│ test1/63a18909 │
└────────────────┘
test1/63a18909: Current Working Directory : /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex2/test1/63a18909/stage
test1/63a18909: Running Test via command: bash test1_build.sh
────────────────────── Output Message for test1/63a18909 ───────────────────────

test1/63a18909: failed to submit job with returncode: 1
─────────────────────── Error Message for test1/63a18909 ───────────────────────

test1/63a18909: Detected failure in running test, will attempt to retry test: 1 times
test1/63a18909: Run - 1/1
test1/63a18909: Running Test via command: bash test1_build.sh
test1/63a18909: failed to submit job with returncode: 1
test1/63a18909: Test completed in 0.016085 seconds with returncode: 1
test1/63a18909: Writing output file -  /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex2/test1/63a18909/test1.out
test1/63a18909: Writing error file - /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex2/test1/63a18909/test1.err
test1/63a18909: Running Post Run Script: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex2/test1/63a18909/stage/test1_postrun.sh
test1/63a18909: Post run script exit code: 1
──────────────────── test1/63a18909: Post Run Script Output ────────────────────

──────────────────── test1/63a18909: Post Run Script Error ─────────────────────
/tmp/tmp75qnqx26/var/tests/generic.local.bash/ex2/test1/63a18909/stage/test1_postrun.sh not found.
───────────────────────────────── Iteration 2 ──────────────────────────────────
test3/e2c6a13e Skipping job because it has job dependency on test2/256816ee 
Builders Eligible to Run
┏━━━━━━━━━━━━━━━━┓
┃ Builder        ┃
┡━━━━━━━━━━━━━━━━┩
│ test2/256816ee │
└────────────────┘
test2/256816ee: Current Working Directory : /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex2/test2/256816ee/stage
test2/256816ee: Running Test via command: bash test2_build.sh
────────────────────── Output Message for test2/256816ee ───────────────────────

test2/256816ee: failed to submit job with returncode: 2
─────────────────────── Error Message for test2/256816ee ───────────────────────

test2/256816ee: Detected failure in running test, will attempt to retry test: 1 times
test2/256816ee: Run - 1/1
test2/256816ee: Running Test via command: bash test2_build.sh
test2/256816ee: failed to submit job with returncode: 2
test2/256816ee: Test completed in 0.015995 seconds with returncode: 2
test2/256816ee: Writing output file -  /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex2/test2/256816ee/test2.out
test2/256816ee: Writing error file - /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex2/test2/256816ee/test2.err
test2/256816ee: Running Post Run Script: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex2/test2/256816ee/stage/test2_postrun.sh
test2/256816ee: Post run script exit code: 1
──────────────────── test2/256816ee: Post Run Script Output ────────────────────

──────────────────── test2/256816ee: Post Run Script Error ─────────────────────
/tmp/tmp75qnqx26/var/tests/generic.local.bash/ex2/test2/256816ee/stage/test2_postrun.sh not found.
───────────────────────────────── Iteration 3 ──────────────────────────────────
Builders Eligible to Run
┏━━━━━━━━━━━━━━━━┓
┃ Builder        ┃
┡━━━━━━━━━━━━━━━━┩
│ test3/e2c6a13e │
└────────────────┘
test3/e2c6a13e: Current Working Directory : /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex2/test3/e2c6a13e/stage
test3/e2c6a13e: Running Test via command: bash test3_build.sh
────────────────────── Output Message for test3/e2c6a13e ───────────────────────

test3/e2c6a13e: failed to submit job with returncode: 1
─────────────────────── Error Message for test3/e2c6a13e ───────────────────────

test3/e2c6a13e: Detected failure in running test, will attempt to retry test: 1 times
test3/e2c6a13e: Run - 1/1
test3/e2c6a13e: Running Test via command: bash test3_build.sh
test3/e2c6a13e: failed to submit job with returncode: 1
test3/e2c6a13e: Test completed in 0.016201 seconds with returncode: 1
test3/e2c6a13e: Writing output file -  /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex2/test3/e2c6a13e/test3.out
test3/e2c6a13e: Writing error file - /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex2/test3/e2c6a13e/test3.err
test3/e2c6a13e: Running Post Run Script: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex2/test3/e2c6a13e/stage/test3_postrun.sh
test3/e2c6a13e: Post run script exit code: 1
──────────────────── test3/e2c6a13e: Post Run Script Output ────────────────────

──────────────────── test3/e2c6a13e: Post Run Script Error ─────────────────────
/tmp/tmp75qnqx26/var/tests/generic.local.bash/ex2/test3/e2c6a13e/stage/test3_postrun.sh not found.
                             Test Summary                              
┏━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━┓
┃ builder        ┃ executor           ┃ status ┃ returncode ┃ runtime ┃
┡━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━┩
│ test2/256816ee │ generic.local.bash │ PASS   │ 2          │ 0.016   │
├────────────────┼────────────────────┼────────┼────────────┼─────────┤
│ test3/e2c6a13e │ generic.local.bash │ PASS   │ 1          │ 0.016   │
├────────────────┼────────────────────┼────────┼────────────┼─────────┤
│ test1/63a18909 │ generic.local.bash │ PASS   │ 1          │ 0.016   │
└────────────────┴────────────────────┴────────┴────────────┴─────────┘



Passed Tests: 3/3 Percentage: 100.000%
Failed Tests: 0/3 Percentage: 0.000%


Adding 3 test results to report file: /tmp/tmp75qnqx26/var/report.json
Writing Logfile to /tmp/tmp75qnqx26/var/logs/buildtest_6yd5mwjg.log

Test Dependency by state

You can specify state as a property to check for test state when specify test dependency. In this next example, we have have four tests pass_test, fail_test, pass_and_fail_test, and final_test. The first test will be a PASS because we have state: PASS. The test fail_test depends on pass_test only if it has state: PASS, if value is mismatch then test will be skipped. Note that buildtest will skip test until next iteration if test is not executed, however if test is complete then buildtest will cancel dependent test. We can specify multiple test dependencies with state property such as test pass_and_fail_test which expects pass_test to have state: PASS and fail_test to have state: FAIL. In test final_test, shows how you can combine the format, the needs property is a list of object where each element is name of test. If no properties are associated with test name then buildtest will wait until job is complete to execute test. In this example, the test expects both pass_test and fail_test to run while pass_and_fail_test must have returncode of 1.

buildspecs:
  pass_test:
    type: script
    executor: generic.local.bash
    description: This test will always pass
    status:
      state: PASS
    run: |
      echo "This test will pass"
      sleep 2

  fail_test:
    type: script
    executor: generic.local.bash
    description: This test will run if test 'pass_test' is in state 'PASS'
    status:
      state: FAIL
    needs:
      - pass_test:
          state: PASS
    run: |
      echo "This test will fail"
      sleep 2

  pass_and_fail_test:
    type: script
    executor: generic.local.bash
    description: This test will run if pass_test is 'PASS' and fail_test is 'FAIL'
    needs:
      - pass_test:
          state: PASS
      - fail_test:
          state: FAIL
    run: |
      sleep 2
      exit 1
    status:
      returncode: 1

  final_test:
    type: script
    executor: generic.local.bash
    description: Test will run after 'pass_test', 'fail_test', and 'pass_and_fail_test'
    needs:
      - pass_test
      - fail_test
      - pass_and_fail_test:
          returncode: 1
    run: |
      sleep 2
      echo "Hello world"

Let’s build this test and take note all tests are run.

buildtest build -b tutorials/job_dependency/ex3.yml
$ buildtest build -b tutorials/job_dependency/ex3.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│                                                                              │
│ User:               docs                                                     │
│ Hostname:           build-24413851-project-280831-buildtest                  │
│ Platform:           Linux                                                    │
│ Current Time:       2024/05/17 18:01:36                                      │
│ buildtest path:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version:  2.0                                                      │
│ python path:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version:     3.9.18                                                   │
│ Configuration File: /tmp/tmp75qnqx26/config.yml                              │
│ Test Directory:     /tmp/tmp75qnqx26/var/tests                               │
│ Report File:        /tmp/tmp75qnqx26/var/report.json                         │
│ Command:            /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯
───────────────────────────  Discovering Buildspecs ────────────────────────────
                             Discovered buildspecs                              
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec                                                                    ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/latest/ ║
║ tutorials/job_dependency/ex3.yml                                             ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ Total: 1                                                                     ║
╚══════════════════════════════════════════════════════════════════════════════╝


Total Discovered Buildspecs:  1
Total Excluded Buildspecs:  0
Detected Buildspecs after exclusion:  1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/latest/tutorials/job_dependency/ex3.yml: VALID
Total builder objects created: 4
                            Builders by type=script                             
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃          ┃        ┃          ┃          ┃       ┃       ┃ descript ┃ buildsp ┃
┃ builder  ┃ type   ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ ion      ┃ ecs     ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ pass_tes │ script │ generic. │ None     │ None  │ None  │ This     │ /home/d │
│ t/b135b6 │        │ local.ba │          │       │       │ test     │ ocs/che │
│ d0       │        │ sh       │          │       │       │ will     │ ckouts/ │
│          │        │          │          │       │       │ always   │ readthe │
│          │        │          │          │       │       │ pass     │ docs.or │
│          │        │          │          │       │       │          │ g/user_ │
│          │        │          │          │       │       │          │ builds/ │
│          │        │          │          │       │       │          │ buildte │
│          │        │          │          │       │       │          │ st/chec │
│          │        │          │          │       │       │          │ kouts/l │
│          │        │          │          │       │       │          │ atest/t │
│          │        │          │          │       │       │          │ utorial │
│          │        │          │          │       │       │          │ s/job_d │
│          │        │          │          │       │       │          │ ependen │
│          │        │          │          │       │       │          │ cy/ex3. │
│          │        │          │          │       │       │          │ yml     │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ fail_tes │ script │ generic. │ None     │ None  │ None  │ This     │ /home/d │
│ t/25cf4d │        │ local.ba │          │       │       │ test     │ ocs/che │
│ 99       │        │ sh       │          │       │       │ will run │ ckouts/ │
│          │        │          │          │       │       │ if test  │ readthe │
│          │        │          │          │       │       │ 'pass_te │ docs.or │
│          │        │          │          │       │       │ st' is   │ g/user_ │
│          │        │          │          │       │       │ in state │ builds/ │
│          │        │          │          │       │       │ 'PASS'   │ buildte │
│          │        │          │          │       │       │          │ st/chec │
│          │        │          │          │       │       │          │ kouts/l │
│          │        │          │          │       │       │          │ atest/t │
│          │        │          │          │       │       │          │ utorial │
│          │        │          │          │       │       │          │ s/job_d │
│          │        │          │          │       │       │          │ ependen │
│          │        │          │          │       │       │          │ cy/ex3. │
│          │        │          │          │       │       │          │ yml     │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ pass_and │ script │ generic. │ None     │ None  │ None  │ This     │ /home/d │
│ _fail_te │        │ local.ba │          │       │       │ test     │ ocs/che │
│ st/893e4 │        │ sh       │          │       │       │ will run │ ckouts/ │
│ 9ea      │        │          │          │       │       │ if       │ readthe │
│          │        │          │          │       │       │ pass_tes │ docs.or │
│          │        │          │          │       │       │ t is     │ g/user_ │
│          │        │          │          │       │       │ 'PASS'   │ builds/ │
│          │        │          │          │       │       │ and      │ buildte │
│          │        │          │          │       │       │ fail_tes │ st/chec │
│          │        │          │          │       │       │ t is     │ kouts/l │
│          │        │          │          │       │       │ 'FAIL'   │ atest/t │
│          │        │          │          │       │       │          │ utorial │
│          │        │          │          │       │       │          │ s/job_d │
│          │        │          │          │       │       │          │ ependen │
│          │        │          │          │       │       │          │ cy/ex3. │
│          │        │          │          │       │       │          │ yml     │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ final_te │ script │ generic. │ None     │ None  │ None  │ Test     │ /home/d │
│ st/8e131 │        │ local.ba │          │       │       │ will run │ ocs/che │
│ fca      │        │ sh       │          │       │       │ after    │ ckouts/ │
│          │        │          │          │       │       │ 'pass_te │ readthe │
│          │        │          │          │       │       │ st',     │ docs.or │
│          │        │          │          │       │       │ 'fail_te │ g/user_ │
│          │        │          │          │       │       │ st', and │ builds/ │
│          │        │          │          │       │       │ 'pass_an │ buildte │
│          │        │          │          │       │       │ d_fail_t │ st/chec │
│          │        │          │          │       │       │ est'     │ kouts/l │
│          │        │          │          │       │       │          │ atest/t │
│          │        │          │          │       │       │          │ utorial │
│          │        │          │          │       │       │          │ s/job_d │
│          │        │          │          │       │       │          │ ependen │
│          │        │          │          │       │       │          │ cy/ex3. │
│          │        │          │          │       │       │          │ yml     │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
pass_test/b135b6d0: Creating Test Directory: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/pass_test/b135b6d0
fail_test/25cf4d99: Creating Test Directory: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/fail_test/25cf4d99
pass_and_fail_test/893e49ea: Creating Test Directory: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/pass_and_fail_test/893e49ea
final_test/8e131fca: Creating Test Directory: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/final_test/8e131fca
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
pass_test/b135b6d0 does not have any dependencies adding test to queue
pass_and_fail_test/893e49ea Skipping job because it has job dependency on pass_test/b135b6d0
final_test/8e131fca Skipping job because it has job dependency on pass_test/b135b6d0 which is in state PENDING
fail_test/25cf4d99 Skipping job because it has job dependency on pass_test/b135b6d0
Builders Eligible to Run
┏━━━━━━━━━━━━━━━━━━━━┓
┃ Builder            ┃
┡━━━━━━━━━━━━━━━━━━━━┩
│ pass_test/b135b6d0 │
└────────────────────┘
pass_test/b135b6d0: Current Working Directory : /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/pass_test/b135b6d0/stage
pass_test/b135b6d0: Running Test via command: bash pass_test_build.sh
──────────────────── Output Message for pass_test/b135b6d0 ─────────────────────
This test will pass

pass_test/b135b6d0: Test completed in 2.009215 seconds with returncode: 0
pass_test/b135b6d0: Writing output file -  /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/pass_test/b135b6d0/pass_test.out
pass_test/b135b6d0: Writing error file - /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/pass_test/b135b6d0/pass_test.err
pass_test/b135b6d0: Running Post Run Script: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/pass_test/b135b6d0/stage/pass_test_postrun.sh
pass_test/b135b6d0: Post run script exit code: 1
────────────────── pass_test/b135b6d0: Post Run Script Output ──────────────────

────────────────── pass_test/b135b6d0: Post Run Script Error ───────────────────
/tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/pass_test/b135b6d0/stage/pass_test_postrun.sh not found.
───────────────────────────────── Iteration 2 ──────────────────────────────────
final_test/8e131fca Skipping job because it has job dependency on fail_test/25cf4d99 which is in state PENDING
pass_and_fail_test/893e49ea Skipping job because it has job dependency on fail_test/25cf4d99
Builders Eligible to Run
┏━━━━━━━━━━━━━━━━━━━━┓
┃ Builder            ┃
┡━━━━━━━━━━━━━━━━━━━━┩
│ fail_test/25cf4d99 │
└────────────────────┘
fail_test/25cf4d99: Current Working Directory : /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/fail_test/25cf4d99/stage
fail_test/25cf4d99: Running Test via command: bash fail_test_build.sh
──────────────────── Output Message for fail_test/25cf4d99 ─────────────────────
This test will fail

fail_test/25cf4d99: Test completed in 2.009431 seconds with returncode: 0
fail_test/25cf4d99: Writing output file -  /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/fail_test/25cf4d99/fail_test.out
fail_test/25cf4d99: Writing error file - /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/fail_test/25cf4d99/fail_test.err
fail_test/25cf4d99: Running Post Run Script: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/fail_test/25cf4d99/stage/fail_test_postrun.sh
fail_test/25cf4d99: Post run script exit code: 1
────────────────── fail_test/25cf4d99: Post Run Script Output ──────────────────

────────────────── fail_test/25cf4d99: Post Run Script Error ───────────────────
/tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/fail_test/25cf4d99/stage/fail_test_postrun.sh not found.
───────────────────────────────── Iteration 3 ──────────────────────────────────
final_test/8e131fca Skipping job because it has job dependency on pass_and_fail_test/893e49ea
   Builders Eligible to Run    
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Builder                     ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ pass_and_fail_test/893e49ea │
└─────────────────────────────┘
pass_and_fail_test/893e49ea: Current Working Directory : /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/pass_and_fail_test/893e49ea/stage
pass_and_fail_test/893e49ea: Running Test via command: bash pass_and_fail_test_build.sh
──────────────── Output Message for pass_and_fail_test/893e49ea ────────────────

pass_and_fail_test/893e49ea: failed to submit job with returncode: 1
──────────────── Error Message for pass_and_fail_test/893e49ea ─────────────────

pass_and_fail_test/893e49ea: Detected failure in running test, will attempt to retry test: 1 times
pass_and_fail_test/893e49ea: Run - 1/1
pass_and_fail_test/893e49ea: Running Test via command: bash pass_and_fail_test_build.sh
pass_and_fail_test/893e49ea: failed to submit job with returncode: 1
pass_and_fail_test/893e49ea: Test completed in 4.020253 seconds with returncode: 1
pass_and_fail_test/893e49ea: Writing output file -  /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/pass_and_fail_test/893e49ea/pass_and_fail_test.out
pass_and_fail_test/893e49ea: Writing error file - /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/pass_and_fail_test/893e49ea/pass_and_fail_test.err
pass_and_fail_test/893e49ea: Checking returncode - 1 is matched in list [1]
pass_and_fail_test/893e49ea: Running Post Run Script: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/pass_and_fail_test/893e49ea/stage/pass_and_fail_test_postrun.sh
pass_and_fail_test/893e49ea: Post run script exit code: 1
───────────── pass_and_fail_test/893e49ea: Post Run Script Output ──────────────

────────────── pass_and_fail_test/893e49ea: Post Run Script Error ──────────────
/tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/pass_and_fail_test/893e49ea/stage/pass_and_fail_test_postrun.sh not found.
───────────────────────────────── Iteration 4 ──────────────────────────────────
Builders Eligible to Run
┏━━━━━━━━━━━━━━━━━━━━━┓
┃ Builder             ┃
┡━━━━━━━━━━━━━━━━━━━━━┩
│ final_test/8e131fca │
└─────────────────────┘
final_test/8e131fca: Current Working Directory : /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/final_test/8e131fca/stage
final_test/8e131fca: Running Test via command: bash final_test_build.sh
──────────────────── Output Message for final_test/8e131fca ────────────────────
Hello world

final_test/8e131fca: Test completed in 2.009768 seconds with returncode: 0
final_test/8e131fca: Writing output file -  /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/final_test/8e131fca/final_test.out
final_test/8e131fca: Writing error file - /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/final_test/8e131fca/final_test.err
final_test/8e131fca: Running Post Run Script: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/final_test/8e131fca/stage/final_test_postrun.sh
final_test/8e131fca: Post run script exit code: 1
───────────────── final_test/8e131fca: Post Run Script Output ──────────────────

────────────────── final_test/8e131fca: Post Run Script Error ──────────────────
/tmp/tmp75qnqx26/var/tests/generic.local.bash/ex3/final_test/8e131fca/stage/final_test_postrun.sh not found.
                                  Test Summary                                  
┏━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━┓
┃ builder                 ┃ executor           ┃ status ┃ returncode ┃ runtime ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━┩
│ pass_test/b135b6d0      │ generic.local.bash │ PASS   │ 0          │ 2.009   │
├─────────────────────────┼────────────────────┼────────┼────────────┼─────────┤
│ fail_test/25cf4d99      │ generic.local.bash │ FAIL   │ 0          │ 2.009   │
├─────────────────────────┼────────────────────┼────────┼────────────┼─────────┤
│ pass_and_fail_test/893e │ generic.local.bash │ PASS   │ 1          │ 4.020   │
│ 49ea                    │                    │        │            │         │
├─────────────────────────┼────────────────────┼────────┼────────────┼─────────┤
│ final_test/8e131fca     │ generic.local.bash │ PASS   │ 0          │ 2.010   │
└─────────────────────────┴────────────────────┴────────┴────────────┴─────────┘



Passed Tests: 3/4 Percentage: 75.000%
Failed Tests: 1/4 Percentage: 25.000%


Adding 4 test results to report file: /tmp/tmp75qnqx26/var/report.json
Writing Logfile to /tmp/tmp75qnqx26/var/logs/buildtest_ro7sjd_h.log

In this next example, we have three tests the first test will runtime_test will sleep for 5 seconds but it will fail due to runtime requirement of 2sec. The next two tests runtime_test_pass and runtime_test_fail both depend on runtime_test however due to condition only one of them can be run because runtime_test_pass expects runtime_test to have state: PASS while runtime_test_fail expects runtime_test to have state: FAIL. This type of workflow can be used if you want to run a set of test based on one condition while running a different set of test based on the negative condition.

buildspecs:
  runtime_test:
    type: script
    executor: generic.local.bash
    description: This test will sleep 5 second but will fail due to runtime 2sec
    status:
      runtime:
        min: 2.0
    run: sleep 5

  runtime_test_pass:
    type: script
    executor: generic.local.bash
    description: This test will run when runtime_test_pass is PASS
    needs:
      - runtime_test:
          state: PASS
    run: echo "Performing some action when test PASS"

  runtime_test_fail:
    type: script
    executor: generic.local.bash
    description: This test will run when runtime_test_pass is FAIL
    needs:
      - runtime_test:
          state: FAIL
    run: echo "Performing some action when test FAIL"

Let’s build this test and take note that we only run two tests and runtime_test_fail was skipped because test runtime_test has a state: PASS.

buildtest build -b tutorials/job_dependency/ex4.yml
$ buildtest build -b tutorials/job_dependency/ex4.yml
╭───────────────────────────── buildtest summary ──────────────────────────────╮
│                                                                              │
│ User:               docs                                                     │
│ Hostname:           build-24413851-project-280831-buildtest                  │
│ Platform:           Linux                                                    │
│ Current Time:       2024/05/17 18:01:47                                      │
│ buildtest path:     /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ buildtest version:  2.0                                                      │
│ python path:        /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│ python version:     3.9.18                                                   │
│ Configuration File: /tmp/tmp75qnqx26/config.yml                              │
│ Test Directory:     /tmp/tmp75qnqx26/var/tests                               │
│ Report File:        /tmp/tmp75qnqx26/var/report.json                         │
│ Command:            /home/docs/checkouts/readthedocs.org/user_builds/buildte │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯
───────────────────────────  Discovering Buildspecs ────────────────────────────
                             Discovered buildspecs                              
╔══════════════════════════════════════════════════════════════════════════════╗
║ buildspec                                                                    ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ /home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/latest/ ║
║ tutorials/job_dependency/ex4.yml                                             ║
╟──────────────────────────────────────────────────────────────────────────────╢
║ Total: 1                                                                     ║
╚══════════════════════════════════════════════════════════════════════════════╝


Total Discovered Buildspecs:  1
Total Excluded Buildspecs:  0
Detected Buildspecs after exclusion:  1
────────────────────────────── Parsing Buildspecs ──────────────────────────────
Valid Buildspecs: 1
Invalid Buildspecs: 0
/home/docs/checkouts/readthedocs.org/user_builds/buildtest/checkouts/latest/tutorials/job_dependency/ex4.yml: VALID
Total builder objects created: 3
                            Builders by type=script                             
┏━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━┳━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━┓
┃          ┃        ┃          ┃          ┃       ┃       ┃ descript ┃ buildsp ┃
┃ builder  ┃ type   ┃ executor ┃ compiler ┃ nodes ┃ procs ┃ ion      ┃ ecs     ┃
┡━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━╇━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━┩
│ runtime_ │ script │ generic. │ None     │ None  │ None  │ This     │ /home/d │
│ test/98f │        │ local.ba │          │       │       │ test     │ ocs/che │
│ c2e3b    │        │ sh       │          │       │       │ will     │ ckouts/ │
│          │        │          │          │       │       │ sleep 5  │ readthe │
│          │        │          │          │       │       │ second   │ docs.or │
│          │        │          │          │       │       │ but will │ g/user_ │
│          │        │          │          │       │       │ fail due │ builds/ │
│          │        │          │          │       │       │ to       │ buildte │
│          │        │          │          │       │       │ runtime  │ st/chec │
│          │        │          │          │       │       │ 2sec     │ kouts/l │
│          │        │          │          │       │       │          │ atest/t │
│          │        │          │          │       │       │          │ utorial │
│          │        │          │          │       │       │          │ s/job_d │
│          │        │          │          │       │       │          │ ependen │
│          │        │          │          │       │       │          │ cy/ex4. │
│          │        │          │          │       │       │          │ yml     │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ runtime_ │ script │ generic. │ None     │ None  │ None  │ This     │ /home/d │
│ test_pas │        │ local.ba │          │       │       │ test     │ ocs/che │
│ s/69f7e8 │        │ sh       │          │       │       │ will run │ ckouts/ │
│ 3a       │        │          │          │       │       │ when     │ readthe │
│          │        │          │          │       │       │ runtime_ │ docs.or │
│          │        │          │          │       │       │ test_pas │ g/user_ │
│          │        │          │          │       │       │ s is     │ builds/ │
│          │        │          │          │       │       │ PASS     │ buildte │
│          │        │          │          │       │       │          │ st/chec │
│          │        │          │          │       │       │          │ kouts/l │
│          │        │          │          │       │       │          │ atest/t │
│          │        │          │          │       │       │          │ utorial │
│          │        │          │          │       │       │          │ s/job_d │
│          │        │          │          │       │       │          │ ependen │
│          │        │          │          │       │       │          │ cy/ex4. │
│          │        │          │          │       │       │          │ yml     │
├──────────┼────────┼──────────┼──────────┼───────┼───────┼──────────┼─────────┤
│ runtime_ │ script │ generic. │ None     │ None  │ None  │ This     │ /home/d │
│ test_fai │        │ local.ba │          │       │       │ test     │ ocs/che │
│ l/21b44f │        │ sh       │          │       │       │ will run │ ckouts/ │
│ 08       │        │          │          │       │       │ when     │ readthe │
│          │        │          │          │       │       │ runtime_ │ docs.or │
│          │        │          │          │       │       │ test_pas │ g/user_ │
│          │        │          │          │       │       │ s is     │ builds/ │
│          │        │          │          │       │       │ FAIL     │ buildte │
│          │        │          │          │       │       │          │ st/chec │
│          │        │          │          │       │       │          │ kouts/l │
│          │        │          │          │       │       │          │ atest/t │
│          │        │          │          │       │       │          │ utorial │
│          │        │          │          │       │       │          │ s/job_d │
│          │        │          │          │       │       │          │ ependen │
│          │        │          │          │       │       │          │ cy/ex4. │
│          │        │          │          │       │       │          │ yml     │
└──────────┴────────┴──────────┴──────────┴───────┴───────┴──────────┴─────────┘
──────────────────────────────── Building Test ─────────────────────────────────
runtime_test/98fc2e3b: Creating Test Directory: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex4/runtime_test/98fc2e3b
runtime_test_pass/69f7e83a: Creating Test Directory: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex4/runtime_test_pass/69f7e83a
runtime_test_fail/21b44f08: Creating Test Directory: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex4/runtime_test_fail/21b44f08
──────────────────────────────── Running Tests ─────────────────────────────────
Spawning 1 processes for processing builders
───────────────────────────────── Iteration 1 ──────────────────────────────────
runtime_test_pass/69f7e83a Skipping job because it has job dependency on runtime_test/98fc2e3b
runtime_test/98fc2e3b does not have any dependencies adding test to queue
runtime_test_fail/21b44f08 Skipping job because it has job dependency on runtime_test/98fc2e3b
Builders Eligible to Run 
┏━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Builder               ┃
┡━━━━━━━━━━━━━━━━━━━━━━━┩
│ runtime_test/98fc2e3b │
└───────────────────────┘
runtime_test/98fc2e3b: Current Working Directory : /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex4/runtime_test/98fc2e3b/stage
runtime_test/98fc2e3b: Running Test via command: bash runtime_test_build.sh
─────────────────── Output Message for runtime_test/98fc2e3b ───────────────────

runtime_test/98fc2e3b: Test completed in 5.008778 seconds with returncode: 0
runtime_test/98fc2e3b: Writing output file -  /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex4/runtime_test/98fc2e3b/runtime_test.out
runtime_test/98fc2e3b: Writing error file - /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex4/runtime_test/98fc2e3b/runtime_test.err
runtime_test/98fc2e3b: Checking  mintime < runtime: 2.0 < 5.008778
runtime_test/98fc2e3b: Running Post Run Script: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex4/runtime_test/98fc2e3b/stage/runtime_test_postrun.sh
runtime_test/98fc2e3b: Post run script exit code: 1
──────────────── runtime_test/98fc2e3b: Post Run Script Output ─────────────────

───────────────── runtime_test/98fc2e3b: Post Run Script Error ─────────────────
/tmp/tmp75qnqx26/var/tests/generic.local.bash/ex4/runtime_test/98fc2e3b/stage/runtime_test_postrun.sh not found.
───────────────────────────────── Iteration 2 ──────────────────────────────────
runtime_test_fail/21b44f08 is cancelled because it depends on runtime_test/98fc2e3b to have state: FAIL but actual value is PASS
   Builders Eligible to Run   
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ Builder                    ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ runtime_test_pass/69f7e83a │
└────────────────────────────┘
runtime_test_pass/69f7e83a: Current Working Directory : /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex4/runtime_test_pass/69f7e83a/stage
runtime_test_pass/69f7e83a: Running Test via command: bash runtime_test_pass_build.sh
──────────────── Output Message for runtime_test_pass/69f7e83a ─────────────────
Performing some action when test PASS

runtime_test_pass/69f7e83a: Test completed in 0.007558 seconds with returncode: 0
runtime_test_pass/69f7e83a: Writing output file -  /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex4/runtime_test_pass/69f7e83a/runtime_test_pass.out
runtime_test_pass/69f7e83a: Writing error file - /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex4/runtime_test_pass/69f7e83a/runtime_test_pass.err
runtime_test_pass/69f7e83a: Running Post Run Script: /tmp/tmp75qnqx26/var/tests/generic.local.bash/ex4/runtime_test_pass/69f7e83a/stage/runtime_test_pass_postrun.sh
runtime_test_pass/69f7e83a: Post run script exit code: 1
────────────── runtime_test_pass/69f7e83a: Post Run Script Output ──────────────

────────────── runtime_test_pass/69f7e83a: Post Run Script Error ───────────────
/tmp/tmp75qnqx26/var/tests/generic.local.bash/ex4/runtime_test_pass/69f7e83a/stage/runtime_test_pass_postrun.sh not found.
                                  Test Summary                                  
┏━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━┓
┃ builder                 ┃ executor           ┃ status ┃ returncode ┃ runtime ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━┩
│ runtime_test_pass/69f7e │ generic.local.bash │ PASS   │ 0          │ 0.008   │
│ 83a                     │                    │        │            │         │
├─────────────────────────┼────────────────────┼────────┼────────────┼─────────┤
│ runtime_test/98fc2e3b   │ generic.local.bash │ PASS   │ 0          │ 5.009   │
└─────────────────────────┴────────────────────┴────────┴────────────┴─────────┘



Passed Tests: 2/2 Percentage: 100.000%
Failed Tests: 0/2 Percentage: 0.000%


Adding 2 test results to report file: /tmp/tmp75qnqx26/var/report.json
Writing Logfile to /tmp/tmp75qnqx26/var/logs/buildtest_dyk5t5om.log