kaya 0.0.1

data/lib/kaya/suites/suite.rb

@@ -0,0 +1,177 @@
+module Kaya
+  module Suites
+    class Suite
+
+      attr_accessor :id,
+      :name,
+      :branch,
+      :status,
+      :command,
+      :custom,
+      :info,
+      :last_execution,
+      :last_result,
+      :active
+
+      # First, try to get suite info from mongo.
+      # If it does not exist creates a new one with default values
+      def initialize suite_data = nil
+        $K_LOG.debug "[#{suite_data["_id"]}:#{suite_data["name"]}] Creating suite object " if $K_LOG
+        if suite_data.is_a? Hash
+          @id             = suite_data["_id"]
+          @name           = suite_data["name"]
+          @branch         = suite_data["branch"]
+          @status         = suite_data["status"]
+          @command        = suite_data["command"]
+          @custom         = suite_data["custom"] || []
+          @info           = suite_data["info"] || ""
+          @last_execution = suite_data["last_execution"]
+          @last_result    = suite_data["last_result"]
+          @active         = suite_data["active"]
+
+        else
+          $K_LOG.error "Creting suite object. Argument is not a hash" if $K_LOG
+          raise "Suite data not defined correctly. Expecting info about suite"
+        end
+      end
+
+
+      def api_response
+        response = suite_data_structure
+        response["results"]={
+          "size" => number_of_results,
+          "ids" => all_results_ids
+        }
+        response
+      end
+
+      def self.get suite_id
+        $K_LOG.debug "Getting suite data for [id:#{suite_id}]"  if $K_LOG
+        suite_data = Kaya::Database::MongoConnector.suite_data_for suite_id
+        suite_data = suite_data.to_h if respond_to? :to_h
+        new(suite_data) if suite_data
+      end
+
+      def self.get_suite_with name
+        self.new(Kaya::Database::MongoConnector.suite_data_for_name(name))
+      end
+
+      def self.new_suite(suite_name)
+        $K_LOG.debug "Defining new suite [#{suite_name}]" if $K_LOG
+        suite_data = {
+          "_id" => Kaya::Database::MongoConnector.generate_id,
+          "name" => suite_name,
+          "branch" => Kaya::Support::Git.actual_branch,
+          "status" => "READY",
+          "active" => true
+        }
+        self.new(suite_data)
+
+      end
+
+      def suite_data_for suite_name
+        Kaya::Database::MongoConnector.suite_data_for(suite_name)
+      end
+
+      # Returns the structure of a suite data
+      # @return [Hash] data structure
+      def suite_data_structure
+        {
+          "_id" => id,
+          "name" => name,
+          "branch" => branch,
+          "status" => status,
+          "command" => command,
+          "custom" => custom,
+          "info"  => info,
+          "last_execution" => last_execution,
+          "last_result" => last_result,
+          "active" => active
+        }
+      end
+
+      def has_custom_params?
+        !@custom.empty?
+      end
+
+      # Returns an array of those required custom params
+      # This is for start execution validations
+      # @return [Array]
+      def required_custom_params
+        custom.select{|param| param["required"]}.map{|param| param["name"]}
+      end
+
+      def has_info?
+        not @info.empty?
+      end
+
+      def activate!
+        @active= true
+        $K_LOG.debug "[#{@id}:#{@name}] Activated" if $K_LOG
+        self.save!
+      end
+
+      def deactivate!
+        @active = false
+        $K_LOG.debug "[#{@id}:#{@name}] Deactivated" if $K_LOG
+        self.save!
+      end
+
+      def is_ready?
+        status == "READY"
+      end
+
+      def is_running?
+        status == "RUNNING"
+      end
+
+      def set_ready!
+        @status = "READY"
+        $K_LOG.debug "[#{@id}:#{@name}] Marked as ready" if $K_LOG
+        self.save!
+      end
+
+      def set_running!
+        @status= "RUNNING"
+        $K_LOG.debug "[#{@id}:#{@name}] Marked as running" if $K_LOG
+        self.save!
+      end
+
+      def number_of_results
+        all_results.size
+      end
+
+      def all_results_ids
+        all_results.inject([]){|res, result| res << result["_id"]}
+      end
+
+      def all_results
+        Kaya::Database::MongoConnector.results_for(id)
+      end
+
+      def has_results?
+        number_of_results > 0
+      end
+
+      def save!
+        if Kaya::Database::MongoConnector.suite_data_for(id)
+          Kaya::Database::MongoConnector.update_suite(suite_data_structure)
+        else
+          Kaya::Database::MongoConnector.insert_suite(suite_data_structure)
+        end
+        $K_LOG.debug "[#{@id}:#{@name}] Suite saved" if $K_LOG
+      end
+
+      # If test suites ir running
+      def check_last_result!
+        if self.is_running? and (result = Results::Result.get(@last_result))
+            $K_LOG.debug "[#{@id}:#{@name}] Checking last result" if $K_LOG
+            self.set_ready! if (result.update_values! or result.finished?)
+            $K_LOG.debug "[#{@id}:#{@name}] Done" if $K_LOG
+        end
+      end
+
+    end
+
+  end
+end

data/lib/kaya/suites/suites.rb

@@ -0,0 +1,130 @@
+module Kaya
+  module Suites
+
+    def self.cucumber_yml
+      $K_LOG.debug "Getting cucumber.yml content" if $K_LOG
+      begin
+        # Try to open cucumber.yml file from root folder
+        content = YAML.load_file("#{Dir.pwd}/cucumber.yml")
+      rescue  # Could not find the file
+        # Try to open from /config/
+        $K_LOG.warn "cucumber.yml file not found"  if $K_LOG
+        begin
+          content = YAML.load_file("#{Dir.pwd}/config/cucumber.yml")
+        rescue # Could not find the file
+          $K_LOG.warn "cucumber.yml file not found"  if $K_LOG
+          content ={}
+        end
+      end
+
+      begin
+        unless content.empty?
+
+          content.select do |suite_name, command|
+            command.include? "runnable=true"
+          end.map do |suite_name, command|
+
+            command.gsub!(' runnable=true','').gsub!(', ',',')
+
+            suite_info = command.scan(/info\=\[(.*)\]/).flatten.first
+
+            suite_info.gsub('<br>','\n') if suite_info.respond_to? :gsub
+
+            command.gsub!(/info\=\[(.*)\]/,"")
+
+            custom_params = command.scan(/custom\=\[(.*)\]/).flatten.first
+
+            custom = Kaya::Suites::Custom::Params.new(custom_params)
+
+            command.gsub!(/custom\=\[(.*)\]/,"")
+            $K_LOG.debug "{suite_name => #{suite_name}, command => #{command}, custom => #{custom.params}, info => #{suite_info}}" if $K_LOG
+
+            {"suite_name" => suite_name, "command" => command, "custom" => custom.params, "info" => suite_info}
+          end
+        else
+          []
+        end
+      rescue => e
+        $K_LOG.error "Suites: #{e}#{e.backtrace}" if $K_LOG
+        []
+      end
+    end
+
+    def self.update_suites
+      $K_LOG.debug "Updating suites" if $K_LOG
+      existing_suites_ids = self.suite_ids
+
+      self.cucumber_yml.each do |suite_data|
+        # If is there a suite for the given name suite_id will be setted
+        # and the id will be deleted from existing_suites_ids
+        existing_suites_ids.delete(suite_id = is_there_suite_with?(suite_data["suite_name"]))
+
+        if suite_id # Update
+          suite = Kaya::Suites::Suite.get(suite_id)
+          suite.name= suite_data["suite_name"]
+        else
+          suite = Kaya::Suites::Suite.new_suite(suite_data["suite_name"])
+        end
+
+        suite.command= suite_data["command"]
+        suite.custom = suite_data["custom"]
+        suite.info=    suite_data["info"]
+
+        suite.activate! if suite_id
+        $K_LOG.debug "[#{suite.id}:#{suite.name}] Suite Updated" if $K_LOG
+        suite.save!
+      end
+
+      unless existing_suites_ids.empty?
+        existing_suites_ids.each do |suite_id|
+          suite = Kaya::Suites::Suite.get(suite_id)
+          suite.deactivate!
+        end
+      end
+    end
+
+    def self.is_there_suite_with? name
+      self.suite_id_for name
+    end
+
+    # Returns a list of suites id
+    # @param [Boolean] actives or not
+    # @return [Array] a list of suite ids
+    def self.suite_ids active=nil
+      $K_LOG.debug "Suites:Getting all suites ids" if $K_LOG
+      Kaya::Database::MongoConnector.suites(active).map do |suite_data|
+        suite_data["_id"]
+      end
+    end
+
+    # Returns the id for given suite name
+    # @param [String] suite name
+    # @return [Fixnum] suite id
+    def self.suite_id_for(suite_name, active=nil)
+      $K_LOG.debug "Suites:Getting suite id for #{suite_name}" if $K_LOG
+      Kaya::Database::MongoConnector.suite_id_for(suite_name, active)
+    end
+
+    # Returns the ids for running suites
+    # @return [Array] of suite ids
+    def self.all_running_suites
+      $K_LOG.debug "Suites: Getting all runnnig suites" if $K_LOG
+      Kaya::Database::MongoConnector.all_suites.select do |suite|
+        suite["status"] == "RUNNING"
+      end.map{|suite| suite["_id"]}
+    end
+
+    def self.reset_statuses
+      $K_LOG.debug "Resetting suites status" if $K_LOG
+      self.all_running_suites.each do |suite_id|
+        if suite = Kaya::Suites::Suite.get(suite_id)
+          if result = Kaya::Results::Result.get(suite.last_result)
+            result.update_values! # update_values! true means result got finished status
+          end
+          suite.set_ready!
+        end
+      end
+    end
+
+  end
+end

data/lib/kaya/support/clean.rb

@@ -0,0 +1,12 @@
+module Kaya
+  module Support
+    module Clean
+      def self.start
+        Kaya::Suites.reset_statuses
+        Kaya::Results.reset_defuncts
+        Kaya::Support::FilesCleanner.delete_all_kaya_reports
+        Kaya::Support::FilesCleanner.delete_all_console_output_files
+      end
+    end
+  end
+end

data/lib/kaya/support/configuration.rb

@@ -0,0 +1,254 @@
+module Kaya
+  module Support
+    class Configuration
+
+      attr_reader :input
+
+      def self.get
+        $K_LOG.debug "Creating configuration object" if $K_LOG
+        if File.exist?("#{Dir.pwd}/kaya_conf")
+          puts "Moving kaya_conf from #{Dir.pwd}/kaya_conf to #{self.path}".colorize(:green)
+          FileUtils.mv("#{Dir.pwd}/kaya_conf", self.path)
+          puts "Done.".colorize(:green)
+        end
+
+        if self.config_file_exists?
+          @@input = Kaya::Support::Update.kaya_conf
+        else
+          @@input = self.default_input
+          puts "Error loading kaya_conf. Using default values".colorize(:red)
+        end
+      end
+
+      def self.default_input
+        $K_LOG.debug "#{self.class}Setting default input (from template)" if $K_LOG
+        JSON.parse(IO.read(self.path_template))
+      end
+
+      def self.path
+        "#{Dir.pwd}/kaya/kaya_conf"
+      end
+
+      def self.path_template
+        File.expand_path("../../", __FILE__) + "/generators/templates/kaya_conf.tt"
+      end
+
+      def self.project_name
+        $K_LOG.debug "Project name: #{Dir.pwd.split("/").last}"
+        "#{Dir.pwd.split("/").last}"
+      end
+
+      def self.project_name= value
+        @@project_name = value
+      end
+
+      def self.project_name
+        @@project_name
+      end
+
+      def self.hostname
+        @@input['HOSTNAME'] || 'localhost'
+      end
+
+      # Returns the configured port. If it isn't a number, port 8080 will be returned by defualt
+      # @return [Fixnum] port number
+      def self.port
+        self.is_a_number?(@@input["APP_PORT"]) ? @@input["APP_PORT"] : 8080
+      end
+
+      def self.config_file_exists?
+        File.exist? self.path
+      end
+
+      def self.project_name
+        @@input['PROJECT_NAME'] || 'A project using Kaya'
+      end
+
+      def self.project_url
+        url = @@input['PROJECT_URL'] == "http://your.project.url" ? "" : @@input['PROJECT_URL']
+        url.empty? ? Kaya::Support::Git.remote_url : url
+      end
+
+      def self.db_type
+        @@input["DATABASE"]['TYPE'] || 'mongodb'
+      end
+
+      def self.db_host
+        @@input["DATABASE"]['HOST'] || 'localhost'
+      end
+
+      def self.db_port
+        @@input["DATABASE"]['PORT'] || 27017
+      end
+
+      def self.db_username
+        @@input["DATABASE"]["USERNAME"] || nil
+      end
+
+      def self.db_pass
+        @@input["DATABASE"]["PASSWORD"] || nil
+      end
+
+      def self.db_connection_data
+        {
+          :host => self.db_host,
+          :port => self.db_port,
+          :username => self.db_username,
+          :pass => self.db_pass
+        }
+      end
+
+      def self.notification?
+        self.notification_username and self.notification_password and self.use_gmail?
+      end
+
+      def self.notifications_to
+        self.recipients
+      end
+
+      def self.recipients
+        self.is_email_correct? ? @@input['NOTIFICATION']['RECIPIENTS'] : ''
+      end
+
+      def self.notification_username
+        @@input['NOTIFICATION']['USERNAME']
+      end
+
+      def self.notification_password
+        @@input['NOTIFICATION']['PASSWORD']
+      end
+
+      def self.refresh_time
+        self.is_a_number?(@@input['REFRESH_TIME']) ? @@input['REFRESH_TIME'] : 0
+      end
+
+      def self.refresh?
+        !self.refresh_time.zero?
+      end
+
+      def self.use_gmail?
+        self.is_boolean? @@input['USE_GMAIL'] ? @@input['USE_GMAIL'] : false
+      end
+
+      def self.is_email_correct?
+        begin
+          !@@input['NOTIFICATION']['RECIPIENTS'].scan(/\w+@[a-zA-Z]+?\.[a-zA-Z]{2,6}/).empty?
+        rescue
+          false
+        end
+      end
+
+      def self.attach_report?
+        value = @@input['NOTIFICATION']['ATTACH_REPORT']
+        self.is_boolean? value ? value : false
+      end
+
+
+
+      def self.is_a_number? value
+        !"#{value}".scan(/\d+/).empty?
+      end
+
+      def self.is_boolean? object
+        [TrueClass, FalseClass].include? object.class
+      end
+
+      def self.use_git?
+        self.validate_use_git_configuration_value
+        @@input['USE_GIT']
+      end
+
+      def self.validate_use_git_configuration_value
+        raise "You have to set USE_GIT config with true or false. Has #{@@input['USE_GIT']}" unless is_boolean? @@input['USE_GIT']
+      end
+
+      def self.formatted_datetime
+        @@input['FORMAT_DATETIME'] || "%d/%m/%Y %H:%M:%S"
+      end
+
+      def self.company
+        if @@input['FOOTER'].is_a? String
+          @@input['FOOTER']
+        else
+          ""
+        end
+      end
+
+      # After this period of time (in seconds) Kaya will show a stop execution button on result report and results list
+      def self.inactivity_timeout
+        self.is_a_number?(@@input["INACTIVITY_TIMEOUT"]) ? @@input["INACTIVITY_TIMEOUT"] : 60
+      end
+
+      # After this period of time (in seconds) Kaya will kill process execution automatically
+      def self.execution_time_to_live
+        self.is_a_number?(@@input["KILL_INACTIVE_EXECUTIONS_AFTER"]) ? @@input["KILL_INACTIVE_EXECUTIONS_AFTER"] : 3600
+      end
+
+      def self.kill_after_time?
+        self.execution_time_to_live > 0
+      end
+
+      def self.reset_execution_availability?
+        inactivity_timeout > 0
+      end
+
+      def self.auto_execution_id
+        if @@input.has_key? "AUTO_EXECUTION_ID"
+          if @@input["AUTO_EXECUTION_ID"]["datetime"]
+            Time.now.strftime(@@input["AUTO_EXECUTION_ID"]["format"])
+          else
+            @@input["AUTO_EXECUTION_ID"]["default"]
+          end
+        end
+      end
+
+      def self.headless?
+        if self.is_boolean? @@input["HEADLESS"]["active"]
+          "xvfb-run --auto-servernum --server-args='-screen 0, #{self.resolution}x#{self.size}' " if @@input["HEADLESS"]["active"]
+        end
+
+        # begin
+        #   @@input["HEADLESS"]["active"] if self.is_boolean? @@input["HEADLESS"]["active"]
+        # rescue
+        #   false
+        # end
+      end
+
+      # Returns value for screen resolution
+      # @return [String] resolution like 1024x768
+      def self.resolution
+        @@input["HEADLESS"]["resolution"]
+      end
+
+      # Returns value for screen size.
+      # This is used by xvfb configuration
+      # @return [String] value in inches
+      def self.size
+        @@input["HEADLESS"]["size"]
+      end
+
+      def self.pretty_configuration_values
+        output = self.configuration_values
+        JSON.pretty_generate(output).gsub("\"******\"", "******")
+      end
+
+      def self.configuration_values
+        output = Marshal.load(Marshal.dump(@@input))
+        output["DATABASE"]["USERNAME"] = "******"
+        output["DATABASE"]["PASSWORD"] = "******"
+        output["NOTIFICATION"]["USERNAME"] = "******"
+        output["NOTIFICATION"]["PASSWORD"] = "******"
+        output
+      end
+
+      def self.show_configuration_values
+        puts "
+
+    * Configuration values loaded at starting Kaya:
+
+  #{self.pretty_configuration_values}"
+      end
+
+    end
+  end
+end

data/lib/kaya/support/console.rb

@@ -0,0 +1,11 @@
+module Kaya
+  module Support
+    module Console
+
+      # Executes system command
+      def self.execute command
+        `#{command}`
+      end
+    end
+  end
+end

data/lib/kaya/support/documentation.rb

@@ -0,0 +1,34 @@
+module Kaya
+  module Support
+    class Documentation
+
+      @@main_folder = File.expand_path("../../../../", __FILE__) + "/"
+      @@docs_folder = @@main_folder + "documentation/"
+
+      @@folders_to_search = [@@main_folder, @@docs_folder]
+
+
+      def self.load_documentation
+        print "\nLoading documentation..."
+        Kaya::Database::MongoConnector.clean_documentation
+        @@folders_to_search.each { |folder| self.open_files folder }
+        print "OK"
+      end
+
+      def self.open_files folder
+        Dir.glob(folder + "*.md") do |md_file|
+          name = md_file.split("/").last.gsub('.md','')
+          text = File.read(md_file)
+          Kaya::Database::MongoConnector.insert_documentation self.generate_entry(name,text)
+        end
+      end
+
+      def self.generate_entry name, text
+        {
+            "title" => name,
+            "body" => text
+        }
+      end
+    end
+  end
+end

data/lib/kaya/support/error_handler_helper.rb

@@ -0,0 +1,24 @@
+module Kaya
+  module Support
+    class ErrorHandlerHelper
+
+      def self.evaluate exception
+        case exception
+          when Mongo::ConnectionTimeoutError
+            ["Timeout Error","Could not connect to database"]
+          when Psych::SyntaxError
+            ["Parse Error","Cucumber.yml file is not configured correctly (#{exception.message})"]
+          when Kaya::Error::Suite
+            ["Suite Name Error",exception.message]
+          when Kaya::Error::CucumberYML
+            ["No Cucumber file", exception.message]
+          else
+            message = "#{exception.message}#{exception.backtrace}"
+            ["Unknown Error", message]
+        end
+      end
+    end
+  end
+end
+
+