off_the_grid 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 07155e2121e33460113166ae7876130af5698fff
+  data.tar.gz: ef80d7252bedc9328729276b1a2e0c8cd78b760a
+SHA512:
+  metadata.gz: cfd6d1f0c1b1ef367c6b1fdcee8aa5a09ff6cdeaee40245ed719138ec91edd62f9c7bdaafee36a7c5b909cae9974bc12b8d09200e378ccb3e519f79e6cb5da4d
+  data.tar.gz: a9e08a7cc9ace51e28536cd0b272edbe481b7c5bf1df299ab3f77437716e6df9b7a04ea2115118f82c06124df09d84c1d84b1c6ca6c5654cebcd132aa891e5fe

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2016 KnuEdge Corporation
+
+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/lib/off_the_grid.rb

@@ -0,0 +1,19 @@
+# Standard Library
+require 'erb'
+require 'tempfile'
+
+# Internal Requirements
+require 'off_the_grid/version'
+require 'off_the_grid/erb_helpers'
+require 'off_the_grid/templates/execute_host'
+require 'off_the_grid/templates/project'
+require 'off_the_grid/templates/user'
+require 'off_the_grid/grid_resource'
+require 'off_the_grid/host'
+require 'off_the_grid/host_group'
+require 'off_the_grid/access_list'
+require 'off_the_grid/admin_host'
+require 'off_the_grid/execute_host'
+require 'off_the_grid/submit_host'
+require 'off_the_grid/project'
+require 'off_the_grid/user'

data/lib/off_the_grid/access_list.rb

@@ -0,0 +1,50 @@
+module OffTheGrid
+  class AccessList
+    attr_reader :name
+    include GridResource
+
+    # Get the list of SGE access lists
+    def self.list
+      `qconf -sul`.chomp.split("\n").sort.collect {|name| self.new(name) }
+    end
+
+    def details
+      `qconf -su #{name}`.chomp
+    end
+
+    def users
+      if new?
+        @unsaved_users ||= []
+      else
+        # Only returns users
+        extract_detail(:entries).select {|e| !e.match /^@/ }.collect {|user| User.new(user) }
+      end
+    end
+
+    def add_user(user)
+      if new?
+        @unsaved_users ||= []
+        @unsaved_users << user
+      else
+        users.include?(user) ? true : system("qconf -au #{user.name} #{name}")
+      end
+    end
+
+    def remove_user(user)
+      users.include?(user) ? system("qconf -du #{user.name} #{name}") : true
+    end
+
+    private
+
+    # Add an SGE access list
+    def add
+      fail "Creating ACL Requires One or More Users" if users.empty?
+      system("qconf -au #{users.map(&:name).join(',')} #{name}")
+    end
+
+    # Remove an SGE access list
+    def remove
+      system("qconf -dul #{name}")
+    end
+  end
+end

data/lib/off_the_grid/admin_host.rb

@@ -0,0 +1,20 @@
+module OffTheGrid
+  class AdminHost < Host
+    # Get the list of SGE adminstrative hosts
+    def self.list
+      `qconf -sh`.chomp.split("\n").sort.collect {|name| self.new(name) }
+    end
+
+    private
+
+    # Add an SGE administrative host
+    def add
+      system("qconf -ah #{hostname}")
+    end
+
+    # Remove an SGE administrative host
+    def remove
+      system("qconf -dh #{hostname}")
+    end
+  end
+end

data/lib/off_the_grid/erb_helpers.rb

@@ -0,0 +1,7 @@
+module OffTheGrid
+  module ErbHelpers
+    def render(template_data)
+      ERB.new(template_data.gsub(/^(\t|\s)+<%/, '<%'), 0, "<>").result(binding)
+    end
+  end
+end

data/lib/off_the_grid/execute_host.rb

@@ -0,0 +1,48 @@
+module OffTheGrid
+  class ExecuteHost < Host
+    # Get the list of SGE execute hosts
+    def self.list
+      `qconf -sel`.chomp.split("\n").sort.collect {|name| self.new(name) }
+    end
+
+    def details
+      `qconf -se #{name}`.chomp
+    end
+
+    def load_scaling
+      extract_detail(:load_scaling).last
+    end
+
+    def load_values
+      extract_detail(:load_values)
+    end
+
+    def processors
+      value = extract_detail(:processors).last
+      value.match(/[0-9]+/) ? Integer(value) : value
+    end
+
+    # very slow method for now
+    def host_groups
+      HostGroup.list.select {|group| group.hosts.include?(self) }
+    end
+
+    private
+
+    # Add an SGE execution host
+    def add
+      # TODO construct a template
+      Tempfile.open do |tmpfile|
+        tmpfile.puts render(Templates::ExecuteHost::ERB)
+        tmpfile.flush
+        system("qconf -Ae #{tmpfile.path}")
+        sleep 5
+      end
+    end
+
+    # Remove an SGE execution host
+    def remove
+      system("qconf -de #{hostname}")
+    end
+  end
+end

data/lib/off_the_grid/grid_resource.rb

@@ -0,0 +1,65 @@
+module OffTheGrid
+  module GridResource
+    include Comparable
+
+    def initalize(name)
+      @name = name
+    end
+
+    def self.list
+      []
+    end
+
+    def new?
+      !self.class.list.map(&:name).include?(name)
+    end
+
+    def save(safe = true)
+      if safe
+        raise "Validation Failed" unless validate_before_save
+        add
+      else
+        add # don't bother checking if the resource exists
+      end
+    end
+
+    def delete(safe = true)
+      if safe
+        raise "Validation Failed" unless validate_before_delete
+        remove
+      else
+        remove # don't bother checking if the resource exists
+      end
+    end
+
+    def extract_detail(detail, options = {})
+      options[:split_on] ||= /,|\s/
+      return [] unless respond_to?(:details)
+
+      values = []
+      details.split("\n").each do |line|
+        if values.size > 0
+          # Add follow-up lines from the weird word-wrapped output
+          line.match(/^( ){8}/) ? values << line : break
+        end
+        values << line if line.match /^#{detail.to_s} /
+      end
+      values.join
+            .gsub(/(#{detail.to_s} |\\|\s{2,})/, '')
+            .split(options[:split_on])
+            .uniq - ['']
+    end
+
+    def validate_before_save
+      new?
+    end
+
+    def validate_before_delete
+      !new?
+    end
+
+    def <=>(other)
+      name <=> other.name
+    end
+  end
+end

data/lib/off_the_grid/host.rb

@@ -0,0 +1,18 @@
+module OffTheGrid
+  class Host
+    attr_reader :hostname
+    include GridResource
+
+    def initialize(hostname)
+      @hostname = hostname
+    end
+
+    def name
+      hostname
+    end
+
+    def name=(hname)
+      hostname = hname
+    end
+  end
+end

data/lib/off_the_grid/host_group.rb

@@ -0,0 +1,37 @@
+module OffTheGrid
+  class HostGroup
+    attr_reader :name
+    include GridResource
+
+    # Get the list of SGE host groups
+    def self.list
+      `qconf -shgrpl`.chomp.split("\n").sort.collect {|name| self.new(name)}
+    end
+
+    def details
+      `qconf -shgrp #{name}`.chomp
+    end
+
+    def as_tree
+      `qconf -shgrp_tree #{name}`.chomp
+    end
+
+    def hosts
+      extract_detail(:hostlist).map {|host| ExecuteHost.new(host) }
+    end
+
+    # TODO Adding a Host to a HostGroup...
+
+    private
+
+    # Add an SGE host group
+    def add
+      system("qconf -ahgrp #{name}")
+    end
+
+    # Remove an SGE host group
+    def remove
+      system("qconf -dhgrp #{name}")
+    end
+  end
+end

data/lib/off_the_grid/project.rb

@@ -0,0 +1,51 @@
+module OffTheGrid
+  class Project
+    attr_reader :name
+    include GridResource
+
+    # Get the list of SGE projects
+    def self.list
+      `qconf -sprjl`.chomp.split("\n").sort.collect {|name| self.new(name) }
+    end
+
+    def details
+      `qconf -sprj #{name}`.chomp
+    end
+
+    def acls
+      extract_detail(:acl).each do |acl|
+        AccessList.new(acl)
+      end
+    end
+
+    def xacls
+      extract_detail(:xacl).each do |acl|
+        AccessList.new(acl)
+      end
+    end
+
+    # A Read-only list of users that can use this project
+    # Uses ACL association
+    def users
+      acls.map(&:users).flatten.uniq
+    end
+
+    private
+
+    # Add an SGE project
+    def add
+      # TODO construct a template
+      Tempfile.open do |tmpfile|
+        tmpfile.puts render(Templates::Project::ERB)
+        tmpfile.flush
+        system("qconf -Aprj #{tmpfile.path}")
+        sleep 5
+      end
+    end
+
+    # Remove an SGE project
+    def remove
+      system("qconf -dprj #{name}")
+    end
+  end
+end

data/lib/off_the_grid/submit_host.rb

@@ -0,0 +1,20 @@
+module OffTheGrid
+  class SubmitHost < Host
+    # Get the list of SGE submit hosts
+    def self.list
+      `qconf -ss`.chomp.split("\n").sort.collect {|name| self.new(name)}
+    end
+
+    private
+
+    # Add an SGE submit host
+    def add
+      system("qconf -as #{hostname}")
+    end
+
+    # Remove an SGE submit host
+    def remove
+      system("qconf -ds #{hostname}")
+    end
+  end
+end

data/lib/off_the_grid/templates/execute_host.rb

@@ -0,0 +1,17 @@
+module OffTheGrid
+  module Templates
+    module ExecuteHost
+      ERB = <<EOF
+hostname              <%= @hostname %>
+load_scaling          NONE
+complex_values        NONE
+user_lists            NONE
+xuser_lists           NONE
+projects              NONE
+xprojects             NONE
+usage_scaling         NONE
+report_variables      NONE
+EOF
+    end
+  end
+end

data/lib/off_the_grid/templates/project.rb

@@ -0,0 +1,13 @@
+module OffTheGrid
+  module Templates
+    module Project
+      ERB = <<EOF
+name <%= @name %>
+oticket 0
+fshare 0
+acl NONE
+xacl NONE
+EOF
+    end
+  end
+end

data/lib/off_the_grid/templates/user.rb

@@ -0,0 +1,13 @@
+module OffTheGrid
+  module Templates
+    module User
+      ERB = <<EOF
+name <%= @name %>
+oticket 0
+fshare 0
+delete_time 0
+default_project <%= @project %>
+EOF
+    end
+  end
+end

data/lib/off_the_grid/user.rb

@@ -0,0 +1,77 @@
+module OffTheGrid
+  class User
+    attr_reader :name
+
+    include GridResource
+
+    # Get the list of all SGE users
+    def self.list
+      `qconf -suserl`.chomp.split("\n").sort.collect {|name| self.new(name)}
+    end
+
+    # Get the list of admin users
+    def self.admins
+      `qconf -sm`.chomp.split("\n").sort.collect {|name| self.new(name)}
+    end
+
+    # An alias for admins
+    def self.managers
+      admins
+    end
+
+    # Get the list of operator users
+    def self.operators
+      `qconf -so`.chomp.split("\n").sort.collect {|name| self.new(name)}
+    end
+
+    def details
+      `qconf -suser #{name}`.chomp
+    end
+
+    def default_project=(project)
+      @default_project = project
+    end
+
+    def default_project
+      @default_project
+    end
+
+    def admin?
+      admins.include?(self)
+    end
+
+    alias_method :manager?, :admin?
+
+    def operator?
+      # TODO learn more about the difference between "operator" and "manager"
+      #  Maybe admins are always operators?
+      operators.include?(self)
+    end
+
+    private
+
+    # Add an SGE user
+    def add
+      Tempfile.open do |tmpfile|
+        tmpfile.puts render(Templates::User::ERB)
+        tmpfile.flush
+        system("qconf -Auser #{tmpfile.path}")
+        sleep 5
+      end
+    end
+
+    # Remove an SGE user
+    def remove
+      system("qconf -duser #{name}")
+    end
+
+    # Validations go here
+    def validate_before_save
+      if super
+        (@default_project && @default_project.is_a?(Project))
+      else
+        false
+      end
+    end
+  end
+end

data/lib/off_the_grid/version.rb

@@ -0,0 +1,5 @@
+module OffTheGrid
+  def self.version
+    '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: off_the_grid
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonathan Gnagy
+- Daniel Schaaff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: The Ruby library for interacting with Son of Grid Engine
+email: jgnagy@knuedge.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- lib/off_the_grid.rb
+- lib/off_the_grid/access_list.rb
+- lib/off_the_grid/admin_host.rb
+- lib/off_the_grid/erb_helpers.rb
+- lib/off_the_grid/execute_host.rb
+- lib/off_the_grid/grid_resource.rb
+- lib/off_the_grid/host.rb
+- lib/off_the_grid/host_group.rb
+- lib/off_the_grid/project.rb
+- lib/off_the_grid/submit_host.rb
+- lib/off_the_grid/templates/execute_host.rb
+- lib/off_the_grid/templates/project.rb
+- lib/off_the_grid/templates/user.rb
+- lib/off_the_grid/user.rb
+- lib/off_the_grid/version.rb
+homepage: https://github.com/knuedge/off_the_grid
+licenses:
+- MIT
+metadata: {}
+post_install_message: Thanks for installing Off The Grid!
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Off The Grid can perform basic management tasks for SGE.
+test_files: []