Add CircleCI workflow; update coveralls, dialyxir (#261)

Author: rjanja

.circleci/config.yml

@@ -3,45 +3,116 @@ general:
   branches:
     ignore:
       - gh-pages
+defaults: &defaults
+  working_directory: ~/bootleg
 jobs:
   build:
-    machine: true
-    working_directory: ~/bootleg
+    <<: *defaults
+    parallelism: 1 # run only one instance of this job in parallel
+    docker: # run the steps with Docker
+      - image: circleci/elixir:1.6
+        environment: # environment variables for primary container
+          SHELL: /bin/bash
     steps:
       - checkout
-      - run: echo 'export INSTALL_PATH="$HOME/dependencies";export PATH="$INSTALL_PATH/bin:$PATH";export MIX_ENV=test;export VERSION_CIRCLECI=2' >> $BASH_ENV
+
+      - run: mix local.hex --force
+      - run: mix local.rebar --force
+
+      - 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
+
+      - run: mix do deps.get, deps.compile # get updated dependencies & compile them
+
+      - save_cache: # generate and store cache so `restore_cache` works
+          key: mix-cache-{{ .Branch }}-{{ checksum "mix.lock" }}
+          paths: "deps"
+      - 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
+
+      - save_cache:
+          key: dialyzer-cache
+          paths: "_build/test/dialyxir*.plt"
+
+      - store_test_results:
+          path: ~/bootleg/_build/test/lib/bootleg
+
+  functional:
+    <<: *defaults
+    machine:
+      image: circleci/classic:latest
+    steps:
+      - checkout
+      - run:
+          name: Setup Environment Variables
+          command: |
+            echo 'export INSTALL_PATH="$HOME/dependencies"' >> $BASH_ENV
+            echo 'export PATH="$INSTALL_PATH/bin:$PATH"' >> $BASH_ENV
+            echo 'export VERSION_CIRCLECI=2' >> $BASH_ENV
+            echo 'export COVERALLS_REPO_TOKEN=$COVERALLS_REPO_TOKEN' >> $BASH_ENV
+            echo 'export CI_PULL_REQUEST=$CIRCLE_PR_NUMBER' >> $BASH_ENV
       - restore_cache:
-          key: environment-cache-{{ checksum ".circleci/config.yml" }}-{{ checksum "script/ci/prepare.sh" }}-{{ arch }}
+          key: environment-cache-{{ checksum "script/ci/prepare.sh" }}-{{ arch }}
       - run:
           name: Install Elixir
           command: script/ci/prepare.sh
       - save_cache:
-          key: environment-cache-{{ checksum ".circleci/config.yml" }}-{{ checksum "script/ci/prepare.sh" }}-{{ arch }}
+          key: environment-cache-{{ checksum "script/ci/prepare.sh" }}-{{ arch }}
           paths:
             - ~/dependencies
       - restore_cache:
-          key: dependencies-cache-{{ checksum ".circleci/config.yml" }}-{{ checksum "script/ci/prepare.sh" }}-{{ checksum "mix.lock" }}-{{ arch }}
+          key: dependencies-cache-{{ checksum "script/ci/prepare.sh" }}-{{ checksum "mix.lock" }}-{{ arch }}
       - run:
           name: Preparing dependencies
           command: |
             mix local.hex --force
             mix local.rebar --force
             mix deps.get;
             mix deps.compile;
-            mix dialyzer --plt;
-          no_output_timeout: 10m
       - save_cache:
-          key: dependencies-cache-{{ checksum ".circleci/config.yml" }}-{{ checksum "script/ci/prepare.sh" }}-{{ checksum "mix.lock" }}-{{ arch }}
+          key: dependencies-cache-{{ checksum "script/ci/prepare.sh" }}-{{ checksum "mix.lock" }}-{{ arch }}
           paths:
             - ~/.mix
             - _build
             - deps
       - run: mix compile
-      - run: mix dialyzer
-      - run: mix format --check-formatted --dry-run || (mix format && git --no-pager diff && false)
-      - run: mix credo --strict
       - run: mix coveralls.html
       - store_test_results:
           path: ~/bootleg/_build/test/lib/bootleg
       - store_artifacts:
           path: cover
+workflows:
+  version: 2
+  build-and-verify:
+    jobs:
+      - build
+      - functional:
+          requires:
+            - build

coveralls.json .excoveralls/coveralls.json

@@ -4,7 +4,7 @@
   ],
   "coverage_options": {
     "treat_no_relevant_lines_as_covered": true,
-    "minimum_coverage": 40,
+    "minimum_coverage": 85,
     "output_dir": "cover"
   }
-}
+}

circle.yml

@@ -30,7 +30,7 @@ defmodule Bootleg.Tasks do
   end
 
   @doc false
-  @spec pop_env_task(binary, [binary]) :: {nil, nil} | {nil, atom} | {binary, atom}
+  @spec pop_env_task(any, [binary]) :: {nil, nil} | {nil, atom} | {binary, atom}
   defp pop_env_task(env, args) when args == [] do
     {env, nil}
   end

lib/bootleg/tasks.ex

@@ -14,7 +14,14 @@ defmodule Bootleg.Mixfile do
       start_permanent: Mix.env() == :prod,
       elixirc_paths: elixirc_paths(Mix.env()),
       test_coverage: [tool: ExCoveralls],
-      dialyzer: [plt_add_deps: :transitive, plt_add_apps: [:mix, :sshkit]],
+      preferred_cli_env: [
+        dialyzer: :dev,
+        coveralls: :test,
+        "coveralls.detail": :test,
+        "coveralls.circle": :test,
+        "coveralls.html": :test
+      ],
+      dialyzer: [plt_add_apps: [:mix, :sshkit, :ex_unit]],
       docs: docs(),
       description: description(),
       deps: deps(),
@@ -46,9 +53,9 @@ defmodule Bootleg.Mixfile do
       {:sshkit, "0.1.0"},
       {:ssh_client_key_api, "~> 0.2.1"},
       {:credo, "~> 0.10", only: [:dev, :test]},
-      {:dialyxir, "~> 0.5", only: [:dev, :test], runtime: false},
+      {:dialyxir, "~> 1.0.0-rc.3", only: [:dev], runtime: false},
       {:ex_doc, "~> 0.16", only: :dev, runtime: false},
-      {:excoveralls, "~> 0.6", only: :test},
+      {:excoveralls, "~> 0.10", only: :test},
       {:mock, "~> 0.3.0", only: :test},
       {:junit_formatter, "~> 2.0", only: :test},
       {:temp, "~> 0.4.3", only: :test}

mix.exs

@@ -2,7 +2,7 @@
   "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.1", "e85efaf2dd7054399083ab2c6a5199f6cb1805de1a5b00d9e8c5f07033407b1f", [:mix], [{:bunt, "~> 0.2.0", [hex: :bunt, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: false]}], "hexpm"},
-  "dialyxir": {:hex, :dialyxir, "0.5.1", "b331b091720fd93e878137add264bac4f644e1ddae07a70bf7062c7862c4b952", [:mix], [], "hexpm"},
+  "dialyxir": {:hex, :dialyxir, "1.0.0-rc.3", "774306f84973fc3f1e2e8743eeaa5f5d29b117f3916e5de74c075c02f1b8ef55", [:mix], [], "hexpm"},
   "earmark": {:hex, :earmark, "1.2.6", "b6da42b3831458d3ecc57314dff3051b080b9b2be88c2e5aa41cd642a5b044ed", [:mix], [], "hexpm"},
   "ex_doc": {:hex, :ex_doc, "0.19.1", "519bb9c19526ca51d326c060cb1778d4a9056b190086a8c6c115828eaccea6cf", [:mix], [{:earmark, "~> 1.1", [hex: :earmark, repo: "hexpm", optional: false]}, {:makeup_elixir, "~> 0.7", [hex: :makeup_elixir, 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"},

mix.lock

@@ -1,7 +1,11 @@
 defmodule Bootleg.Fixtures do
   @moduledoc false
 
-  def inflate_project(name \\ :build_me) do
+  @dialyzer {:no_return, inflate_project: 0, inflate_project: 1}
+  @spec inflate_project(atom) :: binary
+  def inflate_project(name \\ :build_me)
+
+  def inflate_project(name) do
     project_dir = Temp.mkdir!("git-#{name}")
     File.cp_r!("./test/fixtures/#{name}", project_dir)
 

test/support/fixtures.ex

@@ -72,6 +72,8 @@ defmodule Bootleg.FunctionalCase do
     Map.merge(config, %{id: id, ip: ip, port: port})
   end
 
+  @dialyzer {:no_return, init: 1, init: 2}
+  @spec init(binary, []) :: %{}
   def init(host, options \\ []) do
     adduser!(host, @user)
     chpasswd!(host, @user, @pass)

test/support/functional_case.ex

@@ -1,20 +1,27 @@
 unless System.get_env("TEST_LEAVE_TEMP"), do: Temp.track!()
 
-unless Docker.ready?() do
-  IO.puts("""
-  It seems like Docker isn't running?
+skip_functional_tests =
+  ExUnit.configuration()
+  |> Keyword.get(:exclude)
+  |> Enum.member?(:functional)
 
-  Please check:
+unless skip_functional_tests do
+  unless Docker.ready?() do
+    IO.puts("""
+    It seems like Docker isn't running?
 
-  1. Docker is installed: `docker version`
-  2. On OS X and Windows: `docker-machine start`
-  3. Environment is set up: `eval $(docker-machine env)`
-  """)
+    Please check:
 
-  exit({:shutdown, 1})
-end
+    1. Docker is installed: `docker version`
+    2. On OS X and Windows: `docker-machine start`
+    3. Environment is set up: `eval $(docker-machine env)`
+    """)
+
+    exit({:shutdown, 1})
+  end
 
-Docker.build!("bootleg-test-sshd", "test/support/docker")
+  Docker.build!("bootleg-test-sshd", "test/support/docker")
+end
 
 ExUnit.configure(formatters: [JUnitFormatter, ExUnit.CLIFormatter])
 ExUnit.start()

test/test_helper.exs

@@ -204,4 +204,18 @@ defmodule Bootleg.UITest do
     assert Enum.count(char_out, fn codepoint -> codepoint === 8217 end) == 2000
     assert size == 273_036, "Received data not in expected form."
   end
+
+  test "prompt returns user input" do
+    assert capture_io([input: "foobar", capture_prompt: false], fn ->
+             input = UI.prompt(">")
+             IO.write(input)
+           end) == "foobar"
+  end
+
+  test "prompt pads input prompt with a space" do
+    assert capture_io([input: "bazfoo"], fn ->
+             input = UI.prompt(">")
+             IO.write(input)
+           end) == "> bazfoo"
+  end
 end