knife-role-convert 0.0.1

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.

data/README.rdoc

@@ -0,0 +1,23 @@
+== Knife Role Convert
+
+= DESCRIPTION:
+
+knife-role-convert helps convert existing roles into recipes to be placed
+into role cookbooks.
+
+= INSTALLATION:
+This plugin can be installed as a Ruby Gem.
+
+    gem install knife-role-convert
+
+You can also copy the source repository and install it using +rake install+.
+
+= USAGE:
+
+   knife role convert ROLE -c COOKBOOK -r RECIPE
+
+knife role convert take a single role and spits an equivalent recipe to
+stdout. The -c and -r options allow you to specify the intended name of
+the cookbook and recipe you wish the generated code to be saved as. In
+this release of knife-role-convert this currently only modifies the
+header of the generated recipe.

data/Rakefile

@@ -0,0 +1,24 @@
+require 'bundler'
+require 'rubygems'
+require 'rubygems/package_task'
+require 'rdoc/task'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+gem_spec = eval(File.read("knife-role-convert.gemspec"))
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "knife-role-convert #{gem_spec.version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/lib/chef/knife/role_convert.rb

@@ -0,0 +1,53 @@
+#
+# Author:: Mathieu Sauve-Frankel <msf@kisoku.net>
+# Copyright:: Copyright (c) 2013 Mathieu Sauve-Frankel
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require 'chef/knife'
+require 'chef/role_converter'
+
+class Chef
+  class Knife
+    class RoleConvert < Knife
+
+      banner "knife role convert ROLE (options)"
+
+      option :cookbook,
+        :short => "-c COOKBOOK",
+        :long => "--cookbook COOKBOOK",
+        :description => "Cookbook name you want the role to be added to"
+
+      option :recipe,
+        :short => "-r RECIPE",
+        :long => "--recipe RECIPE",
+        :description => "Recipe name you want the role to be ceonverted to",
+        :default => nil
+
+      def run
+        if @name_args.length < 1
+          ui.error("You must supply the name of the role you wish to convert")
+          exit 1
+        end
+
+        role = @name_args[0]
+
+        converter = Chef::RoleConverter.new(role, config)
+        converter.convert
+        puts converter.generate_recipe
+      end
+    end
+  end
+end

data/lib/chef/role_converter/templates/recipe.erb

@@ -0,0 +1,26 @@
+# This recipe was autogenerated by knife-role-convert
+#
+# Cookbook Name:: <%= @cookbook %>
+# Recipe:: <%= @recipe %>
+#
+# Author:: Your Name Here
+# Copyright <%= Time.now.year -%>
+# Add license of your choice here
+
+<% unless @default_attributes.empty? -%>
+# default attributes
+<% @default_attributes.each do |line| -%>
+node.default<%= line -%>
+<% end -%>
+
+<% end -%>
+<% unless @override_attributes.empty? -%>
+# override attributes
+<% @override_attributes.each do |line| -%>
+node.override<%= line -%>
+<% end -%>
+
+<% end -%>
+<% @run_list.each do |entry| -%>
+<%= entry =%>
+<% end -%>

data/lib/chef/role_converter/version.rb

@@ -0,0 +1,5 @@
+class Chef
+  class RoleConverter
+    VERSION = '0.0.1'
+  end
+end

data/lib/chef/role_converter.rb

@@ -0,0 +1,94 @@
+#
+# Author:: Mathieu Sauve-Frankel <msf@kisoku.net>
+# Copyright:: Copyright (c) 2013 Mathieu Sauve-Frankel
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require 'erubis'
+require 'chef/role'
+
+class Chef
+  class RoleConverter
+    RECIPE_TEMPLATE = File.join(File.dirname(__FILE__), "role_converter", "templates", "recipe.erb")
+
+    attr_reader :role, :cookbook, :recipe
+    attr_accessor :attributes, :dependencies, :run_list
+
+    def initialize(role, config={})
+      @role = Chef::Role.from_disk(role)
+      @config = config
+      @recipe = config[:recipe] || @role.name
+      @cookbook = config[:cookbook] || 'new_cookbook'
+      @attributes = {
+        'default' => [],
+        'override' => []
+      }
+      @run_list = []
+      @dependencies = []
+    end
+
+    def convert
+      convert_attributes(role.default_attributes, "default")
+      convert_attributes(role.override_attributes, "override")
+      convert_runlist
+    end
+
+    def convert_attributes(attrs, type, parents=[])
+      # XXX this whole bit stinks, redo it later
+      attrs.each do |attribute, value|
+        if value.is_a? Hash
+          parents << attribute
+          convert_attributes(value, type, parents)
+        else
+          if parents.empty?
+            attr_path = "['#{attribute}']"
+          else
+            attr_path = parents.map {|a| "['#{a}']" }.join() + "['#{attribute}']"
+          end
+          attributes[type] << "#{attr_path} = #{value.pretty_inspect}"
+        end
+      end
+    end
+
+    def convert_runlist
+      role.run_list.each do |entry|
+        if entry.recipe?
+          cookbook = entry.name.split("::").first
+          unless dependencies.member? cookbook
+            dependencies << cookbook
+          end
+          run_list << "include_recipe '#{entry.name}'\n"
+        elsif entry.role?
+          # XXX process recursively ?
+          run_list << "# XXX detected role in run_list: #{entry.name}\n"
+          run_list << "# include_recipe 'role_cookbook::#{entry.name}\n'"
+        end
+      end
+    end
+
+    def generate_recipe
+      template = IO.read(Chef::RoleConverter::RECIPE_TEMPLATE).chomp
+      eruby = Erubis::Eruby.new(template)
+      context = {
+        :cookbook => cookbook,
+        :recipe => recipe,
+        :default_attributes => attributes['default'],
+        :override_attributes => attributes['override'],
+        :run_list => run_list
+      }
+      eruby.evaluate(context)
+    end
+  end
+end

data/spec/data/roles/simple_role.rb

@@ -0,0 +1,16 @@
+name 'simple_role'
+description 'simple test role for knife-role-coonvert'
+
+run_list(
+  "recipe[foo]"
+)
+
+override_attributes(
+  "foo" => {
+    "unicorn" => {
+      "collect_tears" => true
+    }
+  },
+  "bar" => 1,
+  "quux" => %w{unos dos tres}
+)

data/spec/support/spec_helper.rb

@@ -0,0 +1,7 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+
+require 'chef/config'
+require 'chef/role'
+require 'chef/role_converter'
+
+Chef::Config[:role_path] = File.join(File.dirname(__FILE__), '..', 'data', 'roles')

data/spec/unit/role_convert_spec.rb

@@ -0,0 +1,41 @@
+#
+# Author:: Mathieu Sauve-Frankel <msf@kisoku.net>
+# Copyright:: Copyright (c) 2013 Mathieu Sauve-Frankel
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require 'support/spec_helper.rb'
+
+class Chef
+  describe RoleConverter do
+    describe "#initialize" do
+      let(:simple_role) {
+        RoleConverter.new("simple_role")
+      }
+      it "should load the role from disk" do
+        simple_role.recipe.should eq "simple_role"
+        simple_role.role.run_list.first.should be_a_kind_of Chef::RunList::RunListItem
+        simple_role.role.run_list.first.name.should eq "foo"
+      end
+
+      it "process nested attributes" do
+        simple_role.convert_attributes(simple_role.role.override_attributes, "override")
+        require 'pry'
+        binding.pry
+        # simple_role.attributes['override']
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: knife-role-convert
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mathieu Sauve-Frankel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mixlib-cli
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Knife plugin for converting roles to role cookbooks
+email: msf@kisoku.net
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+- LICENSE
+files:
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/chef/role_converter.rb
+- lib/chef/knife/role_convert.rb
+- lib/chef/role_converter/version.rb
+- lib/chef/role_converter/templates/recipe.erb
+- spec/unit/role_convert_spec.rb
+- spec/support/spec_helper.rb
+- spec/data/roles/simple_role.rb
+homepage: http://www.opscode.com
+licenses:
+- Apache 2.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Knife plugin for converting roles to role cookbooks
+test_files: []
+has_rdoc: true