boinc_drone 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5739b02a34da53750e57b65f8d3637f8ba05090
-  data.tar.gz: 90b309e06b5291e9a3e4c45d2d20f8a6418ecfcc
+  metadata.gz: 1a0b3edaf818d6f8d699f8888459b25c0de5391d
+  data.tar.gz: faeb1bfcd721bbed93b934810ebaac9ab84cf27a
 SHA512:
-  metadata.gz: 8033985f2978eb08ab1ff376c55c81547746baa7c156226b986b5c0396f6eb7c28d81dac0682b4e988ebcfa45aeba8b7508935ac04f3934713e169e488d9f775
-  data.tar.gz: f6d480a79806a355782daf3aefe19657b8870c825d2b658bac2e3c95d57b42b85034b3b30cded061f754dfaf35fb66362fb2baeac9b6718e5eeae2d757cec782
+  metadata.gz: 0293eb2091a7ef52f2738bc72412cea48e4760ca19d8f04beec6ed21ad5a1d620814efd6d82c67da0b9291c0a2db9d21ebc0d75d550b31371b62ead5a2afe181
+  data.tar.gz: 5a7dece293ac08ffc673d02f9b8d4ba42fefff19a3fb274d77bd2a3f0056b6b1dd6930b334f66b7e627d4aa23e9685caca9929186d9669453b069ef3dd34731d

data/README.md

@@ -1,29 +1,214 @@
-# BoincDrone
+# boinc_drone
+This script allows the easily deployment of a [Boinc](https://boinc.berkeley.edu) process in a farm where each drone reports back to a main application in JSON.
 
-TODO: Write a gem description
+## Requirements
+This script leverages the `boinccmd` command and will require that you have the [commandline tool](http://boinc.berkeley.edu/wiki/Boinccmd_tool) installed, configured, and running.
 
 ## Installation
+Run this from your terminal:
 
-Add this line to your application's Gemfile:
-
-    gem 'boinc_drone'
+```bash
+$ gem install "boinc_drone"
+```
 
 And then execute:
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install boinc_drone
+```bash
+$ boinc_drone -a API_KEY -u WEBHOOK_URL -w WORKER_ID # worker_id is optional, it's included for the app this was made for
+```
 
 ## Usage
+Every 60 seconds this script will read the commandline output of the `boinccmd --get_state` and convert it to some nice JSON and `POST` it to the supplied `WEBHOOK_URL` with `API_KEY` set as an `X-API-KEY` header. If the `POST` fails for any reason it will fail silently and just keep looping.
 
-TODO: Write usage instructions here
+The request body's JSON:
+```json
+{
+  "meta":{
+    "worker_id": WORKER_ID
+  },
+  "projects":[
+    {
+      "name":"LHC@home 1.0",
+      "master_url":"http://lhcathome.cern.ch/lhcathome/",
+      "user_name":"Matthew",
+      "team_name":"",
+      "resource_share":"100.000000",
+      "user_total_credit":"1767.307159",
+      "user_expavg_credit":"148.063753",
+      "host_total_credit":"1767.307159",
+      "host_expavg_credit":"148.063766",
+      "nrpc_failures":"0",
+      "master_fetch_failures":"0",
+      "master_fetch_pending":"no",
+      "scheduler_rpc_pending":"no",
+      "trickle_upload_pending":"no",
+      "attached_via_account_manager":"yes",
+      "ended":"no",
+      "suspended_via_gui":"no",
+      "don't_request_more_work":"no",
+      "disk_usage":"0.000000",
+      "last_rpc":"1405565949.830400",
+      "project_files_downloaded":"0.000000"
+    }
+  ],
+  "applications":[
+    {
+      "name":"sixtrack",
+      "project":"LHC@home 1.0"
+    }
+  ],
+  "application_versions":[
+    {
+      "application":"sixtrack",
+      "version":"451.07",
+      "project":"LHC@home 1.0"
+    },
+    {
+      "application":"sixtrack",
+      "version":"451.07",
+      "project":"LHC@home 1.0"
+    }
+  ],
+  "workunits":[
+    {
+      "name":"sd_HL_7.5_490_1.6_4D_err__1__s__62.31_60.32__0_2__6__35_1_sixvf_boinc7",
+      "fp_estimate":"1.800000e+14",
+      "fp_bound":"1.800000e+17",
+      "memory_bound":"95.37 MB",
+      "disk_bound":"190.73 MB"
+    },
+    {
+      "name":"sd_HL_7.5_490_1.6_4D_err__2__s__62.31_60.32__0_2__6__40_1_sixvf_boinc110",
+      "fp_estimate":"1.800000e+14",
+      "fp_bound":"1.800000e+17",
+      "memory_bound":"95.37 MB",
+      "disk_bound":"190.73 MB"
+    },
+    {
+      "name":"sd_HL_7.5_690_1.6_4D_err__1__s__62.31_60.32__10_12__6__50_1_sixvf_boinc95",
+      "fp_estimate":"1.800000e+14",
+      "fp_bound":"1.800000e+17",
+      "memory_bound":"95.37 MB",
+      "disk_bound":"190.73 MB"
+    },
+    {
+      "name":"sd_HL_7.5_340_1.8_4D_err__5__s__62.31_60.32__8_10__6__15_1_sixvf_boinc479",
+      "fp_estimate":"1.800000e+14",
+      "fp_bound":"1.800000e+17",
+      "memory_bound":"95.37 MB",
+      "disk_bound":"190.73 MB"
+    }
+  ],
+  "tasks":[
+    {
+      "name":"sd_HL_7.5_490_1.6_4D_err__1__s__62.31_60.32__0_2__6__35_1_sixvf_boinc7_1",
+      "wu_name":"sd_HL_7.5_490_1.6_4D_err__1__s__62.31_60.32__0_2__6__35_1_sixvf_boinc7",
+      "project_url":"http://lhcathome.cern.ch/lhcathome/",
+      "report_deadline":"Wed Jul 23 03:21:09 2014",
+      "ready_to_report":"no",
+      "got_server_ack":"no",
+      "final_cpu_time":"0.000000",
+      "state":"downloaded",
+      "scheduler_state":"scheduled",
+      "exit_status":"0",
+      "signal":"0",
+      "suspended_via_gui":"no",
+      "active_task_state":"EXECUTING",
+      "app_version_num":"45107",
+      "checkpoint_cpu_time":"32849.200000",
+      "current_cpu_time":"32864.980000",
+      "fraction_done":"0.888423",
+      "swap_size":"82915328.000000",
+      "working_set_size":"58507264.000000",
+      "estimated_cpu_time_remaining":"3262.893271"
+    },
+    {
+      "name":"sd_HL_7.5_490_1.6_4D_err__2__s__62.31_60.32__0_2__6__40_1_sixvf_boinc110_0",
+      "wu_name":"sd_HL_7.5_490_1.6_4D_err__2__s__62.31_60.32__0_2__6__40_1_sixvf_boinc110",
+      "project_url":"http://lhcathome.cern.ch/lhcathome/",
+      "report_deadline":"Wed Jul 23 03:21:09 2014",
+      "ready_to_report":"no",
+      "got_server_ack":"no",
+      "final_cpu_time":"0.000000",
+      "state":"downloaded",
+      "scheduler_state":"uninitialized",
+      "exit_status":"0",
+      "signal":"0",
+      "suspended_via_gui":"no",
+      "active_task_state":"UNINITIALIZED",
+      "app_version_num":"0",
+      "checkpoint_cpu_time":"0.000000",
+      "current_cpu_time":"0.000000",
+      "fraction_done":"0.000000",
+      "swap_size":"0.000000",
+      "working_set_size":"0.000000",
+      "estimated_cpu_time_remaining":"11111.865751"
+    },
+    {
+      "name":"sd_HL_7.5_690_1.6_4D_err__1__s__62.31_60.32__10_12__6__50_1_sixvf_boinc95_1",
+      "wu_name":"sd_HL_7.5_690_1.6_4D_err__1__s__62.31_60.32__10_12__6__50_1_sixvf_boinc95",
+      "project_url":"http://lhcathome.cern.ch/lhcathome/",
+      "report_deadline":"Wed Jul 23 04:30:48 2014",
+      "ready_to_report":"no",
+      "got_server_ack":"no",
+      "final_cpu_time":"0.000000",
+      "state":"downloaded",
+      "scheduler_state":"uninitialized",
+      "exit_status":"0",
+      "signal":"0",
+      "suspended_via_gui":"no",
+      "active_task_state":"UNINITIALIZED",
+      "app_version_num":"0",
+      "checkpoint_cpu_time":"0.000000",
+      "current_cpu_time":"0.000000",
+      "fraction_done":"0.000000",
+      "swap_size":"0.000000",
+      "working_set_size":"0.000000",
+      "estimated_cpu_time_remaining":"11111.865751"
+    },
+    {
+      "name":"sd_HL_7.5_340_1.8_4D_err__5__s__62.31_60.32__8_10__6__15_1_sixvf_boinc479_0",
+      "wu_name":"sd_HL_7.5_340_1.8_4D_err__5__s__62.31_60.32__8_10__6__15_1_sixvf_boinc479",
+      "project_url":"http://lhcathome.cern.ch/lhcathome/",
+      "report_deadline":"Wed Jul 23 06:30:58 2014",
+      "ready_to_report":"no",
+      "got_server_ack":"no",
+      "final_cpu_time":"0.000000",
+      "state":"downloaded",
+      "scheduler_state":"uninitialized",
+      "exit_status":"0",
+      "signal":"0",
+      "suspended_via_gui":"no",
+      "active_task_state":"UNINITIALIZED",
+      "app_version_num":"0",
+      "checkpoint_cpu_time":"0.000000",
+      "current_cpu_time":"0.000000",
+      "fraction_done":"0.000000",
+      "swap_size":"0.000000",
+      "working_set_size":"0.000000",
+      "estimated_cpu_time_remaining":"11111.865751"
+    }
+  ],
+  "time_stats":{
+    "now":"1405569063.884657",
+    "on_frac":"1.000000",
+    "connected_frac":"-1.000000",
+    "cpu_and_network_available_frac":"0.999854",
+    "active_frac":"0.999854",
+    "gpu_active_frac":"0.999854",
+    "client_start_time":"1405183215.367770",
+    "previous_uptime":"385848.516887"
+  }
+}
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/boinc_drone/fork )
+1. Fork it ( https://github.com/msull92/boinc_drone/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 a new Pull Request
+
+## License
+Do whatever you want with it, just don't hurt anyone or expect me to be responsible for your use of it.

data/bin/boinc_drone

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require "boinc_drone"
+require "optparse"
+
+params = {}
+opt = OptionParser.new do |opt|
+  opt.on('-k', '--key KEY', 'API key') do |key|
+    params[:api_key] = key
+  end
+
+  opt.on('-u', '--url URL', 'Webhook URL') do |url|
+    things[:webhook_url] = url
+  end
+  
+  opt.on('-w', '--worker ID', 'Woker ID') do |id|
+    things[:worker_id] = id
+  end
+end
+
+opt.parse
+
+loop do
+  @report = BoincDrone::Report.new(params)
+  @report.post
+  sleep(60)
+end

data/lib/boinc_drone.rb

@@ -3,54 +3,57 @@ require "httparty"
 require "json"
 
 module BoincDrone
-  @report = { 
-    meta: {
-     worker_id: ENV["WORKER_ID"]
-    }
-  }
+  class Report
+    attr_accessor :api_key, :report, :webhook_url, :worker_id
+    
+    def initialize(api_key: "ABC123", webhook_url: "http://localhost:3000", worker_id: "123456")
+      @api_key = api_key
+      @webhook_url = webhook_url
+      @worker_id = worker_id
+      
+      @report = { 
+        meta: {
+         worker_id: @worker_id
+        }
+      }
 
-  input = `boinccmd --get_state`
-  input.each_line do |line|
-    if line.match(/======== (.+) ========/i)
-      match = line.match(/======== (.+) ========/i)
-      @scope = match.captures.first.gsub(" ", "_").downcase.to_sym
-      instance_variable_set("@#{@scope.to_s}", [])
+      input = `boinccmd --get_state`
+      input.each_line do |line|
+        if line.match(/======== (.+) ========/i)
+          match = line.match(/======== (.+) ========/i)
+          @scope = match.captures.first.gsub(" ", "_").downcase.to_sym
+          instance_variable_set("@#{@scope.to_s}", [])
     
-      if @scope == :time_stats
-        @time_stats = {}
-        @current = @time_stats
-      end
-    end
+          if @scope == :time_stats
+            @time_stats = {}
+            @current = @time_stats
+          end
+        end
   
-    if line.match(/\d+\) -----------$/i)
-      instance_variable_get("@#{@scope.to_s}") << {}
-      @current = instance_variable_get("@#{@scope.to_s}").send(:last)
-    elsif line.match(/(\S+): (.*)/i)
-      match = line.match(/\s+(.+): (.*)/i)
-      @current[match.captures.first.gsub(" ", "_").downcase.to_sym] = match.captures[1]
-    else
-      @report[@scope.to_sym] = instance_variable_get("@#{@scope.to_s}")
+        if line.match(/\d+\) -----------$/i)
+          instance_variable_get("@#{@scope.to_s}") << {}
+          @current = instance_variable_get("@#{@scope.to_s}").send(:last)
+        elsif line.match(/(\S+): (.*)/i)
+          match = line.match(/\s+(.+): (.*)/i)
+          @current[match.captures.first.gsub(" ", "_").downcase.to_sym] = match.captures[1]
+        else
+          @report[@scope.to_sym] = instance_variable_get("@#{@scope.to_s}")
+        end
+      end
     end
-  end
-
-  def post_report
-    begin
-      result = HTTParty.post(ENV["WEBHOOK_URL"],
-        body: { 
-          report: @report
-        },
-        headers: {
-          "X-API-KEY" => ENV["API_KEY"]
-        }
-      ).body
     
-      unless result.status == 200
-        sleep(60)
-        post_report
+    def post
+      begin
+        HTTParty.post(@webhook_url,
+          body: { 
+            report: @report
+          },
+          headers: {
+            "X-API-KEY" => @api_key
+          }
+        )
+      rescue => e
       end
-    rescue => e
-      sleep(60)
-      post_report
     end
   end
 end

data/lib/boinc_drone/version.rb

@@ -1,3 +1,3 @@
 module BoincDrone
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boinc_drone
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Matthew Sullivan
@@ -56,7 +56,8 @@ description: This script allows the easily deployment of a boinc process farm wh
   each drone reports back to a main application.
 email:
 - msull92@gmail.com
-executables: []
+executables:
+- boinc_drone
 extensions: []
 extra_rdoc_files: []
 files:
@@ -65,6 +66,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/boinc_drone
 - boinc_drone.gemspec
 - lib/boinc_drone.rb
 - lib/boinc_drone/version.rb