chef-dk 0.9.0 → 0.10.0

data/lib/chef-dk/cookbook_profiler/identifiers.rb

@@ -1,72 +1,72 @@
-#
-# Copyright:: Copyright (c) 2014 Chef Software Inc.
-# 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.
-#
-
-# TODO: Chef should require its dependency correctly.
-require 'singleton'
-require 'chef/cookbook/cookbook_version_loader'
-require 'digest/sha1'
-
-require 'chef/digester'
-
-require 'chef-dk/exceptions'
-
-module ChefDK
-  module CookbookProfiler
-    class Identifiers
-
-      attr_reader :cookbook_version
-
-      def initialize(cookbook_version)
-        @cookbook_version = cookbook_version
-      end
-
-      def semver_version
-        cookbook_version.version
-      end
-
-      def content_identifier
-        Digest::SHA1.new.hexdigest(fingerprint_text)
-      end
-
-      def dotted_decimal_identifier
-        hex_id = content_identifier
-        major = hex_id[0...14]
-        minor = hex_id[14...28]
-        patch = hex_id[28..40]
-        decimal_integers =[major, minor, patch].map {|hex| hex.to_i(16) }
-        decimal_integers.join(".")
-      end
-
-      def fingerprint_text
-        files_with_checksums.sort {|a,b| a[0] <=> b[0]}.inject("") do |fingerprint, file_spec|
-          fingerprint << "#{file_spec[0]}:#{file_spec[1]}\n"
-        end
-      end
-
-      def files_with_checksums
-        cookbook_files.inject([]) do |files_with_checksums, (_name, file_info)|
-          files_with_checksums << [file_info["path"], file_info["checksum"]]
-        end
-      end
-
-      def cookbook_files
-        @files ||= cookbook_version.manifest_records_by_path
-      end
-
-    end
-  end
-end
+#
+# Copyright:: Copyright (c) 2014 Chef Software Inc.
+# 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.
+#
+
+# TODO: Chef should require its dependency correctly.
+require 'singleton'
+require 'chef/cookbook/cookbook_version_loader'
+require 'digest/sha1'
+
+require 'chef/digester'
+
+require 'chef-dk/exceptions'
+
+module ChefDK
+  module CookbookProfiler
+    class Identifiers
+
+      attr_reader :cookbook_version
+
+      def initialize(cookbook_version)
+        @cookbook_version = cookbook_version
+      end
+
+      def semver_version
+        cookbook_version.version
+      end
+
+      def content_identifier
+        Digest::SHA1.new.hexdigest(fingerprint_text)
+      end
+
+      def dotted_decimal_identifier
+        hex_id = content_identifier
+        major = hex_id[0...14]
+        minor = hex_id[14...28]
+        patch = hex_id[28..40]
+        decimal_integers =[major, minor, patch].map {|hex| hex.to_i(16) }
+        decimal_integers.join(".")
+      end
+
+      def fingerprint_text
+        files_with_checksums.sort {|a,b| a[0] <=> b[0]}.inject("") do |fingerprint, file_spec|
+          fingerprint << "#{file_spec[0]}:#{file_spec[1]}\n"
+        end
+      end
+
+      def files_with_checksums
+        cookbook_files.inject([]) do |files_with_checksums, (_name, file_info)|
+          files_with_checksums << [file_info["path"], file_info["checksum"]]
+        end
+      end
+
+      def cookbook_files
+        @files ||= cookbook_version.manifest_records_by_path
+      end
+
+    end
+  end
+end

data/lib/chef-dk/cookbook_profiler/null_scm.rb

@@ -1,32 +1,32 @@
-#
-# Copyright:: Copyright (c) 2014 Chef Software Inc.
-# 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.
-#
-
-module ChefDK
-  module CookbookProfiler
-    class NullSCM
-
-      def initialize(cookbook_path)
-      end
-
-      def profile_data
-        nil
-      end
-
-    end
-  end
-end
-
+#
+# Copyright:: Copyright (c) 2014 Chef Software Inc.
+# 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.
+#
+
+module ChefDK
+  module CookbookProfiler
+    class NullSCM
+
+      def initialize(cookbook_path)
+      end
+
+      def profile_data
+        nil
+      end
+
+    end
+  end
+end
+

data/lib/chef-dk/exceptions.rb

@@ -1,113 +1,126 @@
-#
-# Copyright:: Copyright (c) 2014 Chef Software Inc.
-# 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.
-#
-
-module ChefDK
-
-  class CachedCookbookNotFound < StandardError
-  end
-
-  class LocalCookbookNotFound < StandardError
-  end
-
-  class MalformedCookbook < StandardError
-  end
-
-  class DependencyConflict < StandardError
-  end
-
-  class CookbookNotInWorkingSet < DependencyConflict
-  end
-
-  class InvalidCookbookLockData < StandardError
-  end
-
-  class CachedCookbookModified < StandardError
-  end
-
-  class InvalidPolicyfileAttribute < StandardError
-  end
-
-  class MissingComponentError < RuntimeError
-    def initialize(component_name, path_checked)
-      super("Component #{component_name} is missing. \nReason: Could not find #{path_checked}.")
-    end
-  end
-
-  class OmnibusInstallNotFound < RuntimeError
-    def initialize()
-      super("Can not find omnibus installation directory for Chef.")
-    end
-  end
-
-  class UnsupportedFeature < StandardError
-  end
-
-  class PolicyfileError < StandardError
-  end
-
-  class MissingCookbookLockData < StandardError
-  end
-
-  class InvalidLockfile < StandardError
-  end
-
-  class InvalidPolicyfileFilename < StandardError
-  end
-
-  class InvalidUndoRecord < StandardError
-  end
-
-  class CantUndo < StandardError
-  end
-
-  class UndoRecordNotFound < StandardError
-  end
-
-  class MultipleErrors < StandardError
-  end
-
-  class BUG < RuntimeError
-  end
-
-  class CookbookSourceConflict < StandardError
-
-    attr_reader :conflicting_cookbooks
-
-    attr_reader :cookbook_sources
-
-    def initialize(conflicting_cookbooks, cookbook_sources)
-      @conflicting_cookbooks = conflicting_cookbooks
-      @cookbook_sources = cookbook_sources
-      super(compute_message)
-    end
-
-    private
-
-    def compute_message
-      conflicting_cookbook_sets = cookbook_sources.combination(2).map do |source_a, source_b|
-        overlapping_cookbooks = conflicting_cookbooks.select do |cookbook_name|
-          source_a.universe_graph.key?(cookbook_name) && source_b.universe_graph.key?(cookbook_name)
-        end
-        "Source #{source_a.desc} and #{source_b.desc} contain conflicting cookbooks:\n" +
-          overlapping_cookbooks.sort.map {|c| "- #{c}"}.join("\n")
-      end
-      conflicting_cookbook_sets.join("\n") + "\n"
-    end
-
-  end
-
-end
+#
+# Copyright:: Copyright (c) 2014 Chef Software Inc.
+# 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.
+#
+
+module ChefDK
+
+  class CachedCookbookNotFound < StandardError
+  end
+
+  class LocalCookbookNotFound < StandardError
+  end
+
+  class MalformedCookbook < StandardError
+  end
+
+  class DependencyConflict < StandardError
+  end
+
+  class CookbookNotInWorkingSet < DependencyConflict
+  end
+
+  class InvalidCookbookLockData < StandardError
+  end
+
+  class CachedCookbookModified < StandardError
+  end
+
+  class InvalidPolicyfileAttribute < StandardError
+  end
+
+  class MissingComponentError < RuntimeError
+    def initialize(component_name, reason)
+      super("Component #{component_name} is missing.\nReason: #{reason}")
+    end
+  end
+
+  class OmnibusInstallNotFound < RuntimeError
+    def initialize()
+      super("Can not find omnibus installation directory for Chef.")
+    end
+  end
+
+  class UnsupportedFeature < StandardError
+  end
+
+  class PolicyfileError < StandardError
+  end
+
+  class MissingCookbookLockData < StandardError
+  end
+
+  class InvalidLockfile < StandardError
+  end
+
+  class InvalidPolicyfileFilename < StandardError
+  end
+
+  class InvalidUndoRecord < StandardError
+  end
+
+  class CantUndo < StandardError
+  end
+
+  class UndoRecordNotFound < StandardError
+  end
+
+  class MultipleErrors < StandardError
+  end
+
+  class BUG < RuntimeError
+  end
+
+  class CookbookSourceConflict < StandardError
+
+    attr_reader :conflicting_cookbooks
+
+    attr_reader :cookbook_sources
+
+    def initialize(conflicting_cookbooks, cookbook_sources)
+      @conflicting_cookbooks = conflicting_cookbooks
+      @cookbook_sources = cookbook_sources
+      super(compute_message)
+    end
+
+    private
+
+    def compute_message
+      conflicting_cookbook_sets = cookbook_sources.combination(2).map do |source_a, source_b|
+        overlapping_cookbooks = conflicting_cookbooks.select do |cookbook_name|
+          source_a.universe_graph.key?(cookbook_name) && source_b.universe_graph.key?(cookbook_name)
+        end
+        "Source #{source_a.desc} and #{source_b.desc} contain conflicting cookbooks:\n" +
+          overlapping_cookbooks.sort.map {|c| "- #{c}"}.join("\n") + "\n\n" +
+          resolution_message(overlapping_cookbooks)
+      end
+      conflicting_cookbook_sets.join("\n")
+    end
+
+    def resolution_message(overlapping_cookbooks)
+      example_source = cookbook_sources.first
+      source_key, location = example_source.default_source_args
+      <<-EXAMPLE
+You can set a preferred source to resolve this issue with code like:
+
+default_source :#{source_key}, "#{location}" do |s|
+  s.preferred_for "#{overlapping_cookbooks.join('", "')}"
+end
+EXAMPLE
+    end
+
+  end
+
+end

data/lib/chef-dk/generator.rb

@@ -1,163 +1,163 @@
-#
-# Copyright:: Copyright (c) 2014 Chef Software Inc.
-# 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.
-#
-
-module ChefDK
-
-  module Generator
-
-    # This is here to hold attr_accessor data for Generator context variables
-    class Context
-      def self.add_attr(name)
-        @attributes ||= [ ]
-
-        if !@attributes.include?(name)
-          @attributes << name
-          attr_accessor(name)
-        end
-      end
-
-      def self.reset
-        return if @attributes.nil?
-
-        @attributes.each do |attr|
-          remove_method(attr)
-        end
-
-        @attributes = nil
-      end
-    end
-
-    def self.reset
-      @context = nil
-    end
-
-    def self.context
-      @context ||= Context.new
-    end
-
-    def self.add_attr_to_context(name, value=nil)
-      sym_name = name.to_sym
-      ChefDK::Generator::Context.add_attr(sym_name)
-      ChefDK::Generator::TemplateHelper.delegate_to_app_context(sym_name)
-      context.public_send("#{sym_name}=", value)
-    end
-
-    module TemplateHelper
-
-      def self.delegate_to_app_context(name)
-        define_method(name) do
-          ChefDK::Generator.context.public_send(name)
-        end
-      end
-
-      def year
-        Time.now.year
-      end
-
-      # Prints the short description of the license, suitable for use in a
-      # preamble to a file. Optionally specify a comment to prepend to each line.
-      def license_description(comment=nil)
-        case license
-        when 'all_rights'
-          result = "Copyright (c) #{year} #{copyright_holder}, All Rights Reserved."
-        when 'apache2'
-          result = <<-EOH
-Copyright #{year} #{copyright_holder}
-
-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 'mit'
-          result = <<-EOH
-The MIT License (MIT)
-
-Copyright (c) #{year} #{copyright_holder}
-
-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.
-EOH
-        when 'gplv2'
-          result = <<-EOH
-Copyright (C) #{year}  #{copyright_holder}
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along
-with this program; if not, write to the Free Software Foundation, Inc.,
-51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-EOH
-        when 'gplv3'
-          result = <<-EOH
-Copyright (C) #{year}  #{copyright_holder}
-
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
-EOH
-        end
-        if comment
-          # Ensure there's no trailing whitespace
-          result.gsub(/^(.+)$/, "#{comment} \\1").gsub(/^$/, "#{comment}")
-        else
-          result
-        end
-      end
-    end
-
-  end
-end
+#
+# Copyright:: Copyright (c) 2014 Chef Software Inc.
+# 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.
+#
+
+module ChefDK
+
+  module Generator
+
+    # This is here to hold attr_accessor data for Generator context variables
+    class Context
+      def self.add_attr(name)
+        @attributes ||= [ ]
+
+        if !@attributes.include?(name)
+          @attributes << name
+          attr_accessor(name)
+        end
+      end
+
+      def self.reset
+        return if @attributes.nil?
+
+        @attributes.each do |attr|
+          remove_method(attr)
+        end
+
+        @attributes = nil
+      end
+    end
+
+    def self.reset
+      @context = nil
+    end
+
+    def self.context
+      @context ||= Context.new
+    end
+
+    def self.add_attr_to_context(name, value=nil)
+      sym_name = name.to_sym
+      ChefDK::Generator::Context.add_attr(sym_name)
+      ChefDK::Generator::TemplateHelper.delegate_to_app_context(sym_name)
+      context.public_send("#{sym_name}=", value)
+    end
+
+    module TemplateHelper
+
+      def self.delegate_to_app_context(name)
+        define_method(name) do
+          ChefDK::Generator.context.public_send(name)
+        end
+      end
+
+      def year
+        Time.now.year
+      end
+
+      # Prints the short description of the license, suitable for use in a
+      # preamble to a file. Optionally specify a comment to prepend to each line.
+      def license_description(comment=nil)
+        case license
+        when 'all_rights'
+          result = "Copyright (c) #{year} #{copyright_holder}, All Rights Reserved."
+        when 'apache2'
+          result = <<-EOH
+Copyright #{year} #{copyright_holder}
+
+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 'mit'
+          result = <<-EOH
+The MIT License (MIT)
+
+Copyright (c) #{year} #{copyright_holder}
+
+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.
+EOH
+        when 'gplv2'
+          result = <<-EOH
+Copyright (C) #{year}  #{copyright_holder}
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+EOH
+        when 'gplv3'
+          result = <<-EOH
+Copyright (C) #{year}  #{copyright_holder}
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+EOH
+        end
+        if comment
+          # Ensure there's no trailing whitespace
+          result.gsub(/^(.+)$/, "#{comment} \\1").gsub(/^$/, "#{comment}")
+        else
+          result
+        end
+      end
+    end
+
+  end
+end