chefdore 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a84f685835980c8244fb75ea91e0aed988162e3
-  data.tar.gz: ca1089f95b4403bdcc480e7e4edc577cf9155bfe
+  metadata.gz: 36e9cb7d6225f41e9bd7213a3ad4bc89de92f7ff
+  data.tar.gz: e5f615b3fca910f964826135c43627dee595619d
 SHA512:
-  metadata.gz: 625ba115805fe88a94c0829d6316947a5bed4a5ee15d98158e529c2e0513516916ef715c26d99598dc5b25e1de720d39e5773f7c3dd0dc72599aa6ec470a7af5
-  data.tar.gz: 1d3b1ce26793566b6fcd1f0fcfc4cecd3dfa71d2f45b13620f6b4e93a75b45a8f247efb8c90b2859448d120bbd9ff1cf66350d103c5927cae4db48d1940ea72d
+  metadata.gz: cd1df4b4dd91a2d1afc902009f382edf0d351740c0528120fe47f2800d0825ff1071c76336d39a4ba348c4b2628a9a4cec19b039365a410f6a1924c7f4819551
+  data.tar.gz: ebbd400323524a9cc9eb1955cb368c7bfa4204eba7d78f25ff49eb3d3eb7afe19286a8731fa78c07229e19ad56a6a79e082cf8b78cce4b2c9a55ece9932adbee

data/README.md

@@ -2,13 +2,141 @@
 
 Chef tool that was named after Dumbledore.
 
+I created this gem in order to help those who may want to convert Chef Roles to Chef Cookbooks.
+
 ## Installation
 
     $ gem install chefdore
 
 ## Usage
 
-    knife role show base --format json | chefdore convert
+Let's say you have a Chef Role in your Chef Server and you want to convert it to a Chef Cookbook.
+
+First let's take a look at an "example_role":
+
+```bash
+$ knife role show example_role --format json
+{
+  "name": "example_role",
+  "description": "Chef-server example role",
+  "json_class": "Chef::Role",
+  "default_attributes": {
+
+  },
+  "override_attributes": {
+    "developer_mode": false,
+    "monitoring": {
+      "metric_provider": "collectd",
+      "procmon_provider": "monit"
+    },
+    "glance": {
+      "image_upload": true,
+      "images": [
+        "cirros",
+        "precise"
+      ]
+    },
+    "nova": {
+      "ratelimit": {
+        "api": {
+          "enabled": true
+        },
+        "volume": {
+          "enabled": true
+        }
+      },
+      "libvirt": {
+        "virt_type": "qemu"
+      },
+      "networks": {
+        "public": {
+          "label": "public",
+          "ipv4_cidr": "10.10.100.0/24",
+          "bridge": "br100",
+          "bridge_dev": "eth0.100",
+          "dns1": "8.8.8.8",
+          "dns2": "8.8.4.4"
+        },
+        "private": {
+          "label": "private",
+          "ipv4_cidr": "172.16.101.0/24",
+          "bridge": "br101",
+          "bridge_dev": "eth0.101",
+          "dns1": "8.8.8.8",
+          "dns2": "8.8.4.4"
+        }
+      }
+    },
+    "mysql": {
+      "allow_remote_root": true,
+      "root_network_acl": "%"
+    },
+    "osops_networks": {
+      "nova": "192.168.1.0/24",
+      "public": "192.168.1.0/24",
+      "management": "192.168.1.0/24"
+    },
+    "package_component": "folsom"
+  },
+  "chef_type": "role",
+  "run_list": [
+    "recipe[osops-utils::packages]",
+    "recipe[osops-utils::nf_conntrack_max]",
+    "recipe[osops-utils::vhost_net]",
+    "recipe[openssh]",
+    "recipe[ntp]",
+    "recipe[rsyslog::default]",
+    "recipe[hardware]",
+    "recipe[osops-utils::version]"
+  ],
+  "env_run_lists": {
+
+  }
+}
+```
+
+All we have to do is pipe that output into our little command line client:
+
+```bash
+$ knife role show example_role --format json | chefdore convert
+override["developer_mode"] = false
+override["monitoring"]["metric_provider"] = "collectd"
+override["monitoring"]["procmon_provider"] = "monit"
+override["glance"]["image_upload"] = true
+override["glance"]["images"] = ["cirros", "precise"]
+override["nova"]["ratelimit"]["api"]["enabled"] = true
+override["nova"]["ratelimit"]["volume"]["enabled"] = true
+override["nova"]["libvirt"]["virt_type"] = "qemu"
+override["nova"]["networks"]["public"]["label"] = "public"
+override["nova"]["networks"]["public"]["ipv4_cidr"] = "10.10.100.0/24"
+override["nova"]["networks"]["public"]["bridge"] = "br100"
+override["nova"]["networks"]["public"]["bridge_dev"] = "eth0.100"
+override["nova"]["networks"]["public"]["dns1"] = "8.8.8.8"
+override["nova"]["networks"]["public"]["dns2"] = "8.8.4.4"
+override["nova"]["networks"]["private"]["label"] = "private"
+override["nova"]["networks"]["private"]["ipv4_cidr"] = "172.16.101.0/24"
+override["nova"]["networks"]["private"]["bridge"] = "br101"
+override["nova"]["networks"]["private"]["bridge_dev"] = "eth0.101"
+override["nova"]["networks"]["private"]["dns1"] = "8.8.8.8"
+override["nova"]["networks"]["private"]["dns2"] = "8.8.4.4"
+override["mysql"]["allow_remote_root"] = true
+override["mysql"]["root_network_acl"] = "%"
+override["osops_networks"]["nova"] = "192.168.1.0/24"
+override["osops_networks"]["public"] = "192.168.1.0/24"
+override["osops_networks"]["management"] = "192.168.1.0/24"
+override["package_component"] = "folsom"
+include_recipe "osops-utils::packages"
+include_recipe "osops-utils::nf_conntrack_max"
+include_recipe "osops-utils::vhost_net"
+include_recipe "openssh"
+include_recipe "ntp"
+include_recipe "rsyslog::default"
+include_recipe "hardware"
+include_recipe "osops-utils::version"
+```
+
+It outputs exactly what should be dropped into your new Chef Cookbook attributes file.
+e.g. `attributes/default.rb`
 
 ## Contributing
 
@@ -17,3 +145,31 @@ Chef tool that was named after Dumbledore.
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## License & Authors
+- Author: Jason Barnett
+
+```
+Copyright (c) 2015 Jason Barnett
+
+MIT License
+
+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.
+```

data/lib/chefdore/cli.rb

@@ -5,27 +5,27 @@ require 'json'
 module Chefdore
   class Cli < Thor
     namespace "chefdore"
+
+    option :append_arrays,
+      type: :boolean,
+      desc: "If this is used we will convert arrays by first creating it and then appending each value.",
+      aliases: "-a",
+      default: false
+
     map %w(v V -v -V ver --version) => :version
 
-    desc "convert", "Convert Chef role to a Chef cookbook. Expects the json formatted Chef Role to be piped to this command."
+    desc "convert", "Convert Chef Role/Environment to a Chef Cookbook. Expects the json formatted Chef Role/Environment to be piped to this command."
     def convert
       ARGV.replace []
       stdin = ARGF.read
 
       begin
-        json = JSON.parse(stdin)
+        Chefdore::Magic.convert(json: stdin, cli: self)
       rescue JSON::ParserError => e
         puts e.message
         exit 1
       end
 
-      toa = %w(default_attributes override_attributes)
-
-      toa.each do |type|
-        attr = json[type]
-        prefix = type.split('_').first
-        Chefdore::Magic.convert(attr, prefix)
-      end
     end
 
     desc "version", "Display version information"

data/lib/chefdore/utils.rb

@@ -1,21 +1,58 @@
+require 'chef/role'
+require 'chef/json_compat'
+
 module Chefdore
   class Magic
-    def self.convert(value={}, prefix="default", path=[])
+
+
+    def self.convert_run_list(opts = {})
+      rl  = opts[:run_list] ? opts[:run_list] : []
+      cli = opts[:cli]      ? opts[:cli]      : Chefdore::Cli.new
+
+      rl.recipes.each do |x|
+        puts "include_recipe #{x.inspect}"
+      end
+    end
+
+
+    def self.convert_attr(opts = {})
+      value  = opts[:value]
+      prefix = opts[:prefix] ? opts[:prefix] : "default"
+      path   = opts[:path]   ? opts[:path]   : []
+      cli    = opts[:cli]    ? opts[:cli]    : Chefdore::Cli.new
+
+      #puts "INFO :: #{value.inspect} (#{value.class}) -- #{prefix} -- #{path}"
+
       if value.is_a?(Hash)
         value.each do |subkey, subval|
-          convert(subval, prefix, path+[subkey])
+          convert_attr(opts.merge(value: subval, path: path+[subkey]))
         end
-      elsif value.is_a?(Array)
-        value.each do |i|
-          if i.is_a?(Hash)
-            convert(i, prefix, path)
-          else
-            puts "#{prefix}#{path.map{|p| "[#{p.inspect}]"}.join('')} = #{value.inspect}"
-          end
+      elsif value.is_a?(Array) && cli.options[:append_arrays]
+        puts "#{prefix}#{path.map{|p| "[#{p.inspect}]"}.join('')} = #{Array.new.inspect}"
+        value.each do |x|
+          puts "#{prefix}#{path.map{|p| "[#{p.inspect}]"}.join('')} << #{x.inspect}"
         end
       else
         puts "#{prefix}#{path.map{|p| "[#{p.inspect}]"}.join('')} = #{value.inspect}"
       end
     end
+
+
+    def self.convert(opts = {})
+      json = opts[:json] ? opts[:json] : fail("You must pass some JSON in :json opt")
+      cli  = opts[:cli]  ? opts[:cli]  : fail("You must pass the CLI in :cli opt")
+      klass = Chef::JSONCompat.from_json(json)
+
+      rl = klass.run_list
+      da = klass.default_attributes
+      oa = klass.override_attributes
+
+      convert_attr(cli: cli, value: da)
+      convert_attr(cli: cli, value: oa, prefix: "override")
+
+      convert_run_list(cli: cli, run_list: rl)
+    end
+
+
   end
 end

data/lib/chefdore/version.rb

@@ -1,3 +1,3 @@
 module Chefdore
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/spec/fixtures/base_example.json

@@ -0,0 +1,31 @@
+{
+  "name": "base_example",
+  "description": "Base Example role for a server",
+  "json_class": "Chef::Role",
+  "default_attributes": {
+    "ntp": {
+      "servers": [
+        "0.pool.ntp.org",
+        "1.pool.ntp.org",
+        "2.pool.ntp.org"
+      ]
+    }
+  },
+  "override_attributes": {
+
+  },
+  "chef_type": "role",
+  "run_list": [
+    "recipe[osops-utils::packages]",
+    "recipe[osops-utils::nf_conntrack_max]",
+    "recipe[osops-utils::vhost_net]",
+    "recipe[openssh]",
+    "recipe[ntp]",
+    "recipe[rsyslog::default]",
+    "recipe[hardware]",
+    "recipe[osops-utils::version]"
+  ],
+  "env_run_lists": {
+
+  }
+}

data/spec/fixtures/example_role.json

@@ -0,0 +1,77 @@
+{
+  "name": "example_role",
+  "description": "Chef-server example role",
+  "json_class": "Chef::Role",
+  "default_attributes": {
+
+  },
+  "override_attributes": {
+    "developer_mode": false,
+    "monitoring": {
+      "metric_provider": "collectd",
+      "procmon_provider": "monit"
+    },
+    "glance": {
+      "image_upload": true,
+      "images": [
+        "cirros",
+        "precise"
+      ]
+    },
+    "nova": {
+      "ratelimit": {
+        "api": {
+          "enabled": true
+        },
+        "volume": {
+          "enabled": true
+        }
+      },
+      "libvirt": {
+        "virt_type": "qemu"
+      },
+      "networks": {
+        "public": {
+          "label": "public",
+          "ipv4_cidr": "10.10.100.0/24",
+          "bridge": "br100",
+          "bridge_dev": "eth0.100",
+          "dns1": "8.8.8.8",
+          "dns2": "8.8.4.4"
+        },
+        "private": {
+          "label": "private",
+          "ipv4_cidr": "172.16.101.0/24",
+          "bridge": "br101",
+          "bridge_dev": "eth0.101",
+          "dns1": "8.8.8.8",
+          "dns2": "8.8.4.4"
+        }
+      }
+    },
+    "mysql": {
+      "allow_remote_root": true,
+      "root_network_acl": "%"
+    },
+    "osops_networks": {
+      "nova": "192.168.1.0/24",
+      "public": "192.168.1.0/24",
+      "management": "192.168.1.0/24"
+    },
+    "package_component": "folsom"
+  },
+  "chef_type": "role",
+  "run_list": [
+    "recipe[osops-utils::packages]",
+    "recipe[osops-utils::nf_conntrack_max]",
+    "recipe[osops-utils::vhost_net]",
+    "recipe[openssh]",
+    "recipe[ntp]",
+    "recipe[rsyslog::default]",
+    "recipe[hardware]",
+    "recipe[osops-utils::version]"
+  ],
+  "env_run_lists": {
+
+  }
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chefdore
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Jason Barnett
@@ -71,6 +71,8 @@ files:
 - lib/chefdore/cli.rb
 - lib/chefdore/utils.rb
 - lib/chefdore/version.rb
+- spec/fixtures/base_example.json
+- spec/fixtures/example_role.json
 - spec/test.rb
 homepage: https://github.com/jasonwbarnett/chefdore
 licenses:
@@ -97,5 +99,7 @@ signing_key:
 specification_version: 4
 summary: Chef tool that was named after Dumbledore.
 test_files:
+- spec/fixtures/base_example.json
+- spec/fixtures/example_role.json
 - spec/test.rb
 has_rdoc: