defmodule Mix.Tasks.Bench do use Mix.Task @shortdoc "Benchmark your code" @moduledoc """ ## Usage mix bench [options] [...] When one or more arguments are supplied, each of them will be treated as a wildcard pattern and only those bench tests that match the pattern will be selected. By default, all files matching `bench/**/*_bench.exs` are run. The results of a test run are pretty-printed to the standard output. Additionally, the output in machine format is written to a snapshot file. ## Options -n, --no-pretty Instead of pretty-printing the output, print it in the format that can be parsed by bench.cmp and bench.graph. -q, --quiet Don't print progress report while the tests are running. Reports are printed to stderr so as not to interfere with output redirection. -d , --duration= Minimum duration of each test in seconds. -o , --output= Path to the directory in which to store snapshots. The directory will be created if necessary. Setting it to an empty value will prevent benchfella from creating any files or directories. Default: bench/snapshots. --no-compile Do not compile the target project before running benchmarks. """ def run(args) do switches = [no_pretty: :boolean, quiet: :boolean, duration: :float, output: :string, no_compile: :boolean] aliases = [n: :no_pretty, q: :quiet, d: :duration, o: :output] {paths, options, no_compile} = case OptionParser.parse(args, strict: switches, aliases: aliases) do {opts, paths, []} -> {paths, opts} {_, _, [{opt, val}|_]} -> valstr = if val do "=#{val}" end Mix.raise "Invalid option: #{opt}#{valstr}" end |> normalize_options() prepare_mix_project(no_compile) Process.put(:"benchfella cli options", options) load_bench_files(paths) end defp prepare_mix_project(no_compile) do # Set up the target project's paths Mix.Project.get! unless no_compile, do: Mix.Task.run("compile", []) Mix.Task.run("loadpaths", []) end defp load_bench_files([]) do Path.wildcard("bench/**/*_bench.exs") |> do_load_bench_files end defp load_bench_files(paths) do Enum.flat_map(paths, &Path.wildcard/1) |> do_load_bench_files end defp do_load_bench_files([]), do: nil defp do_load_bench_files(files) do load_bench_helper() Kernel.ParallelRequire.files(files) end @helper_path "bench/bench_helper.exs" defp load_bench_helper() do if File.exists?(@helper_path) do Code.require_file(@helper_path) else Benchfella.start() end end defp normalize_options({paths, options}) do options = Enum.reduce(options, %{}, fn {:no_pretty, flag}, map -> Map.put(map, :format, pretty_to_format(!flag)) {:quiet, flag}, map -> Map.put(map, :verbose, not flag) {k, v}, map -> Map.put(map, k, v) end) {no_compile, options} = Map.pop(options, :no_compile) {paths, Enum.to_list(options), no_compile} end defp pretty_to_format(true), do: :pretty defp pretty_to_format(false), do: :machine end