A sample app that validates some basic CircleCI features in three parallel workflows.

To run realitycheck, fork the repository and start building it on your installation of CircleCI. See Using realitycheck to validate your CircleCI installation, in the CircleCI Support Center, for details on forking the project and building it on your CircleCI installation.

Descriptions of the three workflows follow.

Tests all known resource_class options—queries the CircleCI API to verify that jobs ran with the requested resources.

• Your instances must be large enough to accommodate these options—see our Configuration Reference for details
• The base URL of your CircleCI installation (e.g. https://circleci.com) must be specified via a CIRCLE_HOSTNAME project environment variable
• A personal API token (see CIRCLE_HOSTNAME/account/api URL endpoint) must be stored as a CIRCLE_TOKEN project environment variable

Tests the functionality of the machine executor, Remote Docker Environment, and Docker Layer Caching.

• Tests ability to save and restore caches
• Tests writing to and reading from workspaces
• Tests the default org-global context (NOTE: needs a key called CONTEXT_END_TO_END_TEST_VAR to exist in a context called org-global)
• Tests multiple contexts (NOTE: needs a key called MULTI_CONTEXT_END_TO_END_VAR to exist in a context called individual-local)
• Tests upload/storage of artifacts and test results
• Tests the functionality of restarting a build with SSH enabled. For this test you pass, there must be an SSH key added to your VCS provider. After adding the SSH key, you must base64 encode the private certificate and store in variable TEST_SSH_KEY_B64 in reality check project settings. A valid circle api token for the reality check project must also be included in CIRCLE_TOKEN to restart a build with SSH and fetch the build details

If you have more ideas for things that should tested, please submit a PR against the open-source repository on GitHub where this project is maintained: https://github.com/circleci/realitycheck.

See the current CI status of the main repo at https://circleci.com/gh/circleci/workflows/realitycheck.

View the LICENSE file in this repository for licensing information.