berkshelf 0.6.0.beta4 → 1.0.0.rc1

data/berkshelf.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   s.version               = Berkshelf::VERSION
   s.required_ruby_version = ">= 1.9.1"
 
-  s.add_runtime_dependency 'chozo', '>= 0.1.0'
+  s.add_runtime_dependency 'chozo', '>= 0.2.1'
   s.add_runtime_dependency 'ridley', '>= 0.0.5'
   s.add_runtime_dependency 'solve', '>= 0.4.0.rc1'
   s.add_runtime_dependency 'chef', '~> 10.12'

data/features/config.feature

@@ -7,7 +7,6 @@ Feature: cookbook creation with a config file
     Given I do not have a Berkshelf config file
     When I run the cookbook command to create "sparkle_motion"
     Then the resulting "sparkle_motion" Vagrantfile should contain:
-      | config.vm.host_name = "sparkle_motion-berkshelf" |
       | config.vm.box = "Berkshelf-CentOS-6.3-x86_64-minimal" |
       | config.vm.box_url = "https://dl.dropbox.com/u/31081437/Berkshelf-CentOS-6.3-x86_64-minimal.box" |
     And the exit status should be 0
@@ -23,7 +22,6 @@ Feature: cookbook creation with a config file
           "forward_port": {
             "12345": "54321"
           },
-          "host_name": "my_host",
           "network": {
             "bridged": true,
             "hostonly": "12.34.56.78"
@@ -37,7 +35,6 @@ Feature: cookbook creation with a config file
       | config.vm.box = "my_box" |
       | config.vm.box_url = "http://files.vagrantup.com/lucid64.box" |
       | config.vm.forward_port 12345, 54321 |
-      | config.vm.host_name = "my_host" |
       | config.vm.network :hostonly, "12.34.56.78" |
       | config.vm.network :bridged |
     And the exit status should be 0
@@ -64,24 +61,27 @@ Feature: cookbook creation with a config file
     Given I have a Berkshelf config file containing:
     """
     {
-      "wat": null
+      "vagrant": null
     }
     """
     When I run the cookbook command to create "sparkle_motion"
     Then the output should contain "Invalid configuration"
-    And the output should contain "wat is not a valid key"
+    And the output should contain "vagrant.vm.box Expected attribute: 'vagrant.vm.box' to be a type of: 'String'"
+    And the output should contain "vagrant.vm.box A value is required for attribute: 'vagrant.vm.box'"
+    And the output should contain "vagrant.vm.box_url Expected attribute: 'vagrant.vm.box_url' to be a type of: 'String'"
+    And the output should contain "vagrant.vm.box_url A value is required for attribute: 'vagrant.vm.box_url'"
     And the CLI should exit with the status code for error "InvalidConfiguration"
 
   Scenario: creating a new cookbook with a chef client config
     Given I have a Berkshelf config file containing:
     """
     {
+      "chef": {
+        "chef_server_url": "localhost:4000",
+        "validation_client_name": "my_client-validator",
+        "validation_key_path": "/a/b/c/my_client-validator.pem"
+      },
       "vagrant": {
-        "chef": {
-          "chef_server_url": "localhost:4000",
-          "validation_client_name": "my_client-validator",
-          "validation_key_path": "/a/b/c/my_client-validator.pem"
-        },
         "vm": {
           "provision": "chef_client"
         }

data/features/configure_command.feature

@@ -0,0 +1,60 @@
+Feature: configure command
+  As CLI user of Berkshelf
+  I want a command to generate a Berkshelf configuration file based on my input
+  So I can quickly get up and running with the least amount of resistance
+
+  Scenario: generating a new config file
+    Given I do not have a Berkshelf config file
+    When I run the "configure" command interactively
+    And I type "https://api.opscode.com/organizations/vialstudios"
+    And I type "node_name"
+    And I type "client_key"
+    And I type "reset"
+    And I type "/Users/reset/.chef/reset.pem"
+    And I type "Berkshelf-minimal"
+    And I type "https://dl.dropbox.com/Berkshelf.box"
+    Then the output should contain:
+      """
+      Config written to:
+      """
+    And the exit status should be 0
+    And a Berkshelf config file should exist and contain:
+      | chef.chef_server_url        | https://api.opscode.com/organizations/vialstudios |
+      | chef.validation_client_name | reset                                             |
+      | chef.node_name              | node_name                                         |
+      | chef.client_key             | client_key                                        |
+      | chef.validation_key_path    | /Users/reset/.chef/reset.pem                      |
+      | vagrant.vm.box              | Berkshelf-minimal                                 |
+      | vagrant.vm.box_url          | https://dl.dropbox.com/Berkshelf.box              |
+
+  Scenario: generating a config with default values
+    Given I do not have a Berkshelf config file
+    When I run the "configure" command interactively
+    And I type ""
+    And I type ""
+    And I type ""
+    And I type ""
+    And I type ""
+    And I type ""
+    And I type ""
+    Then the output should contain:
+      """
+      Config written to:
+      """
+    And the exit status should be 0
+    And a Berkshelf config file should exist and contain:
+      | chef.chef_server_url        | http://localhost:4000               |
+      | chef.validation_client_name | chef-validator                      |
+      | chef.client_key             | /etc/chef/client.pem                |
+      | chef.validation_key_path    | /etc/chef/validation.pem            |
+      | vagrant.vm.box              | Berkshelf-CentOS-6.3-x86_64-minimal |
+      | vagrant.vm.box_url          | https://dl.dropbox.com/u/31081437/Berkshelf-CentOS-6.3-x86_64-minimal.box |
+
+  Scenario: attempting to generate a new config when one already exists
+    Given I have a default Berkshelf config file
+    When I run the "configure" command interactively
+    Then the output should contain:
+      """
+      A configuration file already exists. Re-run with the --force flag if you wish to overwrite it.
+      """
+    And the CLI should exit with the status code for error "ConfigExists"

data/features/install.feature

@@ -198,7 +198,7 @@ Feature: install cookbooks from a Berksfile
   Scenario: with a cookbook definition containing a chef_api source location
     Given I write to "Berksfile" with:
       """
-      cookbook "artifact", "= 0.10.2", chef_api: :knife
+      cookbook "artifact", "= 0.10.2", chef_api: :config
       """
     And the Chef server has cookbooks:
       | artifact | 0.10.2 |
@@ -211,18 +211,18 @@ Feature: install cookbooks from a Berksfile
       | artifact | 0.10.2 |
     And the exit status should be 0
 
-  Scenario: with a chef_api source location specifying :knife when a Knife config is not found at the given path
+  Scenario: with a chef_api source location specifying :config when a Berkshelf config is not found at the given path
     Given I write to "Berksfile" with:
       """
-      cookbook "artifact", chef_api: :knife
+      cookbook "artifact", chef_api: :config
       """
     When I run the install command with flags:
-      | -c /tmp/nothere.lol |
+      | -c /tmp/notthere.lol |
     Then the output should contain:
       """
-      A Knife config is required when ':knife' is given for the value of a 'chef_api' location. Attempted to load configuration from: '/tmp/nothere.lol' but not found.
+      You specified a path to a configuration file that did not exist: '/tmp/notthere.lol'
       """
-    And the CLI should exit with the status code for error "KnifeConfigNotFound"
+    And the CLI should exit with the status code for error "BerksConfigNotFound"
 
   Scenario: with a chef_api source location specifying a Chef API URL but missing a node_name option
     Given I write to "Berksfile" with:

data/features/step_definitions/cli_steps.rb

@@ -66,8 +66,8 @@ When /^I run the cookbook command to create "(.*?)" with options:$/ do |name, op
   run_simple(unescape("berks cookbook #{name} #{options.raw.join(" ")}"))
 end
 
-When /^I run the config command$/ do
-  run_simple unescape("berks config")
+When /^I run the "(.*?)" command interactively$/ do |command|
+  run_interactive("berks #{command}")
 end
 
 Then /^the CLI should exit with the status code for error "(.*?)"$/ do |error_constant|

data/features/step_definitions/configure_cli_steps.rb

@@ -0,0 +1,6 @@
+Then /^a Berkshelf config file should exist and contain:$/ do |table|
+  config = Berkshelf::Config.from_file(Berkshelf::Config.path)
+  table.raw.each do |key, value|
+    config.get_attribute(key).should eql(value)
+  end
+end

data/features/step_definitions/filesystem_steps.rb

@@ -18,14 +18,16 @@ Given /^I do not have a Berksfile\.lock$/ do
   in_current_dir { FileUtils.rm_f(Berkshelf::Lockfile::DEFAULT_FILENAME) }
 end
 
+Given /^I have a default Berkshelf config file$/ do
+  Berkshelf::Config.new.save
+end
+
 Given /^I have a Berkshelf config file containing:$/ do |contents|
-  write_file File.expand_path("~/.berkshelf/config.json"), contents
+  Berkshelf::Config.new.from_json(contents).save
 end
 
 Given /^I do not have a Berkshelf config file$/ do
-  file = File.expand_path "~/.berkshelf/config.json"
-
-  remove_file file if File.exists? file
+  remove_file Berkshelf::Config.path if File.exists? Berkshelf::Config.path
 end
 
 Given /^the cookbook "(.*?)" has the file "(.*?)" with:$/ do |cookbook_name, file_name, content|
@@ -234,9 +236,3 @@ end
 Then /^the current directory should not have the following files:$/ do |files|
   check_file_presence(files.raw.map{|file_row| file_row[0]}, false)
 end
-
-Then /^I should have a Berkshelf config file$/ do
-  Pathname.new(ENV['HOME']).join(".berkshelf").should have_structure {
-    file "config.json"
-  }
-end

data/features/support/env.rb

@@ -12,6 +12,7 @@ Spork.prefork do
   APP_ROOT = File.expand_path('../../../', __FILE__)
 
   ENV["BERKSHELF_PATH"] = File.join(APP_ROOT, "tmp", "berkshelf")
+  ENV["BERKSHELF_CHEF_CONFIG"] = File.join(APP_ROOT, "tmp", "knife.rb")
 
   Dir[File.join(APP_ROOT, "spec/support/**/*.rb")].each {|f| require f}
 

data/generator_files/Vagrantfile.erb

@@ -8,17 +8,6 @@ Vagrant::Config.run do |config|
   # The path to the Berksfile to use with Vagrant Berkshelf
   # config.berkshelf.berksfile_path = "./Berksfile"
 
-  # The path to the Knife config to use with Vagrant Berkshelf
-  # config.berkshelf.config_path = "~/.chef/knife.rb"
-
-  # A client name (node_name) to use with the Chef Client provisioner to upload
-  # cookbooks installed by Berkshelf.
-  # config.berkshelf.node_name = "reset"
-
-  # A path to a client key on disk to use with the Chef Client provisioner to
-  # upload cookbooks installed by Berkshelf.
-  # config.berkshelf.client_key = "~/.chef/reset.pem"
-
   # An array of symbols representing groups of cookbook described in the Vagrantfile
   # to skip installing and copying to Vagrant's shelf.
   # config.berkshelf.only = []
@@ -27,24 +16,10 @@ Vagrant::Config.run do |config|
   # to skip installing and copying to Vagrant's shelf.
   # config.berkshelf.except = []
 
-<% if options[:berkshelf_config][:vagrant][:vm][:box].present? -%>
-  config.vm.host_name = "<%= options[:berkshelf_config][:vagrant][:vm][:host_name] %>"
-<% else -%>
   config.vm.host_name = "<%= "#{cookbook_name}-berkshelf" %>"
-<% end -%>
 
-
-  # CentOS 6.3
-<% if options[:berkshelf_config][:vagrant][:vm][:box].present? -%>
-  config.vm.box = "<%= options[:berkshelf_config][:vagrant][:vm][:box] %>"
-<% else %>
-  config.vm.box = "Berkshelf-CentOS-6.3-x86_64-minimal"
-<% end -%>
-<% if options[:berkshelf_config][:vagrant][:vm][:box_url].present? -%>
-  config.vm.box_url = "<%= options[:berkshelf_config][:vagrant][:vm][:box_url] %>"
-<% else %>
-  config.vm.box_url = "https://dl.dropbox.com/u/31081437/Berkshelf-CentOS-6.3-x86_64-minimal.box"
-<% end -%>
+  config.vm.box = "<%= options[:berkshelf_config].vagrant.vm.box %>"
+  config.vm.box_url = "<%= options[:berkshelf_config].vagrant.vm.box_url %>"
 
   # Boot with a GUI so you can see the screen. (Default is headless)
   # config.vm.boot_mode = :gui
@@ -53,22 +28,27 @@ Vagrant::Config.run do |config|
   # via the IP. Host-only networks can talk to the host machine as well as
   # any other machines on the same network, but cannot be accessed (through this
   # network interface) by any external networks.
+<% if options[:berkshelf_config].vagrant.vm.network.hostonly.present? -%>
+  config.vm.network :hostonly, "<%= options[:berkshelf_config].vagrant.vm.network.hostonly %>"
+<% else %>
   # config.vm.network :hostonly, "33.33.33.10"
-<% if options[:berkshelf_config][:vagrant][:vm][:network][:hostonly].present? -%>
-  config.vm.network :hostonly, "<%= options[:berkshelf_config][:vagrant][:vm][:network][:hostonly] %>"
 <% end -%>
 
   # Assign this VM to a bridged network, allowing you to connect directly to a
   # network using the host's network device. This makes the VM appear as another
   # physical device on your network.
-  <% unless options[:berkshelf_config][:vagrant][:vm][:network][:bridged].present? %># <% end %>config.vm.network :bridged
+<% if options[:berkshelf_config].vagrant.vm.network.bridged -%>
+  config.vm.network :bridged
+<% else %>
+  # config.vm.network :bridged
+<% end -%>
 
   # Forward a port from the guest to the host, which allows for outside
   # computers to access the VM, whereas host only networking does not.
   # config.vm.forward_port 80, 8080
-<% options[:berkshelf_config][:vagrant][:vm][:forward_port].each do |guest, host| %>
+<% options[:berkshelf_config].vagrant.vm.forward_port.each do |guest, host| %>
   config.vm.forward_port <%= guest %>, <%= host %>
-<% end if options[:berkshelf_config][:vagrant][:vm][:forward_port].present? %>
+<% end -%>
 
   # Share an additional folder to the guest VM. The first argument is
   # an identifier, the second is the path on the guest to mount the
@@ -78,18 +58,18 @@ Vagrant::Config.run do |config|
   config.ssh.max_tries = 40
   config.ssh.timeout   = 120
 
-<% if options[:berkshelf_config][:vagrant][:vm][:provision] == "chef_client" -%>
+<% if options[:berkshelf_config].vagrant.vm.provision == "chef_client" -%>
   config.vm.provision :chef_client do |chef|
-    chef.chef_server_url = "<%= options[:berkshelf_config][:vagrant][:chef][:chef_server_url] %>"
-    chef.validation_client_name = "<%= options[:berkshelf_config][:vagrant][:chef][:validation_client_name] %>"
-    chef.validation_key_path = "<%= options[:berkshelf_config][:vagrant][:chef][:validation_key_path] %>"
+    chef.chef_server_url = "<%= options[:berkshelf_config].chef.chef_server_url %>"
+    chef.validation_client_name = "<%= options[:berkshelf_config].chef.validation_client_name %>"
+    chef.validation_key_path = "<%= options[:berkshelf_config].chef.validation_key_path %>"
 
     chef.run_list = [
       "recipe[<%= cookbook_name %>::default]"
     ]
   end
-<% else -%>
-  config.vm.provision :chef_solo do |chef|    
+<% elsif options[:berkshelf_config].vagrant.vm.provision == "chef_solo" -%>
+  config.vm.provision :chef_solo do |chef|
     chef.json = {
       :mysql => {
         :server_root_password => 'rootpass',

data/lib/berkshelf.rb

@@ -25,7 +25,6 @@ require 'thor/monkies'
 Chef::Config[:cache_options][:path] = Dir.mktmpdir
 
 module Berkshelf
-  DEFAULT_CONFIG = File.expand_path(ENV["CHEF_CONFIG"] || "~/.chef/knife.rb")
   DEFAULT_STORE_PATH = File.expand_path("~/.berkshelf").freeze
   DEFAULT_FILENAME = 'Berksfile'.freeze
 
@@ -44,15 +43,12 @@ module Berkshelf
   autoload :Uploader, 'berkshelf/uploader'
   autoload :Resolver, 'berkshelf/resolver'
   autoload :Config, 'berkshelf/config'
-  autoload :ConfigGenerator, 'berkshelf/config_generator'
-  autoload :ConfigValidator, 'berkshelf/config_validator'
 
   require 'berkshelf/location'
 
   class << self
     attr_accessor :ui
     
-    attr_writer :config_path
     attr_writer :cookbook_store
 
     # @return [Pathname]
@@ -99,21 +95,6 @@ module Berkshelf
       @cookbook_store ||= CookbookStore.new(cookbooks_dir)
     end
 
-    # @return [String]
-    def config_path
-      @config_path ||= DEFAULT_CONFIG
-    end
-
-    # Load the config found at the given path as the Chef::Config. If no path is specified
-    # the value of Berkshelf.chef_config will be used.
-    #
-    # @param [String] path
-    def load_config(path = config_path)
-      Chef::Config.from_file(File.expand_path(path))
-    rescue Errno::ENOENT
-      raise KnifeConfigNotFound, "Attempted to load configuration from: '#{path}' but not found."
-    end
-
     # Ascend the directory structure from the given path to find a
     # metadata.rb file of a Chef Cookbook. If no metadata.rb file
     # was found, nil is returned.

data/lib/berkshelf/cli.rb

@@ -14,7 +14,14 @@ module Berkshelf
     
     def initialize(*args)
       super(*args)
-      Berkshelf.config_path = @options[:config]
+
+      if @options[:config]
+        unless File.exist?(@options[:config])
+          raise BerksConfigNotFound, "You specified a path to a configuration file that did not exist: '#{@options[:config]}'"
+        end
+        Berkshelf::Config.path = @options[:config]
+      end
+
       Berkshelf.set_format @options[:format]
       @options = options.dup # unfreeze frozen options Hash from Thor
     end
@@ -27,15 +34,9 @@ module Berkshelf
     map 'ver'       => :version
     map 'book'      => :cookbook
 
-    desc "config", "Generate a default Berkshelf configuration file"
-    def config
-      ConfigGenerator.new.invoke_all
-    end
-
     class_option :config,
       type: :string,
-      default: Berkshelf::DEFAULT_CONFIG,
-      desc: "Path to Knife or Chef configuration to use.",
+      desc: "Path to Berkshelf configuration to use.",
       aliases: "-c",
       banner: "PATH"
     class_option :format,
@@ -45,6 +46,51 @@ module Berkshelf
       aliases: "-F",
       banner: "FORMAT"
 
+    method_option :force,
+      type: :boolean,
+      default: false,
+      desc: "create a new configuration file even if one already exists."
+    desc "configure", "Create a new configuration file to customize Berkshelf's behavior"
+    def configure(path = Berkshelf::Config.path)
+      path = File.expand_path(path)
+
+      if File.exist?(path) && !options[:force]
+        raise Berkshelf::ConfigExists, "A configuration file already exists. Re-run with the --force flag if you wish to overwrite it."
+      end
+
+      @config = Berkshelf::Config.new(path)
+
+      [
+        "chef.chef_server_url",
+        "chef.node_name",
+        "chef.client_key",
+        "chef.validation_client_name",
+        "chef.validation_key_path",
+        "vagrant.vm.box",
+        "vagrant.vm.box_url",
+      ].each do |attribute|
+        default = @config.get_attribute(attribute)
+
+        message = "Enter value for #{attribute}"
+        message << " (default: '#{default}')" if default
+        message << ": "
+
+        input = Berkshelf.ui.ask(message)
+
+        if input.present?
+          @config.set_attribute(attribute, input)
+        end
+      end
+
+      unless @config.valid?
+        raise InvalidConfiguration.new(@config.errors)
+      end
+
+      @config.save
+
+      Berkshelf.formatter.msg "Config written to: '#{path}'"
+    end
+
     method_option :except,
       type: :array,
       desc: "Exclude cookbooks that are in these groups.",
@@ -64,7 +110,7 @@ module Berkshelf
       desc: "Path to install cookbooks to (i.e. vendor/cookbooks).",
       aliases: "-p",
       banner: "PATH"
-    desc "install", "Install the Cookbooks specified by a Berksfile or a Berksfile.lock."
+    desc "install", "Install the Cookbooks specified by a Berksfile or a Berksfile.lock"
     def install
       berksfile = ::Berkshelf::Berksfile.from_file(options[:berksfile])
       berksfile.install(options)
@@ -84,7 +130,7 @@ module Berkshelf
       type: :array,
       desc: "Only cookbooks that are in these groups.",
       aliases: "-o"
-    desc "update", "Update all Cookbooks and their dependencies specified by a Berksfile to their latest versions."
+    desc "update", "Update all Cookbooks and their dependencies specified by a Berksfile to their latest versions"
     def update
       Lockfile.remove!
       invoke :install
@@ -116,19 +162,34 @@ module Berkshelf
       type: :boolean,
       default: true,
       desc: "Disable/Enable SSL verification when uploading cookbooks"
-    desc "upload", "Upload the Cookbooks specified by a Berksfile or a Berksfile.lock to a Chef Server."
+    desc "upload", "Upload the Cookbooks specified by a Berksfile or a Berksfile.lock to a Chef Server"
     def upload
-      Berkshelf.load_config 
       berksfile = ::Berkshelf::Berksfile.from_file(options[:berksfile])
 
+      unless Berkshelf::Config.instance.chef.chef_server_url.present?
+        msg = "Could not upload cookbooks: Missing Chef server_url."
+        msg << " Generate or update your Berkshelf configuration that contains a valid Chef Server URL."
+        raise UploadFailure, msg
+      end
+
+      unless Berkshelf::Config.instance.chef.node_name.present?
+        msg = "Could not upload cookbooks: Missing Chef node_name."
+        msg << " Generate or update your Berkshelf configuration that contains a valid Chef node_name."
+        raise UploadFailure, msg
+      end
+
       berksfile.upload(
-        server_url: Chef::Config[:chef_server_url],
-        client_name: Chef::Config[:node_name],
-        client_key: Chef::Config[:client_key],
+        server_url: Berkshelf::Config.instance.chef.chef_server_url,
+        client_name: Berkshelf::Config.instance.chef.node_name,
+        client_key: Berkshelf::Config.instance.chef.client_key,
         ssl: {
-          verify: options[:ssl_verify]
+          verify: (options[:ssl_verify] || Berkshelf::Config.instance.ssl.verify)
         }
       )
+    rescue Ridley::Errors::ClientKeyFileNotFound => e
+      msg = "Could not upload cookbooks: Missing Chef client key: '#{Berkshelf::Config.instance.chef.client_key}'."
+      msg << " Generate or update your Berkshelf configuration that contains a valid path to a Chef client key."
+      raise UploadFailure, msg
     end
 
     method_option :foodcritic,
@@ -152,7 +213,7 @@ module Berkshelf
     method_option :skip_git,
       type: :boolean,
       desc: "Skips adding a .gitignore and running git init in the cookbook directory"
-    desc "init [PATH]", "Prepare a local path to have its Cookbook dependencies managed by Berkshelf."
+    desc "init [PATH]", "Prepare a local path to have its Cookbook dependencies managed by Berkshelf"
     def init(path = Dir.pwd)
       Berkshelf.formatter.deprecation "--git is now the default" if options[:git]
       Berkshelf.formatter.deprecation "--vagrant is now the default" if options[:vagrant]
@@ -213,6 +274,10 @@ module Berkshelf
       Berkshelf.formatter.deprecation "--git is now the default" if options[:git]
       Berkshelf.formatter.deprecation "--vagrant is now the default" if options[:vagrant]
 
+      unless Config.instance.valid?
+        raise InvalidConfiguration.new(Config.instance.errors)
+      end
+
       ::Berkshelf::CookbookGenerator.new([name, File.join(Dir.pwd, name)], options).invoke_all
     end