testlink-api-client 0.0.1

data/lib/test_link/objects/project.rb

@@ -0,0 +1,25 @@
+#    This file is part of testlink-api-client.
+#
+#    testlink-api-client is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    testlink-api-client is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'test_link/objects/methods'
+
+module TestLink
+  module Objects
+    class Project
+      include Methods
+      attr_accessor :id, :name, :prefix, :notes
+    end
+  end
+end

data/lib/test_link/objects/status.rb

@@ -0,0 +1,25 @@
+#    This file is part of testlink-api-client.
+#
+#    testlink-api-client is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    testlink-api-client is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'test_link/objects/methods'
+
+module TestLink
+  module Objects
+    class Status
+      include Methods
+      attr_accessor :id, :status, :message, :additional_info, :operation
+    end
+  end
+end

data/lib/testlink-api-client.rb

@@ -0,0 +1,16 @@
+#    This file is part of testlink-api-client.
+#
+#    testlink-api-client is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    testlink-api-client is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'test_link'

data/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+#    This file is part of testlink-api-client.
+#
+#    testlink-api-client is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    testlink-api-client is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
+
+module RSpec::Matchers
+  def attribute_provided? object, attribute
+    assignment = (attribute.to_s + '=').to_sym
+    (object.respond_to? attribute) && (object.respond_to? assignment)
+  end
+end
+
+RSpec::Matchers.define :provide do |attribute|
+  match do |object|
+    attribute_provided? object, attribute
+  end
+end
+
+RSpec::Matchers.define :provide_mandatory_argument do |argument|
+  match do |command|
+    (attribute_provided? command, argument) && command.class.arguments[argument].mandatory?
+  end
+end
+
+RSpec::Matchers.define :provide_argument do |argument|
+  match do |command|
+    (attribute_provided? command, argument) && (command.class.arguments.has_key? argument)
+  end
+end

data/spec/test_link/adapters/base_spec.rb

@@ -0,0 +1,56 @@
+#    This file is part of testlink-api-client.
+#
+#    testlink-api-client is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    testlink-api-client is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
+
+require "test_link/adapters/base"
+require "test_link/exceptions/error_response_exception"
+require "test_link/exceptions/empty_response_exception"
+
+describe TestLink::Adapters::Base do
+  before :each do
+    @adapter = TestLink::Adapters::Base.new
+  end
+
+  it "manages responses" do
+    @adapter.should provide :response
+  end
+
+  it "raises an exception when an error code is detected in the response" do
+    @adapter.response = [{"code"=> 2000, "message"=>"Can not authenticate client: invalid developer key"}]
+    expect { @adapter.adapt }.to raise_exception TestLink::Exceptions::ErrorResponseException, "Can not authenticate client: invalid developer key"
+  end
+
+  it "raises an exception when response is empty" do
+    @adapter.response = []
+    expect { @adapter.adapt }.to raise_exception TestLink::Exceptions::EmptyResponseException, "Response is empty"
+  end
+
+  it "raises an exception when response is nil" do
+    @adapter.response = nil
+    expect { @adapter.adapt }.to raise_exception TestLink::Exceptions::EmptyResponseException, "Response is empty"
+  end
+
+  it 'calls adapt_row' do
+    def @adapter.adapt_row row
+    end
+    @adapter.response = [{'name' => 'a'}, {'name' => 'b'}]
+    @adapter.response.each { |row| @adapter.should_receive(:adapt_row).with(row) }
+    @adapter.adapt
+  end
+
+  it 'recognises when a command failed' do
+    @adapter.response = {"status_ok" => 0, 'id' => 0, 'msg' => msg = 'Rorem ipsum erroor sit amet'}
+    expect { @adapter.adapt }.to raise_exception TestLink::Exceptions::CommandFailedException, "Command has failed: #{msg}"
+  end
+end

data/spec/test_link/adapters/node_adapter_spec.rb

@@ -0,0 +1,102 @@
+#    This file is part of testlink-api-client.
+#
+#    testlink-api-client is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    testlink-api-client is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
+
+require "test_link/adapters/node_adapter"
+require "test_link/objects/node"
+
+describe TestLink::Adapters::NodeAdapter do
+  before :each do
+    @adapter = TestLink::Adapters::NodeAdapter.new
+  end
+
+  it "inherits from TestLink::Adapters::Base" do
+    TestLink::Adapters::NodeAdapter.should < TestLink::Adapters::Base
+  end
+
+  it "should know how to adapt a single row of a response" do
+    node = TestLink::Objects::Node.new
+    row = { "id" => (node.id = 2).to_s,
+            "parent_id" => (node.parent_id = 1).to_s,
+            "node_type_id" => (node.type_id = 2).to_s,
+            "node_order" => (node.order = 1).to_s,
+            "node_table" => node.table = "testsuites",
+            "name" => node.name = "First Testsuite"}
+
+    @adapter.adapt_row(row).should == node
+  end
+
+  it "should should adapt raw response to Project objects" do
+    node1 = TestLink::Objects::Node.new
+    node2 = TestLink::Objects::Node.new
+
+    response = [
+        { "id" => (node1.id = 2).to_s,
+            "parent_id" => (node1.parent_id = 1).to_s,
+            "node_type_id" => (node1.type_id = 2).to_s,
+            "node_order" => (node1.order = 1).to_s,
+            "node_table" => node1.table = "testsuites",
+            "name" => node1.name = "First Testsuite"},
+        { "id" => (node2.id = 3).to_s,
+            "parent_id" => (node2.parent_id = 1).to_s,
+            "node_type_id" => (node2.type_id = 2).to_s,
+            "node_order" => (node2.order = 2).to_s,
+            "node_table" => node2.table = "testsuites",
+            "name" => node2.name = "Second Testsuite"}]
+
+    @adapter.response = response
+    @adapter.adapt.should == [ node1, node2 ]
+  end
+
+  describe "workaround unexpected messages form" do
+    it 'allows to receive hashes pretending do be arrays' do
+      node1 = TestLink::Objects::Node.new
+      node2 = TestLink::Objects::Node.new
+
+      response = {
+          "4" => {
+              "id" => (node1.id = 4).to_s,
+              "details" => node1.details = "<p>First one's child</p>",
+              "name" => node1.name = "First Testsuite's child",
+              "node_type_id" => (node1.type_id = 2).to_s,
+              "node_order"=> (node1.order = 1).to_s,
+              "parent_id" => (node1.parent_id = 2).to_s},
+          "5" => {
+              "id" => (node2.id = 5).to_s,
+              "details" => node2.details = "",
+              "name" => node2.name = "Frist's Second testsuite",
+              "node_type_id" => (node2.type_id = 2).to_s,
+              "node_order" => (node2.order = 2).to_s,
+              "parent_id"=> (node2.parent_id = 2).to_s}}
+
+      @adapter.response = response
+      @adapter.adapt.should == [ node1, node2 ]
+    end
+
+    it 'allows to receive a single node out of an array' do
+      node = TestLink::Objects::Node.new
+
+      response = {
+          "id" => (node.id = 4).to_s,
+          "details" => node.details = "<p>First one's child</p>",
+          "name" => node.name = "First Testsuite's child",
+          "node_type_id" => (node.type_id = 2).to_s,
+          "node_order" => (node.order = 1).to_s,
+          "parent_id" => (node.parent_id = 2).to_s}
+
+      @adapter.response = response
+      @adapter.adapt.should == [ node ]
+    end
+  end
+end

data/spec/test_link/adapters/project_adapter_spec.rb

@@ -0,0 +1,81 @@
+#    This file is part of testlink-api-client.
+#
+#    testlink-api-client is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    testlink-api-client is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
+
+require "test_link/adapters/project_adapter"
+require "test_link/objects/project"
+
+describe TestLink::Adapters::ProjectAdapter do
+  before :each do
+    @project_adapter = TestLink::Adapters::ProjectAdapter.new
+  end
+
+  it "inherits from TestLink::Adapters::Base" do
+    TestLink::Adapters::ProjectAdapter.should < TestLink::Adapters::Base
+  end
+
+  it "should know how to adapt a single row of a response" do
+    p_formation = TestLink::Objects::Project.new
+    row = {"id"=> (p_formation.id = 203).to_s ,
+         "notes"=> p_formation.notes = "",
+         "color"=>"",
+         "active"=>"1",
+         "prefix"=> p_formation.prefix = "FOR",
+         "tc_counter"=>"0",
+         "is_public"=>"1",
+         "options"=>"O:8:\"stdClass\":4:{s:19:\"requirementsEnabled\";s:1:\"1\";s:19:\"testPriorityEnabled\";s:1:\"1\";s:17:\"automationEnabled\";s:1:\"1\";s:16:\"inventoryEnabled\";b:0;}",
+         "name"=> p_formation.name = 'Formation',
+         "opt"=>{"requirementsEnabled"=>"1",
+                 "testPriorityEnabled"=>"1",
+                 "automationEnabled"=>"1",
+                 "inventoryEnabled"=>false}}
+
+    @project_adapter.adapt_row(row).should == p_formation
+  end
+
+  it "should should adapt raw response to Project objects" do
+    p_formation = TestLink::Objects::Project.new
+    p_val = TestLink::Objects::Project.new
+    response = [
+        {"id"=> (p_formation.id = 203).to_s ,
+         "notes"=> p_formation.notes = "",
+         "color"=>"",
+         "active"=>"1",
+         "prefix"=> p_formation.prefix = "FOR",
+         "tc_counter"=>"0",
+         "is_public"=>"1",
+         "options"=>"O:8:\"stdClass\":4:{s:19:\"requirementsEnabled\";s:1:\"1\";s:19:\"testPriorityEnabled\";s:1:\"1\";s:17:\"automationEnabled\";s:1:\"1\";s:16:\"inventoryEnabled\";b:0;}",
+         "name"=> p_formation.name = 'Formation',
+         "opt"=>{"requirementsEnabled"=>"1",
+                 "testPriorityEnabled"=>"1",
+                 "automationEnabled"=>"1",
+                 "inventoryEnabled"=>false}},
+        {"id"=>(p_val.id = 1),
+         "notes"=> p_val.notes = "",
+         "color"=>"",
+         "active"=>"1",
+         "prefix"=> p_val.prefix = "TC185",
+         "tc_counter"=>"74",
+         "is_public"=>"1",
+         "options"=>"O:8:\"stdClass\":4:{s:19:\"requirementsEnabled\";s:1:\"1\";s:19:\"testPriorityEnabled\";s:1:\"1\";s:17:\"automationEnabled\";s:1:\"1\";s:16:\"inventoryEnabled\";b:0;}",
+         "name"=> p_val.name = "Validation TestLink",
+         "opt"=>{"requirementsEnabled"=>"1",
+                 "testPriorityEnabled"=>"1",
+                 "automationEnabled"=>"1",
+                 "inventoryEnabled"=>false}}]
+
+    @project_adapter.response = response
+    @project_adapter.adapt.should == [ p_formation, p_val ]
+  end
+end

data/spec/test_link/adapters/status_adapter_spec.rb

@@ -0,0 +1,51 @@
+#    This file is part of testlink-api-client.
+#
+#    testlink-api-client is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    testlink-api-client is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
+
+require "test_link/adapters/status_adapter"
+require "test_link/objects/status"
+
+describe TestLink::Adapters::StatusAdapter do
+  before :each do
+    @status_adapter = TestLink::Adapters::StatusAdapter.new
+  end
+
+  it "inherits from TestLink::Adapters::Base" do
+    TestLink::Adapters::StatusAdapter.should < TestLink::Adapters::Base
+  end
+
+  it "knows how to adapt a single row of a response" do
+    status = TestLink::Objects::Status.new
+    row = {
+        "id"=> (status.id = 2).to_s,
+        "status" => status.status = true,
+        "operation" => status.operation = "createTestSuite",
+        "additionalInfo" => status.additional_info = "some more infos",
+        "message" => status.message = "ok"}
+    @status_adapter.adapt_row(row).should == status
+  end
+
+  it "should should adapt raw response to Status objects" do
+    status = TestLink::Objects::Status.new
+    response = [{
+        "id"=> (status.id = 2).to_s,
+        "status" => status.status = true,
+        "operation" => status.operation = "createTestSuite",
+        "additionalInfo" => status.additional_info = "some more infos",
+        "message" => status.message = "ok"}]
+
+    @status_adapter.response = response
+    @status_adapter.adapt.should == [ status ]
+  end
+end

data/spec/test_link/api_link_spec.rb

@@ -0,0 +1,106 @@
+#    This file is part of testlink-api-client.
+#
+#    testlink-api-client is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    testlink-api-client is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'test_link/api_link'
+require 'test_link/command/base'
+
+describe TestLink::ApiLink do
+  before :each do
+    @url = 'http://qa.example.com'
+    @key = '__dev_key__'
+    @link = TestLink::ApiLink.new @url, @key
+  end
+
+  it 'has a server url' do
+    @link.url.should == @url
+  end
+
+  it 'has an API key' do
+    @link.key.should == @key
+  end
+
+  it 'has an API url' do
+    @link.api_url.should == (@url + '/lib/api/xmlrpc.php')
+  end
+
+  it 'holds a XMLRPC client' do
+    @link.client.should be_an_instance_of XMLRPC::Client
+  end
+
+  it 'allows to add remote methods' do
+    TestLink::ApiLink.should respond_to :remote_method
+  end
+
+  it 'allows to define an adapter for each remote method' do
+    TestLink::ApiLink.should respond_to :set_adapter_for
+  end
+
+  describe 'Adding remote method support' do
+    before :all do
+      class TestLink::ApiLink
+        def self.remote_methods
+          @@remote_methods
+        end
+      end
+
+      class FooAdapter
+        attr_accessor :response
+        def adapt
+        end
+      end
+
+      class Foo < TestLink::Command::Base
+        adapt_with FooAdapter
+
+        def command_name
+          'foo'
+        end
+
+        def execute link
+          [{}]
+        end
+      end
+
+      TestLink::ApiLink.remote_method Foo
+    end
+
+    it 'finds out the name of the method with class command_name method' do
+      link = TestLink::ApiLink.new('http://qa.example.com/', '')
+      link.should respond_to :foo
+    end
+
+    it 'registers a new class instance with the command symbol' do
+      TestLink::ApiLink.remote_methods[:foo].should be_an_instance_of Foo
+    end
+
+    describe 'execution' do
+      before :each do
+        @link = TestLink::ApiLink.new('http://qa.example.com/', '___dev_key___')
+      end
+
+      it 'calls the registered command class execute method with parameters' do
+        args = {:foo => 'bar', :baz => 42}
+        foo = TestLink::ApiLink.remote_methods[:foo]
+        foo.should_receive(:execute).with(@link)
+        foo.should_receive(:reset_arguments_hash).with(args)
+        @link.foo args
+      end
+
+      it 'uses the command specified adapter' do
+        TestLink::ApiLink.adapter_for(Foo.command_name.to_sym).should be_an_instance_of FooAdapter
+      end
+    end
+  end
+end