ruby_bugzilla 0.4.2 → 0.5.1

data/lib/ruby_bugzilla.rb

@@ -1,6 +1,10 @@
 require 'linux_admin'
+require "xmlrpc/client"
 
 class RubyBugzilla
+  CLONE_FIELDS = [:assigned_to, :cc, :cf_devel_whiteboard, :cf_internal_whiteboard, :component,
+    :groups, :keywords, :op_sys, :platform, :priority, :product, :qa_contact, :severity,
+    :summary, :target_release, :url, :version, :whiteboard, :comments, :description,]
   CMD = `which bugzilla`.chomp
   COOKIES_FILE = File.expand_path('~/.bugzillacookies')
 
@@ -16,11 +20,12 @@ class RubyBugzilla
     File.delete(COOKIES_FILE) if File.exists?(COOKIES_FILE)
   end
 
-  attr_accessor :bugzilla_uri, :username, :password, :last_command
-  attr_reader   :bugzilla_request_uri
+  attr_accessor :bugzilla_uri, :username, :password, :last_command, :xmlrpc
+  attr_reader   :bugzilla_request_uri, :bugzilla_request_hostname
 
   def bugzilla_uri=(value)
     @bugzilla_request_uri = URI.join(value, "xmlrpc.cgi").to_s
+    @bugzilla_request_hostname = URI(value).hostname
     @bugzilla_uri = value
   end
 
@@ -31,6 +36,8 @@ class RubyBugzilla
     self.bugzilla_uri = bugzilla_uri
     self.username     = username
     self.password     = password
+    self.xmlrpc       = ::XMLRPC::Client.new(bugzilla_request_hostname, '/xmlrpc.cgi', 443, nil,
+      nil, username, password, true, 60)
   end
 
   def inspect
@@ -60,7 +67,7 @@ class RubyBugzilla
     params["login"]   = [username, password]
 
     begin
-      execute(params)
+      execute_shell(params)
     rescue
       clear_login! # A failed login attempt could result in a corrupt COOKIES_FILE
       raise
@@ -93,7 +100,7 @@ class RubyBugzilla
     params["query"] = nil
     set_params_options(params, options)
 
-    execute(params)
+    execute_shell(params)
   end
 
   # Modify an existing bug or set of bugs
@@ -123,16 +130,83 @@ class RubyBugzilla
     params["modify"] = bug_ids
     set_params_options(params, options)
 
-    execute(params)
+    execute_shell(params)
+  end
+
+  # Clone of an existing bug
+  #
+  # Example:
+  #   # Perform a clone of an existing bug, and return the new bug ID.
+  #   bz.clone(948970)
+  #
+  # @param bug_id [String, Fixnum] A single bug id to process.
+  # @param overrides [Hash] The properties to change from the source bug. Some properties include
+  #   * <tt>:target_release</tt> - The target release for the new cloned bug.
+  #   * <tt>:assigned_to</tt> - The person to assign the new cloned bug to.
+  # @return [Fixnum] The bug id to the new, cloned, bug.
+  def clone(bug_id, overrides={})
+    raise ArgumentError, "bug_id must be numeric" unless bug_id.to_s =~ /^\d+$/ 
+
+    existing_bz = xmlrpc_bug_query(bug_id)
+
+    clone_description, clone_comment_is_private = assemble_clone_description(existing_bz)
+
+    params = {}
+    CLONE_FIELDS.each do |field|
+      next if field == :comments 
+      params[field] = existing_bz[field.to_s]
+    end
+
+    # Apply overrides
+    overrides.each do |param, value|
+      params[param] = value
+    end
+
+    # Apply base clone fields
+    params[:cf_clone_of]        = bug_id
+    params[:description]        = clone_description
+    params[:comment_is_private] = clone_comment_is_private
+
+    execute_xmlrpc('create', params)[:id.to_s]
+  end
+
+  # XMLRPC Bug Query of an existing bug
+  #
+  # Example:
+  #   # Perform an xmlrpc query for a single bug.
+  #   bz.xmlrpc_bug_query(948970)
+  #
+  # @param bug_id [String, Fixnum] A single bug id to process.
+  # @return [Fixnum] The bug id to the new, cloned, bug.
+  def xmlrpc_bug_query(bug_id)
+    raise ArgumentError, "bug_id must be numeric" unless bug_id.to_s =~ /^\d+$/ 
+
+    params = {}
+    params[:Bugzilla_login]    = username
+    params[:Bugzilla_password] = password
+    params[:ids]               = bug_id
+    params[:include_fields]    = CLONE_FIELDS
+
+    execute_xmlrpc('get', params)['bugs'].last
   end
 
   private
+  def assemble_clone_description(existing_bz)
+    clone_description = " +++ This bug was initially created as a clone of Bug ##{existing_bz[:id.to_s]} +++ \n"
+    clone_description << existing_bz[:description.to_s]
 
-  def execute(params)
-    params = {"--bugzilla=" => bugzilla_request_uri}.merge(params)
+    clone_comment_is_private = false
+    existing_bz[:comments.to_s].each do |comment|
+      clone_description << "\n\n"
+      clone_description << "*" * 70
+      clone_description << "\nFollowing comment by %s on %s\n\n" %
+        [comment['author'], comment['creation_time'].to_time]
+      clone_description << "\n\n"
+      clone_description << comment['text']
+      clone_comment_is_private = true if comment['is_private']
+    end
 
-    self.last_command = string_command(CMD, params, password)
-    LinuxAdmin.run!(CMD, :params => params).output
+    [clone_description, clone_comment_is_private]
   end
 
   def set_params_options(params, options)
@@ -141,7 +215,24 @@ class RubyBugzilla
     end
   end
 
-  def string_command(cmd, params = {}, password=nil)
+  # Execute the command using LinuxAdmin to execute python-bugzilla shell commands.
+  def execute_shell(params)
+    params = {"--bugzilla=" => bugzilla_request_uri}.merge(params)
+
+    self.last_command = shell_command_string(CMD, params, password)
+    LinuxAdmin.run!(CMD, :params => params).output
+  end
+
+  # Bypass python-bugzilla and use the xmlrpc API directly.
+  def execute_xmlrpc(action, params)
+    cmd = "Bug.#{action}"
+
+    self.last_command = xmlrpc_command_string(cmd, params)
+    xmlrpc.call(cmd, params)
+  end
+
+  # Build a printable representation of the python-bugzilla command executed.
+  def shell_command_string(cmd, params = {}, password=nil)
     scrubbed_str = str = ""
     str << cmd
     params.each do |param, value|
@@ -158,4 +249,12 @@ class RubyBugzilla
     scrubbed_str = str.sub(password, "********") unless password.nil?
     scrubbed_str
   end
+
+  # Build a printable representation of the xmlrcp command executed.
+  def xmlrpc_command_string(cmd, params = {})
+    clean_params = Hash[params]
+    clean_params[:Bugzilla_password] = "********"
+    "xmlrpc.call(#{cmd}, #{clean_params})"
+  end
+
 end

data/lib/ruby_bugzilla/version.rb

@@ -1,3 +1,3 @@
 class RubyBugzilla
-  VERSION = "0.4.2"
+  VERSION = "0.5.1"
 end

data/spec/ruby_bugzilla_spec.rb

@@ -124,4 +124,147 @@ describe RubyBugzilla do
       bz.last_command.should include("948972")
     end
   end
+
+  context "#xmlrpc_bug_query" do
+    it "when no argument is specified" do
+      expect { bz.xmlrpc_bug_query }.to raise_error(ArgumentError)
+    end
+
+    it "when an invalid argument is specified" do
+      expect { bz.xmlrpc_bug_query("not a Fixnum") }.to raise_error(ArgumentError)
+    end
+
+    it "when the specified bug does not exist" do
+      output = {}
+
+      allow(::XMLRPC::Client).to receive(:new).and_return(double('xmlrpc_client', :call => output))
+      expect { bz.xmlrpc_bug_query(94897099) }.to raise_error
+    end
+
+    it "when producing valid output" do
+      output = {
+        'bugs' => [
+          {
+            "priority" => "unspecified", 
+            "keywords" => ["ZStream"],
+            "cc"       => ["calvin@redhat.com", "hobbes@RedHat.com"],
+          },
+        ]
+      }
+
+      allow(::XMLRPC::Client).to receive(:new).and_return(double('xmlrpc_client', :call => output))
+      existing_bz = bz.xmlrpc_bug_query("948972")
+
+
+      bz.last_command.should include("Bug.get")
+
+      existing_bz["priority"].should == "unspecified"
+      existing_bz["keywords"].should == ["ZStream"]
+      existing_bz["cc"].should       == ["calvin@redhat.com", "hobbes@RedHat.com"]
+
+    end
+  end
+
+  context "#clone" do
+    it "when no argument is specified" do
+      expect { bz.clone }.to raise_error(ArgumentError)
+    end
+
+    it "when an invalid argument is specified" do
+      expect { bz.clone("not a Fixnum") }.to raise_error(ArgumentError)
+    end
+
+    it "when the specified bug to clone does not exist" do
+      output = {}
+
+      allow(::XMLRPC::Client).to receive(:new).and_return(double('xmlrpc_client', :call => output))
+      expect { bz.clone(94897099) }.to raise_error
+    end
+
+    it "when producing valid output" do
+      output = {"id" => 948992}
+      existing_bz = {
+        "description"    => "Description of problem:\n\nIt's Broken",
+        "priority"       => "unspecified", 
+        "assigned_to"    => "calvin@redhat.com",
+        "target_release" => ["---"], 
+        "keywords"       => ["ZStream"],
+        "cc"             => ["calvin@redhat.com", "hobbes@RedHat.com"],
+        "comments"       => [
+          {
+            "is_private"    => false,
+            "count"         => 0,
+            "time"          => XMLRPC::DateTime.new(1969, 7, 20, 16, 18, 30),
+            "bug_id"        => 948970,
+            "author"        => "Calvin@redhat.com",
+            "text"          => "It's Broken and impossible to reproduce",
+            "creation_time" => XMLRPC::DateTime.new(1969, 7, 20, 16, 18, 30),
+            "id"            => 5777871,
+            "creator_id"    => 349490
+          },
+          {
+            "is_private"    => false,
+            "count"         => 1,
+            "time"          => XMLRPC::DateTime.new(1970, 11, 10, 16, 18, 30),
+            "bug_id"        => 948970,
+            "author"        => "Hobbes@redhat.com",
+            "text"          => "Fix Me Now!",
+            "creation_time" => XMLRPC::DateTime.new(1972, 2, 14, 0, 0, 0),
+            "id"            => 5782170,
+            "creator_id"    => 349490
+          },]
+      }
+
+      RubyBugzilla.any_instance.stub(:xmlrpc_bug_query).and_return(existing_bz)
+      allow(::XMLRPC::Client).to receive(:new).and_return(double('xmlrpc_create', :call => output))
+      new_bz_id = bz.clone("948972")
+
+      bz.last_command.should include("Bug.create")
+
+      new_bz_id.should == output["id"]
+    end
+
+    it "when providing override values" do
+      output = {"id" => 948992}
+      existing_bz = {
+        "description"    => "Description of problem:\n\nIt's Broken",
+        "priority"       => "unspecified", 
+        "assigned_to"    => "calvin@redhat.com",
+        "target_release" => ["---"], 
+        "keywords"       => ["ZStream"],
+        "cc"             => ["calvin@redhat.com", "hobbes@RedHat.com"],
+        "comments"       => [
+          {
+            "is_private"    => false,
+            "count"         => 0,
+            "time"          => XMLRPC::DateTime.new(1969, 7, 20, 16, 18, 30),
+            "bug_id"        => 948970,
+            "author"        => "Buzz.Aldrin@redhat.com",
+            "text"          => "It's Broken and impossible to reproduce",
+            "creation_time" => XMLRPC::DateTime.new(1969, 7, 20, 16, 18, 30),
+            "id"            => 5777871,
+            "creator_id"    => 349490
+          },
+          {
+            "is_private"    => false,
+            "count"         => 1,
+            "time"          => XMLRPC::DateTime.new(1970, 11, 10, 16, 18, 30),
+            "bug_id"        => 948970,
+            "author"        => "Neil.Armstrong@redhat.com",
+            "text"          => "Fix Me Now!",
+            "creation_time" => XMLRPC::DateTime.new(1972, 2, 14, 0, 0, 0),
+            "id"            => 5782170,
+            "creator_id"    => 349490
+          },]
+      }
+
+      RubyBugzilla.any_instance.stub(:xmlrpc_bug_query).and_return(existing_bz)
+      allow(::XMLRPC::Client).to receive(:new).and_return(double('xmlrpc_create', :call => output))
+      new_bz_id = bz.clone("948972", {"assigned_to" => "Ham@NASA.gov", "target_release" => ["2.2.0"],} )
+
+      bz.last_command.should include("Bug.create")
+
+      new_bz_id.should == output["id"]
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_bugzilla
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-12 00:00:00.000000000 Z
+date: 2014-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -125,21 +125,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3744538861231322525
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 3744538861231322525
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: RubyBugzilla is a Ruby wrapper around the python-bugzilla CLI for easy access