testlink-api-client 0.0.1

data/features/support/env.rb

@@ -0,0 +1,32 @@
+#    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/>.
+
+$:.unshift File.dirname(__FILE__)+'/../../lib'
+
+require 'testlink-api-client'
+require 'cucumber/rspec/doubles'
+require File.join(File.dirname(__FILE__), 'test_link_test_module.rb')
+
+class TestLinkWorld
+  include TestLinkTestModule
+end
+
+World do
+  TestLinkWorld.new
+end
+
+Before do
+  @parameters = {}
+end

data/features/support/test_link_test_module.rb

@@ -0,0 +1,32 @@
+#    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 TestLinkTestModule
+  def reset_db sql_file
+    fail('MYSQL_USER environment variable should be set') if ENV['MYSQL_USER'].nil?
+    fail('MYSQL_DB environment variable should be set') if ENV['MYSQL_DB'].nil?
+    mysql_passwd = ENV['MYSQL_PASSWD']
+    `mysql -u #{ENV['MYSQL_USER']} #{("-p " + mysql_passwd) unless mysql_passwd.nil?} #{ENV['MYSQL_DB']} < #{File.dirname(__FILE__)}/db/#{sql_file}`
+  end
+
+  def string2boolean str
+    case str
+      when 'true', '1', 'yes', 'ok'
+        true
+      else
+        false
+    end
+  end
+end

data/lib/test_link.rb

@@ -0,0 +1,22 @@
+#    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'
+require 'test_link/adapters'
+require 'test_link/exceptions'
+
+module TestLink
+end

data/lib/test_link/adapters.rb

@@ -0,0 +1,24 @@
+#    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/adapters/project_adapter'
+require 'test_link/adapters/status_adapter'
+require 'test_link/adapters/node_adapter'
+
+module TestLink
+  module Adapters
+  end
+end

data/lib/test_link/adapters/base.rb

@@ -0,0 +1,35 @@
+#    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/exceptions/empty_response_exception'
+require 'test_link/exceptions/command_failed_exception'
+require 'test_link/exceptions/error_response_exception'
+
+module TestLink
+  module Adapters
+    class Base
+      attr_accessor :response
+
+      def adapt
+        raise TestLink::Exceptions::EmptyResponseException.new if response.nil? || response.empty?
+        raise TestLink::Exceptions::CommandFailedException.new response['msg'] if (response.instance_of? Hash) && (response['status_ok'] == 0)
+        response.map do |row|
+          raise TestLink::Exceptions::ErrorResponseException.new row['message'], row['code'] if row.keys.include? 'code'
+          adapt_row row
+        end
+      end
+    end
+  end
+end

data/lib/test_link/adapters/node_adapter.rb

@@ -0,0 +1,47 @@
+#    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/objects/node'
+
+module TestLink
+  module Adapters
+    class NodeAdapter < Base
+
+      def response= response
+        if response.instance_of? Hash
+          if response.has_key?('node_type_id')
+            response = [ response ]
+          elsif response.count > 1 && response.keys.reject { |key| key =~ /\A\d+?\z/ }.count == 0
+            response = response.values
+          end
+        end
+        super response
+      end
+
+      def adapt_row row
+        node = TestLink::Objects::Node.new
+        node.id = row['id'].to_i
+        node.parent_id = row['parent_id'].to_i
+        node.type_id = row['node_type_id'].to_i
+        node.table = row['node_table'] if row.has_key? 'node_table'
+        node.order = row['node_order'].to_i
+        node.name = row['name']
+        node.details = row['details'] if row.has_key? 'details'
+        node
+      end
+    end
+  end
+end

data/lib/test_link/adapters/project_adapter.rb

@@ -0,0 +1,32 @@
+#    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/objects/project'
+
+module TestLink
+  module Adapters
+    class ProjectAdapter < Base
+      def adapt_row row
+        project = Objects::Project.new
+        project.id = row['id'].to_i
+        project.name = row['name']
+        project.prefix = row['prefix']
+        project.notes = row['notes']
+        project
+      end
+    end
+  end
+end

data/lib/test_link/adapters/status_adapter.rb

@@ -0,0 +1,33 @@
+#    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/objects/status'
+
+module TestLink
+  module Adapters
+    class StatusAdapter < Base
+      def adapt_row row
+        status = Objects::Status.new
+        status.id = row['id'].to_i
+        status.message = row['message']
+        status.status = row['status']
+        status.additional_info = row['additionalInfo']
+        status.operation = row['operation']
+        status
+      end
+    end
+  end
+end

data/lib/test_link/api_link.rb

@@ -0,0 +1,62 @@
+#    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 'xmlrpc/client'
+
+module TestLink
+  class ApiLink
+    attr_accessor :key
+    attr_reader :client, :url
+    @@remote_methods = {}
+    @@adapters = {}
+    def initialize(url, key)
+      @url = url
+      @key = key
+      @client = XMLRPC::Client.new2 self.api_url
+    end
+
+    def api_url()
+      @url + '/lib/api/xmlrpc.php'
+    end
+
+    def self.remote_method(klass)
+      method_name = klass.command_name.to_sym
+      @@remote_methods[method_name] = klass.new
+    end
+
+    def respond_to_missing?(symbol, include_private)
+      return true if @@remote_methods.include? symbol
+      super symbol, include_private
+    end
+
+    def method_missing(symbol, *args)
+      command = @@remote_methods[symbol]
+      adapter = @@adapters[symbol]
+      return super(symbol, args) if command.nil?
+      command_args = args.first || {}
+      command.reset_arguments_hash command_args
+      adapter.response = command.execute self
+      adapter.adapt
+    end
+
+    def self.set_adapter_for command_name, klass
+      @@adapters[command_name.to_sym] = klass.new
+    end
+
+    def self.adapter_for(command_name)
+      @@adapters[command_name.to_sym]
+    end
+  end
+end

data/lib/test_link/command.rb

@@ -0,0 +1,29 @@
+#    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/command/argument'
+require 'test_link/command/base'
+require 'test_link/command/definition'
+require 'test_link/command/get_projects'
+require 'test_link/command/create_test_suite'
+require 'test_link/command/get_first_level_test_suites_for_test_project'
+require 'test_link/command/get_test_suites_for_test_suite'
+require 'test_link/command/get_test_suite_by_id'
+require 'test_link/command/create_test_case'
+
+module TestLink
+  module Command
+  end
+end

data/lib/test_link/command/argument.rb

@@ -0,0 +1,31 @@
+#    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 TestLink
+  module Command
+    class Argument
+      attr_reader :default
+
+      def initialize(default = nil, mandatory = false)
+        @default = default
+        @mandatory = mandatory
+      end
+
+      def mandatory?
+        @mandatory
+      end
+    end
+  end
+end

data/lib/test_link/command/base.rb

@@ -0,0 +1,63 @@
+#    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/command/definition'
+require 'test_link/api_link'
+
+module TestLink
+  module Command
+    class Base < Definition
+      argument :devKey, :mandatory => true
+
+      def execute link
+        self.devKey ||= link.key
+        errors = check_arguments
+        raise ArgumentError.new "Missing mandatory argument(s) #{errors}" unless errors.empty?
+        link.client.call 'tl.' + self.class.command_name, arguments_hash.reject { |key, value| value.nil? }
+      end
+
+      def arguments_hash
+        args = {}
+        (Base.arguments.keys + self.class.arguments.keys).each do |name|
+          args[name] = self.send(name)
+        end
+        args
+      end
+
+      def reset_arguments_hash hash
+        arguments_hash.keys.each do |name|
+          assignment = (name.to_s + '=').to_sym
+          send(assignment, hash[name])
+        end
+      end
+
+      def check_arguments
+        errors = []
+        self.class.arguments.select{ |name, argument| argument.mandatory? }.keys.each do |name|
+          errors.push name if arguments_hash[name].nil?
+        end
+        errors
+      end
+
+      def self.remote_method
+        TestLink::ApiLink.remote_method self
+      end
+
+      def self.adapt_with klass
+        TestLink::ApiLink.set_adapter_for self.command_name, klass
+      end
+    end
+  end
+end