Serverspecベースのサーバー検証基盤「Serverchecker2」を改善した話

こんにちは、AI Labの川口あいです。

本記事では、Serverspecをベースとしたサーバー設定を検証するServerchecker2というシステムの整備・改善プロジェクトについてご紹介します。

Serverchecker2は、ApacheやNginx、MySQLなどのミドルウェア設定やOSのセキュリティ設定を自動で検査し、サーバーが意図した構成になっているかを確認するための仕組みです。日々のインフラ運用や構築作業において、設定ミスやセキュリティリスクを早期に検知する目的で活用されています。

今回の整備では、Ruby3.4対応に伴うRSpec文法の修正を中心に、テストコードの可読性・保守性の改善、HTML形式による検査結果出力の導入検証、さらにApache/Nginx関連のセキュリティチェック強化など、Serverchecker2を今後も継続的に運用しやすい状態へ改善するための取り組みを行いました。

目次

プロジェクトの目的

本プロジェクトの目的は、主に以下の3つです。

  • Ruby3.4で警告が強化されたRSpecの古いshould記法を見直し、expect記法へ統一することで、Serverchecker2を今後も安定して運用できる状態にすること

  • RSpecのHTML出力を導入・検証し、従来のCLIベースのテスト結果よりも確認しやすく、レビューや障害調査を行いやすい環境を整備すること

  • 実行フローやシェルスクリプト、設定ファイル生成周りを見直し、初めて触るメンバーでも扱いやすい運用基盤へ改善すること

(現時点のServerchecker2実行環境はRuby3.3を利用していますが、将来的なRuby3.4系へのアップデートを見据え、RSpecの古いshould記法からexpect記法への移行を進めました。)

実行環境

  • Docker / Docker compose

    • 開発・実行環境をコンテナ化
  • AlmaLinux8

    • コンテナのベースOSとして利用
  • Ruby3.3

    • Serverspec実行環境として使用

使用している主なGem

Gem用途
serverspecサーバー設定のテスト実行
kondateホスト定義やテスト管理
dotenv.env ファイルの読み込み
parallelテストの並列実行

テスト基盤

Serverchecker2はServerspec(RSpecベース)を利用して構築されているため、以下のようなサーバー設定をコードとしてテストできます。

  • Apache / Nginx の設定確認
  • ミドルウェアのインストール確認
  • ユーザー・権限設定
  • セキュリティ設定

サーバー接続方式

対象サーバーへはSSHを利用して接続します。 接続情報は以下のファイルで管理しています。

ファイル用途
sshconfigSSH接続設定
keys/秘密鍵
.env接続先サーバーや対象ノード設定

設定ファイル生成

Serverchecker2では、設定ファイルを手作業で作成するのではなく、対話式スクリプトを利用して自動生成できるようになっています。

生成・更新されるファイル例:

  • .env
  • .env.<マシン名>
  • sshconfig
  • hosts.yml

Serverchecker2 実行環境の概要

ローカルPC
├─ リポジトリ(spec / hosts / env / 生成スクリプト)
└─ Docker Compose(docker compose up)
↓(ボリュームマウント / ビルド)
Docker コンテナ: web(AlmaLinux 8 + Ruby 3.3)
├─ Gems: serverspec / rspec / kondate / dotenv
├─ /root/kondate(kondate/ をマウント)
├─ /root/serverchecker(リポジトリを read-only マウント)
├─ /root/.ssh/config(sshconfig をCOPY)
└─ /root/.ssh/*(keys/ の秘密鍵をCOPY)
↓(SSH / Net::SSH)
テスト対象サーバー
└─ Serverspec が設定・ミドルウェア状態を検証
↓(結果出力)
出力
├─ 標準出力: RSpec formatter(doc / compact)
└─ HTML: RSpec HtmlFormatter → kondate/result.html(追加項目)

ローカルPCでdocker composeを実行し、Serverchecker2の実行用コンテナ(web)をビルド・起動します。コンテナ内でServerspecを実行すると、用意したsshconfigと秘密鍵(keys/)を使ってテスト対象サーバーへSSH接続し、サーバー設定の検証(指定したspecの実行)を行ったうえで結果を出力します。本プロジェクトでの取り組みにより、テスト結果はコマンドライン上だけでなくHTMLレポートとしても生成されるため、ブラウザでテスト結果を確認できます。

各テストコードの改善

ここでは、今回の中心作業であるRSpec文法の変更についてご紹介します。

# 変更前
it { should exist }

# 変更後
it { is_expected.to exist }

Ruby3.4対応に伴い、上記のように古いshould記法を全てexpect記法へと置き換えました。

今回対応したテストコードの中からいくつか抜粋して説明していきます。

※ コードは、実際に利用しているテストコードをベースに、社外公開向けにホスト名・設定ファイル名など一部の情報を抽象化・省略したサンプルです。

1. httpd_SSLOffload_spec.rb

ApacheのSSLオフロード設定をテストするhttpd_SSLOffload_spec.rbです。

変更前

require 'spec_helper'

describe 'SSLオフロード用設定ファイルが作成されていること' do
  describe file('<SSLオフロード用設定ファイルパス>') do
    it {should exist}
  end
end

describe 'SSLオフロード設定で特定ヘッダーが適切に削除されていること' do
  describe file('<SSLオフロード用設定ファイルパス>') do
    its(:content) {should match /^\s*(?!#)Header unset <特定ヘッダー>$/}
  end
end

このコードではRSpecとしては動作するものの、以下のような課題がありました。

  • should記法が使われている
  • 設定ファイルの存在確認しか行なっておらず、実際にWebサーバーへ反映されているかは確認できていない

そこで以下のように改善を行いました。

変更後

require 'spec_helper'

describe 'SSLオフロード用設定ファイルが作成されていること' do
  describe file('<SSLオフロード用設定ファイルパス>') do
    it '<SSLオフロード用設定ファイル>が存在すること' do
      expect(subject).to exist
    end

    it 'コメントアウトされていないHeader unset <特定ヘッダー>が設定されていること' do
      expect(subject.content).to match(/^\s*(?!#)Header unset <特定ヘッダー>$/)
    end
  end
end

describe 'SSLオフロード設定がWebサーバーに読み込まれていること' do
  describe command("httpd -t -D DUMP_CONFIG <設定確認用コマンド>") do
    its(:exit_status) { is_expected.to eq 0 }
  end
end

変更後は、単にexpect記法へ書き換えただけでなく、it '〜であること'の形式で説明文を追加し、テストの意図が読み取りやすい構成へ改善しました。

また、httpd -D DUMP_CONFIGを利用して、実際にWebサーバーへ設定が読み込まれているかまで確認するテストを追加しました。

この改善により、

  • 設定ファイルの存在
  • 設定値の記述
  • 実際のApacheへの反映

までを段階的に検証できるようになりました。

2. monitorix_spec.rb

Monitorix のインストール状態や監視設定、ネットワークインターフェース設定などを確認するテストです。

変更前

describe 'monitorixが実行中で自動起動も有効であること' do
  describe service('monitorix') do
    it { should be_running }    
    it { should be_enabled }      
  end
end

変更前は、should記法を利用したシンプルな構成になっていましたが、テスト内容の意図が実行ログから読み取りづらい状態でした。

変更後

describe 'monitorixが実行中で自動起動も有効であること' do
  describe service('monitorix') do
    it 'monitorixの自動起動が有効であること' do
      expect(subject).to be_enabled
    end 

    it 'monitorixが起動していること' do
      expect(subject).to be_running
    end
  end
end

変更後は、expect記法へと統一するとともに、各テストに説明文を追加し、実行結果から「どのテストが成功・失敗したのか」を把握しやすくしました。

実行結果

Service "monitorix"
    monitorixの自動起動が有効であること
    monitorixが起動していること

テスト内容が日本語で表示されるようになったことで、どの確認項目が成功・失敗したのかを実行ログから把握しやすくなりました。


また、今回特に改善効果が大きかったのが、ネットワークインターフェースを確認するテストです。

変更前は、ip link showの結果から取得した全インターフェースを対象としていたため、Docker環境ではdocker0のような仮想インターフェースまで検査対象となり、不要なテスト失敗が発生していました。

active_interfaces.each do |iface|
  its(:content) { should match(/list = #{iface}$/) }
  its(:content) { should match(/gateway = #{iface}$/)}
end

Monitorixでは、デフォルトルートで利用されているNICを監視対象として扱う方針とし、最終的には以下のように改善しました。

active_interface = command(
  "ip route show default | awk '{print $5; exit}'"
).stdout.strip

これにより、

  • Docker用の仮想NICを誤検知しない

  • クラウド環境ごとのNIC名の違いに対応できる

  • 実際に通信で使用しているNICを対象にできる

という、より実運用に近いテストへ改善できました。

RSpecのHTML出力対応

Serverchecker2では、テスト実行時の結果をCLI上で確認していました。しかし、検査項目が増えるにつれて出力内容が長くなり、特に失敗時にはファイル内容や差分が大量に表示されるため、「どのテストが失敗したのか」「何を期待していたのか」を確認しづらい状態になっていました。

そこで今回、従来のCLI出力は残したまま、RSpecのHTML formatterを利用して、テスト結果をHTMLファイルとしても出力できるようにしました。

# spec_helper.rb(一部抜粋)

require_relative 'support/compact_doc_formatter'
require 'rspec/core/formatters/html_formatter'

RSpec.configure do |config|
  formatter_mode = ENV.fetch('SERVERCHECKER_FORMATTER', 'doc')

  cli_formatter =
    case formatter_mode
    when 'compact'
      CompactDocFormatter
    else
      RSpec::Core::Formatters::DocumentationFormatter
    end

  html_output = ENV.fetch(
    'SERVERCHECKER_HTML_OUT',
    File.expand_path('../result.html', __dir__)
  )

  config.add_formatter(cli_formatter, $stdout)
  config.add_formatter(RSpec::Core::Formatters::HtmlFormatter, html_output)
end

SERVERCHECKER_FORMATTERによってCLI出力の形式を切り替えられるようにし、通常時はRSpec標準のDocumentationFormatter、compact指定時は独自のCompactDocFormatterを使う構成にしました。

また、RSpecではconfig.add_formatterを複数回呼び出せるため、CLI向けのformatterに加えてHTML formatterも追加しています。これにより、従来通りCLIに実行結果を表示しつつ、同時にHTMLレポートも出力できるようになりました。

HTMLの出力先はSERVERCHECKER_HTML_OUTで変更でき、未指定の場合は kondate/result.htmlに保存されます。

CLI出力の可読性改善

さらに、Serverspec実行時の利便性向上のため、run-serverspecと run-serverspec-compactという実行コマンドも追加しました。

このコマンドでは、.envに設定された対象ドメインを読み取り、内部で kondate serverspecを実行するようにしています。毎回長いコマンドを入力する必要がなくなり、簡単にServerspecを実行できるようになりました。

通常実行では以下のコマンドを利用します。

run-serverspec

また、run-serverspec-compactでは、今回新たに作成した独自formatterであるCompactDocFormatterを利用して、CLI上に実行結果を出力するようにしています。

run-serverspec-compact

通常のRSpec formatterでは、失敗時に設定ファイル全体や長い差分が表示されることがあり、Serverspecのように大量の設定確認を行う環境では、必要な情報を見つけづらくなるケースがありました。

そこでCompactDocFormatterでは、

  • どのテストが失敗したか
  • どの対象を確認していたか
  • 何を期待していたか

を中心に、必要最低限の情報だけを表示するように調整しています。

シェルスクリプトの改善

ここでは、Serverchecker2を使用する.envやsshconfig、Serverspec用の設定ファイルなどを生成・更新する、各種シェルスクリプトの改善内容について紹介します。

Serverchecker2では、create-spec.shを実行することで、Serverspec実行に必要な設定ファイルを対話形式で自動生成する構成になっています。

一方で、実際に運用・検証を進める中で、

  • 実行場所によって動作しない
  • 入力ミス時に最初からやり直しになる
  • 入力項目が分かりづらい

など、保守性や操作性の面で改善したい箇所が見えてきました。

そこで今回、シェルスクリプト全体の見直しを行い、運用しやすい構成への改善を進めました。その中からいくつか抜粋して改善した内容についてご紹介します。

実行ディレクトリ依存の解消

変更前のシェルスクリプトは、WORKDIR=.前提で動作しており、実行場所によっては正しくファイルを参照できない状態でした。

そこで、スクリプト自身の配置場所からリポジトリルートを取得するように修正しました。

SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
PROJECT_ROOT="$(git -C "$SCRIPT_DIR" rev-parse --show-toplevel 2>/dev/null)"

これにより、

  • どのディレクトリから実行しても動作する
  • 相対パス依存を減らせる
  • 他スクリプトから呼び出しやすい

といった改善につながりました。

対話入力の操作性改善

create-spec.shでサーバーの必要項目を対話入力することで、各設定ファイルに値が自動で入力されます。

しかし従来は、

  • 入力ミス時に最初からやり直しになる
  • 矢印キーで編集できない
  • apache / nginx を毎回文字入力する必要がある

など操作性に課題がありました。

そこで今回、

  • read -e -pを利用して履歴編集可能にする
  • Webサーバー種別を番号選択式に変更
  • デフォルト値が存在する場合は Enter のみで採用可能にする
  • バリデーションエラー時は処理終了ではなく再入力へ戻す

といった改善を実施しました。

特に、「入力ミスで最初からやり直しにならない」という点は、利便性向上の効果が大きかった部分です。

また、入力項目についても、設計書上の名称と対話メッセージを可能な限り一致させるよう改善しています。これにより、設計書を見ながら作業する際に、「どの項目を入力すればよいのか」が分かりやすくなりました。

README改善

今回の整備では、READMEについても大きく見直しました。

従来のREADMEは情報量自体は多かったものの、

  • 初見ではどこから実行すればよいか分かりづらい
  • 補足情報が各所に散らばっている
  • HTML出力やcompact実行方法が整理されていない

といった課題がありました。

そこで、

  • READMEを「上から順番に実行すれば動く」構成へ整理
  • Tips系情報を末尾へ集約
  • HTMLレポート確認方法を追加
  • run-serverspec-compactの用途を明示

といった改善を行いました。

特に、Tipsを独立セクション化したことで、

  • 初回セットアップ時に必要な情報
  • 運用中に便利な補助機能

を分離でき、README全体の見通しを改善できました。

まとめ・今後の展望

今回のServerchecker2整備プロジェクトでは、RSpec記法のモダン化だけでなく、運用面・保守面も含めた幅広い改善を行いました。

具体的には、

  • should記法からexpect記法への移行
  • テストコードの可読性向上
  • HTMLレポート対応
  • 独自formatterによるCLI出力改善
  • run-serverspec系コマンドによる実行簡略化
  • シェルスクリプトの保守性・操作性改善
  • READMEの再構成によるオンボーディング改善

など、実際に利用するエンジニアが扱いやすい状態を目指して整備を進めました。

特に今回のプロジェクトでは、

「テストを書くこと」

だけでなく、

「継続的に運用・保守できること」

を強く意識して改善を進めています。

実際の運用では、

  • テストが読みづらい
  • 実行方法が分かりづらい
  • 初見では環境構築に迷う
  • ログが長すぎて原因を追いづらい

といった、“コード以外”の部分が大きな負担になるケースも少なくありません。

そのため今回は、Serverspec本体の修正だけではなく、

  • 実行フロー
  • ドキュメント
  • CLI体験
  • 設定生成フロー

まで含めて改善を行ったことが、大きなポイントでした。

今後は、

  • specのさらなる整理・共通化
  • CI/CDとの連携
  • テスト自動実行基盤の強化
  • HTMLレポートの改善
  • 対話入力スクリプトの追加改善

なども進め、より継続的に運用しやすいサーバー検証基盤へ発展させていきたいと考えています。

​

​