TestGemTM 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 435975756de1f69bf23c4c45ce342cfc7b9734ed
+  data.tar.gz: 6c223d55f94e03ae0466077fea1cec18d76a32f8
+SHA512:
+  metadata.gz: 637eb2192dcaed48e71dc963f8ae3c26b25aa49c8eddbe3093a31727f8b6b3eff963376fd6306cd56b37113059455497c86f5f423f83dfb78d2eda7db473d393
+  data.tar.gz: 864dde906c361f0128c4e80f922e554ccd4a24a612026c2b983b2484edb4f537d419719e5bfd3239f789388ddf7e3a7988b6e2b48ca5916aa8d759f2752c131e

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in TestGemTM.gemspec
+#gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Taru Malik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# TestGemTM
+
+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/TestGemTM`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'TestGemTM'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install TestGemTM
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment. 
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/TestGemTM/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/TestGemTM.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'TestGemTM/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "TestGemTM"
+  spec.version       = TestGemTM::VERSION
+  spec.authors       = ["QA Automation Group @ Yellow Pages Group"]
+  spec.email         = ["taru.malik@ypg.com"]
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
+  end
+
+  spec.summary       = %q{Ruby Package to help the wayward QA Tester}
+  spec.description   = %q{Ruby Package to help the wayward QA Tester}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "savon", "~> 2.8.0"
+  spec.add_runtime_dependency "json", "~> 1.8.1"
+  spec.add_runtime_dependency "rest-client", "~> 1.6.7"
+  spec.add_runtime_dependency "rspec", "~> 3.1.0"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "TestGemTM"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/TestGemTM.rb

@@ -0,0 +1,9 @@
+require 'TestGemTM/version'
+require 'TestGemTM/SpiraAgent'
+require 'TestGemTM/ProxyAgent'
+
+
+module TestGemTM
+
+end
+

data/lib/TestGemTM/ProxyAgent.rb

@@ -0,0 +1,129 @@
+require 'rest-client'
+require 'json'
+require 'rspec'
+
+# start logging before each scenario post http://172.27.108.80:9091/start_logging?src_ip=172.22.221.55
+# tear down after each scenario  delete http://172.27.108.80:9091/log?src_ip=172.22.221.55
+#                               post http://172.27.108.80:9091/stop_logging?src_ip=172.22.221.55
+
+
+module TestGemTM
+ class ProxyAgent
+  include RSpec::Matchers
+
+  attr_accessor :proxy_server_ip, :proxy_server_port, :device_ip
+
+  #set the proxy server ip here or write your own function to load from config file
+  def initialize(hash)
+    puts "Initializing proxy agent"
+    @proxy_server_ip = hash[:proxy_server_ip]
+    @proxy_server_port = hash[:proxy_server_port]
+    @device_ip = hash[:device_ip]
+  end
+
+
+  #gets status of logging for the agent
+  #return: boolean
+  def is_logging?
+    begin
+      return (RestClient.get "#{@proxy_server_ip}/logging?src_ip=#{@device_ip}").code == 200
+    rescue
+      return false
+    end
+  end
+
+  def _proxy_url
+    'http://'+@proxy_server_ip+':'+@proxy_server_port
+  end
+
+
+  #sets server to start logging for the agent
+  #returns: None
+  def start_logging
+    begin
+        puts "Trying to Start logging at #{_proxy_url} for device #{@device_ip}" if Calabash::Cucumber::Logging.full_console_logging?
+        RestClient.post "#{_proxy_url}/start_logging?src_ip=#{@device_ip}", ''
+        puts 'Success...!' if Calabash::Cucumber::Logging.full_console_logging?
+        return true
+    rescue
+      return false
+    end
+  end
+
+
+  #stops logging on the proxy server for the agent
+  #returns: None
+  def stop_logging
+    begin
+    	puts "Trying to Terminate logging at #{_proxy_url} for device #{@device_ip}" if Calabash::Cucumber::Logging.full_console_logging?
+    	RestClient.post "#{_proxy_url}/stop_logging?src_ip=#{@device_ip}", ''
+    	puts 'Success...!' if Calabash::Cucumber::Logging.full_console_logging?
+        return true
+    rescue
+      return false
+    end
+  end
+
+
+  #clears proxy server memory
+  #returns: None
+  def clear_server_mem(max_delete_retries=2)
+    max_delete_retries.times do |n|
+    	begin
+      	    puts "Trying to Clear server memory at #{_proxy_url} for device #{@device_ip}..." if Calabash::Cucumber::Logging.full_console_logging?
+            RestClient.delete ("#{_proxy_url}/log?src_ip=#{@device_ip}") { |response, request, result, &block|
+            sleep 1
+            case response.code
+                when 200
+                puts 'Success...!' if Calabash::Cucumber::Logging.full_console_logging?
+                return response
+            else
+               puts "Failed to delete the logs on the proxy server. (attempt #{n+1})"
+               if n==max_delete_retries-1
+                   puts "Delete retry attempts exhausted.\nResponse: #{result.code} #{result.message}"
+                   return false
+               else
+                   puts 'Retrying to delete after failure.'
+               end
+            end
+            }
+         rescue
+            return false
+         end
+    end
+  end
+
+
+  #gets requests from the proxy server
+  #returns: A list of URLs {url1, url2, ..., urlN}
+  def get_all_request(max_get_retries = 2)
+    max_get_retries.times do |n|
+      begin
+      RestClient.get ("#{_proxy_url}/log?src_ip=#{@device_ip}") { |response, request, result, &block|
+        sleep 1
+        case response.code
+          when 200
+            return response
+          when 404
+            if JSON.parse(response)['message'].start_with?('NO logs found for IP')
+              return false
+            end
+          else
+            puts "Failed to get the logs on the proxy server. (attempt #{n+1})"
+            if n==max_get_retries-1
+              puts "Get retry attempts exhausted.\nResponse: #{result.code} #{result.message}"
+              return false
+              #return response.return!(request, result, &block)
+            else
+              puts 'Retrying to get after failure.'
+            end
+        end
+      }
+      rescue
+        return false
+      end
+    end
+  end
+
+ end
+end

data/lib/TestGemTM/SpiraAgent.rb

@@ -0,0 +1,124 @@
+# This class is needed to retrieve test case descriptions and more from the Spira. It uses savon instead of soap4r as
+# savon is more reliable.
+
+require 'savon'
+require 'json'
+
+module TestGemTM
+ class SpiraAgent
+  # This method Establishes connection with the Spira to retrive a test case data for a project_id and test_case_id;
+  # returns a hash with representing a test case with the following keys:
+  #   'tcDescription' => Test Case Description
+  #   'tsExpectedResult' => Array with expected results for the test
+  #   'tsDescription'
+
+  @cookies
+  @client
+  @test_name_table
+  @project_id
+
+  # initializing the spira agent
+  def initialize user_name, password, project_id = nil, folder_id = nil
+    # setting up savon client, passing the wsdl address
+    @client = Savon.client(wsdl: 'http://spirateam.ypg.com/Services/v4_0/ImportExport.svc?wsdl')
+    #connecting to the service point
+    #the complete list of the functions can be found at spira documentation pages.
+    connection = @client.call(:connection_authenticate, message: {user_name: user_name, password: password})
+    # saving cookies for further use, to avoid authentication every time
+    @cookies = connection.http.cookies
+    #retrieving the table which maps test names to the unique test IDs automatically generated by spira (can be found in test URL)
+    if project_id != nil and folder_id != nil
+      set_test_name_table(project_id, folder_id)
+      @project_id = project_id
+    end
+  end
+
+  #this function sets the test_name_table variable to the map that contains mapping of test names to the test IDs
+  def set_test_name_table(project_id, folder_id)
+    @project_id = project_id
+    @test_name_table = self.retrieve_test_table_from_spira_by_folder(project_id, folder_id)
+  end
+
+  # returns the table with test names mapped to test IDs to allow to retrßy name
+  def retrieve_test_table_from_spira_by_folder(project_id, folder_id)
+    #connecting to project Id. Note: project id can be found on url on spira.
+    @client.call(:connection_connect_to_project, message: {project_id: project_id}, cookies: @cookies)
+    resp = @client.call(:test_case_retrieve_by_folder, message: {test_casefolder_id: folder_id}, cookies: @cookies)
+    # getting the response body and retrieving array with the test cases
+    test_cases = resp.body[:test_case_retrieve_by_folder_response][:test_case_retrieve_by_folder_result][:remote_test_case]
+    test_table = {}
+    # for each test case slice the name and the ID of the test case and save it in the table
+    test_cases.each do |test|
+      test_table[test[:name]] = test[:test_case_id]
+    end
+    return test_table
+  end
+
+  def retrieve_from_spira_by_id(project_id, test_case_id)
+    test_case = {}
+    #connecting to project Id. Note: project id can be found on url on spira.
+    # Ex. http://spirateam.ypg.com/49/test_case/0000000.aspx id is 49.
+    @client.call(:connection_connect_to_project, message: {project_id: project_id}, cookies: @cookies)
+
+    resp = @client.call(:test_case_retrieve_by_id, message: {test_case_id: test_case_id}, cookies: @cookies)
+    # getting the response body
+    response_body = resp.body[:test_case_retrieve_by_id_response][:test_case_retrieve_by_id_result]
+    test_case['tcDescription'] = response_body[:description].gsub( %r{</?[^>]+?>}, '' )
+    test_case['tcName']        = response_body[:name]
+    steps_data  = response_body[:test_steps][:remote_test_step]
+    steps = []
+    #parsing and returning the result
+    if steps_data
+      # if multiple steps
+      if steps_data.kind_of?(Array)
+        steps_data.each_with_index{|step|
+          temp_step = {}
+          temp_step['tsExpectedResult'] = step[:expected_result]
+          temp_step['tsDescription'] = step[:description].gsub('<div>',"\n").gsub(/<[^>]*>/,'').strip
+          steps.push temp_step
+        }
+      else
+        temp_step = {}
+        temp_step['tsExpectedResult'] = steps_data[:expected_result]
+        temp_step['tsDescription'] = steps_data[:description].gsub('<div>',"\n").gsub(/<[^>]*>/,'').strip
+        steps.push temp_step
+      end
+    end
+    test_case['tcSteps'] = steps
+    return test_case
+  end
+
+  # this method just returns the expected result in array for a given project and test case in JSON format
+  def get_expected_result_by_id(project_id, test_case_id)
+    test_case = self.retrieve_from_spira_by_id(project_id, test_case_id)
+    steps = test_case['tcSteps']
+    expected = []
+    expected_hash = {}
+    steps.each{|le_step|
+      # expected.push JSON.parse(le_step['tsExpectedResult'])
+      le_step['tsExpectedResult'].split('</div>').each { |item| expected.push(item.gsub( %r{</?[^>]+?>}, '' )) }
+    }
+    expected.each { |item| items =  item.split(':'); expected_hash.merge!({items[0] => items[1] })}
+    { :expected_results => expected_hash, :test_case_name => test_case['tcName'], :test_case_description => test_case['tcDescription'] }
+  end
+
+  # This method allows to pass the test names and get the expected result shipped from the Spira. To get the expected results
+  # first initialize test names by calling set_test_name_table(projectId, folderId) method and provide the ID of the project
+  # and the ID of the folder that contains the test cases. Once the test tables are initialized get the expected result by simply
+  # providing the name of the desired test case.
+  def get_expected_result_by_name(test_case_name)
+    if @test_name_table == nil
+      raise 'ERROR: test_name_table is not set, call set_test_name_table(project_id, folder_id) method to initialize the '+
+                'test_name_table and project ID. Alternatively you can call get_expected_result_by_id(project_id, test_case_id) or' +
+                'set_test_name_table(project_id, folder_id) to set test_name_table.'
+    end
+
+    test_id = @test_name_table[test_case_name]
+    if test_id == nil
+      raise "ERROR: Program returned empty ID for the test name \"#{test_case_name}\""
+    end
+
+    get_expected_result_by_id(@project_id, test_id)
+  end
+ end
+end

data/lib/TestGemTM/translator.rb

@@ -0,0 +1,14 @@
+class Translator
+  def initialize(language)
+    @language = language
+  end
+
+  def hi
+    case @language
+      when "spanish"
+        "hola mundo"
+      else
+        "hello world"
+    end
+  end
+end

data/lib/TestGemTM/version.rb

@@ -0,0 +1,3 @@
+module TestGemTM
+  VERSION = "0.1.3"
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: TestGemTM
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- QA Automation Group @ Yellow Pages Group
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Ruby Package to help the wayward QA Tester
+email:
+- taru.malik@ypg.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TestGemTM.gemspec
+- bin/console
+- bin/setup
+- lib/TestGemTM.rb
+- lib/TestGemTM/ProxyAgent.rb
+- lib/TestGemTM/SpiraAgent.rb
+- lib/TestGemTM/translator.rb
+- lib/TestGemTM/version.rb
+homepage: 
+licenses:
+- MIT
+metadata:
+  allowed_push_host: 'TODO: Set to ''http://mygemserver.com'' to prevent pushes to
+    rubygems.org, or delete to allow pushes to any server.'
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Ruby Package to help the wayward QA Tester
+test_files: []