zephyr_client 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aea260f86029837edd0dd6326ba81979a5d6beb7
-  data.tar.gz: 0344e46665e6cabe3959c7ec3be44c3b9757e154
+  metadata.gz: f930397a3c988e0d19ad8b2ac9f12d193a2b72f7
+  data.tar.gz: 6009dfd571e24c8dde585648b43ba428e3109d8e
 SHA512:
-  metadata.gz: 3596033d868e76a8420457c832efd2e800acf448f8c146e25bff6225d10e87c2d24c046b66032eba2f831fe56c52f1559fc907170a11c8403442ef6414dc0538
-  data.tar.gz: 69b360efdb928559002f846f259faab0c2ae79395e1b3bd88370f568aaa562b273ca73fbf90bef114b9c59f7f99e2a69d969efe3072f22ebbd2d1e82ebc2547a
+  metadata.gz: e2bda3558d1e450ab086134c37d473cf3dbc88ce4c677b4c45d62453049f39bab2a0a1f10c69ebe67e2ac625bc9409cac4ae6d5542d38e01c480cb35cb0613e1
+  data.tar.gz: 987c3614e24a84000f058ce56cdbb9e17323d5ce9bae4585f7eeb02fad4eb24e20d75fc23be603c86e4e40851930338e98276895da8e4249fd5b8a7ac5ec206f

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/private
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 H20Dragon - Application Model Based Automation Framework
+
+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,30 @@
+
+# ZephyrClient
+
+## Description
+
+Convenient Zephyr client library to manage Zephyr Cycles.
+
+
+# References
+1. https://github.com/sumoheavy/jira-ruby
+1. https://docs.ruby-lang.org/en/2.3.0/Net/HTTP.html#class-Net::HTTP-label-GET
+1. http://www.rubyinside.com/nethttp-cheat-sheet-2940.html
+1. http://zetcode.com/web/rubyhttpclient/
+1. http://www.rubydoc.info/gems/zephyr/1.2.1/Zephyr
+1. https://stackoverflow.com/questions/9680227/curl-task-with-ruby-nethttp
+1. https://stackoverflow.com/questions/5244887/eoferror-end-of-file-reached-issue-with-nethttp
+1. HTTP Party
+   * https://stackoverflow.com/questions/2024805/ruby-send-json-request
+
+# Zephyr 
+## Examples
+1. http://jira.concur.com/jira/rest/api/2/search
+1. http://jira.concur.com/jira/rest/zapi/latest/cycle?projectId=12610&projectKey=CORUI
+1. http://jira.concur.com/jira/rest/zapi/latest/execution?projectId=12610&cycleId=541
+
+# Run Tests
+```
+rspec spec
+
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/config.json

@@ -0,0 +1,10 @@
+{
+  "site": "https://jira.concur.com:443/",
+  "context_path": "/jira",
+  "rest_base_path": "/jira/rest/api/2",
+  "ssl_verify_mode": 1,
+  "use_ssl": true,
+  "auth_type": "basic",
+  "http_debug": true,
+  "read_timeout" : 100
+}

data/bin/zc.rb

@@ -0,0 +1,58 @@
+require_relative '../lib/zephyr_client'
+#require 'zephyr_client'
+require 'json'
+
+opts = ZephyrClient::Utils::parseCommandLine();
+#puts __FILE__ + (__LINE__).to_s + " OPTS => #{opts}" if opts[:verbose]
+
+z = ZephyrClient::Client.new(opts[:config])
+z.setUser( {:username => opts[:user], :password => 'Eruption1978!' })
+
+#puts opts
+
+
+rc = z.getProjectPerRelease(opts[:project], opts[:release], opts[:cycle], opts[:debug])
+
+if opts[:verbose]
+  puts '-' * 72
+  puts "== PROJECT PER RELEASE =="
+  puts __FILE__ + (__LINE__).to_s + " => #{rc}"
+  puts ' -- Executions --'
+end
+
+executions = z.getExecutions(rc)
+puts "Total Records: #{executions['recordsCount']}"
+
+
+if opts.has_key?(:jira)
+  filterKey = 'issueKey'
+  i=0
+  filter = { filterKey => opts[:jira]}   # CORUI-3212
+
+
+  executions['executions'].each do |e|
+    if filter[filterKey] && e.has_key?(filterKey) && (e[filterKey] == filter[filterKey])
+      puts "#{i}. #{e}" if opts[:verbose]
+
+
+      if opts.has_key?(:status)
+
+        operationRc = z.updateTestStatus(e['id'], opts[:status])   # pass, fail, wip, blocked, unexecuted
+
+        opStatus = 'Unsuccessfully'
+        if operationRc.is_a?(Net::HTTPOK)
+          opStatus = 'Successfully'
+        end
+        puts "#{opStatus} updated status to '#{opts[:status]}' : #{e['issueKey']} : #{e['summary']}"
+      end
+
+
+      i+=1
+    end
+
+  end
+
+else
+  puts '*' * 72
+  pp executions['executions']
+end

data/lib/zephyr_client.rb

@@ -1,9 +1,17 @@
 
-class ZephyrClient
 
-  def initialize
-    ;
-  end
+module ZephyrClient
+  ROOT_DIR = File.join(File.dirname(File.expand_path(__FILE__)), 'zephyr_client').freeze
 
+  ZSTATUS = {
+    'pass' => 1,
+    'fail' => 2,
+    'wip'  => 3,
+    'blocked' => 4,
+    'unexecuted' => -1
+  }
+
+  Dir["#{ROOT_DIR}/*.rb"].each { |f| require f }
+  Dir["#{ROOT_DIR}/**/*.rb"].each { |f| require f }
 end
 

data/lib/zephyr_client/base/client.rb

@@ -0,0 +1,225 @@
+
+require 'pp'
+require_relative '../utils/utils'
+
+module ZephyrClient
+
+  class Client
+
+    # TODO: Leverage command pattern.
+    EXECUTION_CMD="/jira/rest/zapi/latest/execution"
+
+
+    ZAPI_LIST = {
+      :cycle => "/jira/rest/zapi/latest/cycle"
+    }
+
+    attr_accessor :debug
+    attr_accessor :user
+
+    def initialize(*p)
+
+      @user=nil
+      puts __FILE__ + (__LINE__).to_s + " size : #{p.size}" if @debug
+
+      if p.size==1 && p[0].is_a?(Hash)
+        ;
+      elsif p.size==1 && p[0].is_a?(String)
+        # Load form from a JSON file
+        @options = JSON.parse(File.read(p[0].to_s))
+        pp @options if @debug
+      elsif p.size==2
+        @user=p[0]
+        server=p[1]
+        puts __FILE__ + (__LINE__).to_s + " ZephyrClient::Client.new(#{user}, #{server})" if @debug
+        @options = {
+          'site' => server,
+          'context_path' => "/jira",
+          'rest_base_path' => "/jira/rest/api/2",
+          'ssl_verify_mode' => 1,
+          'use_ssl' => true,
+          'auth_type' => :basic,
+          'http_debug' => true,
+          'read_timeout' => 100
+        }
+      end
+
+    end
+
+    def setUser(u)
+      @user = u
+    end
+
+    def connect(uri=@options['site'])
+      if @debug
+        puts __FILE__ + (__LINE__).to_s + " [enter]:http_con(#{uri})"
+        puts __FILE__ + (__LINE__).to_s + " | options"
+        pp @options
+      end
+
+      ZephyrClient::Utils::connect(@options['site'], @options)
+    end
+
+
+    def sendRequest(path, headers = {'Accept' => 'application/json'})
+      request = ZephyrClient::Utils::createRequest(@user, 'get', path, nil, headers)
+      connection = connect(@options['site'])
+
+      puts __FILE__ + (__LINE__).to_s + " connection => #{connection.class}" if @debug
+      response = connection.request(request)
+      response
+    end
+
+
+    def getCycles(id)
+      response = sendRequest("#{ZAPI_LIST[:cycle]}/#{id}")
+      puts __FILE__ + (__LINE__).to_s + " ==== Cycles #{id}  ====\n" if @debug
+      response.body
+    end
+
+
+    def getCyclesByProjectId(projectId, versionId)
+      response = sendRequest("/jira/rest/zapi/latest/cycle?projectId=#{projectId}&versionId=#{versionId}")
+      puts __FILE__ + (__LINE__).to_s + " ==== Cycles for Project #{projectId} ====\n"  if @debug
+
+      QResponse.new(response)
+    end
+
+
+    def getProjects()
+      response = sendRequest("/jira/rest/api/2/project/")
+      puts __FILE__ + (__LINE__).to_s + " ==== All Projects ====\n" if @debug
+      QResponse.new(response)
+    end
+
+    def getProject(projectId)
+      response = sendRequest("/jira/rest/api/2/project/#{projectId}")
+      puts __FILE__ + (__LINE__).to_s + " ==== Project #{projectId} ====\n" if @debug
+
+      QResponse.new(response)
+    end
+
+
+    def getProjectByKey(k)
+      #puts __FILE__ + (__LINE__).to_s + " [getProjectByKey]: #{k}"
+      matches=[]
+      hits = getProjects().to_json
+      hits.each do |p|
+        if p.is_a?(Hash)
+          if p.has_key?('key') && p['key']==k
+            matches << p
+          end
+
+        else
+          raise "UNEXPECTED::TypeError::#{p.class}"
+        end
+      end
+
+      matches
+    end
+
+    def getProjectCycles(projectId)
+      response = sendRequest("/jira/rest/zapi/latest/cycle?projectId=#{projectId}")
+      puts __FILE__ + (__LINE__).to_s + " ==== Cycles for Project #{projectId} ====\n"
+
+      response.body
+    end
+
+
+    def getProjectPerRelease(projectKey, expected_release, cycle, debug = @debug)
+      projectId = nil
+      cycleId = nil
+      versionId = nil
+
+      hits = getProjectByKey(projectKey)
+
+
+      if hits.size==1
+
+        projectId = hits[0]['id']
+
+        puts "\n\n=========== getProject(#{projectId} ============"  if @debug
+        project = getProject(projectId).to_json
+
+        if debug
+          puts __FILE__ + (__LINE__).to_s + " hits => #{project.keys.sort.to_s}"
+          pp project
+          puts '*' * 72
+        end
+
+        project['versions'].each do |v|
+          puts __FILE__ + (__LINE__).to_s +  " KEY #{v} => " if @debug
+
+          if v['name'].match(/#{expected_release}/)
+            puts "RELEASE: #{v['id']} : #{v['name']}" if @debug
+            versionId = v['id']
+          end
+        end
+
+        if versionId
+
+          ## Find the Cycle (e.g. Sprint)
+          ## We have the projectID, versionId, now let's get the CycleID
+          rc = getCyclesByProjectId(projectId, versionId)
+          pp rc.to_json if @debug
+
+          rc.to_json.each_pair do |k, v|
+
+            if v.is_a?(Hash) && v.has_key?('name') && v['name'].match(/#{cycle}/)
+              cycleId = k.to_s
+
+              if @debug
+                puts __FILE__ + (__LINE__).to_s + " cycleId #{k.to_s}"
+                pp k
+              end
+
+            elsif !v.is_a?(Hash)
+              puts "#{k} => #{v}" if @debug
+            end
+          end
+
+        end
+
+      end
+
+      { :projectId => projectId, :cycleId => cycleId, :versionId => versionId }
+    end
+
+
+    def getExecutions(opt)
+      rc = nil
+      if opt[:projectId] && opt[:versionId] && opt[:cycleId]
+        response = sendRequest("/jira/rest/zapi/latest/execution?projectId=#{opt[:projectId]}&versionId=#{opt[:versionId]}&cycleId=#{opt[:cycleId]}", {'Accept' => 'application/json'})
+        rc = QResponse.new(response).to_json
+      end
+
+      rc
+    end
+
+
+    #   body = { "status" => "3"}
+    def updateTestStatus(id, status)
+
+      unless ZephyrClient::ZSTATUS.has_key?(status.downcase)
+        raise "UNKNOWN::STATUS::#{status.to_s}"
+      end
+
+      body = "{ \"status\" : \"#{ZephyrClient::ZSTATUS[status.downcase]}\"  }"
+
+      request = ZephyrClient::Utils::createRequest(@user, 'PUT', "#{EXECUTION_CMD}/#{id}/execute", body, {'Content-Type' => 'application/json'})
+      httpReq = connect(@options['site'])
+      response = httpReq.request(request)
+
+      if ZephyrClient::Utils::isVerbose()
+        puts ">>>>>  TEST STATUS <<<<<<"
+        puts response
+      end
+
+      response
+    end
+
+  end
+
+
+
+end

data/lib/zephyr_client/base/http_client.rb

@@ -0,0 +1,27 @@
+require 'json'
+require 'net/https'
+require 'cgi/cookie'
+require 'pp'
+require 'uri'
+
+
+class HTTPClient
+
+  attr_accessor :debug
+  attr_accessor :user
+  attr_accessor :request
+
+  def initialize(user)
+    @debug = false
+    @user = user
+  end
+
+  def self.createRequest(user, http_method='get', path=nil, body=nil, headers={})
+    request = Net::HTTP.const_get(http_method.to_s.capitalize).new(path, headers)
+    request.body = body unless body.nil?
+    request.basic_auth(user[:username], user[:password])
+    request
+  end
+
+
+end

data/lib/zephyr_client/base/q_response.rb

@@ -0,0 +1,36 @@
+require 'json'
+
+
+class QResponse
+  attr_accessor :results
+  attr_accessor :debug
+
+  def initialize(s)
+    @results = s
+    @debug=false
+  end
+
+  def to_json
+    rc=nil
+    begin
+      rc = JSON.parse(@results.body)
+    rescue => ex
+      ;
+    end
+    rc
+  end
+
+  def dump()
+    h = to_json
+
+    if h.is_a?(Array)
+      puts __FILE__ + (__LINE__).to_s +  " SIZE : #{h.length.to_s}"
+      i=0
+      h.each do |arr|
+        puts "#{i}. #{arr}"
+        i+=1
+      end
+    end
+  end
+
+end

data/lib/zephyr_client/utils/utils.rb

@@ -0,0 +1,91 @@
+require 'json'
+require 'net/https'
+require 'cgi/cookie'
+require 'pp'
+require 'uri'
+require 'optparse'
+
+
+module ZephyrClient::Utils
+
+  extend self
+
+  def self.createRequest(user, http_method='get', path=nil, body=nil, headers={})
+    request = Net::HTTP.const_get(http_method.to_s.capitalize).new(path, headers)
+    request.body = body unless body.nil?
+    request.basic_auth(user[:username], user[:password])
+    request
+  end
+
+
+  def self.connect(uri, options)
+    #puts __FILE__ + (__LINE__).to_s + " [ Utils.connect( #{uri} ) ]"
+
+    targetUri = URI.parse(uri)
+    http_class = Net::HTTP
+    httpReq = http_class.new(targetUri.host, targetUri.port)
+    httpReq.use_ssl = options['use_ssl']
+    httpReq.verify_mode = options['ssl_verify_mode']
+    httpReq.read_timeout = options['read_timeout']
+
+    #puts __FILE__ + (__LINE__).to_s + " => #{httpReq}"
+
+    httpReq
+  end
+
+  def self.parseCommandLine(args=nil)
+    options={ :verbose => false }
+
+    opt_parser = OptionParser.new do |opt|
+
+      opt.on('-c', '--cycle Cycle') { |o|
+        options[:cycle] = o
+      }
+
+      opt.on('--cfg', '--cfg Config') { |o|
+        options[:config] = o
+      }
+
+      opt.on('-r', '--release Release') { |o|
+        options[:release] = o
+      }
+
+      opt.on('-p', '--project ProjectKey') { |o|
+        options[:project] = o
+      }
+
+      opt.on('--password', '--password Password') { |o|
+        options[:password] = o
+      }
+      opt.on('u', '--user UserId') { |o|
+        options[:user] = o
+      }
+      opt.on('--jira', '--jira JIRA') { |o|
+        options[:jira] = o
+      }
+
+      opt.on('--status', '--status Status') { |o|
+        options[:status] = o
+      }
+
+      opt.on('-v', '--verbose') { |o|
+        options[:verbose] = o
+      }
+
+    end
+
+
+    if !args.nil?
+      opt_parser.parse!(args)
+    else
+      opt_parser.parse!
+    end
+
+    @options=options
+  end
+
+  def self.isVerbose()
+    @options[:verbose]
+  end
+
+end

data/lib/zephyr_client/version.rb

@@ -0,0 +1,3 @@
+module ZephyrClient
+  VERSION = '0.0.1'.freeze
+end

data/zephyr_client.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'zephyr_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zephyr_client"
+  spec.version       = ZephyrClient::VERSION
+  spec.authors       = ["H20Dragon"]
+  spec.email         = ["h20dragon@outlook.com"]
+
+  spec.summary       = %q{Lightweight Zephyr (JIRA) client.}
+  spec.description   = %q{Conveniently query, filter, and update Zephyr Cycles/Executions.}
+  spec.homepage      = "http://github.com/h20dragon."
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+
+ #  require 'json'
+ #  require 'net/https'
+ #  require 'cgi/cookie'
+ #  require 'pp'
+ #  require 'uri'
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "json"
+#  spec.add_development_dependency "net/https"
+#  spec.add_development_dependency "uri"
+#  spec.add_development_dependency "cgi/cookie"
+end

metadata

@@ -1,23 +1,94 @@
 --- !ruby/object:Gem::Specification
 name: zephyr_client
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - H20Dragon
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2017-06-06 00:00:00.000000000 Z
-dependencies: []
-description: Conveniently query, filter, and update Zephyr Test Cycles/Executions.
-email: h20dragon@outlook.com
+date: 2017-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: json
+  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: Conveniently query, filter, and update Zephyr Cycles/Executions.
+email:
+- h20dragon@outlook.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/config.json
+- bin/zc.rb
 - lib/zephyr_client.rb
-homepage: http://rubygems.org/gems/h20dragon
+- lib/zephyr_client/base/client.rb
+- lib/zephyr_client/base/http_client.rb
+- lib/zephyr_client/base/q_response.rb
+- lib/zephyr_client/utils/utils.rb
+- lib/zephyr_client/version.rb
+- zephyr_client.gemspec
+homepage: http://github.com/h20dragon.
 licenses:
 - MIT
 metadata: {}