Moose: The Facts And The Myths

gem 'moose'

Moose.configure do |config|

  # HOOKS
  config.add_before_run_hook do |moose|
    puts "in base config before run hook"
  end

  config.add_after_run_hook do |moose|
    puts "in base config before run hook"
  end

  config.before_each_test_case do |test_case|
    puts "in base config before test case hook"
  end

  config.after_each_test_case do |test_case|
    puts "in base config after test case hook"
  end

  config.around_each_test_case do |test_case, blk|
    puts "in base config around test case hook before call"
    blk.call
    puts "in base config around test case hook after call"
  end

  # OPTIONS
  # DEFAULTS ARE:
  #   config.verbose #=> false,
  #   config.snapshot_directory #=> "snapshots",
  #   config.snapshots #=> false,
  #   config.moose_test_group_directory_pattern #=> "test_groups/**",
  #   config.suite_pattern #=> "*_suite/",
  #   config.run_in_threads #=> false,
  #   config.test_thread_count #=> 5,
  #   config.headless #=> false,
  #   config.browser #=> :chrome,
  #   config.rerun_failed #=> false,
  #   config.show_full_error_backtrace #=> false,
  #   config.test_status_persistence_directory #=> nil,
  #   config.verify_test_case_definition #=> true,
  #   config.status_file_prefix #=> nil,

  config.verbose = true
  config.run_in_threads = true
  config.test_thread_count = 5
  config.test_status_persistence_directory = File.expand_path("tmp", __FILE__)
end

Moose.configure do |config|

  config.configure_msg do |msg_config|
    # OPTIONS
    # DEFAULTS ARE:
    #   msg_config.failure_font_color #=> :white,
    #   msg_config.failure_background_color #=> :red,
    #   msg_config.pass_font_color #=> :white,
    #   msg_config.pass_background_color #=> :green,
    #   msg_config.pending_font_color #=> :white,
    #   msg_config.pending_background_color #=> :magenta,
    #   msg_config.skipped_font_color #=> :white,
    #   msg_config.skipped_background_color #=> :light_red,
    #   msg_config.incomplete_font_color #=> :white,
    #   msg_config.incomplete_background_color #=> :yellow,
    #   msg_config.invert_font_color #=> :white,
    #   msg_config.invert_background_color #=> :black,
    #   msg_config.name_font_color #=> :white,
    #   msg_config.name_background_color #=> :cyan,
    #   msg_config.case_description_font_color #=> :cyan,
    #   msg_config.banner_font_color #=> :blue,
    #   msg_config.info_font_color #=> :blue,
    #   msg_config.header_font_color #=> :cyan,
    #   msg_config.warn_font_color #=> :yellow,
    #   msg_config.error_font_color #=> :red,
    #   msg_config.step_font_color #=> :yellow,
    #   msg_config.dot_font_color #=> :yellow,


    msg_config.info_font_color = :green
  end
end

Moose.configure_suite do |config|
  # REGISTER ENVIRONMENTS

  [
    {
      :beta => {
        :base_url => "https://beta.example.com",
        :api_token =>  "abcde-12345"
      }
    },
    {
      :alpha => {
        :base_url => "https://alpha.example.com",
        :api_token =>  "12345-abcde"
      }
    },
  ].each do |environment, environment_details|
    config.register_environment(environment, environment_details)
  end


  # HOOKS

  config.before_each_test_case do |test_case|
    puts "in suite before test case hook"
  end

  config.after_each_test_case do |test_case|
    puts "in suite after test case hook"
  end

  config.around_each_test_case do |test_case, blk|
    puts "in suite around test case hook before call"
    blk.call
    puts "in suite around test case hook after call"
  end

  config.add_before_suite_hook do |test_suite|
    puts "in suite before suite hook"
  end

  config.add_after_suite_hook do |test_suite|
    puts "in suite after suite hook"
  end
end

Moose.configure_test_group do |config|
  config.add_before_hook do |test_case|
    puts "in test case before hook"
  end

  config.add_after_hook do |test_case|
    puts "in test case after hook"
  end

  config.add_around_hook do |test_case, blk|
    puts "in around test case hook before call"
    blk.call
    puts "in around test case hook after call"
  end

  #OPTIONS
  config.run_in_threads = true # Default nil
end

Moose.define_test_case do
  # test case logic goes here
  # test case should try and use Flows for the logic
end

require_relative '../menu/user_menu_section.rb'
module Application
  module Home
    class SearchPage < Moose::Page::Full
      self.path '/search'
      element(:a_element) { browser.a(:id, 'link_somewhere') }
      section(:search_results, Application::Home::SearchRestultSection) { browser }
      section(:different_name_space, Application::Menu::UserMenuSection) { browser.div(id: "user-menu-section") }
      def click_on_a
        a_element.click
      end

      def click_on_result
        search_results.result.click
      end
    end
  end
end

require_relative '../menu/user_menu_section.rb'
module Application
  module Home
    class SearchPage < Moose::Page::Full
      self.path '/search'

      # This method will be the overridable path for this specific run
      def _path
        original_path = super
        return original_path unless ENV["SEARCH_PAGE_PARAMS"]
        original_path + "?#{ENV['SEARCH_PAGE_PARAMS']}"
      end
    end
  end
end

module Application
  module Home
    class SearchResultSection < Moose::Page::Section
      element(:result) { browser.a(:id, 'result_1') }
    end
  end
end

module Application
  module Home
    class SearchFlow < Moose::Flow
      # :browser is always a required initiliazing attribute
      page(:search_page, Application::Home::SearchPage)

      def initialize(test_case:)
        @test_case = test_case
      end

      def open_link
        search_page.click_on_a
      end

    end
  end
end

# Instantiating a Flow

Application::Home::SearchFlow.new(
  :browser => browser
  :test_case => 'Search test case'
)

module Application
  module Home
    class SearchFlow < Moose::Flow
      def fill_in_search
        wait_until do
          search_page.search_box_present?
        end
      end
    end
  end
end

module Application
  module Home
    class SearchFlow < Moose::Flow
      def fill_in_search
        maybe_block do |maybe|
          maybe.on_success do # optional
            search_page.fill_in_search_box
          end

          maybe.on_failure do # optional
            puts "oh no the search box was never found"
          end

          maybe.loop_over do # required
            search_page.search_box_present?
          end
        end
      end
    end
  end
end

Moose.define_test_case do
  browser # will return the latest browser or spin up new browser
  new_browser # spins up a new browser
  new_browser(:browser => :firefox) # spins up a new firefox browser
  new_browser(:headless => true) # spins up a headless browser
  browser(index: 0) # will return first browser

  run_as(OTHER_SUITE_NAME) do |suite_instance, test_case, suite_browser|

  end

  # run block without browser
  run_as(API_SUITE_NAME, :needs_browser => false) do |suite_instance, test_case|

  end
end

Moose.define_test_case do
  ...
  short_circuit! :incomplete, "Message for why here" # possible values [:incomplete, :fail, :pass, :skipped, :pending]

  run_as(OTHER_SUITE_NAME) do |suite_instance, test_case, suite_browser|

  end
  ...
end