Axlsx でテスト支援

はじめに

「テスト結果の報告書を Excel で作成して提出しなくてはいけない」

そんな状況の中、手作業で Excel を作成されている方はいらっしゃいませんでしょうか? 本稿では、RSpec や Cucumber の自動テストの結果をもとに、Axlsx を使って Excel ファイルのレポートを自動作成をする方法をご紹介したいと思います。

Axlsx って?

Axlsx は Randy Morgan(@morgan_randy) 氏 によって開発されている、Office Open XML Spreadsheet の生成ツールです。 Excel をはじめ、OpenOffice などの各オフィスアプリケーションで閲覧することのできる表計算データを作成することができます。

現在活発に開発が進められており、日々バージョンが上がっています。 本稿での対象とするバージョンは 1.1.8 です。

Axlsx の使い方

さっそくですが、Axlsx をどのように利用すればよいのか、実際に試してみましょう。

まずは Axlsx をインストールしましょう。

 $ gem install axlsx

Bundler を利用する場合は、Gemfile に以下の行を追加してください。

 gem 'axlsx'

これで準備は完了です。 さっそく簡単なサンプルを書いてみましょう。

  • example.rb
   1|require 'axlsx'
   2|
   3|package = Axlsx::Package.new
   4|
   5|worksheet = package.workbook.add_worksheet(name: 'Example')
   6|worksheet.add_row(['Hello', 'World'])
   7|
   8|package.serialize('example.xlsx')

このファイルを実行すると、example.xlsx というファイルが生成されているかと思います。 お手持ちのオフィスアプリケーションで開いてみてください。

example1.png

また、Numbers をお使いの方であれば文字が表示されていないかと思います。 これを解決するためには、文字列を sharedString.xml に保存するようにする必要があります。 Axlsx では以下のように指定します。

   1|# ...
   2|package.use_shared_strings = true # for Numbers
   3|package.serialize('example.xlsx')

なお、本稿では互換性を重視して常にこの指定を行うことにします。

では次に、セルにスタイルをあててみましょう。

   1|package.workbook.styles do |style|
   2|  black = style.add_style(:bg_color => '000000', :fg_color => 'FFFFFF', :sz => 14, :alignment => { :horizontal=> :center })
   3|  worksheet.add_row(['Hello', 'World'], style: black)
   4|end
example2.png

また、画像を貼り付けることもできます。 対応している形式は、PNG, GIF, JPEG の3種類です。

   1|worksheet.add_image(image_src: '/path/to/your/image')

この例では、筆者のアイコン画像を貼り付けてみました。

example3.png

以上、ごく一部ですが Axlsx の簡単な例を試してみました。

また、利用するオフィスアプリケーションによっては、正しく表示されない部分があります。 これについては、Known interoperability issues. に説明があります。

筆者は Numbers'09 バージョン2.2 で検証しています。

テスト支援ツールとしての Axlsx

さて、本稿のテーマは 「Axlsx でテスト支援」です。 ということで、テスト支援のための使い方をご紹介したいと思います。

「テスト結果の報告書を Excel で作成して提出しなくてはいけない」

そんな状況であっても、その Excel ファイルを人間が直接作成するのはあまり好ましい方法とは言えません。できるならば、そのドキュメントはテスト結果から自動で生成したいところです。その提出すべきドキュメントを RSpec や Cucumber のテストから生成できたら気持ちいいと思いませんか?

そこで本稿では、Axlsx を使ってテスト結果を Excel ファイルで生成するための実践的な方法をご紹介します。

RSpec と一緒に使う

まずは RSpec と一緒に使う方法をご紹介します。 対象バージョンは以下です:

  • RSpec (2.11.0)

簡単なテストを作成して、その実行結果を Axlsx でレポート出力してみましょう。 作成するテストは「Array について、初期化された際は中身が空であること」とします。

  • spec/example_spec.rb
   1|# coding: utf-8
   2|describe Array do
   3|  context 'When initialized' do
   4|    it { should be_empty }
   5|  end
   6|end

作成したテストが成功することを確認します。

 $ rspec spec/example_spec.rb

それでは、このテストの実行結果を Axlsx でレポート出力するようにしてみましょう。

  • spec/example_spec.rb
   1|# coding: utf-8
   2|require 'axlsx'
   3|
   4|describe Array do
   5|  context 'When initialized' do
   6|    # テスト実行前にレポート作成の準備をする
   7|    before(:all) do
   8|      @excel = Axlsx::Package.new
   9|      @worksheet = @excel.workbook.add_worksheet(name: 'Array spec')
  10|      @worksheet.add_row(['検証項目', '○/×'])
  11|    end
  12|
  13|    # テスト実行後に成否を取得してレポートに記入する
  14|    after(:each) do
  15|      # テストの検証項目名を取得する
  16|      description = self.example.full_description
  17|      if self.example.metadata[:description].empty?
  18|        description += RSpec::Matchers.generated_description
  19|      end
  20|      # テスト実行時に発生した例外を取得する
  21|      exception = self.example.exception
  22|
  23|      @worksheet.add_row([description, exception ? 'x' : 'o'])
  24|    end
  25|
  26|    # テスト実行後に xlsx ファイルを保存する
  27|    after(:all) do
  28|      @excel.use_shared_strings = true # for Numbers
  29|      @excel.serialize('array_spec.xlsx')
  30|    end
  31|
  32|    it { should be_empty }
  33|  end
  34|end

RSpec の after/before を利用して、すべての検証が終わった後にカレントディレクトリに array_spec.xlsx というファイル名でレポートを生成するよう

それでは、この状態でテストを実行して、レポートが作成されることを確認してみましょう。

 $ rspec spec/example_spec.rb

これで、テストを実行するとレポートが作成されるようになりました。

array_spec.png

しかし、これではテスト自体とは関係の無い処理がテストファイルの中に含まれてしまうため、 新しく検証項目を追加する際に思考を阻害してしまいます。 しかも新しくファイルを追加した際には、その新しいファイルにもレポート生成に関する処理を記述する必要が出てきます。

これは好ましくない状況なので、レポート出力に関する処理はヘルパーに移動させることにしましょう。

  • spec/spec_helper.rb
   1|# coding: utf-8
   2|require 'axlsx'
   3|
   4|RSpec.configure do |config|
   5|  def excel
   6|    @@excel ||= Axlsx::Package.new
   7|  end
   8|
   9|  def worksheet
  10|    @@worksheet ||= excel.workbook.add_worksheet(name: 'Spec')
  11|  end
  12|
  13|  # テスト実行前にレポート作成の準備をする
  14|  config.before(:suite) do
  15|    worksheet.add_row(['検証項目', '○/×'])
  16|  end
  17|
  18|  # テスト実行後に成否を取得してレポートに記入する
  19|  config.after(:each) do
  20|    # テストの検証項目名を取得する
  21|    description = self.example.full_description
  22|    if self.example.metadata[:description].empty?
  23|      description += RSpec::Matchers.generated_description
  24|    end
  25|    # テスト実行時に発生した例外を取得する
  26|    exception = self.example.exception
  27|
  28|    worksheet.add_row([description, exception ? 'x' : 'o'])
  29|  end
  30|
  31|  # テスト実行後に xlsx ファイルを保存する
  32|  config.after(:suite) do
  33|    excel.use_shared_strings = true # for Numbers
  34|    excel.serialize('array_spec.xlsx')
  35|  end
  36|end

これで、テスト本体からレポート出力に関する処理を取り除くことができます。

  • spec/example_spec.rb
   1|require_relative './spec_helper'
   2|
   3|describe Array do
   4|  context 'When initialized' do
   5|    it { should be_empty }
   6|  end
   7|end

こうすることで、レポートに出力するかどうかを意識することなく新しいテストを追加することができます。

RSpec を使ったウェブアプリケーションの受け入れテストで使う

では次に、RSpec を使ったウェブアプリケーションの受け入れテストについてもレポートを作成してみましょう。

受け入れテストは Capybara を利用して作成することにします。 対象バージョンは以下です:

  • Capybara (1.1.2)

まずは、RSpec で Capybara を利用する設定を行います。 さきほど作成した `spec/spec_helper.rb` に以下の内容を追加してください。

  • spec/spec_helper.rb
   1|# coding: utf-8
   2|require 'capybara/dsl'
   3|require 'capybara/rspec'
   4|
   5|Capybara.default_driver = :selenium
   6|
   7|RSpec.configure do |config|
   8|  config.include Capybara::DSL
   9|end

試しに、るびまにアクセスするテストを書いてみましょう。

  • spec/rubima_spec.rb
   1|# coding: utf-8
   2|require_relative './spec_helper'
   3|
   4|describe 'るびま' do
   5|  context 'トップページにアクセスした場合' do
   6|    before do
   7|      visit 'http://jp.rubyist.net/magazine/'
   8|    end
   9|
  10|    it 'タイトルに "るびま" と表示されていること' do
  11|      page.should have_css('h1', text: 'るびま')
  12|    end
  13|  end
  14|end

このテストを実行すると Selenium を利用してるびまにアクセスしコンテンツを検証します。

 $ rspec spec/rubima_spec.rb

レポートの出力は以下のようになります。

rubima_spec.png

せっかくなので、レポートに画面のスクリーンショットも貼り付けることにしましょう。

Capybara のドライバとして Selenium を利用するように設定している場合であれば、現在表示している画面を PNG で出力する機能を使うことができます。 以下のコードを、spec/spec_helper.rb に追加します。

  • spec/spec_helper.rb
   1|require 'mini_magick'
   2|
   3|# ...
   4|
   5|RSpec.configure do |config|
   6|
   7|  # ...
   8|
   9|  def serial_number
  10|    @@serial_number ||= 0
  11|    @@serial_number += 1
  12|  end
  13|
  14|  # テスト実行後にスクリーンショットを取得して xlsx ファイルに貼り付ける
  15|  config.after(:each) do
  16|    spec_number = serial_number
  17|
  18|    image_src = './screenshot_%i.png' % spec_number
  19|    # スクリーンショットを取得する(driver 非互換)
  20|    page.driver.browser.save_screenshot(image_src)
  21|
  22|    # 画像のサイズを取得し設定する
  23|    image_data = MiniMagick::Image.open(image_src)
  24|    excel.workbook.add_worksheet(name: 'Screenshot %s' % spec_number) do |sheet|
  25|      sheet.add_image(image_src: image_src) do |image|
  26|        image.width = image_data[:width]
  27|        image.height = image_data[:height]
  28|      end
  29|    end
  30|  end
  31|end

スクリーンショットを取得する機能は Capybara のドライバ依存なので、別のドライバを利用する際にはそのドライバで用意されているスクリーンショット出力方法を使用してください。 (なお、Capybara 2.0.0 ではスクリーンショット取得用のインターフェースが用意される見込みです: https://github.com/jnicklas/capybara/tree/2.0.0.beta2#debugging )

また Axlsx で画像ファイルを追加する場合、ユーザが画像のサイズを設定する必要があります。 今回は、画像サイズを取得するために MiniMagick を利用しています。 本稿で対象としているバージョンは以下です:

  • MiniMagick (3.4)

これで、スクリーンショット付きのレポートを出力できるようになりました。

rubima_spec2.png

また、CI 環境でテストを実行し、その実行結果を出力することもできます。 その場合には、ヘッドレスで実行できる Capybara のドライバを選択しましょう。 例えば、capybara-webkitpoltergeist が利用可能です。 これらのドライバを利用する場合、スクリーンショットを取得している箇所は以下のメソッドを利用するようにしてください。

 page.driver.render(image_src)

Cucumber と一緒に使う

Cucumber でも、RSpec の場合と同じようにレポートを作成することができます。 対象バージョンは以下です:

  • Cucmber (1.2.1)
  • RSpec (2.11.0)
  • Capybara (1.1.2)
  • MiniMagick (3.4)

まずは、Cucumber を実行するための初期設定をします。

  • features/support/env.rb
   1|# coding: utf-8
   2|require 'capybara/cucumber'
   3|require 'rspec/expectations'
   4|
   5|Capybara.default_driver = :selenium
   6|
   7|World(RSpec::Matchers)

簡単に Cucumber を実行できるよう、Rake タスクを設定しておくこともできます。 Rake タスクの設定については Using Rake - cucumber/cucumber に情報が載っています。

これで、 Cucmber でテストを書く準備が整いました。

それでは、るびまを閲覧できることのフィーチャを書いてみましょう。

  • features/rubima.feature
   1|# coding: utf-8
   2|
   3|Feature: るびまを閲覧できる
   4|  Scenario: るびまのトップページを閲覧できる
   5|    When  webサイト "http://jp.rubyist.net/magazine/" にアクセスする
   6|    Then  ページタイトルが "るびま" であること

このフィーチャを動作させるためのステップ定義は次のようになります。

  • features/step_definitions/steps.rb
   1|# coding: utf-8
   2|
   3|When /^webサイト "(.*?)" にアクセスする$/ do |url|
   4|  visit url
   5|end
   6|
   7|Then /^ページタイトルが "(.*?)" であること$/ do |title|
   8|  page.should have_css('h1', text: title)
   9|end

作成したフィーチャが正しく動作することを確認します。

 $ cucumber

では、ここからレポート出力機能を組み込んでいきましょう。フィーチャを実行後にカレントディレクトリに rubima_features.xlsx というファイル名でレポートを生成するようにします。

  • features/support/env.rb
   1|# coding: utf-8
   2|require 'capybara/cucumber'
   3|require 'rspec/expectations'
   4|
   5|require 'axlsx'
   6|require 'mini_magick'
   7|
   8|Capybara.default_driver = :selenium
   9|
  10|World(RSpec::Matchers)
  11|
  12|def excel
  13|  @@excel ||= Axlsx::Package.new
  14|end
  15|
  16|def worksheet
  17|  @@worksheet ||= excel.workbook.add_worksheet(name: 'Features') do |sheet|
  18|    sheet.add_row(['検証項目', '○/×'])
  19|  end
  20|end
  21|
  22|def serial_number
  23|  @@serial_number ||= 0
  24|  @@serial_number += 1
  25|end
  26|
  27|# スクリーンショットを貼り付ける
  28|After do |scenario|
  29|  spec_number = serial_number
  30|
  31|  image_src = 'screenshot_%i.png' % spec_number
  32|  # スクリーンショットを取得する(driver 非互換)
  33|  page.driver.browser.save_screenshot(image_src)
  34|
  35|  # 画像のサイズを取得し設定する
  36|  image_data = MiniMagick::Image.open(image_src)
  37|  excel.workbook.add_worksheet(name: 'Screenshot %s' % spec_number) do |sheet|
  38|    sheet.add_image(image_src: image_src) do |image|
  39|      image.width = image_data[:width]
  40|      image.height = image_data[:height]
  41|    end
  42|  end
  43|end
  44|
  45|# テスト実行後に成否を取得してレポートに記入する
  46|After do |scenario|
  47|  # テストの検証項目名を取得する
  48|  description = scenario.title
  49|  # テストの成否を取得する
  50|  failed = scenario.failed?
  51|
  52|  worksheet.add_row([description, failed ? '×' : '○'])
  53|end
  54|
  55|# テスト実行後に xlsx ファイルを保存する
  56|at_exit do
  57|  excel.use_shared_strings = true # for Numbers
  58|  excel.serialize('rubima_features.xlsx')
  59|end

レポート出力の処理は RSpec の項で書いたコードとほとんど同じです。 ただ、テスト実行時のフックの書き方が Cucumber と RSpec で異なるので、その部分を Cucmber 用に書き直しています。

それでは、テストを実行して、レポートが作成されることを確認してみましょう。

 $ cucumber

レポートは以下のように出力されます。

rubima_feature1.png

スクリーンショットは以下のように貼付けられます。

rubima_feature2.png

最後に

以上で、本稿は終了となります。 いかがでしたでしょうか。

今回は passed/failure の結果しか表示していませんが、実際に使う場合は pending の結果も表示する必要があるでしょう。 他にも、テスト達成率をグラフで表示したり、テスト失敗時にスタックトレースを表示するなどしてもよいかもしれません。 また、レポートの表示形式もシンプルなものしか試しませんでしたが、レイアウトを工夫したりワークシートの組み方を変えたり、まだまだ改善の余地はあるかと思います。

本稿では、簡単な使い方しかご紹介しませんでしたが、Axlsx にはまだまだ魅力的な機能があります。 ぜひ、 Axlsx に同梱されている example を見てみてください。

さらなるレポートの改善は、読者のみなさまにお任せしたいと思います。 まずは、みなさまのテスト支援の参考としていただければ幸いです。

それでは良いテスト生活を!

著者について

佐藤竜之介(@tricknotes)

Ruby札幌所属、Sapporo.js主催。 札幌在住の Ruby と JavaScript が好きなプログラマ。 GitHub をもっと楽しくつかうためのアプリケーションである NotHub を運営している。

更新日時:2012/08/25 11:00:10
キーワード:
参照:[Rubyist Magazine 0039 号] [Rubyist Magazine 八周年] [0039 号 巻頭言] [分野別目次] [各号目次] [prep-0039]