kaya 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38856c4608568642c6b5e4885d96b96c7a209cbe
+  data.tar.gz: 219449b3fc96ffcb8801a5fd36de867dfd47e2ff
+SHA512:
+  metadata.gz: 62291a41d43b9ac9e22d7af98645ced0edde730c62bdd896eb77fae7aa1a171ef57503edf2389732bbb7340f85e88dd35a76e6eaee50e4a522e8f602508505e4
+  data.tar.gz: 935100afcd4585e704a0293f20aa0215005abfc7ed57c86a3bfaae3e67c41520b15a7774745151df7ea64e250148a7f73e715d5faa9521afb0643b089933a74a

data/.gitignore

@@ -0,0 +1,26 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea/
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+kaya.sublime-project
+kaya.sublime-workspace
+*.kaya
+kaya_conf
+*.html
+unicorn.rb
+config.ru
+

data/CHANGELOG

@@ -0,0 +1,52 @@
+CHANGELOG
+
+Bueno, alguna vez había que hacerlo no?
+
+
+# v 0.0.10
+- Se agregó (y arregló) el uso de Sidekiq para los jobs en background en el chequeo constante de la ejecución para guardar la salida por consola en el resultado y finalizar el mismo como así también pasar al estado Ready a la suite asociada.
+
+- Se agregó chequeo de existencia de Redis en el sistema en el comando Prepare para que no siga adelante si es que no está instalado. Redis se ha convertido en un requisito.
+
+- Se agregó la actualización de la documentación de help en el comando Start para que si se actualiza la gema, esta actualice la base con la nueva info de Help automaticamente.
+
+- Se agregó un chequeo del archivo de configuración para agregar los valores por defectos que puedan llegar a faltar en la actualización de Kaya.
+
+- Cuando quedaba en estado finished no llevava a la ventana de log
+
+- Arreglo en respuesta de error de API
+
+- Extraccion de operaciones de sidekiq en un modulo aparte
+
+- Configuración de base de datos separada, se agregó el puerto, y el tipo. La idea es en un futuro soportar distintos tipos de BBDD como Cassandra por ejemplo.
+
+- No se usa mas selección de branch. Ahora cuando se usa el comando prepare se ofrece la posibilidad de seleccionar el branch sobre el cual trabajará kaya siempre.
+
+- Se agregó el comando restart que llama a stop y luego a start
+
+- Se agregó un worker GarbageCleaner que limpia los archivos que pueden quedar como basura
+
+- Se eliminaron archivos deprecados
+
+- Separación de los comandos en nuevo modulo Commands
+
+- Se agregó logo en consola
+
+- Acceso a los logs desde la app. No está explicito en la aplicación sino que se accede a través de la url con /kaya/logs donde se listan los logs disponibles y /kaya/logs/logfile_name que muestra su contenido
+
+- Log de traza de kaya (kaya_log)
+
+- Se reemplazo el comand prepare por install. Hace lo mismo, solo que ahora se llama install :)
+
+- Dinamic custom parama (select list) Ahora un valor de una lista de selección permite que al ser seleccionado se muestre un campo adicional que solo funcionará con dicha selección
+
+- Ahora desee una ejecucíón de test se puede utilizar la clase Kaya::Custom::Params para obtener los custom params facilmente sin tener que acceder a ENV y discriminar entre todso los valores que viajan en el.
+
+- Arreglos visuales en la sección de resultados
+
+- Se creó una clase Console para la ejecución de comandos de system
+
+- Cuando se hace un pull ahrao se hace un reset --hard previamente
+
+-
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kaya.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Roman Rodriguez
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/NOTAS

@@ -0,0 +1,19 @@
+Prerequisites
+
+To use Kaya you have to have installed on your system Redis and mongoDB
+
+TO INSTALL LASTEST VERSION OF REDIS
+
+$ sudo apt-get install -y python-software-properties
+$ sudo add-apt-repository -y ppa:rwky/redis
+$ sudo apt-get update
+$ sudo apt-get install -y redis-server
+
+
+source => http://tosbourn.com/install-latest-version-redis-ubuntu/
+
+=====================================================================================
+
+TO INSTALL MONGODB
+
+follow instruction http://docs.mongodb.org/manual/tutorial/install-mongodb-on-ubuntu/

data/README.md

@@ -0,0 +1,279 @@
+Kaya
+==============
+
+
+#### *This gem was created in order to expose tests easily so anybody is allowed to execute them.*
+
+
+
+  ONLY FOR UBUNTU (By Now)
+
+  Before installing Kaya you should have installed:
+
+    - MongoDb (version >= 2.6) See http://www.mongodb.org/downloads
+
+    $ sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 7F0CEB10
+    $ sudo apt-get update
+    $ sudo apt-get install mongodb-org
+    $ sudo service mongodb start
+
+    - Redis (http://tosbourn.com/install-latest-version-redis-ubuntu/)
+
+    $ sudo apt-get install -y python-software-properties
+    $ sudo add-apt-repository -y ppa:rwky/redis
+    $ sudo apt-get update
+    $ sudo apt-get install -y redis-server
+
+    - xvfb (if you want to run WebDriver in headless mode.)
+    $sudo apt-get intall xvfb
+
+
+
+## Kaya Installation
+
+    $ gem install kaya
+
+## Usage
+
+Go to your project folder and run install command to use kaya over your project
+
+    $ kaya install
+
+Then bundle it
+
+    $ bundle install
+
+Configure a JSON file called kaya_conf with the values you need
+
+    /kaya_conf
+
+Start Kaya and follow instructions
+
+    $ kaya start
+
+
+
+
+
+How it works
+---------------------
+
+When you run `kaya install` command, kaya will do:
+
+- Update your Gemfile if it exist, else will create it. Also will define gem 'kaya' on it, of course.
+
+- Creates a folder on your root project folder with some files on it. Those files are used by kaya to work.
+
+The file called kaya_conf has some configuration that you can/must modify ( or see at least). You should only use kaya_conf and some logs files (kaya_log & sidekiq_log)
+
+The file config.ru has the needed code to start the service (DO NOT MODIFY IT)
+
+After configuring kaya_conf file you are able to run `kaya start`
+
+After starting Kaya you can go to Help section and see all what you need to know to work with kaya regarding to set up test suites, custom parameters and so.
+
+Enjoy it!
+
+Take it easy!
+
+
+Reference about configuration
+
+kaya/kaya_conf file reference:
+
+{
+
+  "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"}
+}
+
+
+
+
+
+This file is where you can configure:
+
+    "USE_GIT": (Boolean) set as true if you are using git
+
+    "MONGO_HOST" : (String) The host where mongodb is running
+
+    "APP_PORT" : (Fixnum/Int) The http port that Kaya will be listening
+
+  	"PROJECT_NAME" : (String) The name of your Cucumber project
+
+    "PROJECT_URL" : (String) The url of your project (basically the url of the repository)
+
+    "INACTIVITY_TIMEOUT" : (Fixnum/Int) The time in seconds to consider an execution as inactive. This will show you the option to reset an inactive execution
+
+    "KILL_INACTIVE_EXECUTIONS_AFTER" : (Fixnum/Int) The time in seconds to wait for killing automatically those inactive executions
+
+    "FORMAT_DATETIME" : "%d/%m/%Y %H:%M:%S"
+
+    "REFRESH_TIME" : (Fixnum/Int) The time in seconds to refresh result window in console view
+
+    "NOTIFICATION" : (Boolean) This is a flag to use notifications through gmail service. You should have a gmail account to use it.
+
+  	"FOOTER" : (String) A text you want to see at the footer like "Tests by a great team (team_name@domain.com"
+
+    "AUTO_EXECUTION_ID" : (JSON) If you want to use a simple execution id given by the actual time you can set the value of "datetime" to true (Boolean), with this option you can use a strftime format and it will put the execution id automatically.
+    If you set "datetime" to false (Boolean) you can use "default" value. Setting "datetime" as false and "default" as null you will have to (if you need it) set the execution id manually each time you run a suite.
+
+    "HEADLESS" (JSON) : Set active as true to use headless mode
+
+
+
+
+
+
+Available Commands
+---------------------
+
+- To adapt your project to use kaya
+
+    $ kaya install
+
+- To start kaya service
+
+    $ kaya start
+
+- To clear all suites and results collection. To erase all data from database
+
+    $ kaya reset
+
+- To clear all suites collection only. To erase all suites data from database
+
+    $ kaya reset_suites
+
+- to shut down kaya
+
+    $ kaya stop
+
+- to restart kaya
+
+    $ kaya restart
+
+
+
+
+Get (what you need!)
+---------------------
+
+- /kaya/suites
+
+- /kaya/suites/`<suite_name>`/run
+
+- /kaya/results
+
+- /kaya/results/`<suite_name>`
+
+- /kaya/results/`<result_id>`/log
+
+- /kaya/results/`<result_id>`
+
+- /kaya/help
+
+
+
+
+Tip
+---------------------
+
+If you shutdown kaya and then you want to get it up and the port you are using is already in use you could use the following commands (Ubunutu OS):
+
+    $sudo netstat -tapen | grep ":8080 "
+
+In this example we use the port 8080. This command will give you the app that is using the port. Then you could kill it getting its PID previously.
+
+
+API
+=======
+
+Returns the list of suites
+
+    kaya/api/suites
+
+Returns the list of suites that are running
+
+    kaya/api/suites/running
+
+Returns the status of the given suite id
+
+    kaya/api/suites/<suite_id>/status
+
+Returns the suite structure for the given suite id
+
+    kaya/api/suites/<suite_id>
+
+Returns all existing results
+
+    kaya/api/results
+
+Returns the result for a given result id
+
+    kaya/api/results/<result_id>
+
+
+
+
+
+Kaya
+---------------------
+
+[listen](https://www.youtube.com/watch?v=Zgww4QtntnQ "Kaya")
+
+[listen](https://www.youtube.com/watch?v=4t7ghwxuUVo "Kaya")
+
+
+
+Contributing
+---------------------
+
+1. Fork it (http://github.com/`<my-github-username>`/kaya/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/kaya

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'kaya'
+
+Kaya::Base.start(ARGV)

data/documentation/api.md

@@ -0,0 +1,47 @@
+How do i use the api?
+==============
+
+
+Well, we want to do things as simple as possible, so we are using only GET requests. Everyone has a browser, so everyone has the possiblility to use Kaya.
+
+Returns the list of suites
+
+    kaya/api/suites
+
+Returns the list of suites that are running
+
+    kaya/api/suites/running
+
+Returns the status of the given suite id
+
+    kaya/api/suites/<suite_id>/status
+
+Returns the suite structure for the given suite id
+
+    kaya/api/suites/<suite_id>
+
+Returns all existing results
+
+    kaya/api/results
+
+Returns the result for a given result id
+
+    kaya/api/results/<result_id>
+
+Starts an execution
+
+  Perform get to:
+
+    kaya/api/suites/<suite_me>/run
+
+    # pass custom parameters as query string like vkaya/api/suites/:suite/run?environment=RC&foo=bar
+
+    # and if you want identify the execution, you can pass execution_name=your_execution_identification' as query string too.
+
+  If execution starts succesfully, it will return a result id
+
+
+Returns the execution data for a given result id
+
+    kaya/api/results/<result_id>/data
+

data/documentation/api_execution_data.md

@@ -0,0 +1,47 @@
+api Execution Data
+============================
+
+
+With Kaya you can add data to the execution. Then you can find that data through the API by using
+
+    /kaya/api/results/<result id>/data
+
+This will give you the JSON (a part of the result) with the data you setted while your execution was running.
+
+---------------------------------------
+
+How to add execution data
+============================
+
+Basically you have to add kaya gem to your project
+
+    require 'kaya'
+
+Before, you have to add it to your Gemfile
+
+    # Gemfile
+    gem 'kaya'
+
+
+After adding the gem to your project, you can do:
+
+    Kaya::Custom::ExecutionData.add("my_data_key", "some value for data key")
+
+
+Once the execution it is finished, you can see the values through:
+
+    http::/host:port/kaya/api/results/<result_id>/data
+
+And you'll see something like:
+
+    {
+      type: "result",
+      _id: 1427901370053,
+      status: "stopped (Inactivity Timeout reached)",
+      execution_data: {
+        my_data_key: "some value for data key"
+      }
+    }
+
+
+Think about this for integration tests.

data/documentation/configuration.md

@@ -0,0 +1,13 @@
+How to configure Kaya?
+==============
+
+Kaya retrieve information from profiles file called cucumber.yml allocated on project root folder.
+You have to have this file into your project to work with Kaya.
+
+Kaya will show only those suites marked as runnable as test suites. To do this you only have to add a flag to each cucumber profile you want to expose as follows:
+Supose you have a profile called regression on cucumber.yml file
+
+	#cucumber.yml
+	regression: -t @regression runnable=true
+
+The flag `runnable=true` indicates to Kaya to expose the profile to be executed as a test suite.

data/documentation/custom_parameters.md

@@ -0,0 +1,117 @@
+How to pass parameters to a test suite execution?
+==============
+
+As Kaya retrieve information from suite's file called cucumber.yml allocated on projet root folder.
+
+You can send parameters to a test suite execution and your tests can take that data to run in a certain way you need or want.
+
+To ask for parameters into a test suite you have to set them up in cucumber.yml file.
+
+There are basically two types of fields you can show in test suites (text field and select list).
+
+This fields can be setted as required values and or with a default value.
+
+All custom parameters must be defined on each test suite you need by using the custom parameter:
+
+      #cucumber.yml
+
+      regression: -t @regression runnable=true custom=[]
+
+Text field
+---------------------
+
+To show a text field as a custom parameter you just have to define the name of the param
+
+      regression: -t @regression runnable=true custom=[my_param]
+
+<form>
+  <label class="col-sm-2 control-label" for="formGroupInputSmall">my_param</label><input type="text" name="my_param" value="" 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;">
+</form>
+
+---------------------------------------
+
+If you want to define a default value just define the value like:
+
+      regression: -t @regression runnable=true custom=[my_param:a_value]
+
+<form>
+<label class="col-sm-2 control-label" for="formGroupInputSmall">my_param</label><input type="text" name="my_param" value="a_value" 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;">
+</form>
+
+---------------------------------------
+
+You can define the parameter as a required value by using \*
+
+      regression: -t @regression runnable=true custom=[my_param:*]
+
+<form>
+<label class="col-sm-2 control-label" for="formGroupInputSmall">my_param</label><input type="text" name="my_param" value="" 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;">*
+</form>
+
+---------------------------------------
+
+You can also define the parameter as required and with a default value by using:
+
+      regression: -t @regression runnable=true custom=[my_param:a_value:*]
+
+<form>
+<label class="col-sm-2 control-label" for="formGroupInputSmall">my_param</label><input type="text" name="my_param" value="a_value" 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;">*
+</form>
+
+Select List
+---------------------
+
+To provide a certain set of possible values that a test suite can use, you can provide a custom parameter as a select list
+It is like a text field but just use () to provide the possible values separated by | (pipe char).
+
+      regression: -t @regression runnable=true custom=[environment:(RC|IC|BETA|PROD)]
+
+<form>
+<label class="col-sm-2 control-label" for="formGroupInputSmall">environment</label><select id="environment" name="environment" 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;">  <option value="RC">RC</option>  <option value="IC">IC</option>  <option value="BETA">BETA</option>  <option value="PROD">PROD</option>  </select>
+</form>
+
+---------------------------------------
+
+The first value on the list will be used as a default value if user does not select any other value from the list
+With this type of parameter you will ensure that the execution will expect a correct value to run. This is used to make a parameter required with a list of possible values
+---------------------------------------
+But if you do not want to make a select list mandatory, you can use as a first value none to indicate the there is a null value. It is aimed to mimic that user does not select a value
+
+      regression: -t @regression runnable=true custom=[environment:(none|RC|IC|BETA|PROD)]
+
+      # none will be interpreted as an empty option, by using it at the first place on the list, you are setting this parameter as optional.
+
+<form>
+<label class="col-sm-2 control-label" for="formGroupInputSmall">environment</label><select id="environment" name="environment" 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;">  <option value=""></option> <option value="RC">RC</option>  <option value="IC">IC</option>  <option value="BETA">BETA</option>  <option value="PROD">PROD</option></select>
+</form>
+
+---------------------------------------
+
+
+
+
+
+How to get custom parameters
+==============
+
+Once Kaya has got the custom parameters from cucumber.yml, you can get them whenever and wherever you want inside your code.
+You'll can do it by creating an instance of Kaya::Custom::Params
+
+For example
+If you have defined a custom parameter like that: custom=[environment:(RC|PROD)]
+
+So you will be able to get this parameter by the following way:
+
+      $CUSTOM = Kaya::Custom::Params.get
+
+      $CUSTOM.environment
+      # => will return the selected choice of environment param by the user.
+
+If you want to get all custom params in a hash you can use:
+
+      $CUSTOM.all_params
+      # will return a hash with all params and values {}
+
+      $CUSTOM.raw
+      # Same as .all_params
+