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 from the CircleCI Support Center for details on forking the project and building it on your CircleCI installation.

realitycheck is split into three workflows that each consist of a series of jobs that test resource class, VM service (only available on AWS installs), and features (e.g. caching, artifacts, contexts) functionality. More details below.

You may experience failed builds around environment variables and contexts after running building this project on CircleCI for the first time. In order to properly test functionality, please set the following environment variables and contexts from within the CircleCI using the instructions below.

Set environment variables at http(s)://{$CIRCLECI_URI}/gh/{$USER_NAME}/realitycheck/edit#env-vars.

• 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 endpoint) must be stored as a CIRCLE_TOKEN project environment variable

Set contexts at http(s)://{$CIRCLECI_URI}/gh/organizations/{$org|username}/settings#contexts

• Add a key called MULTI_CONTEXT_END_TO_END_VAR with any value to exist in a context called individual-local
• Add a key called CONTEXT_END_TO_END_TEST_VAR with any value to exist in a context called org-global

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

Your Nomad clients must be large enough to accommodate these options—see our Configuration Reference for more details.

Tests the functionality of the machine executor, Remote Docker Environment, and Docker Layer Caching. These features are only supported in an AWS install using enterprise-setup today.

• 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.

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.