mutx 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd516b2fbfcac06cbc311d2dc3ef1bfc04551fdb
+  data.tar.gz: 715c7e97c93571caddb1636ac0d96703b7a546ca
+SHA512:
+  metadata.gz: 4d9356515d7c17cb6bd559b97a242bb22ace7f9117888e181f21010f75e48f8777d0166b0fa96afbc34b0cd2224f6297789d5d619d98c5159b6f8c6851587d88
+  data.tar.gz: 41fe84a5bb8daa2d2e2aa5e2499ac21dc53c1abc298b38e3685b50f7ad92265be1811399b56a8bd68009e5ad4afed5a9cd0408ec5be0b1700a4bb6dcc4a7a01e

data/.gitignore

@@ -0,0 +1,4 @@
+pkg
+Gemfile.lock
+mutx/
+mutx/*

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'mutx', path: '~/Desktop/mutx'

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/README.md

@@ -0,0 +1,259 @@
+Mutx (WIP)
+==============
+
+
+#### *This project was created in order to expose tasks (tests) easily so anybody is allowed to execute them.*
+
+(NOT READY YET)
+
+  ONLY FOR UBUNTU (By Now)
+
+  Before installing Mutx 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
+
+    $ 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
+
+  - If you want to run GUI tests using WebDriver in headless mode you should install xvfb package
+
+    $sudo apt-get intall xvfb
+
+  - While running in headless mode you may face an error like:
+    LIBDBUSMENU-GLIB-WARNING **: Unable to get session bus: Error spawning command line `dbus-launch --autolaunch
+  This coulb be solved by installing dbus-x11 package
+
+    $apt-get install dbus-x11
+
+
+
+## Mutx Installation
+
+    $ gem install mutx
+
+## Usage
+
+Go to your project folder and run install command to use mutx over your project
+
+    $ mutx install
+
+Then bundle it
+
+    $ bundle install
+
+Configure a JSON file called mutx.conf with the values you need
+
+    mutx/conf/mutx.conf
+
+Start Mutx and follow instructions
+
+    $ mutx start
+
+
+  Important: Do not forget to include mutx folder to .gitignore if you will use git
+
+
+How it works
+---------------------
+
+When you run `mutx install` command, mutx will do:
+
+- Update your Gemfile if it exist, else will create it. Also will define gem 'mutx' on it, of course.
+
+- Creates a folder on your root project folder with some files on it. Those files are used by mutx to work.
+
+The file called mutx.conf in conf/ folder has some configuration that you can/must modify ( or see at least). You should only use conf/mutx.conf and some logs files (logs/mutx.log & logs/sidekiq.log)
+
+The file config.ru has the needed code to start the service (DO NOT MODIFY IT)
+
+After configuring mutx.conf file you are able to run `mutx start`
+
+After starting Mutx you can go to Help section and see all what you need to know to work with mutx regarding to set up test tasks, custom parameters and so.
+
+
+
+
+=== Can be changed ===
+Reference about configuration
+
+mutx/conf/mutx.conf file reference:
+
+    {
+    "use_git" : true,
+    "app_name" : "your-app-name",
+    "app_port" : 8080,
+    "database" : {
+    "type" : "mongodb",
+    "host" :"localhost",
+    "port" : 27017,
+    "username" : null,
+    "password" : null},
+    "project_name" : "Mutx",
+    "project_url" : "http://your.project.url",
+    "inactivity_timeout" : 60,
+    "kill_inactive_executions_after" : 300,
+    "datetime_format" : "%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_text" : "Tests by a great and funny team",
+    "execution_tag_placeholder" : {
+    "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 Mutx 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
+
+  "datetime_format" : "%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_text" : (String) A text you want to see at the footer like "Tests by a great team (team_name@domain.com"
+
+  "execution_tag_placeholder" : (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 task.
+
+  "headless" (JSON) : Set active as true to use headless mode
+
+
+Available Commands
+---------------------
+
+- To adapt your project to use mutx
+
+    $ mutx install
+
+- To start mutx service
+
+    $ mutx start
+
+- To clear all tasks and results collection. To erase all data from database
+
+    $ mutx reset
+
+- To clear all tasks collection only. To erase all tasks data from database
+
+    $ mutx reset_tasks
+
+- to shut down mutx
+
+    $ mutx stop
+
+- to restart mutx
+
+    $ mutx restart
+
+
+Get (what you need!)
+---------------------
+
+- /mutx/tasks
+
+- /mutx/tasks/`<task_name>`/run
+
+- /mutx/results
+
+- /mutx/results/`<task_name>`
+
+- /mutx/results/`<result_id>`/log
+
+- /mutx/results/`<result_id>`
+
+- /mutx/help
+
+
+Tip
+---------------------
+
+If you shutdown mutx 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 tasks
+
+    mutx/api/tasks
+
+Returns the list of tasks that are running
+
+    mutx/api/tasks/running
+
+Returns the status of the given task id
+
+    mutx/api/tasks/<task_id>/status
+
+Returns the task structure for the given task id
+
+    mutx/api/tasks/<task_id>
+
+Returns all existing results
+
+    mutx/api/results
+
+Returns the result for a given result id
+
+    mutx/api/results/<result_id>
+
+Returns the data you've added to result from execution
+
+    mutx/api/results/<result_id>/data
+
+
+
+Contributing
+---------------------
+
+1. Fork it (http://github.com/romgrod/mutx/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/mutx

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

data/cron.rb

@@ -0,0 +1,23 @@
+require 'mutx'
+
+module Cron
+	class Tasks
+
+		def self.cron_jobs
+		  cron_tasks_list = Mutx::Database::MongoConnector.cron_tasks
+
+		  cron_tasks_list.each do |task|
+		  	if (((!task[:cron_time].eql? "") && (!task[:cron_time].eql? "0")) && (((Time.now.utc - task[:last_exec_time].utc) + 1) >= (task[:cron_time].to_i * 60)))
+		  		  query_string = {}
+		  		  query_string = {"execution_name"=>"CRONNED-#{task[:cron_time]}-min"}
+		  		  task_name = task[:name]
+		        task_name.gsub!("%20"," ")
+		        puts Mutx::API::Tasks.cron_update task
+		        Mutx::API::Execution.start task_name, query_string
+		    end
+		  end
+		end
+	end#class
+end#module
+
+Cron::Tasks.cron_jobs

data/cron_alive.sh

@@ -0,0 +1,9 @@
+A=`pgrep -f cronned_task.rb | wc -w`
+
+if [ "$A" -eq 0 ]; then
+    echo "Starting Mutx Cron process"
+    export DISPLAY=:0;
+    ruby ./cronned_task.rb;
+else
+  echo "Mutx Cron is already running"
+fi

data/cronned_task.rb

@@ -0,0 +1,9 @@
+require 'rufus/scheduler'
+
+scheduler = Rufus::Scheduler.new
+
+scheduler.every '1m' do
+  current_directory = Dir.pwd
+  system("cd #{current_directory}" && "bundle exec ruby cron.rb")
+end
+scheduler.join

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 Mutx.
+
+Returns the list of tasks
+
+    mutx/api/tasks
+
+Returns the list of tasks that are running
+
+    mutx/api/tasks/running
+
+Returns the status of the given task id
+
+    mutx/api/tasks/<task_id>/status
+
+Returns the task structure for the given task id
+
+    mutx/api/tasks/<task_id>
+
+Returns all existing results
+
+    mutx/api/results
+
+Returns the result for a given result id
+
+    mutx/api/results/<result_id>
+
+Starts an execution
+
+  Perform get to:
+
+    mutx/api/tasks/<task_me>/run
+
+    # pass custom parameters as query string like vmutx/api/tasks/:task/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
+
+    mutx/api/results/<result_id>/data
+

data/documentation/api_execution_data.md

@@ -0,0 +1,56 @@
+Execution
+============================
+
+
+With Mutx you can add data to the execution. Then you can find that data through the API by using
+
+    /mutx/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 mutx gem to your project
+
+    require 'mutx'
+
+Before, you have to add it to your Gemfile
+
+    # Gemfile
+    gem 'mutx'
+
+
+After adding the gem to your project, you can do:
+
+    Mutx::Custom::Execution.add_data("my_data_key", "some value for data key")
+
+
+Once the execution it is finished, you can see the values through:
+
+    http::/host:port/mutx/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.
+
+---------------------------------------
+
+Path to output dir
+============================
+
+If you want to save files you should use Mutx output dir path by using
+
+    "#{Mutx::Custom::Execution.output_path}/<your_file_name.extension>"