ruby_raider 0.7.4 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a03654b03c3ef053dc6816511268f25dbf4e9ce657b1753f724bb3c5143ad1fa
-  data.tar.gz: cd0225ec4cd76957d01f144965471e1a8bf9173ca231bd8cbdad36b37ba9c5bf
+  metadata.gz: a3c7392870379f23c003129b0c892eeb60cfd87fe7d0479e42670cfd9b20fc13
+  data.tar.gz: b09e4169504207c2af34d0a0a0f5846ab370c9df62cd1e350daf747c4980e1c9
 SHA512:
-  metadata.gz: 4aff557676479e52920b19bce5d9e7bd5b5dfe70b6ba44cfe1a433c3367bb60f399abd3f1f7800dae85c51e1223f26866aa9ee7025ecda23e19ba93b6a42ffd2
-  data.tar.gz: 0f4e485e1d0b8270ef9e5a250abf0e3afcc2af50d7526387c89fc32b863ff6f6671dbd4bcc505faf659a9329eb4d2da88d86761236e693b5bc8041c2d079b904
+  metadata.gz: fc2e7a690f3ba2c6f23d2344ad7e634e4046bdfb7da082f4522f0a3736650f32767ac5ad8484649c26df8499624ba522e8f8b2f58122f42debcd54dae87c90bf
+  data.tar.gz: 2e12ed98a785fcee9f22310d4ead6b8de730eea67c092d319c183c5a1051c1317345186b14669e0f417cbe0ab4827390b2e49729704b779e1cb7e04e16305a3a

data/README.md

@@ -57,6 +57,7 @@ Ruby Raider is a generator and scaffolding gem to make UI test automation easier
 * Generating a visual testing framework with Cucumber, Applitools and Selenium
 
 ***In order to run the Appium tests, download the example [app](https://github.com/saucelabs/my-demo-app-rn).***
+***Remember to use the full path of the app that you download in the capabilities file***
 
 ***In order to run the visual tests with applitools, you need to create an account and get your api key, you can read
 more [here](https://applitools.com/docs/topics/overview/obtain-api-key.html#:~:text=If%20you%20already%20have%20an,Your%20key%20will%20be%20displayed.)

data/lib/generators/automation/templates/abstract_page.tt

@@ -1,3 +1,19 @@
+<%- if automation == 'sparkling_ios' -%>
+require 'sparkling_watir/element'
+
+class AbstractPage
+
+  attr_reader :app
+
+  def initialize(app)
+    @app = app
+  end
+
+  def to_s
+    self.class.to_s.sub('Page', ' Page')
+  end
+end
+<%- else -%>
 class AbstractPage
 <% if automation == 'cross_platform' -%>
   include AppiumHelper
@@ -10,3 +26,4 @@ class AbstractPage
     self.class.to_s.sub('Page', ' Page')
   end
 end
+<%- end -%>

data/lib/generators/automation/templates/appium_caps.tt

@@ -1,4 +1,4 @@
-<% if automation == 'ios' %>
+<% if automation.include?('ios') %>
 <%= ERB.new(File.read(File.expand_path('./partials/ios_caps.tt', __dir__))).result(binding) -%>
 <% elsif automation == 'android' %>
 <%= ERB.new(File.read(File.expand_path('./partials/android_caps.tt', __dir__))).result(binding) -%>

data/lib/generators/automation/templates/home_page.tt

@@ -1,7 +1,24 @@
 # frozen_string_literal: true
 
 require_relative '../abstract/abstract_page'
+<%- if automation == 'sparkling_ios' -%>
+class HomePage < AbstractPage
+
+  # Actions
 
+  def go_to_backpack_pdp
+    app.tap on: backpack_image.wait_until(&:present?)
+  end
+
+  private
+
+  # Elements
+
+  def backpack_image
+    app.element(predicate: 'label == "Sauce Labs Backpack"')
+  end
+end
+<%- else -%>
 class HomePage < AbstractPage
 
   # Actions
@@ -18,3 +35,4 @@ class HomePage < AbstractPage
     <%= ERB.new(File.read(File.expand_path('./partials/home_page_selector.tt', __dir__)), trim_mode: '-').result(binding) %>
   end
 end
+<%- end -%>

data/lib/generators/automation/templates/partials/android_caps.tt

@@ -1,5 +1,7 @@
-automationName: UiAutomator2
 platformName: Android
-deviceName: Nexus_7_API_33
-app: "Android-MyDemoAppRN.1.3.0.build-244.apk"
-autoGrantPermissions: true
+appium:options:
+  url: http://localhost:4723/wd/hub
+  platformVersion: '12'
+  automationName: UiAutomator2
+  deviceName: Pixel 3 API 32
+  app: "Android-MyDemoAppRN.1.3.0.build-244.apk"

data/lib/generators/automation/templates/partials/cross_platform_caps.tt

@@ -1,14 +1,15 @@
 android:
-  automationName: UiAutomator2
   platformName: Android
-  deviceName: Nexus_7_API_33
-  app: "Android-MyDemoAppRN.1.3.0.build-244.apk"
-  autoGrantPermissions: true
-
+  appium:options:
+    platformVersion: '12'
+    automationName: UiAutomator2
+    deviceName: Pixel 3 API 32
+    app: "Android-MyDemoAppRN.1.3.0.build-244.apk"
 ios:
-  automationName: XCUITest
   platformName: iOS
-  platformVersion: "15.5"
-  deviceName: iPhone 11
-  app: "MyRNDemoApp.app"
-  autoDismissAlerts: true
+  appium:options:
+    platformVersion: "14.0"
+    deviceName: iPhone 11
+    automationName: XCUITest
+    app: "MyRNDemoApp.app"
+    autoDismissAlerts: true

data/lib/generators/automation/templates/partials/ios_caps.tt

@@ -1,6 +1,8 @@
-automationName: XCUITest
 platformName: iOS
-platformVersion: "15.5"
-deviceName: iPhone 11
-app: "MyRNDemoApp.app"
-autoDismissAlerts: true
+appium:options:
+  url: http://localhost:4723/wd/hub
+  platformVersion: "14.0"
+  deviceName: iPhone 11
+  automationName: XCUITest
+  app: "MyRNDemoApp.app"
+  autoDismissAlerts: true

data/lib/generators/automation/templates/pdp_page.tt

@@ -1,4 +1,22 @@
 require_relative '../abstract/abstract_page'
+<%- if automation == 'sparkling_ios' -%>
+class PdpPage < AbstractPage
+
+  # Actions
+
+  def add_to_cart_text
+    add_to_cart_button.wait_until(&:present?).text
+  end
+
+  private
+
+  # Elements
+
+  def add_to_cart_button
+    app.element(accessibility_id: 'Add To Cart button')
+  end
+end
+<%- else -%>
 
 class PdpPage < AbstractPage
 
@@ -16,3 +34,4 @@ class PdpPage < AbstractPage
     <%= ERB.new(File.read(File.expand_path('./partials/pdp_page_selector.tt', __dir__)), trim_mode: '-').result(binding) %>
   end
 end
+<%- end -%>

data/lib/generators/common_generator.rb

@@ -8,7 +8,7 @@ class CommonGenerator < Generator
   end
 
   def generate_config_file
-    return if mobile?
+    return if single_platform?
 
     template('common/config.tt', "#{name}/config/config.yml")
   end

data/lib/generators/cucumber/templates/partials/appium_env.tt

@@ -1,3 +1,19 @@
+<%- if automation == 'sparkling_ios' -%>
+require_relative '../../helpers/driver_helper'
+
+include DriverHelper
+
+Before do
+  AllureHelper.configure
+  app
+end
+
+After do |scenario|
+  app.screenshot.save("allure-results/screenshots/#{scenario.name}.png")
+  AllureHelper.add_screenshot(scenario.name)
+  app.close
+end
+<%- else -%>
 require_relative '../../helpers/driver_helper'
 
 include DriverHelper
@@ -11,4 +27,5 @@ After do |scenario|
   driver.screenshot("allure-results/screenshots/#{scenario.name}.png")
   AllureHelper.add_screenshot(scenario.name)
   driver.quit_driver
-end
+end
+<%- end -%>

data/lib/generators/cucumber/templates/partials/mobile_steps.tt

@@ -1,3 +1,22 @@
+<%- if automation == 'sparkling_ios' -%>
+# frozen_string_literal: true
+
+require_relative '../../page_objects/pages/home_page'
+require_relative '../../page_objects/pages/pdp_page'
+
+Given("I'm an anonymous user on the home page") do
+    @home_page = HomePage.new(app)
+end
+
+When('I select one of the products') do
+    @home_page.go_to_backpack_pdp
+end
+
+When("I'm redirected to the product details page") do
+    pdp_page = PdpPage.new(app)
+    expect(pdp_page.add_to_cart_text).to eq 'Add To Cart'
+end
+<%- else -%>
 # frozen_string_literal: true
 
 require_relative '../../page_objects/pages/home_page'
@@ -15,3 +34,4 @@ When("I'm redirected to the product details page") do
     pdp_page = PdpPage.new(driver)
     expect(pdp_page.add_to_cart_text).to eq 'Add To Cart'
 end
+<%- end -%>

data/lib/generators/generator.rb

@@ -29,7 +29,11 @@ class Generator < Thor::Group
   end
 
   def mobile?
-    (args & %w[android ios cross_platform]).count.positive?
+    (args & %w[android ios cross_platform sparkling_ios]).count.positive?
+  end
+
+  def single_platform?
+    (args & %w[android ios sparkling_ios]).count.positive?
   end
 
   def rspec?

data/lib/generators/menu_generator.rb

@@ -19,6 +19,7 @@ class MenuGenerator
     prompt.select('Please select your automation framework') do |menu|
       menu.choice :Appium, -> { choose_test_framework('appium') }
       menu.choice :Selenium, -> { choose_test_framework('selenium') }
+      menu.choice 'Sparkling Watir', -> { choose_test_framework('sparkling') }
       menu.choice :Watir, -> { choose_test_framework('watir') }
       menu.choice :Quit, -> { exit }
     end
@@ -30,6 +31,7 @@ class MenuGenerator
 
   def choose_test_framework(automation)
     return choose_mobile_platform if automation == 'appium'
+    return choose_sparkling_platform if automation == 'sparkling'
 
     select_test_framework(automation)
   end
@@ -45,6 +47,13 @@ class MenuGenerator
     system "cd #{name} && gem install bundler && bundle install"
   end
 
+  def choose_sparkling_platform
+    prompt.select('Please select your mobile platform') do |menu|
+      menu.choice :iOS, -> { choose_test_framework 'sparkling_ios' }
+      menu.choice :Quit, -> { exit }
+    end
+  end
+
   def choose_mobile_platform
     prompt.select('Please select your mobile platform') do |menu|
       menu.choice :iOS, -> { choose_test_framework 'ios' }

data/lib/generators/rspec/templates/spec.tt

@@ -42,12 +42,29 @@ describe 'Login' do
     end
   end
 end
+<%- elsif automation == 'sparkling_ios' -%>
+require_relative '../helpers/spec_helper'
+require_relative '../page_objects/pages/home_page'
+require_relative '../page_objects/pages/pdp_page'
+
+class PdpSpec
+  describe 'PDP page' do
+
+    let(:home_page) { HomePage.new(app) }
+    let(:pdp_page) { PdpPage.new(app) }
+
+    it 'shows add to cart button' do
+      home_page.go_to_backpack_pdp
+      expect(pdp_page.add_to_cart_text).to eq 'Add To Cart'
+    end
+  end
+end
 <%- else -%>
 require_relative '../helpers/spec_helper'
 require_relative '../page_objects/pages/home_page'
 require_relative '../page_objects/pages/pdp_page'
 
-class PdpSpec < BaseSpec
+class PdpSpec
   describe 'PDP page' do
 
     let(:home_page) { HomePage.new(driver) }

data/lib/generators/templates/common/gemfile.tt

@@ -30,3 +30,6 @@ gem 'ruby_raider', '~> 0.7.0'
 <% if %w[selenium watir].include? automation -%>
 gem 'webdrivers'
 <% end -%>
+<% if automation == 'sparkling_ios' -%>
+gem 'sparkling_watir'
+<% end -%>

data/lib/generators/templates/common/read_me.tt

@@ -53,6 +53,7 @@ Ruby Raider is a generator and scaffolding gem to make UI test automation easier
 * Generating a visual testing framework with Cucumber, Applitools and Selenium
 
 ***In order to run the Appium tests, download the example [app](https://github.com/saucelabs/my-demo-app-rn).***
+***Remember to use the full path of the app that you download in the capabilities file***
 
 ***In order to run the visual tests with applitools, you need to create an account and get your api key, you can read
 more [here](https://applitools.com/docs/topics/overview/obtain-api-key.html#:~:text=If%20you%20already%20have%20an,Your%20key%20will%20be%20displayed.)

data/lib/generators/templates/helpers/driver_helper.tt

@@ -1,3 +1,25 @@
+<%- if automation == 'sparkling_ios' -%>
+# frozen_string_literal: true
+require 'yaml'
+require 'sparkling_watir'
+
+module DriverHelper
+    def app
+      @app ||= create_app
+    end
+
+  private
+
+  def create_app
+    @app = SparklingWatir::App.new(caps: caps)
+  end
+
+  # :reek:UtilityFunction
+  def caps
+    YAML.load_file('config/capabilities.yml')
+  end
+end
+<%- else -%>
 # frozen_string_literal: true
 require 'yaml'
 <% if automation == 'selenium' -%>
@@ -29,3 +51,4 @@ module DriverHelper
   end
 <%- end -%>
 end
+<%- end -%>

data/lib/generators/templates/helpers/spec_helper.tt

@@ -1,3 +1,30 @@
+<%- if automation == 'sparkling_ios' -%>
+# frozen_string_literal: true
+
+require 'rspec'
+require_relative 'allure_helper'
+require_relative 'driver_helper'
+require 'sparkling_watir'
+
+module SpecHelper
+
+  AllureHelper.configure
+  RSpec.configure do |config|
+    config.formatter = AllureHelper.formatter
+    config.include(DriverHelper)
+    config.before(:each) do
+      app
+    end
+
+    config.after(:each) do
+      example_name = self.class.descendant_filtered_examples.first.description
+      app.screenshot.save("allure-results/screenshots/#{example_name}.png")
+      AllureHelper.add_screenshot example_name
+      app.close
+    end
+  end
+end
+<%- else -%>
 # frozen_string_literal: true
 
 require 'rspec'
@@ -27,4 +54,5 @@ module SpecHelper
       <%= ERB.new(File.read(File.expand_path('./partials/quit_driver.tt', __dir__)), trim_mode: '-').result(binding).strip! %>
     end
   end
-end
+end
+<%- end -%>

data/ruby_raider.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'ruby_raider'
-  s.version     = '0.7.4'
+  s.version     = '0.7.6'
   s.summary     = 'A gem to make setup and start of UI automation projects easier'
   s.description = 'This gem has everything you need to start working with test automation'
   s.authors     = ['Agustin Pequeno']

data/spec/common_generator_spec.rb

@@ -107,12 +107,12 @@ describe CommonGenerator do
   context 'with cucumber and appium cross platform' do
     include_examples 'creates common files', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
     include_examples 'creates a capabilities file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
-    include_examples "doesn't create a config file", "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
+    include_examples 'creates a config file', "#{FRAMEWORKS.first}_#{AUTOMATION_TYPES.last}"
   end
 
   context 'with rspec and appium cross platform' do
     include_examples 'creates common files', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
     include_examples 'creates a capabilities file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
-    include_examples "doesn't create a config file", "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
+    include_examples 'creates a config file', "#{FRAMEWORKS.last}_#{AUTOMATION_TYPES.last}"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_raider
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.7.6
 platform: ruby
 authors:
 - Agustin Pequeno
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-06-11 00:00:00.000000000 Z
+date: 2023-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv