ucb_ist_unix 1.1.4

data/CHANGELOG

@@ -0,0 +1,42 @@
+= UCB::Webfarm Changelog
+
+== Version 0.4.0, 2007-10-04
+
+* Changed to RSpec from Test::Unit
+* Tests run on developer desktop (Mac and PC) and webfarm
+* Removed several methods that were required for testing
+* Made webfarm-only methods raise error when not called from webfarm
+
+== Version 0.3.4, 2007-08-21
+
+* added #mongrel_logs_dir
+* added #apache_logs_dir
+
+== Version 0.3.3, 2007-08-08
+
+* added development_migration_environment
+
+== Version 0.3.2, 2007-07-18
+
+* added #rails_migration_environment
+* added qa/quality_assurance/quality_assurance_migration environments
+
+== Version 0.3.1, 2007-07-17
+
+* added #rails_environment
+
+== Version 0.3.0, 2007-03-05
+
+* added #first_mongrel_port
+* added #home_dir
+* added #local_home_dir
+* added constants for rails environments
+
+== Version 0.2.0, 2007-02-08
+
+* made unit tests runnable on Windows/Unix desktops and Webfarm
+* added "programmer" environment which is where programmer develops applications
+* added #machine_name which returns name of webfarm instance logged on to
+* added #all_machines which returns all machine names in the current instance
+
+== Version 0.1.0, Initial release

data/Manifest

@@ -0,0 +1,10 @@
+CHANGELOG
+Manifest
+README
+Rakefile
+lib/ucb_calweb_pro.rb
+lib/ucb_ist_unix.rb
+lib/ucb_unix_environment.rb
+lib/ucb_webfarm.rb
+tasks/ucb_ist_unix.rake
+version.yml

data/README

@@ -0,0 +1,7 @@
+= UC Berkeley Webfarm
+
+UCB::Webfarm gives Ruby programs access to webfarm settings:
+
+- uid, user, gid, group
+- environment (dev/qa/prod)
+- port info

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+require 'hanna/rdoctask'
+ 
+Echoe.new('ucb_ist_unix', '1.1.4') do |p|
+  p.description    = "UCB Webfarm/Calweb-Pro environment utilities"
+  p.url            = "http://ucbrb.rubyforge.org/ucb_ist_unix"
+  p.author         = "Steven Hansen"
+  p.email          = "runner@berkeley.edu"
+  p.ignore_pattern = ["svn_user.yml", "ucb_ist_unix.rake", "spec/**/**"]
+  p.project = "ucbrb"
+  p.rdoc_options = "-o doc --inline-source -T hanna lib/*.rb"
+  p.rdoc_pattern = ["README", "CHANGELOG", "lib/**/**"]
+end
+ 
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+
+

data/lib/ucb_calweb_pro.rb

@@ -0,0 +1,15 @@
+
+module UCB
+  class CalwebPro
+    include UCB::UnixEnvironment
+    
+    def self.environment
+      'prod'
+    end
+    
+    def self.calweb_pro?
+      machine_name.split('-').first == 'calweb'
+    end
+    
+  end
+end

data/lib/ucb_ist_unix.rb

@@ -0,0 +1,6 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'ucb_unix_environment'
+require 'ucb_calweb_pro'
+require 'ucb_webfarm'
+require 'etc'

data/lib/ucb_unix_environment.rb

@@ -0,0 +1,166 @@
+
+module UCB
+  # Module giving Ruby access to various attributes of the webfarm 
+  # including environment (dev, qa, prod), user/group info and ports.
+  #
+  #   `uname -n`                  #=> "webfarm-dev-01\n"
+  #   
+  #   UCB::Webfarm.machine_name   #=> "webfarm-dev-01"
+  #   UCB::Webfarm.machines       #=> ["webfarm-dev-01", "webfarm-dev-02"]
+  #   
+  #   `id`                        #=> "uid=10099(a_user) gid=10099(a_group)\n"
+  #
+  #   UCB::Webfarm.webfarm_id     #=> 99
+  #   UCB::Webfarm.uid            #=> 10099
+  #   UCB::Webfarm.user           #=> "a_user"
+  #   UCB::Webfarm.shared_dir     #=> "/users/a_user"
+  #   UCB::Webfarm.local_dir      #=> "/users/a_user/local"
+  #
+  #   UCB::Webfarm.http_port      #=> 10099
+  #   UCB::Webfarm.https_port     #=> 20099
+  #   
+  #   UCB::Webfarm.mongrel_port_count  #=> 4
+  #   UCB::Webfarm.mongrel_ports       #=> [30099, 40099, 50099, 60099]
+  #
+  module UnixEnvironment
+
+    def self.included(klass)
+      klass.extend(ClassMethods)
+      klass.extend(AbstractClassMethods)
+    end
+    
+    module AbstractClassMethods
+      def environment
+        begin
+          super
+        rescue NoMethodError
+          raise NoMethodError, "Abstract method 'environment' not implemented."
+        end
+      end
+    end
+    
+    module ClassMethods
+      # Returns +true+ if on Windows.
+      def win32?
+        RUBY_PLATFORM =~ /win32/
+      end
+    
+      # Returns the machine name.
+      def machine_name
+        return "" if win32?
+        `uname -n`.chop
+      end
+      
+      def unix_service
+        return "" if win32?
+        machine_name.split('-')
+      end
+      
+      def domain_name
+        return "" if win32?
+        `domainname`.chomp.downcase
+      end
+      
+      # Returns the user account home directory. This is on shared storage across machines.
+      def shared_dir
+        "/users/#{user}"
+      end
+      alias :home_dir  :shared_dir
+    
+      # Returns the local directory of the individual for your account.
+      # i.e., not shared across webfarm instances.
+      def local_dir
+        "/users/#{user}/local"
+      end
+
+      # Returns full path of the directory containing the mongrel logs.
+      def mongrel_log_dir
+        "#{local_dir}/rails/log"
+      end
+
+      def mongrel_pid_dir
+        "#{local_dir}/rails/#{user}/pid"
+      end
+      
+      # Returns full path of the directory containing the apache logs.
+      def apache_log_dir
+        "#{local_dir}/apache2/logs"
+      end
+
+      # Returns the unique identifier of the account instance.
+      def webfarm_id
+        uid - 10000
+      end
+
+
+      # Returns the +gid+.
+      def gid
+        id_info(:gid)
+      end
+    
+      # Returns the +group+.
+      def group
+        id_info(:group)
+      end
+
+      # Returns the +uid+.
+      def uid
+        id_info(:uid)
+      end
+    
+      # Returns the +user+.
+      def user
+        id_info(:user)
+      end
+          
+      def id_info(symbol) #:nodoc:
+        unless @id_info
+          @id_info = {}
+          unless win32?
+            login = ENV['LOGNAME']
+            user = Etc.getpwnam(login)
+            group = Etc.getgrnam(login)
+            @id_info = {:uid => user.uid, :user => user.name, :gid => group.gid, :group => group.name }
+          end
+        end
+        @id_info[symbol]
+      end
+ 
+ 
+      #### Ports #####
+      
+      # Returns an +Array+ (of +Integer+) of ports.
+      def ports
+        @ports ||= Array.new(6) { |i| (i*10000) + uid }
+      end
+
+      # Returns the Apache http port
+      def http_port
+        ports[0]
+      end
+      alias :non_ssl_port  :http_port
+
+      # Returns the Apache https port.
+      def https_port
+        ports[1]
+      end
+      alias :ssl_port :https_port
+ 
+      # Returns ports not used by Apache in standard webfarm configurations.
+      def apache_ports
+        @apache_ports ||= [http_port, https_port]
+      end
+
+      # Setter for mongrel_port_count.
+      def mongrel_ports=(port_array)
+        @mongrel_ports = port_array
+      end
+
+      # Returns ports for mongrel processes.
+      def mongrel_ports
+        @mongrel_ports ||= (ports - apache_ports)
+      end
+    end
+    
+  end
+end

data/lib/ucb_webfarm.rb

@@ -0,0 +1,108 @@
+
+module UCB #:nodoc:
+  # Module giving Ruby access to various attributes of the webfarm 
+  # including environment (dev, qa, prod), user/group info and ports.
+  #
+  #   require 'ucb_ist_unix'
+  #   
+  #   `domainname`               #=> "dev\n"
+  #   
+  #   UCB::Webfarm.environment   #=> "dev"
+  #   UCB::Webfarm.dev_int?          #=> true
+  #   UCB::Webfarm.prod?         #=> false
+  # 
+  module Webfarm
+    include UCB::UnixEnvironment
+
+    # Webfarm Environments
+    DEV_INT_ENV                              = 'dev' 
+    QA_ENV                                   = 'qa'
+    PROD_ENV                                 = 'prod'
+
+    # Rails Environments
+    RAILS_DEV_INTEGRATION_ENV                = 'dev_integration'
+    RAILS_QUALITY_ASSURANCE_ENV              = 'quality_assurance'
+    RAILS_PRODUCTION_ENV                     = 'production'
+                        
+    # Rails Migration Environments
+    RAILS_DEV_INTEGRATION_MIGRATION_ENV      = 'dev_integration_migration'
+    RAILS_QUALITY_ASSURANCE_MIGRATION_ENV    = 'quality_assurance_migration'
+    RAILS_PRODUCTION_MIGRATION_ENV           = 'production_migration'
+
+
+    class << self
+      # Returns an +Array+ of the Webfarm (not Rails) environments.
+      def environments
+        @webfarm_environments ||= [DEV_INT_ENV, QA_ENV, PROD_ENV]
+      end
+      alias :webfarm_environments :environments
+      
+      # Returns _webfarm_ environment.
+      def environment
+        webfarm_environments.include?(domain_name) ? domain_name : nil
+      end
+      alias :webfarm_environment :environment 
+
+      def webfarm?
+        machine_name.split('-').first == 'webfarm'  
+      end
+
+      # An +Array+ of all machine names for the environment.
+      def machines
+        return [] if win32?
+        
+        if dev?
+          ['localhost']
+        elsif dev_int?
+          ['webfarm-dev-01', 'webfarm-dev-02']          
+        elsif qa?
+          ['webfarm-qa-01', 'webfarm-qa-02']          
+        elsif prod?
+          ['webfarm-prod-01', 'webfarm-prod-02', 'webfarm-prod-03', 'webfarm-prod-04']       
+        else
+          raise(Exception, "Unrecognized Environment")
+        end
+      end
+      
+      def dev?
+        environment.nil?  
+      end
+      
+      # Returns +true+ for dev webfarm instances
+      def dev_int?
+        environment == DEV_INT_ENV
+      end
+
+      # Returns +true+ for qa webfarm instances
+      def qa?
+        environment == QA_ENV
+      end
+
+      # Returns +true+ for prod webfarm instances
+      def prod?
+        environment == PROD_ENV
+      end
+
+      # Returns Rails environment corresponding to the Webfarm environment.
+      # Returns ENV_RAILS_DEVELOPMENT unless webfarm?
+      #
+      # Raises RuntimeError for unknown environment.
+      def rails_environment
+        return RAILS_DEV_INTEGRATION_ENV if dev_int?
+        return RAILS_QUALITY_ASSURANCE_ENV if qa?
+        return RAILS_PRODUCTION_ENV if prod?
+        raise "Unknown webfarm rails_environment '#{environment}'"
+      end
+
+      # Returns environment to use for migrations.  Allows different
+      # credentials for migrations than for web app.
+      def rails_migration_environment
+        return RAILS_DEV_INTEGRATION_MIGRATION_ENV if dev_int?
+        return RAILS_QUALITY_ASSURANCE_MIGRATION_ENV if qa?
+        return RAILS_PRODUCTION_MIGRATION_ENV if prod?
+        raise "Unknown webfarm rails_migration_environment '#{environment}'"
+      end
+    end
+    
+  end
+end

data/tasks/ucb_ist_unix.rake

@@ -0,0 +1,9 @@
+require 'yaml'
+require 'spec/rake/spectask'
+require 'svn/rake/svntask'
+
+svn = Rake::SVN::ProjectTask.new() do |s|
+ s.method = "svn+ssh"
+ s.project_url = "svn.berkeley.edu/svn/ist-svn/berkeley/projects/commons/ruby/ucb-webfarm"
+ s.username = YAML.load_file('svn_user.yml')['svn_username']
+end

data/ucb_ist_unix.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ucb_ist_unix}
+  s.version = "1.1.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Steven Hansen"]
+  s.date = %q{2009-04-15}
+  s.description = %q{UCB Webfarm/Calweb-Pro environment utilities}
+  s.email = %q{runner@berkeley.edu}
+  s.extra_rdoc_files = ["CHANGELOG", "README", "lib/ucb_calweb_pro.rb", "lib/ucb_ist_unix.rb", "lib/ucb_unix_environment.rb", "lib/ucb_webfarm.rb"]
+  s.files = ["CHANGELOG", "Manifest", "README", "Rakefile", "lib/ucb_calweb_pro.rb", "lib/ucb_ist_unix.rb", "lib/ucb_unix_environment.rb", "lib/ucb_webfarm.rb", "tasks/ucb_ist_unix.rake", "version.yml", "ucb_ist_unix.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://ucbrb.rubyforge.org/ucb_ist_unix}
+  s.rdoc_options = ["-o doc --inline-source -T hanna lib/*.rb"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{ucbrb}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{UCB Webfarm/Calweb-Pro environment utilities}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

data/version.yml

@@ -0,0 +1 @@
+version: 'rel-1.1.4'

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: ucb_ist_unix
+version: !ruby/object:Gem::Version 
+  version: 1.1.4
+platform: ruby
+authors: 
+- Steven Hansen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-15 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: UCB Webfarm/Calweb-Pro environment utilities
+email: runner@berkeley.edu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- README
+- lib/ucb_calweb_pro.rb
+- lib/ucb_ist_unix.rb
+- lib/ucb_unix_environment.rb
+- lib/ucb_webfarm.rb
+files: 
+- CHANGELOG
+- Manifest
+- README
+- Rakefile
+- lib/ucb_calweb_pro.rb
+- lib/ucb_ist_unix.rb
+- lib/ucb_unix_environment.rb
+- lib/ucb_webfarm.rb
+- tasks/ucb_ist_unix.rake
+- version.yml
+- ucb_ist_unix.gemspec
+has_rdoc: true
+homepage: http://ucbrb.rubyforge.org/ucb_ist_unix
+post_install_message: 
+rdoc_options: 
+- -o doc --inline-source -T hanna lib/*.rb
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: ucbrb
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: UCB Webfarm/Calweb-Pro environment utilities
+test_files: []
+