mutx 0.1.2

data/documentation/configuration.md

@@ -0,0 +1,13 @@
+How to configure Mutx?
+==============
+
+Mutx 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 Mutx.
+
+Mutx will show only those tasks marked as runnable as test tasks. 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 Mutx to expose the profile to be executed as a test task.

data/documentation/custom_parameters.md

@@ -0,0 +1,117 @@
+How to pass parameters to a test task execution?
+==============
+
+As Mutx retrieve information from task's file called cucumber.yml allocated on projet root folder.
+
+You can send parameters to a test task 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 task you have to set them up in cucumber.yml file.
+
+There are basically two types of fields you can show in test tasks (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 task 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 task 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 Mutx 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 Mutx::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 = Mutx::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
+

data/documentation/document_mutx.md

@@ -0,0 +1,122 @@
+How to make documentation for Mutx?
+==============
+
+Mutx documentation is loaded to your local mongodb during the command `prepare` from all .md files located inside /mutx/documentation/ 
+and /mutx/ folders.
+Then it's made available in [/mutx/help/main](/mutx/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 mutx git project inside /mutx/documentation/ folder, /mutx/ 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 [/mutx/help/main](/mutx/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 mutx 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 [/mutx/help/main](/mutx/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: [/mutx/help/main](/mutx/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: [/mutx/help/main](/mutx/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 task
+==============
+
+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 task 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 task 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 task to see all results for that test task
+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 task
+    </a>
+    <a href="/mutx/results/task/multi" class="btn btn-default">
+      &nbsp;&nbsp;All results for this task&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 tasks. 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 Mutx?
+==============
+*Basically it's about runnnig tests easily.*
+
+With Mutx, you don't have to install or configure nothing.
+Just enter on your favourite web browser the url where Mutx 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 tasks listed. Each test task involves many test (or not).
+If you want to know more about a test task you can mouse over the information icon which could have info about it
+Each test task saves its execution results in a database so you do not have to care about report because Mutx 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 Mutx?
+==============
+
+You can find test tasks on Test Suites section.
+Mutx 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](/mutx/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 task 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 task. 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>