knife-tar 1.3.0

data/lib/chef/tar_file.rb

@@ -0,0 +1,276 @@
+
+require 'open-uri'
+require 'chef/mixin/command'
+require 'tmp_directory'
+
+#A class for handling a tar file that contains chef components.
+
+class Chef
+  class TarFile
+    
+    #The named conventions for chef components
+    COOKBOOKS_PATH = "cookbooks"
+    ROLES_PATH = "roles"
+    ENVIRONMENTS_PATH = "environments"
+    DATA_BAGS_PATH = "data_bags"
+    API_CLIENTS_PATH = "api_clients"
+    WEB_USERS_PATH = "web_users"
+    NODES_PATH = "nodes"
+    
+    #A list of valid chef file extensions
+    CHEF_FILE_EXTENSIONS = [".js", ".json", ".rb"]
+    
+    def initialize tarPath, create=false
+      
+      if tarPath==nil
+        raise ArgumentError, "A tar file path must be given"
+      end
+      
+      @create_tar = create
+      
+      unless create
+        @temp_directory = TmpDirectory.new.path
+        
+        #Assume for now that the components live directly inside the tar file
+        @tar_contents_path = @temp_directory
+        
+        localTarFile = File.join(@temp_directory, 'cookbooks.tgz')
+      
+        #Move/Download tar file to tmp directory
+        File.open(localTarFile, 'wb') do |f|
+          open(tarPath) do |r|
+            f.write(r.read)
+          end
+        end
+      
+        #Untar file
+        Chef::Mixin::Command.run_command(:command => "tar zxfC #{localTarFile} #{@temp_directory}")
+        
+        #Verify tar file structure and update tar_contents_path if necessary
+        
+        dirList = get_directories_names @tar_contents_path
+        
+        if !is_tar_valid? dirList
+          #The tar does not contain any immediate chef component directories, check to see if there is a top-level project folder
+          #that contains any chef component directories
+          
+          if dirList.size!=1 or !is_tar_valid? get_directories_names(File.join(@tar_contents_path, dirList.first))
+            raise InvalidStructureError, "The tar file has an invalid structure"
+          end
+          
+          #The tar file is valid but contains a top-level project folder so update the @tar_contents_path
+          @tar_contents_path = File.join(@tar_contents_path, dirList.first)
+        end
+        
+        #Remove tar file
+        FileUtils.rm_f localTarFile
+        
+      else
+        
+        # Verify that the tarPath doesn't already exist
+        if File.exists? tarPath
+          raise ArgumentError, "We cannot create a tar file at path : #{tarPath} because it already exists"
+        end
+        
+        @temp_directory = TmpDirectory.new("chef-server").path
+        
+        #We will create the tar file such that their is no single root directory inside the tar file
+        @tar_contents_path = @temp_directory
+        
+        FileUtils.mkdir_p @temp_directory
+        
+        @create_tar_path = File.absolute_path tarPath
+        
+        # We are setting up a directory to become a Chef TarFile so create the resource directories
+        FileUtils.mkdir_p File.join @tar_contents_path, COOKBOOKS_PATH
+        FileUtils.mkdir_p File.join @tar_contents_path, ROLES_PATH
+        FileUtils.mkdir_p File.join @tar_contents_path, ENVIRONMENTS_PATH
+        FileUtils.mkdir_p File.join @tar_contents_path, DATA_BAGS_PATH
+        FileUtils.mkdir_p File.join @tar_contents_path, API_CLIENTS_PATH
+        FileUtils.mkdir_p File.join @tar_contents_path, WEB_USERS_PATH
+        FileUtils.mkdir_p File.join @tar_contents_path, NODES_PATH
+        
+      end
+      
+    end
+    
+    #Returns the absolute path to the cookbooks directory
+    def cookbooks_path
+      verify_path COOKBOOKS_PATH
+      File.join @tar_contents_path, COOKBOOKS_PATH
+    end
+    
+    #Returns list of absolute paths of the cookbooks
+    def cookbooks
+      get_directories_absolute_paths cookbooks_path
+    end
+    
+    #Returns the absolute path to the roles directory
+    def roles_path
+      verify_path ROLES_PATH
+      File.join @tar_contents_path, ROLES_PATH
+    end
+    
+    #Returns a list of absolute paths to the roles json files
+    def roles
+      get_chef_files_absolute_paths roles_path
+    end
+    
+    #Returns the absolute path to the environments directory
+    def environments_path
+      verify_path ENVIRONMENTS_PATH
+      File.join @tar_contents_path, ENVIRONMENTS_PATH
+    end
+    
+    #Returns a list of absolute paths to the environemnts json files
+    def environments
+      get_chef_files_absolute_paths environments_path
+    end
+    
+    #Returns the absolute path to the data_bags directory
+    def data_bags_path
+      verify_path DATA_BAGS_PATH
+      File.join @tar_contents_path, DATA_BAGS_PATH
+    end
+    
+    #Returns a list of absolute paths to the data_bags json files
+    def data_bags
+      
+      #Data bags follow a different structure then the other components, their structure is
+      #|- data_bags
+      #\ \- data_bag_1
+      #| | |- values_1.json
+      #| ...
+      
+      dir_list = get_directories_absolute_paths(data_bags_path)
+      
+      data_bags_absolute_paths = Array.new
+      
+      dir_list.each do |dir_path|
+        data_bags_absolute_paths = data_bags_absolute_paths | get_chef_files_absolute_paths(dir_path)
+      end
+      
+      data_bags_absolute_paths
+    end
+    
+    #Returns the absolute path to the api_clients directory
+    def api_clients_path
+      verify_path API_CLIENTS_PATH
+      File.join @tar_contents_path, API_CLIENTS_PATH
+    end
+    
+    #Returns a list of absolute paths to the api_clients json files
+    def api_clients
+      get_chef_files_absolute_paths api_clients_path
+    end
+    
+    #Returns the absolute path of the nodes directory
+    def nodes_path
+      verify_path NODES_PATH
+      File.join @tar_contents_path, NODES_PATH
+    end
+    
+    #Returns a list of absolute paths to the nodes json files
+    def nodes
+      get_chef_files_absolute_paths nodes_path
+    end
+    
+    #Returns the absolute path of the web_users directory
+    def web_users_path
+      verify_path WEB_USERS_PATH
+      File.join @tar_contents_path, WEB_USERS_PATH
+    end
+    
+    #Returns a list of absolute paths to the web_users json files
+    def web_users
+      get_chef_files_absolute_paths web_users_path
+    end
+    
+    def save
+      if @create_tar
+        
+        #Tar up the directory from the parent directory of the tar's contents (this will really be /tmp)
+        Chef::Mixin::Command.run_command(:cwd => File.expand_path("..",@tar_contents_path), :command => "tar zfc #{@create_tar_path} #{File.basename @tar_contents_path}")
+        
+        @create_tar = false
+      else
+        raise StandardError, "The tar file is not in the correct state to be saved"
+      end
+    end
+    
+    private
+    
+    #Returns true if the list of directories contains at least one chef component 
+    def is_tar_valid? dir_list
+      
+      #Remove unnessary directories
+      dir_list.delete(".")
+      dir_list.delete("..")
+      
+      dir_list.each do |dir|
+        [API_CLIENTS_PATH, COOKBOOKS_PATH, DATA_BAGS_PATH, ENVIRONMENTS_PATH, NODES_PATH, ROLES_PATH, WEB_USERS_PATH].each do |component|
+          if dir == component
+            return true
+          end
+        end
+      end
+      return false
+    end
+    
+    #Throws an exception if the given component does not exist within the tar's contents
+    def verify_path component
+      if !File.exists? File.join @tar_contents_path, component
+        raise MissingChefComponentError, "The '#{component}' directory does not exist within the tar file"
+      end
+    end
+    
+    #Returns a list of the base file names for all the directories at the given path
+    def get_directories_names path
+      get_directories_absolute_paths(path).map {|dir| File.basename(dir) }
+    end
+    
+    #Returns a list of the absolute paths of all the directories at the given path
+    def get_directories_absolute_paths path
+      dir_list = Dir["#{path}/*/"]
+      
+      #Remove unnecessary directories
+      dir_list.delete(File.join(path, "."))
+      dir_list.delete(File.join(path, ".."))
+      
+      dir_list
+    end
+    
+    #Returns a list of the base file names for all files at the given path
+    def get_file_names path
+      Dir.entries(path).select { |file| !File.directory? File.join(path, file) }
+    end
+    
+    #Returns a list of the absolute paths of all the files at the given path
+    def get_file_absolute_paths path
+      get_file_names(path).map { |file| File.join(path, file) }
+    end
+    
+    #Returns a list of the absolute paths of all the valid chef component files at the given path
+    def get_chef_files_absolute_paths path
+      get_file_absolute_paths(path).select { |file| is_valid_chef_component_file?(file) }
+    end
+    
+    #Returns true if the filename is a valid chef component file
+    def is_valid_chef_component_file? filename
+      extension = File.extname(filename)
+      CHEF_FILE_EXTENSIONS.each do |validExtension|
+        if extension.casecmp(validExtension) == 0
+          return true
+        end
+      end
+      return false
+    end
+    
+    #Error when a Chef::TarFile does not have the correct structure
+    class InvalidStructureError < StandardError; end
+    
+    #Error thrown when a chef component that is accessed cannot be found
+    class MissingChefComponentError < StandardError; end
+    
+  end
+end

data/lib/tmp_directory.rb

@@ -0,0 +1,25 @@
+require 'tmpdir'
+
+class TmpDirectory
+  
+  attr_reader :path
+  
+  def initialize name="tmp"
+    @path = ::File.join(Dir.tmpdir, "#{name}-#{Time.now.strftime("%Y%m%d%H%M%S")}-#{Random.rand}")
+    
+    FileUtils.mkdir_p @path
+    
+    #Add shutdown hook to remove tar tmp directory
+    Kernel.at_exit do 
+      cleanup
+    end
+  end
+  
+  private
+  
+  #Remove the created temp directory
+  def cleanup
+    FileUtils.rm_rf @path
+  end
+  
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: knife-tar
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- Bryan Baugher
+- Aaron Blythe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+description: This is a knife plugin for Chef which can install and upload chef components
+  from a tar file or url
+email: Bryan.Baugher@Cerner.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/chef/knife/client_tar_download.rb
+- lib/chef/knife/client_tar_upload.rb
+- lib/chef/knife/cookbook_tar_download.rb
+- lib/chef/knife/cookbook_tar_upload.rb
+- lib/chef/knife/data_bag_tar_download.rb
+- lib/chef/knife/data_bag_tar_upload.rb
+- lib/chef/knife/environment_tar_download.rb
+- lib/chef/knife/environment_tar_upload.rb
+- lib/chef/knife/node_tar_download.rb
+- lib/chef/knife/node_tar_upload.rb
+- lib/chef/knife/role_tar_download.rb
+- lib/chef/knife/role_tar_upload.rb
+- lib/chef/knife/tar_download_all.rb
+- lib/chef/knife/tar_upload_all.rb
+- lib/chef/knife/user_tar_download.rb
+- lib/chef/knife/user_tar_upload.rb
+- lib/chef/tar_file.rb
+- lib/tmp_directory.rb
+- Gemfile
+- Rakefile
+- README.md
+homepage: http://github.com/Cerner/knife-tar
+licenses:
+- Apache License, Version 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: A Chef knife plugin to install/upload chef components from a tar file or
+  url
+test_files: []