mixpaneltesting 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 092af6d2591ed376475a1341d7e15c156c367514
+  data.tar.gz: e785e205cdecfff7434f7f0459b01d50cc43cfcf
+SHA512:
+  metadata.gz: c2fdb697bd0a79c76cc9a4e60fb236c9d45e0730c3ca5eb18313de843e75c56d57b44d49347783deef8b912432c9ee3dd81f354eecc8ecb88f0162b7bd339c2a
+  data.tar.gz: 9d4298732c0bc9080c518ed61362759320f391bc9985bc3b53b478ddd510e2950ef36369a02724266631daf6d34fe7d346e7d732d20a5e165641530e477c8888

data/lib/mixpaneltesting.rb

@@ -0,0 +1,57 @@
+require 'yaml'
+require 'erb'
+
+require 'mixpaneltesting/version'
+require 'mixpaneltesting/selenium'
+require 'mixpaneltesting/mixpanel'
+require 'mixpaneltesting/docker'
+require 'mixpaneltesting/localsite'
+require 'mixpaneltesting/rspec_context'
+
+module MixpanelTesting
+
+  class MixpanelTesting
+
+    def self.version
+      puts MixpanelTesting::VERSION
+    end
+
+  end
+
+  class Settings
+    @@generic_timeout = 20
+    @@generic_mixpanel_api_key = nil
+    @@generic_mixpanel_api_secret = nil
+
+    def self.timeout
+      @@generic_timeout
+    end
+
+    def self.mixpanel_api_key
+      @@generic_mixpanel_api_key
+    end
+
+    def self.mixpanel_api_secret
+      @@generic_mixpanel_api_secret
+    end
+
+
+    def self.load_settings(file)
+
+      settings = YAML.load(
+        ERB.new(
+          File.read(
+            RSpec.configuration.mixpanelfilesettings
+          )
+        ).result
+      )
+
+      @@generic_mixpanel_api_key = settings['mixpanel']['api_key']
+      @@generic_mixpanel_api_secret = settings['mixpanel']['api_secret']
+      @@generic_timeout == settings['generic_timeout'] if
+        settings['generic_timeout']
+
+    return settings
+    end
+  end
+end

data/lib/mixpaneltesting/docker.rb

@@ -0,0 +1,97 @@
+require 'docker'
+require 'excon'
+require 'uri'
+
+
+module MixpanelTesting
+
+  class DockerProviderBrowserNotAvailable < StandardError
+  end
+
+  class DockerProvider
+
+    def initialize(browser, version=nil, debug=false)
+      if !['firefox', 'chrome'].include?(browser)
+        raise DockerProviderBrowserNotAvailable, "#{browser} not available"
+      end
+
+      @log = Logger.new(STDOUT)
+      @docker_uri = URI(ENV['DOCKER_HOST'])
+      @browser = browser
+      @debug = debug
+      @version = version.nil? ? "" : ":#{version}"
+      @image_name = (@debug ?
+                      "selenium/standalone-#{@browser}-debug#{@version}" :
+                      "selenium/standalone-#{@browser}#{@version}")
+
+      @threads = []
+
+      @log.info ["Creating selenium docker, if you don't see Docker started",
+                 "message, try to remove mixpaneltesting docker with:",
+                 "docker rm -rf mixpaneltesting"].join('/n')
+      # This settings is fully wired for boot2docker/docker-machines
+      # We should change this to make compatible with other
+      @container = Docker::Container.create(
+        'Image' => @image_name,
+        'name' => 'mixpaneltesting',  # Name given for helping with debug
+        'ExposedPorts' => {
+          '4444/tcp' => {},
+          '5900/tcp' => {},
+        },
+        'HostConfig' => {
+          'PortBindings' => {
+            '4444/tcp' => [{ 'HostPort' => '4444'}], # Selenium Port
+            '5900/tcp' => [{ 'HostPort' => '5900'}], # VNC Port for everyone
+          }
+        },
+        "OomKillDisable": false,
+      )
+
+    end
+
+    def start
+      @container.start
+
+      (1..Settings.timeout).each { |i|
+        sleep 1
+        @log.info "Waiting to docker ready: #{i}"
+        break if ready?
+      }
+      @log.info "Docker started"
+
+      open_vnc if @debug
+    end
+
+    def kill
+      @container.kill!
+      @container.delete(:force => true)
+
+      @threads.each { |thr|
+        @log.info "Killing thread"
+        thr.exit
+      }
+    end
+
+    def ready?
+      puts selenium_uri
+      Excon.get(selenium_uri).status == 302 rescue false
+    end
+
+    def selenium_uri
+      "http://#{@docker_uri.host}:4444/wd/hub"
+    end
+
+    def vnc_uri
+      "vnc://:secret@#{@docker_uri.host}:5900"
+    end
+
+    def open_vnc
+      @threads.push Thread.new {
+        `open #{vnc_uri}`
+      }
+    end
+
+  end
+
+end
+

data/lib/mixpaneltesting/localsite.rb

@@ -0,0 +1,40 @@
+require 'excon'
+
+
+module MixpanelTesting
+
+  class LocalSiteProvider
+
+    def initialize(cmd, uri)
+      @cmd = cmd
+      @uri = uri
+      @timeout = Settings.timeout
+      @log = Logger.new(STDOUT)
+      @pid = nil
+    end
+
+    def start
+      @pid = Process.spawn @cmd
+      puts "Spawn #{@cmd} with pid #{@pid}"
+
+      (1..@timeout).each { |i|
+        sleep 1
+        break if ready?
+      }
+      @log.info "Site should be available on #{@uri}"
+    end
+
+    def kill
+      return nil if @pid.nil?
+      @log.info "Killing subprocess with localsite"
+      Process.kill('KILL', @pid)
+    end
+
+    def ready?
+      !Excon.get(@uri).status.nil? rescue false
+    end
+
+  end
+
+end
+

data/lib/mixpaneltesting/mixpanel.rb

@@ -0,0 +1,111 @@
+require 'logger'
+require 'json'
+
+require 'mixpanel_client'
+
+module MixpanelTesting
+
+  class MixpanelProvider
+
+    def initialize(session_id)
+      @log = Logger.new(STDOUT)
+      @log.info "Login at Mixpanel: #{Settings.mixpanel_api_key}"
+      @client = Mixpanel::Client.new(
+        api_key: Settings.mixpanel_api_key,
+        api_secret: Settings.mixpanel_api_secret
+      )
+      @today = Date.today.strftime("%Y-%m-%d")
+      @yesterday = (Date.today - 1).strftime("%Y-%m-%d")
+      @session_id = session_id
+      puts ""
+    end
+
+    def validate_events(expected_results)
+      # Arguments:
+      #   expected_results: is a hash of event names (string) related with
+      #   expected result
+      # Return:
+      #   true: if succesfull.
+      #   false: if doesn't. Some info messages can go to stdout with this state.
+
+      correct = false
+
+      (1..10).each {
+        mixpanel_result = events_segmentation expected_results.keys
+
+        result = expected_results.each { |event, expected_value|
+          if expected_value != mixpanel_result[event]
+            @log.info "\"#{event}\": expected value #{expected_value} received #{mixpanel_result[event]}"
+            break
+          end
+        }
+        correct = !result.nil?
+
+        break if correct
+        puts "Retrying mixpanel queries in two seconds"
+        sleep(3)
+      }
+
+      correct
+    end
+
+    def validate_complex_query(event, extra_query, expected)
+      # Arguments:
+      #   event: The event name to use in the query
+      #   extra_query: String with params for mixpanel query.
+      #   expected: The integer result to be expected
+      # Return:
+      #   true: if succesfull.
+      #   false: if doesn't. Some info messages can go to stdout with this state.
+      correct = false
+
+      (1..10).each {
+        received = event_complex_query(event, extra_query)
+        @log.info "\"#{event}\": expected value #{expected} received #{received}" unless received == expected
+        correct = received == expected
+
+        break if correct
+        puts "Retrying mixpanel queries in two seconds"
+        sleep(3)
+      }
+
+      correct
+    end
+
+    def events_segmentation(events)
+      # Arguments:
+      #   events: is a list of event names.
+      @log.debug "Request to mixpanel: #{events}"
+      Hash[events.map { |event|
+        response = @client.request(
+          'segmentation',
+          event: event,
+          type: 'general',
+          unit: 'day',
+          from_date: @yesterday,
+          to_date: @today,
+          where: "properties[\"mp_session_id\"] == \"#{@session_id}\""
+        )
+        @log.debug JSON.pretty_generate(response)
+        [event, response['data']['values'][event][@today]]
+      }]
+    end
+
+    def event_complex_query(event, extra_query)
+      # Arguments:
+      #   event: The event to validate dates.
+      @log.debug "Request to mixpanel: #{event}"
+      response = @client.request(
+        'segmentation',
+        event: event,
+        type: 'general',
+        unit: 'day',
+        from_date: @yesterday,
+        to_date: @today,
+        where: "properties[\"mp_session_id\"] == \"#{@session_id}\" and (#{extra_query})"
+      )
+      @log.debug JSON.pretty_generate(response)
+      response['data']['values'][event][@today]
+    end
+  end
+end

data/lib/mixpaneltesting/selenium.rb

@@ -0,0 +1,145 @@
+require 'securerandom'
+require 'logger'
+
+require 'selenium-webdriver'
+
+
+module MixpanelTesting
+
+  class SeleniumProvider
+
+    def initialize(selenium_url, capabilities = :firefox)
+      @selenium_url = selenium_url
+      @log = Logger.new(STDOUT)
+      @log.info "Selenium initializer"
+      if ![:chrome, :firefox].include? capabilities
+        @caps = Selenium::WebDriver::Remote::Capabilities.new
+        if capabilities['device'].nil?
+          @log.info "Creating capabilities, desktop environment"
+          # REQUIRED capabilities
+          ['os', 'os_version', 'browser',
+           'browser_version', 'resolution'].each { |key|
+            @caps[key] = capabilities[key]
+          }
+
+          # NOT REQUIRED capabilities
+          [ 'platform', 'browserName'].each { |key|
+            @caps[key.gsub('_','.')] = capabilities[key] unless
+              capabilities[key].nil?
+          }
+        else
+          @log.info "Creating capabilities, mobile environment"
+          @caps["device"] = capabilities['device']
+          @caps[:platform] = capabilities['platform']
+          @caps[:browserName] = capabilities['browserName']
+        end
+        ['build', 'project', 'browserstack_local', 'browserstack_debug',
+         'browserstack_localIdentifier' ].each { |key|
+            @caps[key.gsub('_','.')] = capabilities[key] unless
+              capabilities[key].nil?
+        }
+
+      else
+        @caps = capabilities
+      end
+
+      @driver = nil
+      @test_cases = []
+      @wait = 2
+      @log.info "Ready to connect"
+    end
+
+    def connect!
+      @log.info "Connecting to selenium through #{@selenium_url}"
+      @log.debug @caps.inspect
+      @driver = Selenium::WebDriver.for(
+        :remote,
+        :url => @selenium_url,
+        :desired_capabilities => @caps)
+      @log.info('Connected to selenium')
+      @driver.manage.timeouts.implicit_wait = Settings.timeout
+    end
+
+    def start_session(site_url)
+      @session_id = SecureRandom.uuid
+      @session_timestamp = Time.now.getutc
+      connect! if @driver.nil?
+      @site_url = site_url
+
+      @log.info "Start mixpanel session #{@session_id}"
+
+      start_url = site_url.include?('?') ? "#{site_url}&" : "#{site_url}?"
+      start_url = "#{start_url}mp_session_start=#{@session_id}"
+      @driver.get start_url
+      waitfor()
+    end
+
+    def reset_cookies
+      @log.info "Reset cookies!!"
+      @driver.deleteAllCookies
+    end
+
+    def navigate(url)
+      @driver.get url.start_with?('http') ? url : "#{@site_url}#{url}"
+      waitfor()
+    end
+
+    def end_session(site_url = nil)
+      puts @site_url
+      site_url = site_url.nil? ? @site_url : site_url
+      end_url = site_url.include?('?') ? "#{site_url}&" : "#{site_url}?"
+      end_url = "#{end_url}mp_session_end=#{@session_id}"
+      @driver.get end_url
+      waitfor()
+    end
+
+    def get_page_source
+      @driver.page_source
+    end
+
+    def quit
+      @log.info "Clossing selenium connection BYE!!"
+      @driver.quit
+    end
+
+    def session_id
+      @session_id
+    end
+
+    def driver
+      @driver
+    end
+
+    def waitfor(n=false)
+      # Use waitfor for correct mixpanel js loading and tracking
+      wait = n ? n : @wait
+      (1..wait).each {
+        print "."
+        sleep(1)
+      }
+      print "\r"
+    end
+
+    def waitfor_object_displayed(*selector)
+      # Use this method to tell selenium to wait until one element is displayed
+      # Arguments:
+      #   selector:  is selenium find_element selector
+      #            ex: waitfor_object_displayed(:class, 'cookies-eu-ok')
+      @log.debug "Waiting for #{selector} to be displayed"
+      return if @driver.find_element(*selector).displayed?
+      wait = Selenium::WebDriver::Wait.new(:timeout =>  Settings.timeout)
+      wait.until { !@driver.find_element(*selector).displayed? }
+    end
+
+    def click(selector)
+      # Click in the object given by selector. It should be visible in the
+      # browser area.
+      @log.debug "Clicking at #{selector}"
+      link = @driver.find_element(selector)
+      @driver.execute_script("arguments[0].scrollIntoView(true);", link)
+      link = @driver.find_element(selector)
+      link.click
+      waitfor()
+    end
+  end
+end

data/lib/mixpaneltesting/version.rb

@@ -0,0 +1,3 @@
+module MixpanelTesting
+  VERSION='0.1.0'
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: mixpaneltesting
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Antonio Perez-Aranda Alcaide
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.46.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.46.2
+- !ruby/object:Gem::Dependency
+  name: mixpanel_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: docker-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Mixpanel integration testing with Selenium Driver (local, docker, browserstack
+  compatible)
+email:
+- ant30tx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mixpaneltesting.rb
+- lib/mixpaneltesting/docker.rb
+- lib/mixpaneltesting/localsite.rb
+- lib/mixpaneltesting/mixpanel.rb
+- lib/mixpaneltesting/selenium.rb
+- lib/mixpaneltesting/version.rb
+homepage: http://rubygems.org/gems/mixpaneltesting
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Mixpanel integration testing with Selenium
+test_files: []