Special Files

As part of the execution of the toolbox commands, some special files will be generated in the $ARTIFACT_DIR directory. They will be recognized by the code in ci-dashboard repository and interpreted to enhance the dashboard display:

• $ARTIFACT_DIR/<toolbox directory>/_ansible.log.json: JSON array of the ansible tasks executed as part of the toolbox command. In particular, in this file, we parse the stats information of the last entry:

{
  "log_level": "info",
  "scope": "playbook",
  "stats": {
      "localhost": {
          "changed": 4,
          "failures": 0,
          "ignored": 0,
          "ok": 5,
          "rescued": 0,
          "skipped": 2,
          "unreachable": 0
      }
  },
  "status": "finished"
}

• $ARTIFACT_DIR/FAILURE: the presence this file after the CI execution indicates that the testing failed.

• $ARTIFACT_DIR/<toolbox step>/FLAKE: the presence of this file after a toolbox command fail indicates that a known flake occurred. The file contains a brief description of the problem(s) that happened, each on a dedicated line.

• $ARTIFACT_DIR/<toolbox step>/EXPECTED_FAIL: the presence of this file after a test run indicates that this toolbox box step failure was expected (i.e., not a failure, only a condition test). The file contains a brief description of what was being tested.

• $ARTIFACT_DIR/FLAKE: the presence of this file after a test run indicates that a known flake occurred. The file contains a brief description of the problem that happened.

• $ARTIFACT_DIR/_WARNINGS: the presence of this directory after a test run indicates that some warnings were raised. The files contain a brief description of the problem that happened.