lib/core_ext/string.rb @@ -18,7 +18,7 @@ ROOT = Pathname(__FILE__).dirname.expand_path require 'lib/warning_shot/version' -CLEAN.include ["**/.*.sw?", "pkg", "lib/*.bundle", "*.gem", "doc/rdoc","doc/yard", "test/output/*", "coverage", "cache"] +CLEAN.include ["**/.*.sw?", "pkg", "lib/*.bundle", "*.gem", "doc/","doc/", "test/output/*", "coverage", "cache"] Dir['tasks/*.rb'].each {|r| require r} Rakefile @@ -1,21 +1,13 @@ Additional TODOS are at: http://warningshot.lighthouseapp.com -WarningShot boot & work (interface & CLI) -DependencResolver Class should run/report back to caller status +==== +Rewrite File stuff using pathname, its sexier -WarningShot logger needs serious love, ie, my output sucks. - -======== WarningShot should have its own set of config files so it can test its self (for WS Developers) -Cyclical healing (loop resolution call until unresolved == 0 or unresolved == last_unresolved) - Gems * Minigems option, prepares gems as minigems - -Permissions Resolver - * chmod, chown Binary Resolver * Apt, Yum, Ports @@ -62,9 +54,6 @@ QA Resolvers - {page: "http://example.com/login", grade: ">90"} - {page: "http://example.com/index", grade: ">=99", rollback: "true"} - -warningshot should get platform information to allow for platfrom specific resolutions - Interfaces for Cap, Vertebra, and Vlad ==== Old SHit. TODO @@ -1,10 +1,33 @@ +require 'open4' + class WarningShot::PermissionResolver include WarningShot::Resolver order 100 branch :permission description 'Validates mode, user, and group permission on files and directories' + + module UnixPermissionsInterface;end; + module WindowsPermissionsInterface;end; - cast do |yaml| + if WarningShot.platform != :windows + include WarningShot::PermissionResolver::UnixPermissionsInterface + #http://www.ruby-doc.org/core/classes/File/Stat.html + #http://www.ruby-doc.org/stdlib/libdoc/etc/rdoc/index.html + #http://www.ruby-doc.org/stdlib/libdoc/pathname/rdoc/index.html + #http://www.ruby-doc.org/stdlib/libdoc/fileutils/rdoc/index.html + #http://www.ruby-doc.org/core/classes/File.html#M002574 + else + include WarningShot::PermissionResolver::WindowsPermissionsInterface + end + + PermissionResource = Struct.new(:path,:target_mode,:target_owner,:target_group) do + def owner;end; + def group;end; + def mode;end; + end + + cast Hash do |yaml| + PermissionResource.new end register :test do |dep| lib/resolvers/permission_resolver.rb @@ -9,9 +9,9 @@ module WarningShot @defaults ||= { :environment => 'development', :resolve => false, - :config_paths => [File.join('.','config','warningshot'),File.join('~','.warningshot')], + :config_paths => ['.' / 'config' / 'warningshot', '~' / 'warningshot'], :application => '.', - :log_path => File.join('.','log','warningshot.log'), + :log_path => '.' / 'log' / 'warningshot.log', :log_level => :info, :growl => false, :verbose => false, lib/warning_shot/config.rb @@ -105,7 +105,7 @@ module WarningShot def load_configs @config[:config_paths].each do |config_path| #Parse the global/running env configs out of the YAML files. - Dir[File.join(config_path,WarningShot::ConfigExt)].each do |config_file| + Dir[config_path / WarningShot::ConfigExt].each do |config_file| # Use WarningShot::ConfigExt & regexp on extension to make supporting add'l # file types easier in the future case File.extname(config_file) lib/warning_shot/dependency_resolver.rb @@ -2,7 +2,7 @@ module WarningShot class Growl def Growl.say(msg) - img = File.join(WarningShot.dir_for(:images),'warning_shot.png') + img = WarningShot.dir_for(:images) / 'warning_shot.png' gmsg = %{growlnotify -t "WarningShot" -n "WarningShot" -m "#{msg}"} gmsg += %{ --image #{img}} unless img.nil? lib/warning_shot/growl.rb @@ -3,29 +3,19 @@ module WarningShot class << self def create(path) generate_configs(path) - #generate_scripts(path,'bash') - #generate_scripts(path,'ruby') end def generate_configs(path) - from = File.join(WarningShot.dir_for(:templates),WarningShot::ConfigExt) + from = WarningShot.dir_for(:templates) / WarningShot::ConfigExt copy_templates from, path end - #def generate_scripts(path,type) - # scripts_path = File.join('scripts',type) - # from = File.join(WarningShot.dir_for(:templates),scripts_path,"*") - # to = File.join(path,scripts_path) - - # copy_templates from, to - #end - private def copy_templates(from,to) FileUtils.mkdir_p to unless File.exists? to Dir[from].each do |file| - file_dest_path = File.join(to,File.basename(file)) + file_dest_path = to / File.basename(file) # Add .sample if config is already present file_dest_path += '.sample' if File.exists? file_dest_path FileUtils.cp file, file_dest_path lib/warning_shot/template_generator.rb @@ -5,14 +5,14 @@ module WarningShot PATHS = { :templates => 'templates', :images => 'images', - :resolvers => File.join('lib','warning_shot','resolvers') + :resolvers => 'lib' / 'warning_shot' / 'resolvers' } ConfigExt = "*.{yml,yaml}".freeze class << self def root - File.join(File.expand_path(File.dirname(__FILE__)),"..","..") + File.expand_path(File.dirname(__FILE__)) / ".." / ".." end # Gets the absolute path for a resource. @@ -28,7 +28,18 @@ module WarningShot # @api public def dir_for(dir) dir = PATHS[dir.to_sym] || dir.to_s - File.join(WarningShot.root,dir) + WarningShot.root / dir + end + + def platform + case ::Config::CONFIG['host_os'] + when /darwin/i: :mac + when /mswin|windows/i: :windows + when /linux/i: :linux + when /sunos|solaris/i: :solaris + else + :unknown + end end # the application/framework warningshot is running in lib/warning_shot/warning_shot.rb @@ -4,13 +4,14 @@ require 'yaml' require 'optparse' require 'logger' require 'set' +require 'rbconfig' # Load core extensions -Dir.glob(File.join(File.dirname(__FILE__), "core_ext","**","*.rb")).each {|f| require f} +Dir.glob(File.join(File.dirname(__FILE__), "core_ext", "**", "*.rb")).each {|f| require f} # Load WarningShot -Dir.glob(File.join(File.dirname(__FILE__), "warning_shot","**","*.rb")).each {|f| require f} +Dir.glob(File.dirname(__FILE__) / "warning_shot" / "**" / "*.rb").each {|f| require f} # Load resolvers -Dir.glob(File.join(File.dirname(__FILE__), "resolvers","**","*.rb")).each {|f| require f} \ No newline at end of file +Dir.glob(File.dirname(__FILE__) / "resolvers" / "**" / "*.rb").each {|f| require f} \ No newline at end of file lib/warningshot.rb @@ -1,4 +1,4 @@ -require File.join(%w(. lib resolvers RESOLVER_NAME)) +require "." / "lib" / "resolvers" RESOLVER_NAME describe WarningShot::RESOLVER_NAME do resolver_spec_template.txt @@ -2,10 +2,19 @@ # the 'global' environment are always checked # Each environt takes an array hashes -# path REQUIRED -# recursive, mode, user, group OPTIONAL (one required) +# @param path [String] REQUIRED +# the path to check permissions +# @param mode [String] OPTIONAL +# MOde of file 0777, 0755, etc +# @param user [String] +# User that should own resource +# @param group [STring] +# Group that should own resource +# @param recursive [String] +# What methods should be recursvie: 'chmod','chown','both','none' +# @example # - { path: './public/images', mode: '0777', user: 'www-data', group: 'www-data'} -# - { path: '.', mode: '0755', user: 'www-data', group: 'www-data' } +# - { path: '.', mode: '0755', user: 'www-data', group: 'www-data', recursive: "both"} # - { path: '/tmp/app_cache/', mode: '0777', user: 'nobody', group: 'nobody' } --- - :branch: permission templates/permissions.yml @@ -1,9 +1,8 @@ require 'lib/warningshot' -$test_data = File.join(%w(. test data)) - -$log_root = File.join(%w(. test log)) -$log_file = File.join($log_root, 'warningshot.log') +$test_data = "." / "test" / "data" +$log_root = "." / "test" / "log" +$log_file = $log_root / 'warningshot.log' FileUtils.mkdir_p $log_root test/spec/spec_helper.rb @@ -1,4 +1,4 @@ -require File.join(%w(. lib resolvers core_lib_resolver)) +require "." / "lib" / "resolvers" / "core_lib_resolver" describe WarningShot::CoreLibResolver do before :all do test/spec/unit/resolvers/core_lib_resolver_spec.rb @@ -1,10 +1,10 @@ -require File.join(%w(. lib resolvers directory_resolver)) +require "." / "lib" / "resolvers" / "directory_resolver" describe WarningShot::DirectoryResolver do before :all do WarningShot::DirectoryResolver.logger = $logger - @@base_path = File.expand_path(File.join(%w(. test data resolvers directory))) + @@base_path = File.expand_path("." / "test" / "data" / "resolvers" / "directory") end after :each do @@ -23,8 +23,8 @@ describe WarningShot::DirectoryResolver do it 'should create the directory if it does not exist' do control_dir = File.expand_path('.') - test_dir1 = File.join(@@base_path,'test1') - test_dir2 = File.join(@@base_path,'test2') + test_dir1 = @@base_path / 'test1' + test_dir2 = @@base_path / 'test2' resolver = WarningShot::DirectoryResolver.new control_dir,test_dir1, test_dir2 resolver.test! resolver.passed.length.should be(1) test/spec/unit/resolvers/directory_resolver_spec.rb @@ -1,12 +1,12 @@ -require File.join(%w(. lib resolvers file_resolver)) +require "." / "lib" / "resolvers" / "file_resolver" describe WarningShot::FileResolver do before :all do WarningShot::FileResolver.logger = $logger - @@base_path = File.expand_path(File.join(%w(. test data resolvers file))) - @@source_path = File.join(@@base_path,'src') - @@dest_path = File.join(@@base_path,'dest') + @@base_path = File.expand_path("." / "test" / "data" / "resolvers" / "file") + @@source_path = @@base_path / 'src' + @@dest_path = @@base_path / 'dest' FileUtils.mkdir_p @@dest_path end @@ -34,8 +34,8 @@ describe WarningShot::FileResolver do describe 'with heal instructions' do describe 'file does not exist' do it 'should add failed dependencies to #failed' do - that_file = File.join @@source_path, 'that.txt' - this_file = File.join @@dest_path, 'this.txt' + that_file = @@source_path / 'that.txt' + this_file = @@dest_path / 'this.txt' fd = WarningShot::FileResolver.new({:source => "file://#{that_file}",:target => this_file}) fd.test! @@ -44,8 +44,8 @@ describe WarningShot::FileResolver do end it 'should heal a file from file://' do - that_file = File.join @@source_path, 'that.txt' - this_file = File.join @@dest_path, 'this.txt' + that_file = @@source_path / 'that.txt' + this_file = @@dest_path / 'this.txt' fd = WarningShot::FileResolver.new({:source => "file://#{that_file}",:target => this_file}) fd.test! @@ -55,7 +55,7 @@ describe WarningShot::FileResolver do end it 'should heal a file from http://' do - fd = WarningShot::FileResolver.new({:source => "http://www.example.com/",:target => File.join(@@dest_path,'internetz.html')}) + fd = WarningShot::FileResolver.new({:source => "http://www.example.com/",:target => (@@dest_path / 'internetz.html')}) fd.test! fd.failed.length.should be(1) fd.resolve! @@ -67,7 +67,7 @@ describe WarningShot::FileResolver do end it 'should not increment #resolved if the resolution fails' do - fd = WarningShot::FileResolver.new({:source => "http://www.example.com/DOESNT.EXIST",:target => File.join(@@dest_path,'doesnt_exist.html')}) + fd = WarningShot::FileResolver.new({:source => "http://www.example.com/DOESNT.EXIST",:target => (@@dest_path / 'doesnt_exist.html')}) fd.test! fd.failed.length.should be(1) fd.resolve! @@ -78,7 +78,7 @@ describe WarningShot::FileResolver do describe 'without heal instructions' do it 'should be able to return unresolved dependencies' do - this_file = File.join @@dest_path, 'this.txt' + this_file = @@dest_path / 'this.txt' fd = WarningShot::FileResolver.new({:target => this_file}) fd.test! @@ -93,7 +93,7 @@ describe WarningShot::FileResolver do describe 'file does not exist' do it 'should add dependency to #failed' do - this_file = File.join @@dest_path, 'this.txt' + this_file = @@dest_path / 'this.txt' fd = WarningShot::FileResolver.new({:target => this_file}) fd.test! @@ -109,8 +109,8 @@ describe WarningShot::FileResolver do describe 'with heal instructions' do describe 'file does not exist' do it 'should add dependency to #failed' do - that_file = File.join @@source_path, 'that.txt' - this_file = File.join @@dest_path, 'this.txt' + that_file = @@source_path / 'that.txt' + this_file = @@dest_path / 'this.txt' fd = WarningShot::FileResolver.new({:target => this_file,:source => that_file}) fd.test! @@ -122,7 +122,7 @@ describe WarningShot::FileResolver do describe 'without heal instructions' do describe 'file does not exist' do it 'should add dependency to #failed' do - this_file = File.join @@dest_path, 'this.txt' + this_file = @@dest_path / 'this.txt' fd = WarningShot::FileResolver.new({:target => this_file}) fd.test! test/spec/unit/resolvers/file_resolver_spec.rb @@ -1,7 +1,7 @@ #Note, this fails if the gem yard is already installed, which sucks. Waiting on rubyforge to # approve ws-dummy gem -require File.join(%w(. lib resolvers gem_resolver)) +require "." / "lib" / "resolvers" / "gem_resolver" require 'fileutils' describe WarningShot::GemResolver do before :all do test/spec/unit/resolvers/gem_resolver_spec.rb @@ -1,11 +1,11 @@ -require File.join(%w(. lib resolvers integrity_resolver)) +require "." / "lib" / "resolvers" / "integrity_resolver" describe WarningShot::IntegrityResolver do before :all do WarningShot::IntegrityResolver.logger = $logger - @@base_path = File.expand_path(File.join(%w(. test data resolvers file))) - @@source_path = File.join(@@base_path,'src') + @@base_path = File.expand_path("." / "test" / "data" / "resolvers" / "file") + @@source_path = @@base_path / 'src' end it 'should have tests registered' do @@ -18,7 +18,7 @@ describe WarningShot::IntegrityResolver do it 'should be able to verify a sha1 digest' do - that_file = File.join @@source_path, 'that.txt' + that_file = @@source_path / 'that.txt' #These values are flipped from FileResolverRspec so that we dont # have to resolve the file dependency to check the integrity resolver = WarningShot::IntegrityResolver.new({ @@ -32,7 +32,7 @@ describe WarningShot::IntegrityResolver do end it 'should be able to determine if a sha1 digest is wrong' do - that_file = File.join @@source_path, 'that.txt' + that_file = @@source_path / 'that.txt' #These values are flipped from FileResolverRspec so that we dont # have to resolve the file dependency to check the integrity resolver = WarningShot::IntegrityResolver.new({ @@ -46,7 +46,7 @@ describe WarningShot::IntegrityResolver do end it 'should be able to determine if an md5 digest is wrong' do - that_file = File.join @@source_path, 'that.txt' + that_file = @@source_path / 'that.txt' #These values are flipped from FileResolverRspec so that we dont # have to resolve the file dependency to check the integrity resolver = WarningShot::IntegrityResolver.new({ @@ -60,7 +60,7 @@ describe WarningShot::IntegrityResolver do end it 'should be able to verify a md5 digest' do - that_file = File.join @@source_path, 'that.txt' + that_file = @@source_path / 'that.txt' #These values are flipped from FileResolverRspec so that we dont # have to resolve the file dependency to check the integrity resolver = WarningShot::IntegrityResolver.new({ @@ -74,7 +74,7 @@ describe WarningShot::IntegrityResolver do end it 'should use sha1 if md5 and sha1 are given' do - that_file = File.join @@source_path, 'that.txt' + that_file = @@source_path / 'that.txt' #These values are flipped from FileResolverRspec so that we dont # have to resolve the file dependency to check the integrity resolver = WarningShot::IntegrityResolver.new({ @@ -89,7 +89,7 @@ describe WarningShot::IntegrityResolver do end it 'should be silent if a digest isnt given' do - that_file = File.join @@source_path, 'that.txt' + that_file = @@source_path / 'that.txt' #These values are flipped from FileResolverRspec so that we dont # have to resolve the file dependency to check the integrity resolver = WarningShot::IntegrityResolver.new({ test/spec/unit/resolvers/integrity_resolver_spec.rb @@ -1,4 +1,4 @@ -require File.join(%w(. lib resolvers manual_resolver)) +require "." / "lib" / "resolvers" / "manual_resolver" describe WarningShot::ManualResolver do before :all do test/spec/unit/resolvers/manual_resolver_spec.rb @@ -1,11 +1,10 @@ -require File.join(%w(. lib resolvers permission_resolver)) +require "." / "lib" / "resolvers" / "permission_resolver" describe WarningShot::PermissionResolver do before :all do WarningShot::PermissionResolver.logger = $logger end - it 'should have tests registered' do WarningShot::PermissionResolver.tests.empty?.should be(false) end @@ -13,32 +12,30 @@ describe WarningShot::PermissionResolver do it 'should have resolutions registered' do WarningShot::PermissionResolver.resolutions.empty?.should be(false) end - - describe 'with healing enabled' do - describe 'with heal instructions' do - it 'should' do - pending - end - end # End healing enabled, instructions provided - - describe 'without heal instructions' do - it 'should' do - pending - end - end # End healing enabled, instructions not provided - end # End healing enabled - describe 'with healing disabled' do - describe 'with heal instructions' do - it 'should' do - pending - end - end #End healing disabled, instructions provided + it 'should be able to determine if the user permission is correct' do + pending + end + + it 'should be able to determine if the group permission is correct' do + pending + end + + it 'should be able to determine if the mode is correct' do + pending + end + + describe 'with healing enabled and with healing instructions' do + it 'should be able to correct the user' do + pending + end - describe 'without heal instructions' do - it 'should' do - pending - end - end # End healing disabled, instructions not provided - end # End healing disabled + it 'should be able to correct the group' do + pending + end + + it 'should be able to correct the mode' do + pending + end + end end \ No newline at end of file test/spec/unit/resolvers/permission_resolver_spec.rb @@ -1,11 +1,11 @@ -require File.join(%w(. lib resolvers symlink_resolver)) +require "." / "lib" / "resolvers" / "symlink_resolver" describe WarningShot::SymlinkResolver do before :all do WarningShot::SymlinkResolver.logger = $logger - @@data_path = File.expand_path(File.join(%w(. test data))) - @@base_path = File.expand_path(File.join(%w(. test data resolvers symlink))) + @@data_path = File.expand_path("." / "test" / "data") + @@base_path = File.expand_path("." / "test" / "data" / "resolvers" / "symlink") end before :each do @@ -28,8 +28,8 @@ describe WarningShot::SymlinkResolver do it 'should create a symlink' do symlink_dep = { - :source => File.join(@@data_path,'mock_resolver.rb'), - :target => File.join(@@base_path,'linked_mock_resolver.rb') + :source => @@data_path / 'mock_resolver.rb', + :target => @@base_path / 'linked_mock_resolver.rb' } resolver = WarningShot::SymlinkResolver.new symlink_dep test/spec/unit/resolvers/symlink_resolver_spec.rb @@ -1,4 +1,4 @@ -require File.join(%w(. lib resolvers url_resolver)) +require '.' / 'lib' / 'resolvers' / 'url_resolver' describe WarningShot::UrlResolver do before :all do test/spec/unit/resolvers/url_resolver_spec.rb @@ -1,4 +1,4 @@ -require File.join($test_data, 'mock_resolver') +require $test_data / 'mock_resolver' describe WarningShot::Resolver do it 'should provide a base set of resolvers' do test/spec/unit/warning_shot/resolver_spec.rb @@ -1,7 +1,7 @@ describe WarningShot::TemplateGenerator do before :all do - @test_path = File.join($test_data,'yaml_configs') + @test_path = $test_data / 'yaml_configs' end after :all do @@ -14,7 +14,7 @@ describe WarningShot::TemplateGenerator do end it "should have generate YAML config files" do - yaml_files = Dir[File.join(@test_path, WarningShot::ConfigExt)] + yaml_files = Dir[@test_path / WarningShot::ConfigExt] yaml_files.empty?.should be(false) end test/spec/unit/warning_shot/template_generator_spec.rb doc/Hash.html doc/Kernel.html doc/Object.html doc/WarningShot.html doc/WarningShot/Config.html doc/WarningShot/CoreLibResolver.html doc/WarningShot/DependencyResolver.html doc/WarningShot/DirectoryResolver.html doc/WarningShot/FileResolver.html doc/WarningShot/FileResolver/UnsupportedProtocolException.html doc/WarningShot/GemResolver.html doc/WarningShot/IntegrityResolver.html doc/WarningShot/LoggerFormatter.html doc/WarningShot/ManualResolver.html doc/WarningShot/Resolver.html doc/WarningShot/Resolver/ClassMethods.html doc/WarningShot/Resolver/InstanceMethods.html doc/WarningShot/SymlinkResolver.html doc/WarningShot/TemplateGenerator.html doc/WarningShot/UrlResolver.html doc/WarningShot/Utilities.html doc/all-methods.html doc/all-namespaces.html doc/app.js doc/index.html doc/jquery.js doc/readme.html doc/style.css doc/syntax_highlight.css 0b8356dd368fe3ee73fb4b95e9de3c189d8cb74a Cory ODaniel github@coryodaniel.com http://github.com/coryodaniel/warningshot/commit/0755a8310e5713005727d10bbc3d92464947b222 0755a8310e5713005727d10bbc3d92464947b222 2008-10-17T18:08:01-07:00 2008-10-17T18:08:01-07:00 Removed some more docs Refactored File.join *strings to => string / string / string c53136c3a4ae0a05c10c22660bab95d2d3a520e7 Cory ODaniel github@coryodaniel.com