Magnolia K > Enbld-0.7031 > docs_ja/Enbld/Tutorial.pod

Download:
Enbld-0.7031.tar.gz

Annotate this POD

Website

View/Report Bugs
Source   Latest Release: Enbld-0.7039

名前 ^

Enbld::Tutorial - Enbldのチュートリアル

説明 ^

このチュートリアルは、EnbldのDSLの文法を解説します。

DSLの文法 ^

Enbldではソフトウェアのインストール条件を専用のDSLで定義します。ここでは、そのDSLの文法を解説します。

コンディションスクリプトの例

  #!/usr/bin/perl

  use strict;
  use warnings;

  use lib "$ENV{HOME}/.enbld/extlib/lib/perl5/";

  use Enbld;

  enbld 'mydevenv' => build {

      target 'git' => define {
          version 'latest';
      };

  };

基本的な構造

ソフトウェアのインストールに使用する関数

以下にEnbldのDSLで使える関数を解説します。これらの関数は全てuse Enbldの時点でエクスポートされています。

EnbldのDSLはperlベースなので、ここに書かれていない事は全てperlの文法に従います。

enbld

  enbld 'mydevenv' => build {
      ...
  };

enbldは、ソフトウェアのインストールを行う関数です。

一つ目の引数は、環境の名前を指定します。文字列であれば何でもかまいません。

二つ目の引数は、build関数が返すコードリファレンスです。enbldは、ソフトウェアのビルド条件が書かれたコードリファレンスを実行することで、ソフトウェアをビルドします。

build

buildは、enbld関数が使うコードリファレンスを返すだけの関数です。

DSLとしての可読性を上げるための関数です :)

target

  target 'git' => define {
      ....
  };

targetは、ソフトウェアごとのインストール条件を定義する関数です。

一つ目の引数は、ソフトウェアの名前を指定します。ソフトウェアの名前は、enblder availableで表示される名前と一致させる必要があります。

二つ目の引数は、define関数が返すコードリファレンスです。targetは、ビルド条件が書かれたコードリファレンスを実行することで、ビルド条件を定義します。

define

defineは、target関数が使うコードリファレンスを返すだけの関数です。

DSLとしての可読性を上げるための存在です :)

version

  target 'perl' => define {
      version '5.18.1';
  };

versionは、インストールしたいバージョン番号を指定する関数です。引数にバージョン番号を指定します。

インストールできるバージョンの一覧は、enblder available [ソフトウェア名]で確認することができます。

なお、存在しないバージョン番号を指定すると、エラーになります。

  target 'git' => define {
      version 'latest';
  };

また、バージョンに'latest'と指定すると、Enbldは自動的に最新バージョンを特定し、インストールします。自分で最新バージョンを探す必要は有りません。

  target 'perl' => define {
      version 'development';
  };

加えて、一部のソフトウェアでは、開発中のバージョンを指定することができます。

例えば、perlでは、バージョンナンバーが偶数は、開発中を示しますが、'development'と指定することで、最新の開発バージョンをインストールすることができます。

詳しくは各Definitionモジュールのドキュメントを参照して下さい。

make_test

  target 'git' => define {
      version 'latest';
      make_test 1;
  };

make_testは、ビルド時にテストを実行するための関数です。

引数にperlで真となる値を指定すると(つまり、udnefと、0と空文字列以外)、ソフトウェアのビルド時にテストを実行します。

テストが失敗すると、ビルドも失敗します。

通常、この機能はオフになっています。

modules

  target 'perl' => define {
      version 'latest';
      modules {
          'App::cpanminus' => 0,
          'Carton'         => 0,
      };
  };

modulesは、プログラミング言語が用意するモジュールインストール機能を使ってモジュールをインストールしたい時に使う関数です。

例えば、perlでは、cpanを呼び出してモジュールをインストールします。

引数にはハッシュリファレンスを指定します。ハッシュでは、キーにモジュール名を、値にはゼロを指定します。

将来的には、モジュールのバージョンを指定できる様になる予定です。

詳しくは各Definitionモジュールのドキュメントを参照して下さい。

arguments

  target 'perl' => define 
      version 'latest';
      arguments '-Dusethreads';
  };

argumentsは、各ソフトウェアの'configure'スクリプトへの引数を追加する関数です。

引数で指定した文字列がそのまま引き渡されます。

annotation

  target 'perl' => define 
      version 'latest';
      arguments '-Dusethreads';
      annotation 'with thread support';
  };

annotationは、注釈を追加する関数です。

単なるスクリプトのコメントと異なり、enblder freezeでも再現されます。

設定ファイルを作成するための関数

  conf '.vimrc' => load {
      from 'https://raw.github.com/magnolia-k/vimrc/master/.vimrc';
  };

Enbldは各ソフトウェアをビルドするだけでなく、各ソフトウェアの設定ファイル(DOTFILES)を作成するための機能も持ちます。

上記の例では、vim用の設定ファイル(.vimrc)をGitHubからダウンロードして、ホームディレクトリに配置します。

また、Enbldでは、インストールできるソフトウェアと、設定ファイルのファイル名の相関まではチェックしないので、どんな設定ファイルでも配置することができます。

conf

  conf '.vimrc' => load {
  ...
  };

confは、設定ファイルを作成するための関数です。

一つ目の引数は、設定ファイルのファイル名を指定します。

ディレクトリ名を付けて指定した時は、以下の様に解釈されます。

なお、conf関数は、build関数の引数に指定されたコードリファレンスの中であれば、どこに記述してもかまいません。

  enbld 'mydevenv' => build {
      target 'vim' => define {
          version 'latest';

          conf '.vimrc' => load {
              from 'https://raw.github.com/magnolia-k/vimrc/master/.vimrc';
          }; # -> これもOK

      };

      conf '.bashrc' => set {
          content 'export PATH=$HOME/.enbld/bin:PATH';
      }; # -> これもOK
  };

二つ目の引数は、設定ファイルをどこから取得するのか、指定する関数です。

load

  conf '.vimrc' => load {
      from 'https://raw.github.com/magnolia-k/vimrc/master/.vimrc';
  };

設定ファイルをfrom関数の引数で指定したURLからダウンロードします。

引数はコードリファレンスです。

既に同じ内容のファイルが存在する場合は何もしません。ファイルが存在しても内容が異なる場合は、既存のファイルのファイル名を変更して、指定された通りにファイルを作成します。

set

  conf '.bashrc' => set {
      content 'export PATH=$HOME/.enbld/bin:PATH';
  };

設定ファイルをcontent関数の引数で指定した内容で作成します。

引数はコードリファレンスです。

既に同じ内容のファイルが存在する場合は何もしません。ファイルが存在しても内容が異なる場合は、既存のファイルのファイル名を変更して、指定された通りにファイルを作成します。

copy

  conf '.vimrc' => copy {
      from '/path/to/.vimrc';
  };

設定ファイルをfrom関数の引数で指定したファイルからコピーして作成します。

引数はコードリファレンスです。

既に同じ内容のファイルが存在する場合は何もしません。ファイルが存在しても内容が異なる場合は、既存のファイルのファイル名を変更して、指定された通りにファイルを配置します。

from

from関数は、設定ファイルの取得元を指定する関数です。

引数には、URLか、フルパスを指定します。

content

  conf '.vimrc' => set {
      content 'syntax on';
  };

content関数は、設定ファイルの内容を指定する関数です。

  conf '.wgetrc' => load {
      from 'http://xxx.xxx.xxx/.wgetrc';

      content 'proxy_user = user';
      content 'proxy_passwd = PassWord';
  }

ダウンロードしたファイルにcontent関数を使って、追記することもできます。

to

  conf 'filerc' => set {
    to "$ENV{HOME}/fileconfig";
    content 'setting string';
  };

to関数は、設定ファイルの配置先を指定する関数です。

conf関数の引数にファイル名だけを指定した時でも、to関数にディレクトリを指定することで、配置場所を自由に制御できます。

コンディションスクリプトのオプション指定

コンディションスクリプトは、いくつかのオプションを取ることができます。ここでは、そのオプションを解説します。

test

  $ ./conditions.pl --test

  $ ./conditions.pl -t

'test'オプションは、インストール時にテストを実行します。

force

  $ ./conditions.pl --force

  $ ./conditions.pl -f

'force'オプションは、インストール済のソフトウェアも含めて全て強制的にインストールします。

deploy

  $ ./conditions.pl --deploy /path/to/install/

  $ ./conditions.pl -d /path/to/install/

'deploy'オプションは、コンディションスクリプトで定義したスクリプトのインストール先を指定します。

ただし、'deploy'でインストールしたソフトウェアの新バージョンのリリースチェックはできません。

その他のトピック ^

'.enbld'ディレクトリの構成

'.enbld'ディレクトリは下記の様な構成になっています。

 $HOME/.enbld --+
                |
                +-- bin/         実行コマンド              (シンボリックリンク)
                |
                +-- lib/         ライブラリ                (シンボリックリンク)
                |
                +-- include/     インクルードファイル      (シンボリックリンク)
                |
                +-- man/         マニュアルファイル        (シンボリックリンク)
                |
                +-- share/       共有ファイル              (シンボリックリンク)
                |
                +-- extlib/      Enbldのモジュールファイル (例: lib/Enbld.pm)
                |
                +-- dists/       ダウンロードしたアーカイブファイル
                |
                +-- etc/         その他の色々なファイル
                |
                +-- build/       ソフトウェアのビルドディレクトリ
                |
                +-- depository/  インストールされたソフトウェアの構成ファイル
                |   |
                |   +-- Software A
                |   |   |
                |   |   +-- version 1
                |   |   |
                |   |   +-- version 2
                |   |   |
                |   |
                |   +-- Software B
                |   |   |
                |   |   +-- version 1
                |   |   |
                |
                +--conf/         Enbldの設定ファイル
                |
                +--log/          Enbldのログファイル

Enbldはソフトウェアを$HOME/.enbld/depository/[ソフトウェア名]/[バージョン]/へインストールし、$HOME/.enbld/binや、$HOME/.enbld/libなどのディレクトリへシンボリックリンクを作ります。

これにより、簡単に新しいバージョンへ切り替えることができるようになっています。

更なる情報 ^

Enbld

enblder

ウェブサイト ^

https://github.com/magnolia-k/Enbld

http://code-stylistics.net/enbld

問題のレポート ^

https://github.com/magnolia-k/Enbld/issues

コピーライト ^

copyright 2013- Magnolia <magnolia.k@me.com>.

LICENSE ^

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

syntax highlighting: