CircleCI updates to test against multiple Elixir versions (#303)

Author: Rob Adams

.circleci/config.yml

@@ -1,16 +1,36 @@
-version: 2
+version: 2.1
+
+default_version: &default_version 1.6.6
+default_steps: &default_steps
+  - run: mix test --exclude functional
+  - store_test_results:
+      path: ~/bootleg/_build/test/lib/bootleg
 general:
   branches:
     ignore:
       - gh-pages
 defaults: &defaults
   working_directory: ~/bootleg
+cache_files: &cache_files
+  - _build
+  - deps
+  - ~/.mix
 jobs:
   build:
     <<: *defaults
-    parallelism: 1 # run only one instance of this job in parallel
-    docker: # run the steps with Docker
-      - image: circleci/elixir:1.6
+    parameters:
+      version:
+        description: Elixir version
+        type: string
+        default: *default_version
+      execute:
+        description: What steps to execute after build
+        type: steps
+        default: *default_steps
+
+    parallelism: 1
+    docker:
+      - image: elixir:<< parameters.version >>
         environment: # environment variables for primary container
           SHELL: /bin/bash
     steps:
@@ -21,48 +41,23 @@ jobs:
 
       - restore_cache: # restores saved mix cache
           keys: # list of cache keys, in decreasing specificity
-            - mix-cache-{{ .Branch }}-{{ checksum "mix.lock" }}
-            - mix-cache-{{ .Branch }}
-            - mix-cache
-      - restore_cache: # restores saved build cache
-          keys:
-            - build-cache-{{ .Branch }}
-            - build-cache
-      - restore_cache:  # restores saved plt cache
-          keys:
-            - dialyzer-cache
+            - build-v<< parameters.version >>-{{ .Branch }}-{{ checksum "mix.lock" }}
+            - build-v<< parameters.version >>-{{ .Branch }}
+            - build-v<< parameters.version >>
 
-      - run: mix do deps.get, deps.compile # get updated dependencies & compile them
+      - run: mix do deps.get, deps.compile, compile
 
       - save_cache: # generate and store cache so `restore_cache` works
-          key: mix-cache-{{ .Branch }}-{{ checksum "mix.lock" }}
-          paths: "deps"
+          key: build-v<< parameters.version >>-{{ .Branch }}-{{ checksum "mix.lock" }}
+          paths: *cache_files
       - save_cache: # make another less specific cache
-          key: mix-cache-{{ .Branch }}
-          paths: "deps"
-      - save_cache: # and one more build cache for good measure
-          key: mix-cache
-          paths: "deps"
-
-      - run: mix compile
-
-      - save_cache: # save a *build* cache, too
-          key: build-cache-{{ .Branch }}
-          paths: "_build"
-      - save_cache: # and one more build cache for good measure
-          key: build-cache
-          paths: "_build"
-
-      - run: mix do format --check-formatted, credo --strict
-      - run: mix test --exclude functional
-      - run: mix dialyzer --halt-exit-status
+          key: build-v<< parameters.version >>-{{ .Branch }}
+          paths: *cache_files
+      - save_cache: # and one more for good measure
+          key: build-v<< parameters.version >>
+          paths: *cache_files
 
-      - save_cache:
-          key: dialyzer-cache
-          paths: "_build/test/dialyxir*.plt"
-
-      - store_test_results:
-          path: ~/bootleg/_build/test/lib/bootleg
+      - steps: << parameters.execute >>
 
   functional:
     <<: *defaults
@@ -109,10 +104,35 @@ jobs:
       - store_artifacts:
           path: cover
 workflows:
-  version: 2
-  build-and-verify:
+  version: 2.1
+  all_versions:
+    jobs:
+      - build:
+          name: "Test in Elixir 1.6.6"
+          version: 1.6.6
+      - build:
+          name: "Test in Elixir 1.8.2"
+          version: 1.8.2
+      - build:
+          name: "Test in Elixir 1.9.0"
+          version: 1.9.0
+  code_quality:
+    jobs:
+      - build:
+          name: "Code quality and style checks"
+          execute:
+            - run: mix do format --check-formatted, credo --strict
+      - build:
+          name: "Dialyzer type checks"
+          execute:
+            - restore_cache:  # restores saved plt cache
+                keys:
+                  - dialyzer
+            - run: mix dialyzer --halt-exit-status
+            - save_cache:
+                key: dialyzer
+                paths: "_build/test/dialyxir*.plt"
+  validate_functional:
     jobs:
-      - build
       - functional:
-          requires:
-            - build
+          name: "Functional tests"

mix.exs

@@ -43,10 +43,10 @@ defmodule Bootleg.Mixfile do
       {:sshkit, "0.1.0"},
       {:ssh_client_key_api, "~> 0.2.1"},
       {:credo, "~> 0.10", only: [:dev, :test]},
-      {:dialyxir, "~> 1.0.0-rc.3", only: [:dev], runtime: false},
+      {:dialyxir, "~> 1.0.0-rc.6", only: [:dev], runtime: false},
       {:ex_doc, "~> 0.18", only: [:docs], runtime: false},
       {:excoveralls, "~> 0.10", only: [:test]},
-      {:mock, "~> 0.3.0", only: [:test]},
+      {:mock, "~> 0.3.3", only: [:test]},
       {:junit_formatter, "~> 2.0", only: [:test]},
       {:temp, "~> 0.4.3", only: [:test]}
     ]

mix.lock

@@ -2,8 +2,9 @@
   "bunt": {:hex, :bunt, "0.2.0", "951c6e801e8b1d2cbe58ebbd3e616a869061ddadcc4863d0a2182541acae9a38", [:mix], [], "hexpm"},
   "certifi": {:hex, :certifi, "2.4.2", "75424ff0f3baaccfd34b1214184b6ef616d89e420b258bb0a5ea7d7bc628f7f0", [:rebar3], [{:parse_trans, "~>3.3", [hex: :parse_trans, repo: "hexpm", optional: false]}], "hexpm"},
   "credo": {:hex, :credo, "0.10.2", "03ad3a1eff79a16664ed42fc2975b5e5d0ce243d69318060c626c34720a49512", [:mix], [{:bunt, "~> 0.2.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm"},
-  "dialyxir": {:hex, :dialyxir, "1.0.0-rc.3", "774306f84973fc3f1e2e8743eeaa5f5d29b117f3916e5de74c075c02f1b8ef55", [:mix], [], "hexpm"},
+  "dialyxir": {:hex, :dialyxir, "1.0.0-rc.6", "78e97d9c0ff1b5521dd68041193891aebebce52fc3b93463c0a6806874557d7d", [:mix], [{:erlex, "~> 0.2.1", [hex: :erlex, repo: "hexpm", optional: false]}], "hexpm"},
   "earmark": {:hex, :earmark, "1.2.6", "b6da42b3831458d3ecc57314dff3051b080b9b2be88c2e5aa41cd642a5b044ed", [:mix], [], "hexpm"},
+  "erlex": {:hex, :erlex, "0.2.3", "102b4f90156f59fd323be9864f7613b3f40e55d73a4cc69bcbd5cb259e0ec2bf", [:mix], [], "hexpm"},
   "ex_doc": {:hex, :ex_doc, "0.18.4", "4406b8891cecf1352f49975c6d554e62e4341ceb41b9338949077b0d4a97b949", [:mix], [{:earmark, "~> 1.1", [hex: :earmark, repo: "hexpm", optional: false]}], "hexpm"},
   "excoveralls": {:hex, :excoveralls, "0.10.0", "a4508bdd408829f38e7b2519f234b7fd5c83846099cda348efcb5291b081200c", [:mix], [{:hackney, "~> 1.13", [hex: :hackney, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm"},
   "exjsx": {:hex, :exjsx, "4.0.0", "60548841e0212df401e38e63c0078ec57b33e7ea49b032c796ccad8cde794b5c", [:mix], [{:jsx, "~> 2.8.0", [hex: :jsx, repo: "hexpm", optional: false]}], "hexpm"},
@@ -14,10 +15,10 @@
   "junit_formatter": {:hex, :junit_formatter, "2.2.0", "da6093f0740c58a824f9585ebb7cb1b960efaecf48d1fa969e95d9c47c6b19dd", [:mix], [], "hexpm"},
   "makeup": {:hex, :makeup, "0.5.5", "9e08dfc45280c5684d771ad58159f718a7b5788596099bdfb0284597d368a882", [:mix], [{:nimble_parsec, "~> 0.4", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm"},
   "makeup_elixir": {:hex, :makeup_elixir, "0.10.0", "0f09c2ddf352887a956d84f8f7e702111122ca32fbbc84c2f0569b8b65cbf7fa", [:mix], [{:makeup, "~> 0.5.5", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm"},
-  "meck": {:hex, :meck, "0.8.12", "1f7b1a9f5d12c511848fec26bbefd09a21e1432eadb8982d9a8aceb9891a3cf2", [:rebar3], [], "hexpm"},
+  "meck": {:hex, :meck, "0.8.13", "ffedb39f99b0b99703b8601c6f17c7f76313ee12de6b646e671e3188401f7866", [:rebar3], [], "hexpm"},
   "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], [], "hexpm"},
   "mimerl": {:hex, :mimerl, "1.0.2", "993f9b0e084083405ed8252b99460c4f0563e41729ab42d9074fd5e52439be88", [:rebar3], [], "hexpm"},
-  "mock": {:hex, :mock, "0.3.2", "e98e998fd76c191c7e1a9557c8617912c53df3d4a6132f561eb762b699ef59fa", [:mix], [{:meck, "~> 0.8.8", [hex: :meck, repo: "hexpm", optional: false]}], "hexpm"},
+  "mock": {:hex, :mock, "0.3.3", "42a433794b1291a9cf1525c6d26b38e039e0d3a360732b5e467bfc77ef26c914", [:mix], [{:meck, "~> 0.8.13", [hex: :meck, repo: "hexpm", optional: false]}], "hexpm"},
   "nimble_parsec": {:hex, :nimble_parsec, "0.4.0", "ee261bb53214943679422be70f1658fff573c5d0b0a1ecd0f18738944f818efe", [:mix], [], "hexpm"},
   "parse_trans": {:hex, :parse_trans, "3.3.0", "09765507a3c7590a784615cfd421d101aec25098d50b89d7aa1d66646bc571c1", [:rebar3], [], "hexpm"},
   "poison": {:hex, :poison, "4.0.1", "bcb755a16fac91cad79bfe9fc3585bb07b9331e50cfe3420a24bcc2d735709ae", [:mix], [], "hexpm"},