regressy_common 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b33becacb91404c4b74cba4b84a17bb8af239ea70205faa1177539f34e1e8de
-  data.tar.gz: 5508f6f630780ed103b7692acd9bccd8cccfbc21358b2dd594c1b72df8d44872
+  metadata.gz: c08038e6fb8863b06fc9d27438c8f3dee51a81ed7207d14f5541d4ef772d2722
+  data.tar.gz: ff7a4f43f7a7df2b55852c08e1b5c73e44fc26ad3105773ffd63805edb441aae
 SHA512:
-  metadata.gz: e11891a7e83fcde8c3b0a0bb8c4d7ca3300ccb23efca04657c083fa4a6e8449bad53a96bd1ad2627285e03879d6e289903db3ec51f62815a082a49ed709b1b22
-  data.tar.gz: 2350e4dedc1a4336ec6de5ed0d531f3677f853389f4e5b3052bbba7a7fcf5290d99733f2c3b77085a6c2d3815c3568adc8b70d2e39800c23ec1328530f9f2c5d
+  metadata.gz: a0bbfe572699a1bfa37cd1be4028d1b14d15233786296302f12951f01456e14d417ac8049ce16e8e0e5aa60e98565f8794e01bb666a72a3dde45bc25041c7f54
+  data.tar.gz: 9a7017a75b8e7bd7843589c5bbb6e6275e0fdde060d570b1cd6e1c27baee7a360bfcee40ab325bcdd54d68e54af3fa56a351a2daae907c431cfcca2ea5fcf313

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    regressy_common (1.4.0)
+    regressy_common (1.4.1)
       activesupport (~> 6.0.1)
       appium_lib (~> 10.5.0)
       httpclient (~> 2.8.3)

data/README.md

@@ -1,12 +1,12 @@
 # RegressyCommon
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/regressy_common`. To experiment with that code, run `bin/console` for an interactive prompt.
+RegressyCommonは、[Regressy](https://regressy.fluxware.jp)でe2eテストを構築するためのライブラリです。
 
-TODO: Delete this and the text above, and describe your gem
+Ruby言語とtest-unitフレームワークを利用して、e2eテストを構築します。
 
-## Installation
+## インストール
 
-Add this line to your application's Gemfile:
+Gemfileに追加し、bundleを実行します。
 
 ```ruby
 gem 'regressy_common'
@@ -20,9 +20,180 @@ Or install it yourself as:
 
     $ gem install regressy_common
 
-## Usage
+## 使い方
+
+RegressyCommonは、ページオブジェクトモデルに基づくe2eテスト構築を支援するライブラリです。
+
+ページオブジェクト、テストセット、テストスイートでテスト全体を構成します。
+
+### ディレクトリ構成
+
+ディレクトリ構成の例を以下に示します。
+
+```
+your-e2e-project
+├── app
+│   ├── pages        # ここにページオブジェクトを格納します。
+│   ├── test_sets    # ここにテストセットを格納します。
+│   ├── test_suites  # ここにテストスイートを格納します。
+│   :
+└── config
+```
+
+- ページオブジェクト: テスト対象サイトのページに対応するオブジェクト。
+  1ページに対して1オブジェクトが対応します。
+- テストセット: 関連した一連のテストの集合。
+  test-unit における TestCaseに相当。
+  ここで定義したテストからページオブジェクトを操作し、テストを実行します。
+- テストスイート: 関連した一連のテストセットの集合。
+  ここで定義したテストスイートから、関連するテストセットを操作します。
+
+## ページオブジェクト
+
+- ページを司るオブジェクトです。
+- テスト対象のサイトを構成する1ページに対して1オブジェクトを定義します。
+- 以下にページオブジェクトの基底クラスを例示します。
+
+```ruby
+require 'test/unit'
+require 'regressy_common'
+module Pages
+  class Base
+    include Test::Unit::Assertions
+    include RegressyCommon::Checker
+    include RegressyCommon::Clicker
+    include RegressyCommon::Sender
+    include RegressyCommon::Selector
+
+    def initialize(test_case)
+      @test_case   = test_case
+      @driver      = test_case.driver
+      @target_host = test_case.target_host
+    end
+
+    def logger
+      RegressyCommon::Utils::StandardLogger.instance
+    end
+
+    def take_snap(tag=nil)
+      tag ||= %(#{self.class.name}##{caller_locations(1).first.label})
+      RegressyCommon::SnapShot.new(@driver, tag).take_and_store
+    end
+
+    def set_window_size
+      @driver.manage.window.resize_to(1600, 1024)
+    end
+
+    def access_to_target_page
+      @driver.get(page_url)
+      assert_element_exists(:xpath, xpath_page_title)
+    end
+
+    protected
+
+    def page_url
+      raise "should implement this method"
+    end
+    def xpath_page_title
+      raise "should implement this method"
+    end
+  end
+end
+```
+
+- そして、基底クラスを継承するページクラス。
+
+```ruby
+require 'pages/base'
+class Pages::Index < Pages::Base
+
+  def execute_search(word)
+    assert_element_present(:xpath, xpath_search_input )
+    send_keys(:xpath, xpath_search_input, word)
+    retry_click(:xpath, xpath_search_submit)
+    assert_element_present(:xpath, xpath_search_result)
+  end
+
+  protected
+
+  def page_url
+    %(#{@test_case.target_host}/)
+  end
+  def xpath_page_title
+    %(//title[contains(text(), "Yahoo! JAPAN")])
+  end
+  def xpath_search_input
+    %(//input[@type="search"])
+  end
+  def xpath_search_submit
+    %(//button[@type="submit"])
+  end
+  def xpath_search_result
+    %(//a[contains(@href, "regressy")])
+  end
+end
+```
+
+## テストセット
+
+- テストの例。
+```ruby
+require 'regressy_common'
+require 'pages/index'
+class SampleTest < RegressyCommon::TestSets::Base
+  def setup
+    @target_host = 'https://yahoo.co.jp'
+    super
+  end
+  def test_01_search
+    index_page = Pages::Index.new(self)
+    index_page.access_to_target_page
+    index_page.take_snap
+
+    index_page.execute_search("regressy")
+  end
+end
+```
+
+## テストスイート
+
+- テストスイートの例。
+```
+require 'test/unit'
+require 'test/unit/testsuite'
+require 'test/unit/ui/console/testrunner'
+require 'test_sets/sample_test'
+
+regression_test = Test::Unit::TestSuite.new("regression test")
+regression_test << SampleTest.suite  # default local chrome
+regression_test << SampleTest.suite_with_capability(:local_firefox)
+
+Test::Unit::UI::Console::TestRunner.run(regression_test)
+```
+ここで、ブラウザの種類を指定します。
+
+## テストの実行
+
+```
+# ruby app/test_suites/regression_test.rb
+Loaded suite regression test
+Started
+..
+Finished in 33.660497466 seconds.
+-----------------------------------------------------------------------------------------------------------------------
+2 tests, 8 assertions, 0 failures, 0 errors, 0 pendings, 0 omissions, 0 notifications
+100% passed
+-----------------------------------------------------------------------------------------------------------------------
+0.06 tests/s, 0.24 assertions/s
+```
+
+## ページオブジェクトで使用する共通機能
+
+- checker
+- clicker
+- sender
+- selector
 
-TODO: Write usage instructions here
 
 ## Development
 

data/lib/regressy_common/utils/standard_logger.rb

@@ -2,7 +2,7 @@ require "logger"
 module RegressyCommon
   module Utils
     module StandardLogger
-      @@logger = Logger.new(STDOUT)
+      @@logger ||= Logger.new(STDOUT)
       def self.instance
         @@logger
       end

data/lib/regressy_common/version.rb

@@ -1,3 +1,3 @@
 module RegressyCommon
-  VERSION = "1.4.0"
+  VERSION = "1.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: regressy_common
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - info@fluxware.co.jp
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-17 00:00:00.000000000 Z
+date: 2019-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient