cookbook_creator 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62da9dff7f403b80e5a45fbca0be0db4e8b20787
-  data.tar.gz: 3d885c992b6f24119a281826aff4badab3a62664
+  metadata.gz: f70ff162f70eff1a36152803cc46ca952c5d966f
+  data.tar.gz: 86bc88ba6ac05b613b49841cbc8af0ed4c5df02d
 SHA512:
-  metadata.gz: d6b642cc52cc9db33593ff1fac05dc8106259e70b6dc83e4dbb7868541e4eb218bd0964d3193eeb3676a215925211f1d67abe95366f7e95137eb68aa44aeee64
-  data.tar.gz: 1b0aadb499adc8060da45decdfa1c6aae9fb3184ed1f6ea8b2287433f5058515ccf4056ad8f86a3093542a7a6eb8b8decea59d5abdac2a869e767a0cc893d877
+  metadata.gz: 8373416c2a9ac6e9d05d4ab1fd6403ac9dbd2814a7768cd00a08ffcedbabaab438eb6000542df1799ca695e4671eb124ec511b6e9db130ddf9de71183f83469e
+  data.tar.gz: 8337b4a7c0e71c039e04d24de2f83d39e6842a8f5c5b8a1759046f0c27608c01fc999a275980bbae70cdd6b00f7ec14cc8bbef66ed9bf3712becd04c52542f9f

data/bin/cookbook_create

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+#
+# Copyright (c) 2016 Tacit Knowledge, All Rights Reserved.
+#
+
+Kernel.trap(:INT) { print("\n"); exit 1 }
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+require 'cookbook_creator/main'
+
+CookbookCreator::Main.new(ARGV.clone).run

data/cookbook_creator.gemspec

@@ -0,0 +1,33 @@
+Gem::Specification.new do |s|
+  s.name        = 'cookbook_creator'
+  s.version     = '0.0.2'
+  s.date        = '2016-01-11'
+  s.summary     = "Everything required for cookbook generation"
+  s.description = "This gem is used to generate cookbook skeleton"
+  s.authors     = ['Serghei Anicheev']
+  s.email       = 'sanicheev@tacitknowledge.com'
+  s.require_paths = ['lib']
+  s.required_ruby_version = '~> 2.2.1'
+  s.bindir       = 'bin'
+  s.executables  = [ 'cookbook_create' ]
+  s.files = %w(test.txt) + Dir.glob("*.gemspec") +
+      Dir.glob("{lib,spec}/**/*", File::FNM_DOTMATCH).reject { |f|  File.directory?(f) }
+  s.add_dependency "chef", "~> 12.6.0"
+  s.add_dependency "bundler"
+  s.add_dependency "berkshelf", "~> 4.0.1"
+  s.add_dependency "berkshelf-api-client", "~> 2.0.0"
+  s.add_dependency "chef-zero", "~> 4.4.0"
+  s.add_dependency "kitchen", "~> 0.0.3"
+  s.add_dependency "json", "~> 1.8.3"
+  s.add_dependency "ohai", "~> 8.8.1"
+  s.add_dependency "rake", "~> 10.4.2"
+  s.add_dependency "rspec", "~> 3.4.0"
+  s.add_dependency "chefspec", "~> 4.5.0"
+  s.add_dependency "serverspec", "~> 2.25.0"
+  s.add_dependency "mixlib-cli", "~> 1.5.0"
+  s.add_dependency "mixlib-config", "~> 2.2.1"
+ 
+  s.homepage    =
+    'http://rubygems.org/gems/cookbook_creator'
+  s.license       = 'Free License'
+end

data/lib/cookbook_creator/cli.rb

@@ -0,0 +1,100 @@
+#
+# Author:: Anicheev Serghei (<sanicheev@tacitknowledge.com>)
+# Copyright:: Copyright (c) 2016 Tacit Knowledge.
+#
+
+require 'mixlib/cli'
+
+module CookbookCreator
+  class MCLI
+    include Mixlib::CLI
+
+    option :config_file, 
+      :short => "-c config_file",
+      :long  => "--config",
+      :description => "The configuration file to use",
+      :default => ConfigLoader.new(nil, nil).config_location
+
+    option :generator_cookbook,
+      :short => "-g generator_cookbook",
+      :long => "--generator_cookbook",
+      :description => "Path to generator cookbook templates",
+      :default => File.expand_path("../skeletons", __FILE__)
+
+    option :maintainer, 
+      :short => "-m maintainer",
+      :long  => "--maintainer",
+      :description => "Maintaining organisation",
+      :default => 'Example Org.'
+
+    option :maintainer_email, 
+      :short => "-e maintainer_email",
+      :long  => "--maintainer_email",
+      :description => "Maintainers Email",
+      :default => 'operator@example.org'
+
+    option :provisioner,
+      :short => "-p provisioner",
+      :long  => "--provisioner",
+      :description => "Provisioner to use",
+      :default => 'chef_zero'
+
+    option :license,
+      :short => "-l license",
+      :long  => "--license",
+      :description => "License to use",
+      :default => 'all_rights'
+
+    option :platform,
+      :short => "-P platform",
+      :long  => "--platform",
+      :description => "Platform to use",
+      :default => 'centos-7.1'
+
+    option :driver,
+      :short => "-d driver",
+      :long  => "--driver",
+      :description => "Driver to use",
+      :default => 'docker'
+
+    option :image,
+      :short => "-i driver",
+      :long  => "--image",
+      :description => "Docker image to use",
+      :default => 'centos-7.1'
+
+    option :supermarket_url,
+      :short => "-s supermarket_url",
+      :long  => "--supermarket_url",
+      :description => "Supermarket URL",
+      :default => 'https://supermarket.chef.io'
+
+    option :lwrp,
+      :short => "-L",
+      :long  => "--lwrp",
+      :description => "Should cookbook contain LWRP?",
+      :boolean => true,
+      :default => false
+
+    option :lib,
+      :short => "-i",
+      :long  => "--lib",
+      :description => "Should cookbook contain lib?",
+      :boolean => true,
+      :default => false
+
+    option :help,
+      :short => "-h",
+      :long => "--help",
+      :description => "Show this message",
+      :on => :tail,
+      :boolean => true,
+      :show_options => true,
+      :exit => 0
+
+    def run(argv=[])
+      parse_options(argv)
+    end
+
+  end
+end

data/lib/cookbook_creator/config.rb

@@ -0,0 +1,24 @@
+#
+# Author:: Anicheev Serghei (<sanicheev@tacitknowledge.com>)
+# Copyright:: Copyright (c) 2016 Tacit Knowledge.
+#
+
+require 'mixlib/config'
+
+module CookbookCreator
+  class Config
+    extend Mixlib::Config
+      config_strict_mode true
+      configurable :maintainer
+      configurable :maintainer_email
+      configurable :provisioner
+      configurable :license
+      configurable :platform
+      configurable :driver
+      configurable :supermarket_url
+      configurable :lwrp
+      configurable :lib
+      configurable :generator_cookbook
+      configurable :image
+  end
+end

data/lib/cookbook_creator/config_loader.rb

@@ -0,0 +1,157 @@
+#
+# Author:: Anicheev Serghei (<sanicheev@tacitknowledge.com>)
+# Copyright:: Copyright (c) 2016 Tacit Knowledge.
+#
+# Initially this code block was developed by Chef community.
+# But in order to fit for our needs it was modified
+#
+
+
+require 'cookbook_creator/null_logger'
+require 'cookbook_creator/pathhelper'
+require 'pathname'
+
+module CookbookCreator
+  class ConfigLoader
+
+    # Path to a config file requested by user, (e.g., via command line option). Can be nil
+    attr_accessor :explicit_config_file
+
+    def initialize(explicit_config_file, logger=nil)
+      @explicit_config_file = explicit_config_file
+      @generator_config_dir = nil
+      @config_location = nil
+      @logger = logger || NullLogger.new
+    end
+
+    def no_config_found?
+      config_location.nil?
+    end
+
+    def config_location
+      @config_location ||= (explicit_config_file || locate_local_config)
+    end
+
+    def generator_config_dir
+      if @generator_config_dir.nil?
+        @generator_config_dir = false
+        full_path = working_directory.split(File::SEPARATOR)
+        (full_path.length - 1).downto(0) do |i|
+          candidate_directory = File.join(full_path[0..i] + [".generator"])
+          if File.exist?(candidate_directory) && File.directory?(candidate_directory)
+            @generator_config_dir = candidate_directory
+            break
+          end
+        end
+      end
+      @generator_config_dir
+    end
+
+    def load
+      # Ignore it if there's no explicit_config_file and can't find one at a
+      # default path.
+      return false if config_location.nil?
+
+      if explicit_config_file && !path_exists?(config_location)
+        raise "Specified config file #{config_location} does not exist"
+      end
+
+      # Have to set Config.config_file b/c other config is derived from it.
+      Config.config_file = config_location
+      read_config(IO.read(config_location), config_location)
+    end
+
+    # (Private API, public for test purposes)
+    def env
+      ENV
+    end
+
+    # (Private API, public for test purposes)
+    def path_exists?(path)
+      Pathname.new(path).expand_path.exist?
+    end
+
+    private
+
+    def have_config?(path)
+      if path_exists?(path)
+        logger.info("Using config at #{path}")
+        true
+      else
+        logger.debug("Config not found at #{path}, trying next option")
+        false
+      end
+    end
+
+    def locate_local_config
+      candidate_configs = []
+
+      # Look for $ARROW_HOME/generator.rb (allow multiple generator config on same machine)
+      if env['ARROW_HOME']
+        candidate_configs << File.join(env['ARROW_HOME'], 'generator.rb')
+      end
+      # Look for $PWD/generator.rb
+      if Dir.pwd
+        candidate_configs << File.join(Dir.pwd, 'generator.rb')
+      end
+      # Look for $UPWARD/.generator/generator.rb
+      if generator_config_dir
+        candidate_configs << File.join(generator_config_dir, 'generator.rb')
+      end
+      # Look for $HOME/.generator/generator.rb
+      PathHelper.home('.generator') do |dot_generator_dir|
+        candidate_configs << File.join(dot_generator_dir, 'generator.rb')
+      end
+
+      candidate_configs.find do | candidate_config |
+        have_config?(candidate_config)
+      end
+    end
+
+    def working_directory
+      Dir.pwd
+    end
+
+    def read_config(config_content, config_file_path)
+      Config.from_string(config_content, config_file_path)
+    rescue SignalException
+      raise
+    rescue SyntaxError => e
+      message = ""
+      message << "You have invalid ruby syntax in your config file #{config_file_path}\n\n"
+      message << "#{e.class.name}: #{e.message}\n"
+      if file_line = e.message[/#{Regexp.escape(config_file_path)}:[\d]+/]
+        line = file_line[/:([\d]+)$/, 1].to_i
+        message << highlight_config_error(config_file_path, line)
+      end
+      raise ChefConfig::ConfigurationError, message
+    rescue Exception => e
+      message = "You have an error in your config file #{config_file_path}\n\n"
+      message << "#{e.class.name}: #{e.message}\n"
+      filtered_trace = e.backtrace.grep(/#{Regexp.escape(config_file_path)}/)
+      filtered_trace.each {|bt_line| message << "  " << bt_line << "\n" }
+      if !filtered_trace.empty?
+        line_nr = filtered_trace.first[/#{Regexp.escape(config_file_path)}:([\d]+)/, 1]
+        message << highlight_config_error(config_file_path, line_nr.to_i)
+      end
+      raise ChefConfig::ConfigurationError, message
+    end
+
+
+    def highlight_config_error(file, line)
+      config_file_lines = []
+      IO.readlines(file).each_with_index {|l, i| config_file_lines << "#{(i + 1).to_s.rjust(3)}: #{l.chomp}"}
+      if line == 1
+        lines = config_file_lines[0..3]
+      else
+        lines = config_file_lines[Range.new(line - 2, line)]
+      end
+      "Relevant file content:\n" + lines.join("\n") + "\n"
+    end
+
+    def logger
+      @logger
+    end
+
+  end
+end

data/lib/cookbook_creator/generator.rb

@@ -0,0 +1,202 @@
+#
+# Author:: Anicheev Serghei (<sanicheev@tacitknowledge.com>)
+# Copyright:: Copyright (c) 2016 Tacit Knowledge.
+#
+# Initially this code block was developed by Chef community.
+# But in order to fit for our needs it was modified
+#
+
+module CookbookCreator
+
+  module Generator
+    # This is here to hold attr_accessor data for Generator context variables
+    class Context
+
+
+      def self.add_attr(name)
+        @attributes ||= [ ]
+
+        if !@attributes.include?(name)
+          @attributes << name
+          attr_accessor(name)
+        end
+      end
+
+        def self.cookbook_root
+          File.dirname(cookbook_full_path)
+        end
+
+        def self.cookbook_full_path
+          File.expand_path(cookbook_name_or_path, Dir.pwd)
+        end
+      
+        def self.cookbook_name_or_path
+           name = ARGV[0]
+           File.expand_path(name, Dir.pwd)
+        end
+
+        def self.recipe
+          "cookbook"
+        end
+
+        def self.recipe_name
+          "default"
+        end
+
+        def self.cookbook_name
+          File.basename(cookbook_full_path)
+        end
+
+        def self.have_git?
+          path = ENV["PATH"] || ""
+          paths = path.split(File::PATH_SEPARATOR)
+          paths.any? {|bin_path| File.exist?(File.join(bin_path, "git#{RbConfig::CONFIG['EXEEXT']}"))}
+        end
+
+      def self.reset
+        return if @attributes.nil?
+
+        @attributes.each do |attr|
+          remove_method(attr)
+        end
+
+        @attributes = nil
+      end
+    end
+
+    def self.reset
+      @context = nil
+    end
+
+    def self.context
+      @context ||= Context.new
+    end
+
+    def self.add_attr_to_context(name, value=nil)
+      sym_name = name.to_sym
+      CookbookCreator::Generator::Context.add_attr(sym_name)
+      CookbookCreator::Generator::TemplateHelper.delegate_to_app_context(sym_name)
+      context.public_send("#{sym_name}=", value)
+    end
+
+    def self.setup_context(config_options)
+      CookbookCreator::Generator.add_attr_to_context(:cookbook_root, CookbookCreator::Generator::Context.cookbook_root)
+      CookbookCreator::Generator.add_attr_to_context(:cookbook_name, CookbookCreator::Generator::Context.cookbook_name)
+      CookbookCreator::Generator.add_attr_to_context(:recipe_name, CookbookCreator::Generator::Context.recipe_name)
+      CookbookCreator::Generator.add_attr_to_context(:copyright_holder, config_options[:maintainer])
+      CookbookCreator::Generator.add_attr_to_context(:email, config_options[:maintainer_email])
+      CookbookCreator::Generator.add_attr_to_context(:license, config_options[:license])
+      CookbookCreator::Generator.add_attr_to_context(:provisioner, config_options[:provisioner])
+      CookbookCreator::Generator.add_attr_to_context(:driver, config_options[:driver])
+      CookbookCreator::Generator.add_attr_to_context(:platform, config_options[:platform])
+      CookbookCreator::Generator.add_attr_to_context(:supermarket_url, config_options[:supermarket_url])
+      CookbookCreator::Generator.add_attr_to_context(:lwrp, config_options[:lwrp])
+      CookbookCreator::Generator.add_attr_to_context(:lib, config_options[:lib])
+      CookbookCreator::Generator.add_attr_to_context(:image, config_options[:image])
+    end
+
+    module TemplateHelper
+
+      def self.delegate_to_app_context(name)
+        define_method(name) do
+          CookbookCreator::Generator.context.public_send(name)
+        end
+      end
+
+      def year
+        Time.now.year
+      end
+
+      # Prints the short description of the license, suitable for use in a
+      # preamble to a file. Optionally specify a comment to prepend to each line.
+      def license_description(comment=nil)
+        case license
+        when 'all_rights'
+          result = "Copyright (c) #{year} #{copyright_holder}, All Rights Reserved."
+        when 'apache2'
+          result = <<-EOH
+Copyright #{year} #{copyright_holder}
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+EOH
+        when 'mit'
+          result = <<-EOH
+The MIT License (MIT)
+
+Copyright (c) #{year} #{copyright_holder}
+
+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.
+EOH
+        when 'gplv2'
+          result = <<-EOH
+Copyright (C) #{year}  #{copyright_holder}
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+EOH
+        when 'gplv3'
+          result = <<-EOH
+Copyright (C) #{year}  #{copyright_holder}
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+EOH
+        end
+        if comment
+          # Ensure there's no trailing whitespace
+          result.gsub(/^(.+)$/, "#{comment} \\1").gsub(/^$/, "#{comment}")
+        else
+          result
+        end
+      end
+    end
+
+  end
+end