既存のServerSpecテストケースから逆算してAnsible IaC化した話

こんにちは、AI Labの馬場 光希です。

今回は、既存インフラのIaC(Infrastructure as Code)化プロジェクトについてご紹介します。

▼ 以前の課題

以前のプロトタイプで、サーバー構築の自動テストツールとして Serverchecker(Itamae ベース + ServerSpec)を構築しました。テストの自動化は実現できた為、つぎに、手作業によるサーバー構築作業に時間がかかっているという課題を解決します。

▼ 今回の目標

サーバー構築プロセスをAnsibleでIaC化することにしました。 ポイントは、既存のServerSpecテストケースを「仕様書」として活用するアプローチです。テストケースから要件を逆算してAnsibleロールを作成することで、テストケースと人間によるダブルチェックが可能になり、要件との齟齬を防ぐことができます。

▼ 結果

最終的に、以下のようなプロトタイプが完成しました。

  • Docker上でAnsibleの実行とServerSpecによるテストが完結する環境
  • ServerSpecのテストケースを満たすAnsibleロール(httpd等)
  • 新規ロール作成用のテンプレート

以降は、この仕組みの詳細について解説します。

目次


開発環境

項目バージョン・内容
Ansible2.19
DockerCompose V2
ターゲットOSAlmaLinux9
テストツールServerSpec(既存のServerchecker)

環境構築

Dockerを使った検証環境を構築しました。3つのコンテナで構成されています。

┌─────────────────────┐
│ ansible-controller  │  Ansible実行環境
│  - Python 3.11      │
│  - Ansible 2.19     │
└──────────┬──────────┘
           │
           │ SSH (ed25519)
           │
┌──────────▼──────────┐
│ almalinux-target    │  テスト対象サーバー
│  - AlmaLinux 9      │
│  - SSHd             │
└──────────▲──────────┘
           │
           │ SSH (ed25519)
           │
┌──────────┴──────────┐
│ kondate-runner      │  ServerSpec実行環境
│  - Ruby 3.3         │
│  - Kondate          │
│  - ServerSpec       │
└─────────────────────┘
  • ansible-controller: Ansibleを実行する環境
  • almalinux-target: Playbookの適用先となるテスト対象サーバー
  • kondate-runner: ServerSpecを実行する環境(Kondateは ServerSpecを用いたテストフレームワーク)

ディレクトリ構成は以下の通りです。

playbook/
├── docker/
│   ├── controller/    # Ansible実行環境
│   ├── target/        # 適用先サーバー(AlmaLinux)
│   └── ssh/           # SSH鍵(自動生成)
├── group_vars/        # 全環境共通の変数
├── inventories/       # 環境別のホスト定義
├── playbooks/         # 実行単位
├── roles/
│   ├── httpd/                   # 作成したロール例
│   └── _template-middleware/    # 新規ロール作成用テンプレート
└── ...

ansible-controller から almalinux-target に対してPlaybookを実行し、その後 kondate-runner からServerSpecでテストを実行する流れになります。

開発フロー

1. ServerSpecをベースラインとする

まず、既存のServerSpecテストコードを確認します。例えばhttpdのテストは以下のようになっています。

describe package('httpd') do
  it { should be_installed }
end

describe service('httpd') do
  it { should be_enabled }
  it { should be_running }
end

describe command('apachectl configtest 2>&1') do
  its(:stdout) { should match /Syntax\s*OK/ }
end

ここから読み取れる要件は以下の3点です。

  • httpdパッケージがインストールされていること
  • httpdが起動中で自動起動も有効であること
  • 設定ファイルにシンタックスエラーがないこと

2. Ansibleタスクに落とし込む

テストケースを満たすようにAnsibleタスクを作成します。

- name: "{{ httpd_package }} のインストール"
  ansible.builtin.package:
    name: "{{ httpd_package }}"
    state: present
  tags:
    - httpd
    - httpd_install

- name: "{{ httpd_package }}の起動・自動起動"
  ansible.builtin.service:
    name: "{{ httpd_package }}"
    state: started
    enabled: true
  when: not ansible_check_mode
  tags:
    - httpd
    - httpd_starter

- name: "{{ httpd_package }}の設定ファイルのエラーチェック"
  ansible.builtin.command: apachectl configtest
  register: result
  changed_when: false
  failed_when: result.rc != 0
  tags:
    - httpd
    - httpd_configtest

3. Dockerで検証 → ServerSpecでテスト → 修正

以降は以下のサイクルを繰り返します。

  1. Ansibleを実行
  2. ServerSpecでテスト
  3. 失敗したら修正して1に戻る

ServerSpecもDocker環境で実行できるようにしているため、実際のクラウドプロバイダーを利用せず、作り直しが容易です。

ディレクトリ構成の検討

今回のプロジェクトで最も苦労したのはディレクトリ構成の設計でした。

Ansibleのベストプラクティスでは、環境ごとのinventory分離やgroup_varsの階層化など、細かい構成が推奨されています。しかし、今回はプロトタイプ開発であり、すべてを採用すると冗長になりすぎてしまいます。

最終的には「現時点で必要な構成」に絞り込み、拡張性は残しつつもシンプルな構成に落ち着きました。

今後の展望

現在はミドルウェア以外にも横展開を進めています。テストケースがすでに存在しているため、「何を満たせばいいか」が明確になっており、作業は比較的スムーズに進んでいます。

​

​