1 Introduction to Mix

この章では、スーパーバイザーの連なり(supervision tree)のことや、設定、テストなどを含んだ完璧なElixirのアプリケーションを作る方法について学びます。

In this guide, we will learn how to build a complete Elixir application, with its own supervision tree, configuration, tests and more.

アプリケーションは分散型キーバリューストアとして動作します。私たちはこれからキーと値のペアのバケット(単位)と複数のノードにまたがる分散型のバケットを管理します。また、次のようなリクエストを同時に送るノードを複数接続するためのシンプルなクライアントも作成していきます。

The application works as a distributed key-value store. We are going to organize key-value pairs into buckets and distribute those buckets across multiple nodes. We will also build a simple client that allows us to connect to any of those nodes and send requests such as:

CREATE shopping
OK

PUT shopping milk 1
OK

PUT shopping eggs 3
OK

GET shopping milk
1
OK

DELETE shopping eggs
OK

このようなキーバリューアプリケーションを作るのに必要な3つのツールを紹介します。

In order to build our key-value application, we are going to use three main tools:

• OTPはErlangのライブラリ集です。Erlangの開発者はOTPを使うことで強力で、障害の起きにくいアプリケーションを開発できます。この章ではOTPをElixirで扱ったり、スーパーバイザーの連なりやイベントマネージャーなどを扱います。

• OTP is a set of libraries that ships with Erlang. Erlang developers use OTP to build robust, fault-tolerant applications. In this chapter we will explore how many aspects from OTP integrate with Elixir, including supervision trees, event managers and more;

• MixはElixirにおける作成、コンパイル、アプリケーションのテスト、依存関係の管理を扱うためのビルドツールです。

• Mix is a build tool that ships with Elixir that provides tasks for creating, compiling, testing your application, managing its dependencies and much more;

• ExUnitはElixirをもとに書かれたテスト駆動フレームワークです。

• ExUnit is a test-unit based framework that ships with Elixir;

この章では、まずMixを使って最初のプロジェクトを作り進めながら、MixやExUnitとOTPとの違いについて扱います。

In this chapter, we will create our first project using Mix and explore different features in OTP, Mix and ExUnit as we go.

注意: この章はElixirのバージョンv0.15.0以降が必要です。Elixirのバージョンを調べるコマンドはelixir -vで、もし詳しい説明が必要であれば、getting startedの最初の章を読んでください。

もし何か質問やこのガイドへの改善案があれば，それぞれメーリングリストかイシュートラッカーへお知らせください．あなたのインプットはとても大切で，私たちがこのガイドを読みやすいように担保し，最新の状態を保つのに役立ちます．

Note: this guide requires Elixir v0.15.0 or later. You can check your Elixir version with elixir -v and install a more recent version if required by following the steps described in the first chapter of the Getting Started guide.

If you have any questions or improvements to the guide, please let us know in our mailing list or issues tracker respectively. Your input is really important to help us guarantee the guides are accessible and up to date!

1.1 最初のプロジェクト - Our first project

Elixirをインストールしたら、まずelixirにelixircとiexの実行ファイルに加えて、Elixirの実行ファイルであるmixを使えるようになります。

When you install Elixir, besides getting the elixir, elixirc and iex executables, you also get an executable Elixir script named mix.

まずは最初のプロジェクトをmix newをコマンドラインから実行してみましょう。プロジェクト名を引数に渡して(今回はkv)、そのままであればメインのモジュールは通常Kvというように処理されてしまうので、今回は大文字でKVであることをmixに伝えましょう。

Let's create our first project by invoking mix new from the command line. We'll pass the project name as argument (kv, in this case), and tell mix that our main module should be the all-uppercase KV, instead of the default, which would have been Kv:

$ mix new kv --module KV

Mixはkvといういくつかのファイルを含んだディレクトリを作成します。

Mix will create a directory named kv with a few files in it:

* creating README.md
* creating .gitignore
* creating mix.exs
* creating config
* creating config/config.exs
* creating lib
* creating lib/kv.ex
* creating test
* creating test/test_helper.exs
* creating test/kv_test.exs

生成されたファイルを見てみましょう。

Let's take a brief look at those generated files.

注意: MixはElixirの実行形式のひとつです。mixを実行するのにElixirの実行形式をPATHに含めなければなりません。あるいは、Elixirに直接スクリプトの引数を与えてください。

$ bin/elixir bin/mix new kv --module KV

注意: -Sオプションを指定することで、直接スクリプトを実行することができます。

$ bin/elixir -S mix new kv --module KV

-Sオプションを使うと、ElixirはPATHとスクリプトを探し出し、どこでも実行できるようにしてくれます。

Note: Mix is an Elixir executable. This means that in order to run mix, you need to have elixir's executable in your PATH. If not, you can run it by passing the script as argument to elixir:

$ bin/elixir bin/mix new kv --module KV

Note that you can also execute any script in your PATH from Elixir via the -S option:

$ bin/elixir -S mix new kv --module KV

When using -S, elixir finds the script wherever it is in your PATH and executes it.

1.2 プロジェクトのコンパイル - Project compilation

mix.exsというファイルは新しいプロジェクトを生成した時に作成され、主な用途はプロジェクトの設定です。さっそく見てみましょう(コメント行は削除しています)。

A file named mix.exs was generated inside our new project and its main responsibility is to configure our project. Let's take a look at it (comments removed):

defmodule KV.Mixfile do
  use Mix.Project

  def project do
    [app: :kv,
     version: "0.0.1",
     deps: deps]
  end

  def application do
    [applications: [:logger]]
  end

  defp deps do
    []
  end
end

mix.exsの定義はプロジェクト名やバージョンといったプロジェクトの設定を返すためのprojectと、アプリケーションによってそのまま生成されたapplicationによるふたつの公開関数です。

Our mix.exs defines two public functions: project, which returns project configuration like the project name and version, and application, which is used to generate an application file.

どちらもdepsという非公開の関数を含んでいて、projectが要求されると依存関係を定義します。本来はdepsを別々のものとして定義する必要はありませんが、プロジェクトの設定を小さくするのに役立っています。

There is also a private function named deps, which is invoked from the project function, that defines our project dependencies. Defining deps as a separate function is not required, but it helps keep the project configuration tidy.

Mixは単純なモジュールの定義を含んだlib/kv.exというファイルを生成します。

Mix also generates a file at lib/kv.ex with a simple module definition:

defmodule KV do
end

プロジェクトをそのままコンパイルするのに十分です。

This structure is enough to compile our project:

$ mix compile

これらは、

Will generate:

Compiled lib/kv.ex
Generated kv.app

lib/kv.exというファイルがkv.appというファイルをコンパイルしました。この.appというファイルはapplication/0という情報が定義されたmix.exsから生成されています。詳細なmix.exsの設定についての機能は後々触れます。

Notice the lib/kv.ex file was compiled and kv.app file was generated. This .app file is generated with the information from the application/0 function in the mix.exs file. We will further explore mix.exs configuration features in future chapters.

一度プロジェクトがコンパイルされると、プロジェクト内でiexを実行させることができます。

Once the project is compiled, you can start an iex session inside the project by running:

$ iex -S mix

1.3 テストの実行 - Running tests

Mixはプロジェクトをテストするために必要なファイルを自動で用意します。Mixは通常libディレクトリのファイルごとにそれぞれ対応する、testというディレクトリの<ファイル名>_test.exsに沿って実行されます。この規則により、すでにtest/kv_test.exsとlib/kv.exというファイルが見つかるはずです。しかし、これらはまだうまく結びついていません。

Mix also generated the appropriate structure for running our project tests. Mix projects usually follow the convention of having a <filename>_test.exs file in the test directory for each file in the lib directory. For this reason, we can already find a test/kv_test.exs corresponding to our lib/kv.ex file. It doesn't do much at this point:

defmodule KVTest do
  use ExUnit.Case

  test "the truth" do
    assert 1 + 1 == 2
  end
end

重要なポイントがふたつあります。

It is important to note a couple things:

1. テストが書かれたファイルはElixirのファイル(.exs)なので、テストを実行するたびにファイルをコンパイルする必要がありません。

2. the test file is an Elixir script file (.exs). This is convenient because we don't need to compile test files before running them;

3. ExUnit.CaseをテストのAPIに組み込んだり、test/2という単純なマクロを定義するためにKVTestと呼ばれるテストモジュールを定義しました。

4. we define a test module named KVTest, use ExUnit.Case to inject the testing API and define a simple test using the test/2 macro;

Mixはtest/test_helper.exsという素早くテストフレームワークのセットアップさせるファイルも生成しています。

Mix also generated a file named test/test_helper.exs which is responsible for setting up the test framework:

ExUnit.start

このファイルは毎回テストを実行するごとに自動的にMixに呼び出されます。テストの実行はmix testです。

This file will be automatically required by Mix every time before we run our tests. We can run tests with mix test:

Compiled lib/kv.ex
Generated kv.app
.

Finished in 0.04 seconds (0.04s on load, 0.00s on tests)
1 tests, 0 failures

Randomized with seed 540224

mix testを実行すると、Mixはソースファイルをコンパイルして、アプリケーションを生成し直してくれます。これはMixが次の章で説明する複数の環境を使い分けているからです。

Notice that by running mix test, Mix has compiled the source files and generated the application file once again. This happens because Mix supports multiple environments, which we will explore in the next section.

そのうえ、ExUnitはテストの結果を成功はピリオドで表示して、ランダムな値をシードに表示していることがわかります。目的にあわせてテストに失敗して、何が起こるか確かめましょう。

Furthermore, you can see that ExUnit prints a dot for each successful test and automatically randomizes tests too. Let's make the test fail on purpose and see what happens.

test/kv_test.exsのアサーションを書き換えてください。

Change the assertion in test/kv_test.exs to the following:

assert 1 + 1 == 3

mix testを再び実行します(二回目以降はコンパイルされません)

Now run mix test again (notice this time there was no compilation):

1) test the truth (KVTest)
   test/kv_test.exs:4
   Assertion with == failed
   code: 1 + 1 == 3
   lhs:  2
   rhs:  3
   stacktrace:
     test/kv_test.exs:5

Finished in 0.05 seconds (0.05s on load, 0.00s on tests)
1 tests, 1 failures

アサーションの失敗ごとにExUnitは詳細な結果と、テストケースの名前と左手側(lfs)に失敗した値と右手側(rfs)に==オペレーターを表示しています。

For each failure, ExUnit prints a detailed report, containing the test name with the test case, the code that failed and the values for the left-hand side (lhs) and right-hand side (rhs) of the == operator.

2行目の失敗は、テストそのもののファイル名で、テストがどこに定義されているかを示しています。もし、2行目をそのままコピーして、mix textのあとにペーストすると、Mixは直接そのテストの箇所を部分的に実行します。

In the second line of the failure, right below the test name, there is the location the test was defined. If you copy the test location in the second line, containing the file and line, and paste it in-front of mix test, Mix will load and run just that particular test:

$ mix test test/kv_test.exs:4

このショートカットはプロジェクトの開発を進めるにあたり、該当箇所のテストだけを実行しながら修正することができるのでとても便利です。

This shortcut will be extremely useful as we build our project, allowing us to quickly iterate by running just a specific test.

最後に、スタックトレースは与えられたテストの情報をもとに、ソースの失敗部分を部分的に実行し、失敗した原因を関連づけます。

Finally, the stacktrace relates to the failure itself, giving information about the test and often the place the failure was generated from within the source files.

1.4 環境 - Environments

Mixには"環境"という概念があります。これは開発者が特定の状況に応じた拡張を可能にします。標準では、Mixは3つの環境が存在しています。

Mix supports the concept of "environments". They allow a developer to customize compilation and other options for specific scenarios. By default, Mix understands three environments:

• :dev - Mixが標準で実行するタスク(例: compile)
• :test - mix testで使われる

• :prod - プロダクションに一度だけ実行される

• :dev - the one in which mix tasks (like compile) run by default

• :test - used by mix test

• :prod - the one you will use to put your project in production

注意: プロジェクトにそれぞれの環境に対して依存するライブラリを加える場合、これらは自動で引き継がれることはありません。ただし、:prodは環境の設定を引き継ぎます。

Note: If you add dependencies to your project, they will not inherit your project's environment, but instead run with their :prod environment settings!

標準で、これらの3つの環境はすべて同じ設定で動作します。環境ごとの個別設定を行う必要がある場合はMix.envの機能を参考に、mix.exsがそれぞれの環境をatomで返します。

By default, these environments behave the same and all configuration we have seen so far will affect all three environments. Customization per environment can be done by accessing the Mix.env function in your mix.exs file, which returns the current environment as an atom:

def project do
  [deps_path: deps_path(Mix.env)]
end

defp deps_path(:prod), do: "prod_deps"
defp deps_path(_), do: "deps"

Mixは標準で:dev、テストのタスクを実行するための:testを使用します。環境はMIX_ENVの環境変数をもとに変更できます。

Mix will default to the :dev environment, except for the test task that will default to the :test environment. The environment can be changed via the MIX_ENV environment variable:

$ MIX_ENV=prod mix compile

1.5 詳細 - Exploring

プロジェクトの開発に詳細なMixの情報が必要であれば、いつでもヘルプタスクを開いて、実行可能なすべてのタスクのリストを取得することができます。

There is much more to Mix, and we will continue to explore it as we build our project. A general overview is available on the Mix documentation.

Keep in mind that you can always invoke the help task to list all available tasks:

$ mix help

そして、タスクごとの詳細な内容を知るにはmix help タスク名を実行します。

You can get further information about a particular task by invoking mix help TASK.

さあ、コードを書きましょう！

Let's write some code!