mutx 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e6d51098762a59058ac78f8d555d4b1e1dde841
-  data.tar.gz: 837b24fa28e238b47c02306fc7d3fe51082d2b96
+  metadata.gz: 59c6ec4325709306828982280037d2b948a596d6
+  data.tar.gz: 142bbcdf1c0f8153f909235e5b5e750cb0681bf5
 SHA512:
-  metadata.gz: 033846539b9d85ba30524db05c7b0962e15518efc3165696e9e87fc523ad1cef1bdfeea2b96403c707928149cc49c882972d4a97aa68253f6a513a093c51b08c
-  data.tar.gz: 7a29987b8674b5d012c07fad2bffdc049e6c052574e82aacd386b03d1f89a5607a73fbabefd2f64dbabd8739db4bd556460c3264616b196ac59b74a2d56da1f6
+  metadata.gz: 4ef36addee27851f1b8fb2fb6c85beba0cfe3326486cb0f256bcdc83ab0a30fe372752344286ca123bf33c015b5cfccd97c8750c53e082d559c9e1741a46a827
+  data.tar.gz: e11d4425d9b651ee628cec0b52c823e907b61fdc5bbc5192326e0b4a36f6e36beea99e9a347c1e3e79de49921fdb88847ce4bdd1596f7bc4b3e19b9ffe3fadb5

data/lib/generators/create_alert.rb

@@ -0,0 +1,45 @@
+require 'colorize'
+module Mutx
+  class CreateAlert < Thor::Group
+
+    include Thor::Actions
+
+    desc "Create an Alert in Mutx"
+    argument :name, type: :string, desc: 'alert name'
+
+    def self.source_root
+      File.dirname(__FILE__) + "/templates/"
+    end
+
+    def self.alert_folder
+      "#{Dir.pwd}/alerts"
+    end
+
+    def self.alert_filename(alert_name)
+      File.join(self.alert_folder, "#{alert_name}_alert.rb")
+    end
+
+    def check_alert_folder
+      unless Dir.exist? self.class.alert_folder
+        say "creating alert folder: #{self.class.alert_folder}".green
+        empty_directory(self.class.alert_folder)
+      else
+        say "alert folder exists ( #{self.class.alert_folder} )".green
+      end
+    end
+
+    def check_not_exist_alert
+      raise Error, "alert exists ( #{ self.class.alert_filename(name) } )" if File.exists? self.class.alert_filename(name)
+    end
+
+    def create_alarm
+      template 'mutx_alert.rb.tt', self.class.alert_filename(name)
+    end
+
+    def finish_message
+      say 'Alert created!'.green
+      say "please, edit: #{self.class.alert_filename(name)}".green
+    end
+
+  end
+end      

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

@@ -3,6 +3,7 @@
 require 'mutx'
 require 'sidekiq'
 require 'sidekiq/web'
+require 'sidekiq/cron/web'
 
 #Sidekiq.configure_client do |config|
 #  config.redis = { :url => 'redis://10.211.15.195:6379/0' }

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

@@ -0,0 +1,10 @@
+# TODO cron: * * * * *
+# TODO email: a email or emails
+# TODO telegram: a group id
+
+require 'mutx'
+include Mutx::Alert::Script
+
+# put your code here!
+
+# write success! warning! or critical! to finish script

data/lib/mutx.rb

@@ -13,6 +13,7 @@ require 'byebug'
 require 'digest'
 require 'basica'
 require 'sidetiq'
+require 'sidekiq-cron'
 
 require_rel 'mutx'
 require_rel 'generators'
@@ -81,6 +82,11 @@ module Mutx
       Mutx::Commands.reset_tasks
     end
 
+    desc 'create_alert NAME', "Create a new alert"
+    def create_alert(name)
+      Mutx::Commands.create_alert(name)
+    end
+
     desc "Say bye to mutx", ""
     def bye
       if yes? "Are you sure to say bye to Mutx? (yes/no)"

data/lib/mutx/background_jobs/workers/alerts_worker.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+require 'sidekiq'
+
+module Mutx
+  module Workers
+    class AlertsWorker
+      include Sidekiq::Worker
+
+      sidekiq_options retry: false
+      
+      def perform(args)
+        stringio = StringIO.new
+        @alert = Alert.find(name: args['name'])
+        status = nil
+        begin
+          PTY.spawn("ruby #{args['path']}") do |stdout, stdin, pid|
+            begin
+              stdout.each do |line|
+                stringio.puts line
+              end
+            rescue Errno::EIO
+            ensure
+              Process.wait pid
+              status = $?.exitstatus
+            end
+          end 
+        rescue => e
+          logger.debug(e.message)
+          logger.debug(e.backtrace)
+          raise e
+        ensure
+          @alert.update_status(status, info: stringio.string)
+        end
+      end
+    end
+  end
+end

data/lib/mutx/background_jobs/workers/executor.rb

@@ -30,9 +30,9 @@ module Mutx
 
           efective_command = []
           efective_command << Mutx::Support::Configuration.headless? if result.gui_task?
+          efective_command << result.custom_params_values
           efective_command << result.command
           efective_command << "-f pretty -f html -o mutx/temp/#{result.mutx_report_file_name}" if result.is_cucumber?
-          efective_command << result.custom_params_values
           efective_command << "_id=#{result.id}" # to use inside execution the possibility to add information to the result
           puts "[#{result.id}]| Command: #{efective_command.join(" ")}"
           result.mutx_command = efective_command.join(" ")

data/lib/mutx/background_jobs/workers/notificator.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+require 'telegramsender'
+
+module Mutx
+  module Workers
+    class Notificator
+      include Sidekiq::Worker
+
+      def perform(type, destination, args= {})
+        simbolized = args.map { |k, v| [k.to_sym, v] }.to_h
+        self.send(type.to_sym, destination, **simbolized)
+      end
+
+      def telegram(group_id, message: '')
+        TelegramSender.send_message(group_id, message)
+      end
+
+      def email(mail_to, subject: '', body: '', attachment: nil)
+        # TODO
+      end
+    end
+  end
+end

data/lib/mutx/commands/create_alert.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+module Mutx
+  module Commands
+    def self.create_alert(name)
+      begin
+        Mutx::CreateAlert.start([name])
+      end
+    end
+  end
+end

data/lib/mutx/lib/notification.rb

@@ -0,0 +1,18 @@
+
+module Mutx
+  class Notification
+
+    def self.send_email(destination, subject: nil, body: nil, attachment: nil)
+      self.send(:email, destination, subject: subject, body: body, attachment: attachment)
+    end
+
+    def self.send_telegram(destination, message: '')
+      self.send(:telegram, destination, message: message)
+    end
+
+    def self.send(type, destination, options={})
+      Mutx::Workers::Notificator.perform_async(type, destination, options)
+    end
+
+  end
+end

data/lib/mutx/lib/paths.rb

@@ -54,6 +54,11 @@ module Mutx
       tests_run: '/tests/:test_name/run',
       tests_status: '/tests/:test_name/status',
 
+      alerts_index: '/alerts',
+      alerts_show: '/alerts/:alert_name',
+      alerts_on: '/alerts/:alert_name/run',
+      alerts_off: '/alerts/:alert_name/stop',
+
       features_index: '/features',
       features_file: '/features/file',
 

data/lib/mutx/models/alert.rb

@@ -0,0 +1,174 @@
+module Mutx
+  class Alert
+
+    module Script
+
+      def ok!
+        puts "Result: OK"
+        exit STATUS[:ok]
+      end
+
+      def skip!
+        puts "Result: SKIP"
+        exit STATUS[:skip]
+      end
+
+      def unknown!
+        puts "Result: UNKNOWN"
+        exit STATUS[:unknown]
+      end
+
+      def warning!
+        puts "Result: WARNING"
+        exit STATUS[:warning]
+      end
+
+      def critical!
+        puts "Result: CRITICAL"
+        exit STATUS[:critical]
+      end
+
+    end
+
+    ALERT_FOLDER = File.join("#{Dir.pwd}", 'alerts')
+
+    STATUS = {
+      ok: 0,
+      unknown: 1,
+      skip: 2,
+      warning: 3,
+      critical: 4
+    }
+
+    def self.all
+      alerts =  Dir.entries(ALERT_FOLDER).select { |file|
+                  file.match(/_alert.rb$/)        
+                }.map {|file| self.new(file) }
+    end
+
+    def self.find(args={})
+      if args.is_a? Hash
+        filename = "#{args[:name]}_alert.rb"
+        if File.exists?(File.join(ALERT_FOLDER, filename))
+          return self.new(filename)
+        else
+          return nil
+        end
+      else
+        return nil    
+      end
+    end
+
+    attr_reader :filename, :attributes, :job, :notification
+
+    def initialize(filename)
+      @filename = filename
+      extract_info
+      @enqueue = true
+      @job = Sidekiq::Cron::Job.find(name) || ((@enqueue = false) || create_job )
+    end
+
+    def name
+      filename.gsub('_alert.rb', '')
+    end
+
+    def email
+      attributes['email']
+    end
+
+    def telegram
+      attributes['telegram']
+    end
+
+    def slack
+      attributes['slack']
+    end
+
+    def cron
+      attributes['cron']
+    end
+
+    def last_enqueue
+      @job.last_enqueue_time
+    end
+
+    def enqueue?
+      @enqueue
+    end
+
+    def on!
+      if @job.valid?
+        @job.save
+        @enqueue = true
+      end
+      return self.enqueue?
+    end
+
+    def off!
+      @job.destroy
+      @enqueue = false
+    end
+
+    def status
+      STATUS.invert[self.result.to_i] || :unknown
+    end
+
+    def update_status(a_new_status, info: nil)
+      last_result = self.result
+      return if ((last_result.to_s == a_new_status.to_s) or (a_new_result.to_i == STATUS[:skip]))
+      self.result = a_new_status
+      notify(info) if last_result
+    end
+
+    def result
+      Sidekiq.redis do |redis|
+        redis.get("alerts:#{name}")
+      end
+    end
+
+    def result=(value)
+      Sidekiq.redis do |redis|
+        redis.set("alerts:#{name}", value.to_s)
+      end
+    end
+
+    private
+    def extract_info
+      content = File.read(File.join(ALERT_FOLDER, filename))
+      lines = content.split("\n").select {|line| line.match(/^\s*\#\s\w[\w_]+\:.+/) && !line.match(/TODO/)}
+      attributes = lines.map{ |line| line.gsub(/^\s*\#/,'').split(':',2).map(&:strip) }
+      @attributes = Hash[attributes]
+      @notification = @attributes.select do |k,v|
+        [:email, :slack, :telegram].include?(k.to_sym)
+      end
+    end
+
+    def create_job
+      Sidekiq::Cron::Job.new(name: name,
+                                   cron: attributes['cron'],
+                                   class: 'Mutx::Workers::AlertsWorker',
+                                   args: {
+                                            name: name,
+                                            file: filename,
+                                            path: File.join(ALERT_FOLDER, filename),
+                                            email: attributes['email']
+                                      })
+    end
+
+    def notify(info)
+      notify_telegram(self.telegram, info) if self.telegram
+      notify_email(self.email, info) if self.email
+    end
+
+    def notify_telegram(group_id, info)
+      return unless group_id
+      Notification.send_telegram(group_id, message: "Alert #{name} is #{status.upcase}")
+      Notification.send_telegram(group_id, message: info)
+    end
+
+    def notify_email(mail_to, info)
+      return unless mail_to
+      Notification.send_email(mail_to, subject: "Alert #{name} is #{status.upcase}", body: info)
+    end
+  end
+end

data/lib/mutx/routes.rb

@@ -36,6 +36,7 @@ module Mutx
           res.redirect path_for(:tasks_index)
         end
         on('admin') { run Mutx::Routes::Admin::Routes }
+        on('alerts') { run Mutx::Routes::Alerts::Routes }
         on('tasks') { run Mutx::Routes::Tasks::Routes }
         on('tests') { run Mutx::Routes::Tests::Routes }
         on('task-results') { run Mutx::Routes::TaskResults::Routes }

data/lib/mutx/routes/alerts_routes.rb

@@ -0,0 +1,40 @@
+# encoding: utf-8
+
+module Mutx
+  module Routes
+    module Alerts
+      class Routes < App
+        define do
+          on get do
+            on ":alert_name" do |alert_name|
+              res.write view('Alert', alert: Alert.find(name: alert_name))
+            end
+
+            on root do
+              res.write view('Alerts', alerts: Alert.all)
+            end
+          end
+
+          on post do
+            on ':alert_name/run' do |alert_name|
+              alert = Alert.find(name: alert_name)
+              if alert.on!
+                flash[:info] = "Alert add success"
+              else
+                flash[:error] = alert.job.errors.join(', ')
+              end
+              res.redirect path_for(:alerts_index) 
+            end
+
+            on ':alert_name/stop' do |alert_name|
+              alert = Alert.find(name: alert_name)
+              alert.off!
+              flash[:info] = "Alert off success"
+              res.redirect path_for(:alerts_index) 
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mutx/version.rb

@@ -1,3 +1,3 @@
 module Mutx
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/lib/mutx/view/alerts/_alert.mote

@@ -0,0 +1,45 @@
+<td>
+  {{ alert.name }}
+</td>
+<td>
+  {{ alert.cron }}
+</td>
+<td>
+  % alert.notification.each do |type, destination|
+    <b>{{ type}}:</b> {{destination}}<br/>
+  % end
+</td>
+
+% if alert.enqueue?
+  <td>
+    <span class="label label-success"> Running at {{ alert.job.cron }}</span>
+  </td>
+
+  <td>
+    {{ alert.last_enqueue.strftime("at %I:%M%p") if alert.last_enqueue }}
+  </td>
+
+  <td>
+    <span class="label label-{{ { success: 'success', warning: 'warning', critical: 'danger', unknown: 'primary' }[alert.status] }}"> {{ alert.status }} </span>
+    
+  </td>
+
+  <td>
+    <form name="{{ alert.name }}" method="POST" action="{{ path_for(:alerts_off, alert_name: alert.name )}}" >
+      
+      <button type="submit">{{ Mutx::View.icon_for("off") }}</button>
+    </form>
+  </td>
+% else
+  <td>
+    <span class="label label-danger"> Stopped </span>
+  </td>
+
+  <td/>
+  <td/>
+  <td>
+    <form name="{{ alert.name }}" method="POST" action="{{ path_for(:alerts_on, alert_name: alert.name)}}" >
+      <button type="submit">{{ Mutx::View.icon_for("on") }}</button>
+    </form>
+  </td>
+% end

data/lib/mutx/view/alerts/index.mote

@@ -0,0 +1,25 @@
+<div class="panel panel-default">
+  <div class="panel-heading">
+    <h4>{{section.capitalize}}</h4>
+  </div>
+  <table class="table table-striped table-hover">
+    <thead>
+      <tr>
+        <th>Name</th>
+        <th>Cron</th>
+        <th>Notificate to</th>
+        <th>Status</th>
+        <th>Last Exec.</th>
+        <th>Last Result</th>
+        <th/>
+      </tr>
+    </thead>
+    <tbody>
+      %  alerts.each do |alert|
+        <tr>
+          {{ partial('alerts/_alert', alert: alert) }}
+        </tr>
+      %  end
+    </tbody>
+  </table>
+</div>

data/lib/mutx/view/alerts/show.mote

@@ -0,0 +1,8 @@
+{{alert.name}}
+<br/>
+
+{{alert.filename}}
+
+<br/>
+
+{{alert.attributes}}

data/lib/mutx/view/sections.rb

@@ -24,6 +24,9 @@ module Mutx
         'Tasks' => "tasks/index",
         'Task' => "tasks/show",
         
+        'Alerts' => 'alerts/index',
+        'Alert' => 'alerts/show',
+
         'Task Results' => 'task_results/index',
 
         "Results"=> "results/index",

data/mutx.gemspec

@@ -42,6 +42,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'basica'
   spec.add_dependency 'sidetiq'
   spec.add_dependency 'chronic'
+  spec.add_dependency 'sidekiq-cron'
   #spec.add_dependency 'zip'
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mutx
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Roman Rodriguez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-07 00:00:00.000000000 Z
+date: 2017-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -304,6 +304,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sidekiq-cron
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -375,6 +389,7 @@ files:
 - img/mutx_logo.svg
 - lib/.DS_Store
 - lib/generators/.DS_Store
+- lib/generators/create_alert.rb
 - lib/generators/task_rack.rb
 - lib/generators/templates/.DS_Store
 - lib/generators/templates/Gemfile.tt
@@ -384,6 +399,7 @@ files:
 - lib/generators/templates/cronned_task.rb.tt
 - lib/generators/templates/mutx.conf.tt
 - lib/generators/templates/mutx.log.tt
+- lib/generators/templates/mutx_alert.rb.tt
 - lib/generators/templates/mutx_body_template.html.erb
 - lib/generators/templates/mutx_body_template.html.erb.zip
 - lib/generators/templates/mutx_template.html.erb
@@ -407,15 +423,18 @@ files:
 - lib/mutx/background_jobs/.DS_Store
 - lib/mutx/background_jobs/sidekiq.rb
 - lib/mutx/background_jobs/workers/.DS_Store
+- lib/mutx/background_jobs/workers/alerts_worker.rb
 - lib/mutx/background_jobs/workers/connectivity_check.rb
 - lib/mutx/background_jobs/workers/email_sender.rb
 - lib/mutx/background_jobs/workers/executor.rb
 - lib/mutx/background_jobs/workers/garbage_cleaner.rb
 - lib/mutx/background_jobs/workers/listener.rb
 - lib/mutx/background_jobs/workers/mutx_cron.rb
+- lib/mutx/background_jobs/workers/notificator.rb
 - lib/mutx/background_jobs/workers/update_started.rb
 - lib/mutx/commands/.DS_Store
 - lib/mutx/commands/bye.rb
+- lib/mutx/commands/create_alert.rb
 - lib/mutx/commands/help.rb
 - lib/mutx/commands/install.rb
 - lib/mutx/commands/reset.rb
@@ -438,7 +457,9 @@ files:
 - lib/mutx/lib/middlewares/flash_middleware.rb
 - lib/mutx/lib/middlewares/logger_middleware.rb
 - lib/mutx/lib/monkey_patch.rb
+- lib/mutx/lib/notification.rb
 - lib/mutx/lib/paths.rb
+- lib/mutx/models/alert.rb
 - lib/mutx/platforms/ruby.rb
 - lib/mutx/public/css/bootstrap.min.css
 - lib/mutx/public/css/font-awesome.min.css
@@ -456,6 +477,7 @@ files:
 - lib/mutx/routes/admin_routes/custom_params_routes.rb
 - lib/mutx/routes/admin_routes/repositories_routes.rb
 - lib/mutx/routes/admin_routes/tasks_routes.rb
+- lib/mutx/routes/alerts_routes.rb
 - lib/mutx/routes/api_routes.rb
 - lib/mutx/routes/api_routes/custom_params_routes.rb
 - lib/mutx/routes/api_routes/input_routes.rb
@@ -520,6 +542,9 @@ files:
 - lib/mutx/view/admin/tasks/index.mote
 - lib/mutx/view/admin/tasks/new.mote
 - lib/mutx/view/admin/tasks/show.mote
+- lib/mutx/view/alerts/_alert.mote
+- lib/mutx/view/alerts/index.mote
+- lib/mutx/view/alerts/show.mote
 - lib/mutx/view/body.mote
 - lib/mutx/view/custom-params/_custom_params.mote
 - lib/mutx/view/custom-params/types/json.mote