Merge remote-tracking branch 'upstream/master'

Author: eddiewebb

.circleci/config.yml

@@ -1,9 +1,15 @@
 version: 2
-debug: true
 
 resource_job_defaults: &resource_job_defaults
-  docker: [{image: 'circleci/ruby:2.4.1'}]
-  steps: [{run: 'echo $CIRCLE_JOB'}]
+  docker:  [{image: 'circleci/ruby:2.4.1'}]
+  steps:
+    - run:
+        name: verify that job ran with the requested resource_class option
+        command: |
+          curl -k \
+          "$CIRCLE_HOSTNAME/api/v1.1/project/github/$CIRCLE_PROJECT_USERNAME/$CIRCLE_PROJECT_REPONAME/$CIRCLE_BUILD_NUM?\
+          circle-token=$CIRCLE_TOKEN" | \
+          jq '.picard.resource_class.class' | grep $CIRCLE_JOB
 
 remote_docker_defaults: &remote_docker_defaults
   docker: [{image: 'docker:17.06-git'}]
@@ -35,7 +41,7 @@ jobs:
     <<: *resource_job_defaults
     resource_class: medium
 
-  medium-plus: # 3 vCPUs, 6GB RAM
+  medium+: # 3 vCPUs, 6GB RAM
     <<: *resource_job_defaults
     resource_class: medium+
 
@@ -128,6 +134,35 @@ jobs:
             exit 0
           fi
 
+  save_and_restore_cache:
+    docker:
+      - image: circleci/python
+    working_directory: ~/realitycheck
+    steps:
+      - checkout
+
+      - run: mkdir -p stuff
+      - run: echo 5 >./stuff/thing
+
+      - save_cache:
+          key: v3-file-cache-{{ .BuildNum }}
+          paths:
+            - ./stuff/thing
+
+      - run: rm -rf ./stuff/thing
+      - run: sleep 5
+
+      - restore_cache:
+            keys:
+              - v3-file-cache-{{ .BuildNum }}
+
+      - run: |
+            if [[ $(< stuff/thing) != '5' ]]; then
+              exit 1
+            else
+              echo "The cache was populated"
+            fi
+
   artifacts_test_results:
     docker:
       - image: python:3.6.0
@@ -158,7 +193,7 @@ workflows:
     jobs:
       - small
       - medium
-      - medium-plus
+      - medium+
       - large
       - xlarge
 
@@ -171,6 +206,7 @@ workflows:
 
   feature_jobs:
     jobs:
+      - save_and_restore_cache
       - contexts:
           context: org-global
       - multi-contexts:

.gitignore

@@ -0,0 +1 @@
+.DS_Store

README.md

@@ -1,14 +1,37 @@
- # realitycheck
-A sample app that reality-checks some basic features on your installation of CircleCI:
-1. Runs jobs using all known `resource_class` options (*NOTE:* your build instances must be large enough to accomodate these options—see our [Configuration Reference](https://circleci.com/docs/2.0/configuration-reference/#resource_class) for details)
-2. Runs [machine executor](https://circleci.com/docs/2.0/executor-types/#using-machine) & [remote Docker](https://circleci.com/docs/2.0/building-docker-images) jobs, both with and without [Docker Layer Caching](https://circleci.com/docs/2.0/docker-layer-caching)
-3. Tests writing to and reading from [workspaces](https://circleci.com/docs/2.0/workflows/#using-workspaces-to-share-data-among-jobs)
-4. Tests the default `org-global` [context](https://circleci.com/docs/2.0/contexts) (*NOTE:* needs a key called `CONTEXT_END_TO_END_TEST_VAR` to exist in the `org-global` context), along with one additional context (likewise needs a key called `MULTI_CONTEXT_END_TO_END_VAR` to exist in an `individual-local` context)
-5. Tests upload/storage of [artifacts](https://circleci.com/docs/2.0/artifacts) and [test results](https://circleci.com/docs/2.0/collect-test-data)
+# realitycheck
 
-To run realitycheck, fork the repository and start building it on your installation of CircleCI.
+A sample app that validates some basic CircleCI features in three parallel workflows.
 
-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>
+To run realitycheck, fork the repository and start building it on your installation of CircleCI. See [Using realitycheck to validate your CircleCI installation](https://support.circleci.com/hc/en-us/articles/360011235534), in the CircleCI Support Center, for details on forking the project and building it on your CircleCI installation.
+
+Descriptions of the three workflows follow.
+
+### `resource_class` workflow
+
+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](https://circleci.com/docs/2.0/configuration-reference/#resource_class) 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
+
+
+### VM service workflow
+
+Tests the functionality  of the [`machine` executor](https://circleci.com/docs/2.0/executor-types/#using-machine), [Remote Docker Environment](https://circleci.com/docs/2.0/building-docker-images), and [Docker Layer Caching](https://circleci.com/docs/2.0/docker-layer-caching).
+
+
+### Features workflow
+
+- Tests ability to save and restore [caches](circleci.com/docs/2.0/caching)
+- Tests writing to and reading from [workspaces](https://circleci.com/docs/2.0/workflows/#using-workspaces-to-share-data-among-jobs)
+- Tests the default `org-global` [context](https://circleci.com/docs/2.0/contexts) (*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](https://circleci.com/docs/2.0/artifacts) and [test results](https://circleci.com/docs/2.0/collect-test-data)
+
+
+## Contributing
+
+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>.