Class: Chef::Knife::CookbookCreate

Inherits:
Chef::Knife show all
Includes:
Mixin::ShellOut
Defined in:
lib/chef/knife/cookbook_create.rb

Constant Summary

Constants inherited from Chef::Knife

DEFAULT_SUBCOMMAND_FILES

Instance Attribute Summary

Attributes inherited from Chef::Knife

#name_args

Instance Method Summary collapse

Methods included from Mixin::ShellOut

#shell_out, #shell_out!

Methods inherited from Chef::Knife

#ask_question, #bulk_delete, category, #configure_chef, #confirm, #create_object, #delete_object, #edit_data, #edit_object, #file_exists_and_is_readable?, #format_for_display, #format_list_for_display, guess_category, inherited, #initialize, list_commands, load_commands, #load_from_file, #msg, msg, #output, #parse_options, #pretty_print, #rest, run, #show_usage, snake_case_name, #stdin, #stdout, subcommand_category, subcommand_class_from, subcommands, subcommands_by_category, unnamed?

Methods included from Mixin::ConvertToClassName

#convert_to_class_name, #convert_to_snake_case, #filename_to_qualified_string, #snake_case_basename

Constructor Details

This class inherits a constructor from Chef::Knife

Instance Method Details

#create_cookbook(dir, cookbook_name, copyright, license) ⇒ Object



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'lib/chef/knife/cookbook_create.rb', line 79

def create_cookbook(dir, cookbook_name, copyright, license)
  msg("** Creating cookbook #{cookbook_name}")
  shell_out "mkdir -p #{File.join(dir, cookbook_name, "attributes")}"
  shell_out "mkdir -p #{File.join(dir, cookbook_name, "recipes")}"
  shell_out "mkdir -p #{File.join(dir, cookbook_name, "definitions")}"
  shell_out "mkdir -p #{File.join(dir, cookbook_name, "libraries")}"
  shell_out "mkdir -p #{File.join(dir, cookbook_name, "resources")}"
  shell_out "mkdir -p #{File.join(dir, cookbook_name, "providers")}"
  shell_out "mkdir -p #{File.join(dir, cookbook_name, "files", "default")}"
  shell_out "mkdir -p #{File.join(dir, cookbook_name, "templates", "default")}"
  unless File.exists?(File.join(dir, cookbook_name, "recipes", "default.rb"))
    open(File.join(dir, cookbook_name, "recipes", "default.rb"), "w") do |file|
      file.puts <<-EOH
#
# Cookbook Name:: #{cookbook_name}
# Recipe:: default
#
# Copyright #{Time.now.year}, #{copyright}
#
EOH
      case license
      when "apachev2"
        file.puts <<-EOH
# 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 "none"
        file.puts <<-EOH
# All rights reserved - Do Not Redistribute
#
EOH
      end
    end
  end
end

#create_metadata(dir, cookbook_name, copyright, email, license) ⇒ Object



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
# File 'lib/chef/knife/cookbook_create.rb', line 172

def (dir, cookbook_name, copyright, email, license)
  msg("** Creating metadata for cookbook: #{cookbook_name}")

  license_name = case license
                 when "apachev2"
                   "Apache 2.0"
                 when "none"
                   "All rights reserved"
                 end

  unless File.exists?(File.join(dir, cookbook_name, "metadata.rb"))
    open(File.join(dir, cookbook_name, "metadata.rb"), "w") do |file|
      if File.exists?(File.join(dir, cookbook_name, "README.#{config[:readme_format]}"))
        long_description = "long_description IO.read(File.join(File.dirname(__FILE__), 'README.#{config[:readme_format]}'))"
      end
      file.puts <<-EOH
maintainer       "#{copyright}"
maintainer_email "#{email}"
license          "#{license_name}"
description      "Installs/Configures #{cookbook_name}"
#{long_description}
version          "0.0.1"
EOH
    end
  end
end

#create_readme(dir, cookbook_name) ⇒ Object



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
# File 'lib/chef/knife/cookbook_create.rb', line 125

def create_readme(dir, cookbook_name)
  msg("** Creating README for cookbook: #{cookbook_name}")
  unless File.exists?(File.join(dir, cookbook_name, "README.#{config[:readme_format]}"))
    open(File.join(dir, cookbook_name, "README.#{config[:readme_format]}"), "w") do |file|
      case config[:readme_format]
      when "rdoc"
        file.puts <<-EOH
= DESCRIPTION:

= REQUIREMENTS:

= ATTRIBUTES:

= USAGE:

EOH
      when "md","mkd","txt"
        file.puts <<-EOH
Description
===========

Requirements
============

Attributes
==========

Usage
=====

EOH
      else
        file.puts <<-EOH
Description

Requirements

Attributes

Usage

EOH
      end
    end
  end
end

#runObject



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/chef/knife/cookbook_create.rb', line 57

def run
    self.config = Chef::Config.merge!(config)
    if @name_args.length < 1
      show_usage
      Chef::Log.fatal("You must specify a cookbook name")
      exit 1
    end

    if default_cookbook_path_empty? && parameter_empty?(config[:cookbook_path])
      raise ArgumentError, "Default cookbook_path is not specified in the knife.rb config file, and a value to -o is not provided. Nowhere to write the new cookbook to."
    end

    cookbook_path = Array(config[:cookbook_path]).first
    cookbook_name = @name_args.first
    copyright = config[:cookbook_copyright] || "YOUR_COMPANY_NAME"
    email = config[:cookbook_email] || "YOUR_EMAIL"
    license = ((config[:cookbook_license] != "false") && config[:cookbook_license]) || "none"
    create_cookbook(cookbook_path,cookbook_name, copyright, license)
    create_readme(cookbook_path,cookbook_name)
    (cookbook_path,cookbook_name, copyright, email, license)
end