kaya 0.0.1

data/documentation/document_kaya.md

@@ -0,0 +1,122 @@
+How to make documentation for Kaya?
+==============
+
+Kaya documentation is loaded to your local mongodb during the command `prepare` from all .md files located inside /kaya/documentation/ 
+and /kaya/ folders.
+Then it's made available in [/kaya/help/main](/kaya/help/main "Help") where you can see all documents and perform searches through them.
+
+Where do i put the documents?
+---------------------
+
+You can push them to the kaya git project inside /kaya/documentation/ folder, /kaya/ folder it's also functional but it's discouraged.
+
+What type of file do i use?
+---------------------
+
+You can only use Markdown (.md) files.
+
+How do i name it?
+---------------------
+
+The name should describe the content of the document, beware that this name its going to be the title of the document in the [/kaya/help/main](/kaya/help/main "Help") page so take that into consideration.
+Also all the name should be all in undercase, and words should be separated by "_" wich are replaced by spaces afterwards.
+
+An example of this:
+
+Name of the file:
+
+	this_is_an_example.md
+
+The the title will be like this:
+
+	This is an example
+
+How do i format de content of the file?
+---------------------
+
+All files in kaya project shuld be formated like this
+
+	Main title
+	==============
+
+	Body of the file
+
+- Main title: it describes the content of the file, it is also the description dispayed here [/kaya/help/main](/kaya/help/main "Help")
+
+- Body of the file: here you can place all the content you want, see ´How do i format de body?´ for more info.
+
+
+How do i format de body?
+---------------------
+
+You can use most of Markdown rules.
+Also you can use some basic HTML, but it's strongly discouraged.
+
+Here are some examples:
+
+	Main title
+	==============
+
+	Secondary titles
+	---------------------
+
+	Normal text.
+
+	> This is a quote.
+
+	*This is italicized*
+
+	**This is bold**
+
+	***This is italicized and bold***
+
+	`this is higlighted`
+
+	- this
+	- is a
+	- list
+
+	This is a link: [Despegar](http://www.despegar.com/)
+
+	You can make relative links too: [/kaya/help/main](/kaya/help/main "Help")
+
+		 This is a block.
+
+	This is a ruler:
+
+	---------------------------------------
+
+
+They are displayed as follows:
+
+Main title
+==============
+
+Secondary titles
+---------------------
+
+Normal text.
+
+> This is a quote.
+
+*This is italicized*
+
+**This is bold**
+
+***This is italicized and bold***
+
+`this is higlighted`
+
+- this
+- is a
+- list
+
+This is a link: [Despegar](http://www.despegar.com/)
+
+You can make relative links too: [/kaya/help/main](/kaya/help/main "Help")
+
+	This is a block
+
+This is a ruler:
+
+----------------------------------------

data/documentation/link.md

@@ -0,0 +1,12 @@
+Share a link to execute a test suite
+==============
+
+Pressing this button:
+
+<form>
+<button type="button" class="btn btn-default" aria-label="Left Align" ><span class="glyphicon glyphicon-star" aria-hidden="true">Link</span></button>
+</form>
+
+you will see a message with the url that starts the test suite execution with the configured custom params and execution name
+This could be helpful when a story is in development process and your test is ready to be executed, so you can create a test suite related to the history,
+set custom params, execution name and then share the link to de developer which is responsible about the history implementation

data/documentation/results.md

@@ -0,0 +1,119 @@
+Results and details about them.
+==============
+
+Each Test Suite execution creates a result. You can see them in Results section.
+You will see each Test Suite box with its results. If a Test Suite has more than three results, you'll see a green button that says `All results` for this test suite to see all results for that test suite
+A result line looks like:
+
+<div class="panel panel-primary">
+  <div class="panel-heading" data-toggle="collapse" data-target="#at_world">
+    <h3 class="panel-title">
+      Regression Tests
+      <div class="pull-right">28 Results</div>
+    </h3>
+  <div></div>
+</div>
+<div class="panel-body collapse in" id="at_world">
+  <div title="Command: -t @multi "></div>
+  <div title="Command: -t @multi "></div>
+  <div title="Command: -t @multi "></div>
+  <table class="table">
+    <thead>
+      <tr>
+        <th style="font-weight: bold;">When</th>
+        <th style="font-weight: bold;">Label</th>
+        <th style="font-weight: bold;">Duration (sec)</th>
+        <th style="font-weight: bold; text-align: center;">Unviewed</th>
+        <th style="font-weight: bold;">Console</th>
+        <th style="font-weight: bold;">Status</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr class="small">
+        <th>01/04/2015 12:16:10</th>
+        <th>01APR15-1216</th>
+        <th> 5 m 2 s</th>
+        <th style="text-align: center;">
+          No
+        </th>
+        <th>
+          <a class="label label-default">
+            Console Log
+          </a>
+        </th>
+        <th>
+          <a href="#" class="label label-danger">Stopped (inactivity timeout reached)</a>
+        </th>
+      </tr>
+      <tr class="small">
+        <th>19/03/2015 16:00:30</th>
+        <th>19MAR15-1600</th>
+        <th>11 s</th>
+        <th style="text-align: center;">
+            No
+        </th>
+        <th>
+          <a class="label label-default">
+            Console Log
+          </a>
+        </th>
+        <th>
+          <a href="#" class="label label-success">1 scenario (1 passed) - 1 step (1 passed)</a>
+        </th>
+      </tr>
+      <tr class="small">
+        <th>19/03/2015 15:17:16</th>
+        <th>19MAR15-1517</th>
+        <th> 4 m 21 s</th>
+        <th style="text-align: center;">
+            No
+        </th>
+        <th>
+          <a class="label label-default">
+            Console Log
+          </a>
+        </th>
+        <th>
+          <a href="#" class="label label-success">1 scenario (1 passed) - 1 step (1 passed)</a>
+        </th>
+      </tr>
+    </tbody>
+  </table>
+  <div class="text-center">
+    <a class="btn btn-info">
+      Go to suite
+    </a>
+    <a href="/kaya/results/suite/multi" class="btn btn-default">
+      &nbsp;&nbsp;All results for this suite&nbsp;
+      <span class="label label-info label-as-badge">
+        3
+      </span>
+    </a>
+  </div>
+  </div>
+</div>
+
+---------------------------------------
+
+
+You can click on this button to see the console output of the execution
+
+<a  class="btn btn-info">Console Log</a>
+
+---------------------------------------
+
+When the execution is still running this label will be shown
+
+<span class="label label-success">Running</span>
+
+---------------------------------------
+
+You can click on summary description like this to see the cucumber report.
+
+<span class="label label-success">4 scenarios (4 passed) - 20 steps (20 passed)</span>
+
+---------------------------------------
+
+When an execution is stopped you'll see this in All Results section you'll see all execution results for all test suites. You can find a specific result by typing a keyword or selecting a status and pressing Search
+
+<span class="label label-danger">Suite execution stopped!</span>

data/documentation/start.md

@@ -0,0 +1,19 @@
+What is Kaya?
+==============
+*Basically it's about runnnig tests easily.*
+
+With Kaya, you don't have to install or configure nothing.
+Just enter on your favourite web browser the url where Kaya is running for your test automation project,
+go to Suites and start the execution you need to run.
+
+How to run tests?
+==============
+
+You can run tests in Test Suites section. You'll find test suites listed. Each test suite involves many test (or not).
+If you want to know more about a test suite you can mouse over the information icon which could have info about it
+Each test suite saves its execution results in a database so you do not have to care about report because Kaya do that for you and store all reports as a history.
+You also can provide some parameters to the execution. This values are called Custom Parameters and you can set them up as your execution needs.
+
+Only test?
+==============
+Well, why not use this to run any code?

data/documentation/suites.md

@@ -0,0 +1,60 @@
+How to use Test Suites in Kaya?
+==============
+
+You can find test suites on Test Suites section.
+Kaya will retrieve all profiles masked as runnable defined on cucumber.yml
+Each Test Suite can be executed by pressing Run button. The execution result could be identified after the execution by adding a label before pressing Run button
+For example, an identifier could be a release product version like r2.3.44. So you will be able to identify quickly the execution result later
+You can provide some parameters to the execution by using [Custom Parameters](/kaya/help/custom_parameters "Custom Parameters")
+
+A Test Suite looks like:
+---------------------
+
+<div class="panel panel-primary">
+  <div class="panel-heading" data-toggle="collapse" data-target="#multi">
+    <h4 class="panel-title">multi</h4>
+  </div>
+  <div class="panel-body collapse in" id="multi">
+    <ul class="list-group">
+      <li class="list-group-item">Command: -t @multi</li>
+      <li class="list-group-item">Last result:&nbsp;<a href="#" class="label label-danger" >Stopped (inactivity timeout reached)</a></li>
+      <li class="list-group-item">Started on:&nbsp;24/05/47218 02:27:33</li>
+      <li class="list-group-item">
+        <form name="run" id="multi" method="get" action="#">
+          <h4 title="This parameters will be passed to the test suite execution">&nbsp;&nbsp;&nbsp;Custom Parameters</h4>
+          <div class="container" style="width: inherit">
+          <li class="list-group-item" style="position:relative; with=100%">
+            <div class="form-group-sm">
+              <label class="col-sm-2 control-label" for="formGroupInputSmall">environment</label>
+              <select id="environment" name="environment" class="customParam" style="height: 34px; padding: 6px 12px; font-size: 14px; line-height: 1.42857143; color: #555; background-color: #fff; background-image: none; border: 1px solid #ccc; border-radius: 4px; font-weight:normal;">
+                <option value="RC">RC</option>
+                <option value="BETA">BETA</option>
+                <option value="PROD">PROD</option>
+              </select>
+              <input type="text" id="otro0" name="otro" value="Enter otro" onfocus="if (this.value==&quot;Enter otro&quot;) this.value=&quot;&quot;;" placeholder="" style="display: none; height: 34px; padding: 6px 12px; font-size: 14px; line-height: 1.42857143; color: #555; background-color: #fff; background-image: none; border: 1px solid #ccc; border-radius: 4px;"></div>
+              <div class="form-group-sm">
+                <label class="col-sm-2 control-label" for="formGroupInputSmall">my param A</label>
+                <textarea class="customParam" type="text" name="blabla" placeholder="" style="height: 34px; padding: 6px 12px; font-size: 14px; line-height: 1.42857143; color: #555; background-color: #fff; background-image: none; border: 1px solid #ccc; border-radius: 4px; max-width: 70%; max-height: 500px; min-height: 34px; min-width: 212px; font-weight:normal;"></textarea>
+              </div>
+              <div class="form-group-sm">
+                <label class="col-sm-2 control-label" for="formGroupInputSmall">my param B</label>
+                  <textarea class="customParam" type="text" name="etc" placeholder="" style="height: 34px; padding: 6px 12px; font-size: 14px; line-height: 1.42857143; color: #555; background-color: #fff; background-image: none; border: 1px solid #ccc; border-radius: 4px; max-width: 70%; max-height: 500px; min-height: 34px; min-width: 212px; font-weight:normal;"></textarea>
+              </div>
+              <div class="form-group-sm">
+                <label class="col-sm-2 control-label" for="formGroupInputSmall">my Param C</label>
+                <textarea class="customParam" type="text" name="country" placeholder="" style="height: 34px; padding: 6px 12px; font-size: 14px; line-height: 1.42857143; color: #555; background-color: #fff; background-image: none; border: 1px solid #ccc; border-radius: 4px; max-width: 70%; max-height: 500px; min-height: 34px; min-width: 212px; font-weight:normal;"></textarea>
+              </div>
+            </li>
+          </div>
+          <br><br>
+            <input type="submit" class="btn btn-success" value="Execute Suite">&nbsp;
+            <input type="text" name="execution_name" class="customParam" title="This value could be used to identify the result execution from other execution of this suite. E.g: You could use the release your are going to test" placeholder="Identify your execution" value="01APR15-1356" style="height: 34px; padding: 6px 12px; font-size: 14px; line-height: 1.42857143; color: #555; background-color: #fff; background-image: none; border: 1px solid #ccc; border-radius: 4px; font-weight:normal;">
+            <button type="button" class="btn btn-default" aria-label="Left Align" data-toggle="modal" data-target="#myModal" onclick="javascript:starter_link(&quot;multi&quot;);">
+              <span class="glyphicon glyphicon-star" aria-hidden="true">Link</span>
+            </button>
+          </form>
+        </li>
+      </ul>
+      <a href="#" class="btn btn-default pull-center">All results(28)</a>
+    </div>
+  </div>

data/documentation/test_suite_information.md

@@ -0,0 +1,9 @@
+How to provide information about a test suite?
+==============
+
+You can provide some information about a test suite by adding info value to each suite you need
+
+      #cucumber.yml 
+      regression: -t @regression info=[This is to execute a regression tests suite]
+
+This value `info=[Explaining text]` will show the icon <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span> where you can mouse over and read the text 

data/kaya.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kaya/version'
+
+Gem::Specification.new do |spec|
+  spec.name                   = "kaya"
+  spec.version                = Kaya::VERSION
+  spec.authors                = ["Roman Rodriguez"]
+  spec.email                  = ["roman.g.rodriguez@gmail.com"]
+  spec.summary                = %q{Exposes Cucumber suites in a web service to make them run}
+  spec.description            = %q{You can run your cucumber suites easily, save and see the execution results}
+  spec.homepage               = "http://qqq.akjsdh"
+  spec.license                = "MIT"
+  spec.required_ruby_version  = ">= 2.0.0"
+
+  spec.files                  = `git ls-files -z`.split("\x0")
+  spec.executables            = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files             = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths          = ["lib"]
+
+  spec.add_dependency 'thor'
+  spec.add_dependency 'cuba'
+  spec.add_dependency 'unicorn'
+  spec.add_dependency 'mongodb'
+  spec.add_dependency 'redis'
+  spec.add_dependency 'sidekiq'
+  spec.add_dependency 'bson_ext'
+  spec.add_dependency 'syntax'
+  spec.add_dependency 'colorize'
+  spec.add_dependency 'github-markup'
+  spec.add_dependency 'redcarpet'
+  spec.add_dependency 'byebug'
+  spec.add_dependency 'gmail'
+  spec.add_dependency 'mote'
+
+
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "cucumber"
+end

data/lib/generators/task_rack.rb

@@ -0,0 +1,160 @@
+class TaskRack < Thor::Group
+
+  	include Thor::Actions
+
+    desc "Generates files needed by Kaya"
+
+# ===============================
+# Evaluates prerequisites
+#
+#
+
+    def check_for_mongo_existance
+      begin
+        mongo = Kaya::Support::Console.execute "mongo --version"
+        mongo_version = mongo.scan(/(\d+\.\d+\.\d+)/).flatten.first
+      rescue
+        raise "
+MONGODB NOT INSTALLED. INSTALL MONGODB BEFORE USING KAYA
+to install MongoDB go to: http://docs.mongodb.org/manual/installation/
+" if mongo_version.nil?
+        end
+        puts "MongoDB version installed => #{mongo_version} => OK"
+    end
+
+
+    def check_redis_existance
+      redis = Kaya::Support::Console.execute "redis-server -v"
+      raise "
+REDIS SERVER IS NOT INSTALLED ON YOUR SYSTEM.
+INSTALL REDIS SERVER BEFORE USING KAYA
+to install Redis go to:
+      " unless redis =~ /Redis server v=\d+\.\d+\.\d+/
+    end
+
+
+    def choose_working_branch
+
+      # Gets the list of branches
+      branch_list=Kaya::Support::Git.branch_list
+
+      begin
+        system "clear"
+        Kaya::Support::Logo.show
+        puts "
+You have to choose one of the following branches to tell Kaya where to work with:"
+        # Print the options
+        branch_list.each_with_index do |branch_name, index|
+          puts "\t(#{index + 1}) - #{branch_name}"
+        end
+        print "\n\t     Your option:"; option = STDIN.gets
+
+        #Converted to Fixnum
+        option = option.gsub!("\n","").to_i
+
+      end until (1..branch_list.size).include? option
+
+
+      selected_branch_name = branch_list[option-1]
+      puts "
+      Lets work on '#{selected_branch_name}'
+
+      "
+
+
+      Kaya::Support::Git.checkout_to(selected_branch_name)
+    end
+
+# ==============================
+# Start install task
+#
+#
+#
+    def self.source_root
+      File.dirname(__FILE__) + "/templates/"
+    end
+
+    def creates_kaya_folder
+      empty_directory "kaya"
+    end
+
+    def creates_kaya_temp_folder
+      empty_directory "kaya/temp"
+    end
+
+    def copy_server_file
+      unless File.exist? "#{Dir.pwd}/kaya/config.ru"
+    	 template "config.ru.tt", "#{Dir.pwd}/kaya/config.ru"
+
+      else
+
+        if yes?("\n  It seems that you already have a config.ru file. DO YOU WANT TO REPLACE IT? (yes/no)", color = :green)
+          template "config.ru.tt", "#{Dir.pwd}/kaya/config.ru"
+        else
+          raise "The existing config.ru file must be replaced with config.ru file from Kaya"
+        end
+      end
+    end
+
+
+    def copy_kaya_conf
+      template "kaya_conf.tt", "#{Dir.pwd}/kaya/kaya_conf" unless File.exist? "#{Dir.pwd}/kaya/kaya_conf"
+    end
+
+    def copy_kaya_log_file
+      template "kaya_log.tt", "#{Dir.pwd}/kaya/kaya_log" unless File.exist? "#{Dir.pwd}/kaya/kaya_log"
+    end
+
+    def copy_sidekiq_log_file
+      template "sidekiq_log.tt", "#{Dir.pwd}/kaya/sidekiq_log" unless File.exist? "#{Dir.pwd}/kaya/sidekiq_log"
+    end
+
+    def copy_unicorn_config_file
+      unless File.exist? "#{Dir.pwd}/kaya/unicorn.rb"
+        template "unicorn.rb.tt", "#{Dir.pwd}/kaya/unicorn.rb"
+        @unicorn_created = true
+      end
+    end
+
+    def update_gitignore
+      path = "#{Dir.pwd}/.gitignore"
+      if File.exist? path
+        f = File.open(path, "a+")
+        content = ""
+        f.each_line{|line| content += line}
+        f.write "\n" unless content[-1] == "\n"
+        # ['*.kaya','kaya_conf','*.html','unicorn.rb', 'config.ru','Gemfile.lock', 'kaya_pids','sidekiq_pids', 'sidekiq_log'].each do |file_name|
+        #   f.write "#{file_name}\n" unless content.include? "#{file_name}"
+        # end
+
+        f.write "kaya/\n" unless content.include? "kaya/"
+        f.write "kaya/*\n" unless content.include? "kaya/*"
+
+
+        f.close
+      end
+    end
+
+    def update_gemfile
+      path = "#{Dir.pwd}/Gemfile"
+      if File.exist? path
+        f = File.open(path, "a+")
+        content = ""
+        f.each_line{|line| content += line}
+        f.write "\n" unless content[-1] == "\n"
+        ["gem 'kaya'"].each do |file_name|
+          f.write "#{file_name}\n" unless content.include? "#{file_name}"
+        end
+      else
+        # Only cucumber projects are allowed to use Kaya (by now)
+        raise "There is no Gemfile. Is this a Cucumber Ruby Project?"
+      end
+
+    end
+
+    def push_changes
+      Kaya::Support::Git.git_add_commit "Kaya: Commit after install command execution"
+      Kaya::Support::Git.git_push_origin_to_actual_branch
+    end
+
+end

data/lib/generators/templates/Gemfile.tt

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+

data/lib/generators/templates/config.ru.tt

@@ -0,0 +1,2 @@
+require 'kaya'
+run Cuba

data/lib/generators/templates/kaya_conf.tt

@@ -0,0 +1,49 @@
+{
+
+  "USE_GIT" : true,
+
+  "HOSTNAME" : "your-host-name",
+
+  "APP_PORT" : 8080,
+
+  "DATABASE" : {
+
+    "TYPE" : "mongodb",
+    "HOST" :"localhost",
+    "PORT" : 27017,
+    "USERNAME" : null,
+    "PASSWORD" : null},
+
+  "PROJECT_NAME" : "Awesome Project",
+
+  "PROJECT_URL" : "http://your.project.url",
+
+  "INACTIVITY_TIMEOUT" : 60,
+
+  "KILL_INACTIVE_EXECUTIONS_AFTER" : 300,
+
+  "FORMAT_DATETIME" : "%d/%m/%Y %H:%M:%S",
+
+  "REFRESH_TIME" : 10,
+
+  "NOTIFICATION" : {
+    "USE_GMAIL" : false,
+    "USERNAME" : null,
+    "PASSWORD" : null,
+    "RECIPIENTS" : "your@email.com",
+    "ATTACH_REPORT" : false
+  },
+
+  "FOOTER" : "Tests by a great and funny team",
+
+  "AUTO_EXECUTION_ID" : {
+    "datetime" : true,
+    "format" : "%d%^b%y-%H%M",
+    "default" : null
+  },
+
+  "HEADLESS" : {
+    "active" : false,
+    "resolution" : "1024x768",
+    "size":"24"}
+}

data/lib/generators/templates/tasks.kaya.tt

@@ -0,0 +1,10 @@
+{
+  "kaya":{
+    "tasks":{
+      "task_name":{
+        "command":"echo 'this is the command you can perform by calling task_name on your get request'"
+      }
+    },
+    "update_command":""
+  }
+}

data/lib/generators/templates/unicorn.rb.tt

@@ -0,0 +1,21 @@
+worker_processes Integer(ENV["WEB_CONCURRENCY"] || 3)
+
+timeout 600
+
+preload_app true
+
+before_fork do |server, worker|
+  Signal.trap 'TERM' do
+    puts 'Unicorn master intercepting TERM and sending myself QUIT instead'
+    Process.kill 'QUIT', Process.pid
+  end
+
+  defined?(ActiveRecord::Base) and
+    ActiveRecord::Base.connection.disconnect!
+end
+
+after_fork do |server, worker|
+  Signal.trap 'TERM' do
+    puts 'Unicorn worker intercepting TERM and doing nothing. Wait for master to send QUIT'
+  end
+end

data/lib/kaya/API/error.rb

@@ -0,0 +1,17 @@
+module Kaya
+  module API
+    class Error
+
+      # @param [QueryString Object] args =
+      #   :msg
+      #   :request
+      def self.show(args)
+        response = {
+          "message" => args.msg,
+          "request" => args.request
+        }
+        response
+      end
+    end
+  end
+end