knife-cookbook-readme 0.2.0 → 0.2.1

data/spec/fixtures/mysql-metadata.rb

@@ -0,0 +1,140 @@
+name		  "mysql"
+maintainer        "Opscode, Inc."
+maintainer_email  "cookbooks@opscode.com"
+license           "Apache 2.0"
+description       "Installs and configures mysql for client or server"
+long_description  IO.read(File.join(File.dirname(__FILE__), 'README.md'))
+version           "3.0.5"
+recipe            "mysql", "Includes the client recipe to configure a client"
+recipe            "mysql::client", "Installs packages required for mysql clients using run_action magic"
+recipe            "mysql::server", "Installs packages required for mysql servers w/o manual intervention"
+recipe            "mysql::server_ec2", "Performs EC2-specific mountpoint manipulation"
+
+%w{ debian ubuntu centos suse fedora redhat scientific amazon freebsd windows mac_os_x }.each do |os|
+  supports os
+end
+
+depends "openssl"
+depends "build-essential", "> 1.1.0"
+suggests "homebrew"
+suggests "windows"
+
+attribute "mysql/server_root_password",
+  :display_name => "MySQL Server Root Password",
+  :description => "Randomly generated password for the mysqld root user",
+  :default => "randomly generated"
+
+attribute "mysql/bind_address",
+  :display_name => "MySQL Bind Address",
+  :description => "Address that mysqld should listen on",
+  :default => "ipaddress"
+
+attribute "mysql/data_dir",
+  :display_name => "MySQL Data Directory",
+  :description => "Location of mysql databases",
+  :default => "/var/lib/mysql"
+
+attribute "mysql/conf_dir",
+  :display_name => "MySQL Conf Directory",
+  :description => "Location of mysql conf files",
+  :default => "/etc/mysql"
+
+attribute "mysql/ec2_path",
+  :display_name => "MySQL EC2 Path",
+  :description => "Location of mysql directory on EC2 instance EBS volumes",
+  :default => "/mnt/mysql"
+
+attribute "mysql/reload_action",
+  :display_name => "MySQL conf file reload action",
+  :description => "Action to take when mysql conf files are modified",
+  :default => "reload"
+
+attribute "mysql/tunable",
+  :display_name => "MySQL Tunables",
+  :description => "Hash of MySQL tunable attributes",
+  :type => "hash"
+
+attribute "mysql/tunable/key_buffer",
+  :display_name => "MySQL Tuntable Key Buffer",
+  :default => "250M"
+
+attribute "mysql/tunable/max_connections",
+  :display_name => "MySQL Tunable Max Connections",
+  :default => "800"
+
+attribute "mysql/tunable/wait_timeout",
+  :display_name => "MySQL Tunable Wait Timeout",
+  :default => "180"
+
+attribute "mysql/tunable/net_read_timeout",
+  :display_name => "MySQL Tunable Net Read Timeout",
+  :default => "30"
+
+attribute "mysql/tunable/net_write_timeout",
+  :display_name => "MySQL Tunable Net Write Timeout",
+  :default => "30"
+
+attribute "mysql/tunable/back_log",
+  :display_name => "MySQL Tunable Back Log",
+  :default => "128"
+
+attribute "mysql/tunable/table_cache",
+  :display_name => "MySQL Tunable Table Cache for MySQL < 5.1.3",
+  :default => "128"
+
+attribute "mysql/tunable/table_open_cache",
+  :display_name => "MySQL Tunable Table Cache for MySQL >= 5.1.3",
+  :default => "128"
+
+attribute "mysql/tunable/max_heap_table_size",
+  :display_name => "MySQL Tunable Max Heap Table Size",
+  :default => "32M"
+
+attribute "mysql/tunable/expire_logs_days",
+  :display_name => "MySQL Exipre Log Days",
+  :default => "10"
+
+attribute "mysql/tunable/max_binlog_size",
+  :display_name => "MySQL Max Binlog Size",
+  :default => "100M"
+
+attribute "mysql/client",
+  :display_name => "MySQL Connector/C Client",
+  :description => "Hash of MySQL client attributes",
+  :type => "hash"
+
+attribute "mysql/client/version",
+  :display_name => "MySQL Connector/C Version",
+  :default => "6.0.2"
+
+attribute "mysql/client/arch",
+  :display_name => "MySQL Connector/C Architecture",
+  :default => "win32"
+
+attribute "mysql/client/package_file",
+  :display_name => "MySQL Connector/C Package File Name",
+  :default => "mysql-connector-c-6.0.2-win32.msi"
+
+attribute "mysql/client/url",
+  :display_name => "MySQL Connector/C Download URL",
+  :default => "http://www.mysql.com/get/Downloads/Connector-C/mysql-connector-c-6.0.2-win32.msi/from/http://mysql.mirrors.pair.com/"
+
+attribute "mysql/client/package_name",
+  :display_name => "MySQL Connector/C Registry DisplayName",
+  :default => "MySQL Connector C 6.0.2"
+
+attribute "mysql/client/basedir",
+  :display_name => "MySQL Connector/C Base Install Directory",
+  :default => "C:\\Program Files (x86)\\MySQL\\Connector C 6.0.2"
+
+attribute "mysql/client/lib_dir",
+  :display_name => "MySQL Connector/C Library Directory (containing libmysql.dll)",
+  :default => "C:\\Program Files (x86)\\MySQL\\Connector C 6.0.2\\lib\\opt"
+
+attribute "mysql/client/bin_dir",
+  :display_name => "MySQL Connector/C Executable Directory",
+  :default => "C:\\Program Files (x86)\\MySQL\\Connector C 6.0.2\\bin"
+
+attribute "mysql/client/ruby_dir",
+  :display_name => "Ruby Executable Directory which should gain MySQL support",
+  :default => "system ruby"

data/spec/metadata_spec.rb

@@ -1,11 +1,28 @@
-require File.expand_path("../../lib/knife_cookbook_readme/metadata", __FILE__)
+require_relative "../lib/knife_cookbook_readme/metadata"
 
 module KnifeCookbookReadme
   describe "Metadata.from_file" do
-    it "knows how to read metadata from metadata.rb" do
-      file = double
-      Chef::Cookbook::Metadata.any_instance.should_receive(:from_file).with(file)
-      Metadata.from_file(file)
+    let(:fixtures_path) { File.expand_path("../fixtures", __FILE__) }
+
+    it "reads metadata.rb of apache2 cookbook" do
+      file = File.join(fixtures_path, "apache2-metadata.rb")
+      metadata = Metadata.from_file(file)
+      metadata.name.should == "apache2"
+      metadata.platforms.should include "redhat"
+    end
+
+    it "reads metadata.rb of git cookbook" do
+      file = File.join(fixtures_path, "git-metadata.rb")
+      metadata = Metadata.from_file(file)
+      metadata.name.should == "git"
+      metadata.dependencies.should include "build-essential"
+    end
+
+    it "reads metadata.rb of mysql cookbook" do
+      file = File.join(fixtures_path, "mysql-metadata.rb")
+      metadata = Metadata.from_file(file)
+      metadata.name.should == "mysql"
+      metadata.attributes["mysql/data_dir"][:default].should == "/var/lib/mysql"
     end
   end
 end

data/spec/readme_spec.rb

@@ -1,6 +1,4 @@
-require File.expand_path("../../lib/knife_cookbook_readme/readme", __FILE__)
-
-class Template; end
+require_relative "../lib/knife_cookbook_readme"
 
 module KnifeCookbookReadme
   describe Readme do
@@ -18,11 +16,18 @@ module KnifeCookbookReadme
       readme.description.should == description
     end
 
-    it "generates recipes" do
-      recipes = double
-      metadata = double(:metadata, :recipes => recipes)
+    it "generates supported platforms" do
+      platforms = { "debian" => "= 7", "ubuntu" => ">= 10.04" }
+      metadata = double(:metadata, :platforms => platforms)
       readme = Readme.new(metadata)
-      readme.recipes.should == recipes
+      readme.platforms.should == ["Debian (= 7)", "Ubuntu (>= 10.04)"]
+    end
+
+    it "generates cookbook dependencies" do
+      dependencies = { "cats" => "< 1.0", "dogs" => DEFAULT_CONSTRAINT }
+      metadata = double(:metadata, :dependencies => dependencies)
+      readme = Readme.new(metadata)
+      readme.dependencies.should == ["cats (< 1.0)", "dogs"]
     end
 
     it "generates cookbook attributes" do
@@ -38,88 +43,78 @@ module KnifeCookbookReadme
       }
       metadata = double(:metadata, :attributes => attributes)
       readme = Readme.new(metadata)
-      readme.attributes.sort.should == [
+      readme.attributes.should == [
         ["node['pets']['cat']['name']", "The name of your cat", "Kitty"],
         ["node['pets']['dog']['name']", "The name of your dog", "Barf"],
       ]
     end
 
-    context "supported platforms" do
-      let(:metadata) do
-        platforms = { "debian" => "= 7", "ubuntu" => ">= 10.04" }
-        double(:metadata, :platforms => platforms)
-      end
-
-      it "generates platforms with version constraints" do
-        constraints = true
-        readme = Readme.new(metadata, constraints)
-        readme.platforms.sort.should == ["Debian (= 7)", "Ubuntu (>= 10.04)"]
-      end
+    it "generates recipes" do
+      recipes = double
+      metadata = double(:metadata, :recipes => recipes)
+      readme = Readme.new(metadata)
+      readme.recipes.should == recipes
+    end
 
-      it "generates platforms without version constraints" do
-        constraints = false
-        readme = Readme.new(metadata, constraints)
-        readme.platforms.sort.should == ["Debian", "Ubuntu"]
-      end
+    it "generates author from maintainer name" do
+      maintainer = double
+      metadata = double(:metadata, :maintainer => maintainer)
+      readme = Readme.new(metadata)
+      readme.author.should == maintainer
     end
 
-    context "cookbook dependencies" do
-      let(:metadata) do
-        dependencies = { "cats" => "< 1.0", "dogs" => DEFAULT_CONSTRAINT }
-        double(:metadata, :dependencies => dependencies)
-      end
+    it "generates author email from maintainer email" do
+      maintainer_email = double
+      metadata = double(:metadata, :maintainer_email => maintainer_email)
+      readme = Readme.new(metadata)
+      readme.author_email.should == maintainer_email
+    end
 
-      it "generates dependencies with version constraints" do
-        constraints = true
-        readme = Readme.new(metadata, constraints)
-        readme.dependencies.sort.should == ["cats (< 1.0)", "dogs"]
-      end
+    it "generates copyright year from current year" do
+      time_now = Time.mktime(2013, 1, 1)
+      Time.stub(:now).and_return(time_now)
+      metadata = double
+      readme = Readme.new(metadata)
+      readme.copyright_year.should == time_now.year
+    end
 
-      it "generates dependencies without version constraints" do
-        constraints = false
-        readme = Readme.new(metadata, constraints)
-        readme.dependencies.sort.should == ["cats", "dogs"]
-      end
+    it "generates license name" do
+      license = double
+      metadata = double(:metadata, :license => license)
+      readme = Readme.new(metadata)
+      readme.license.should == license
     end
 
-    context "license and author" do
-      it "generates author from maintainer name" do
-        maintainer = double
-        metadata = double(:metadata, :maintainer => maintainer)
-        readme = Readme.new(metadata)
-        readme.author.should == maintainer
-      end
+    context "#render" do
+      let(:template_file) { File.expand_path("../../template/README.md.erb", __FILE__) }
+      let(:template)      { File.read(template_file) }
+      let(:fixtures_path) { File.expand_path("../fixtures", __FILE__) }
 
-      it "generates author email from maintainer email" do
-        maintainer_email = double
-        metadata = double(:metadata, :maintainer_email => maintainer_email)
-        readme = Readme.new(metadata)
-        readme.author_email.should == maintainer_email
-      end
+      it "renders README.md for apache2 cookbook" do
+        metadata_file = File.join(fixtures_path, "apache2-metadata.rb")
+        readme_file   = File.join(fixtures_path, "apache2-README.md")
 
-      it "generates copyright year from current year" do
-        time_now = Time.mktime(2013, 1, 1)
-        Time.stub(:now).and_return(time_now)
-        metadata = double
-        readme = Readme.new(metadata)
-        readme.copyright_year.should == time_now.year
+        metadata = Metadata.from_file(metadata_file)
+        output = Readme.new(metadata).render(template)
+        output.should == File.read(readme_file)
       end
-      
-      it "generates license name" do
-        license = double
-        metadata = double(:metadata, :license => license)
-        readme = Readme.new(metadata)
-        readme.license.should == license
+
+      it "renders README.md for git cookbook" do
+        metadata_file = File.join(fixtures_path, "git-metadata.rb")
+        readme_file   = File.join(fixtures_path, "git-README.md")
+
+        metadata = Metadata.from_file(metadata_file)
+        output = Readme.new(metadata).render(template)
+        output.should == File.read(readme_file)
       end
-    end
 
-    context "#render" do
-      it "knows how to render a README.md file" do
-        template = double
-        Template.should_receive(:render).with(template, kind_of(Binding))
-        metadata = double
-        readme = Readme.new(metadata)
-        readme.render(template)
+      it "renders README.md for mysql cookbook" do
+        metadata_file = File.join(fixtures_path, "mysql-metadata.rb")
+        readme_file   = File.join(fixtures_path, "mysql-README.md")
+
+        metadata = Metadata.from_file(metadata_file)
+        output = Readme.new(metadata).render(template)
+        output.should == File.read(readme_file)
       end
     end
   end

data/spec/template_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path("../../lib/knife_cookbook_readme/template", __FILE__)
+require_relative "../lib/knife_cookbook_readme/template"
 
 module KnifeCookbookReadme
   describe "Template.render" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-cookbook-readme
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Mathias Lafeldt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-22 00:00:00.000000000 Z
+date: 2013-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -82,10 +82,18 @@ files:
 - Rakefile
 - knife_cookbook_readme.gemspec
 - lib/chef/knife/cookbook_readme_from.rb
+- lib/knife_cookbook_readme.rb
 - lib/knife_cookbook_readme/metadata.rb
 - lib/knife_cookbook_readme/readme.rb
 - lib/knife_cookbook_readme/template.rb
 - lib/knife_cookbook_readme/version.rb
+- spec/fixtures/README.md
+- spec/fixtures/apache2-README.md
+- spec/fixtures/apache2-metadata.rb
+- spec/fixtures/git-README.md
+- spec/fixtures/git-metadata.rb
+- spec/fixtures/mysql-README.md
+- spec/fixtures/mysql-metadata.rb
 - spec/metadata_spec.rb
 - spec/readme_spec.rb
 - spec/template_spec.rb
@@ -110,11 +118,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.1.4
 signing_key: 
 specification_version: 4
 summary: Knife plugin to generate README.md from metadata.rb
 test_files:
+- spec/fixtures/README.md
+- spec/fixtures/apache2-README.md
+- spec/fixtures/apache2-metadata.rb
+- spec/fixtures/git-README.md
+- spec/fixtures/git-metadata.rb
+- spec/fixtures/mysql-README.md
+- spec/fixtures/mysql-metadata.rb
 - spec/metadata_spec.rb
 - spec/readme_spec.rb
 - spec/template_spec.rb