chef-umami 0.0.3

data/lib/chef-umami/policyfile/uploader.rb

@@ -0,0 +1,92 @@
+#   Copyright 2017 Bloomberg Finance, L.P.
+#
+#   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-dk/authenticated_http'
+require 'chef-dk/policyfile/storage_config'
+require 'chef-dk/policyfile/uploader'
+require 'chef-dk/policyfile_lock'
+require 'chef-dk/ui'
+
+module Umami
+  class Policyfile
+    class Uploader
+
+      attr_reader :http_client
+      attr_reader :policyfile_lock
+      attr_reader :policyfile_lock_file
+      attr_reader :policyfile_uploader
+      attr_reader :storage_config
+      attr_reader :ui
+		  def initialize(policyfile_lock_file = nil)
+        @http_client = http_client
+        @policyfile_lock_file = policyfile_lock_file
+        @policyfile_lock = policyfile_lock
+        @policyfile_uploader = policyfile_uploader
+        @storage_config = storage_config
+        @ui = ui
+		  end
+
+      def storage_config
+        @storage_config ||= ChefDK::Policyfile::StorageConfig.new.use_policyfile(policyfile_lock_file)
+      end
+
+      def ui
+        @ui ||= ChefDK::UI.new
+      end
+
+      def policyfile_lock_content
+        IO.read(policyfile_lock_file)
+      end
+
+      def lock_data
+        FFI_Yajl::Parser.new.parse(policyfile_lock_content)
+      end
+
+      def policyfile_lock
+        @policyfile_lock ||= ChefDK::PolicyfileLock.new(
+          storage_config,
+          ui: ui
+        ).build_from_lock_data(lock_data)
+      end
+
+      def http_client
+        @http_client ||= ChefDK::AuthenticatedHTTP.new(Chef::Config['chef_server_url'])
+      end
+
+      def policy_group
+        Chef::Config['policy_group']
+      end
+
+      def policy_document_native_api
+        true
+      end
+
+      def policyfile_uploader
+        @policyfile_uploader ||= ChefDK::Policyfile::Uploader.new(
+          policyfile_lock,
+          policy_group,
+          ui: ui,
+          http_client: http_client,
+          policy_document_native_api: policy_document_native_api
+        )
+      end
+
+      # Push the policy, including all dependent cookbooks.
+      def upload
+        policyfile_uploader.upload
+      end
+
+    end
+  end
+end

data/lib/chef-umami/runner.rb

@@ -0,0 +1,112 @@
+#   Copyright 2017 Bloomberg Finance, L.P.
+#
+#   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'
+require 'chef-umami/exceptions'
+require 'chef-umami/client'
+require 'chef-umami/logger'
+require 'chef-umami/server'
+require 'chef-umami/policyfile/exporter'
+require 'chef-umami/policyfile/uploader'
+require 'chef-umami/test/unit'
+require 'chef-umami/test/integration'
+
+module Umami
+  class Runner
+
+    include Umami::Logger
+
+    attr_reader :cookbook_dir
+    attr_reader :policyfile_lock_file
+    attr_reader :policyfile
+    # TODO: Build the ability to specify a custom policy lock file name.
+    def initialize(policyfile_lock_file = nil, policyfile = nil)
+      @cookbook_dir = Dir.pwd
+      @policyfile_lock_file = 'Policyfile.lock.json'
+      @policyfile = policyfile || 'Policyfile.rb'
+      @exporter = exporter
+      @chef_zero_server = chef_zero_server
+      # If we load the uploader or client now, they won't see the updated
+      # Chef config!
+      @uploader = nil
+      @chef_client = nil
+    end
+
+    def validate_lock_file!
+      unless policyfile_lock_file.end_with?("lock.json")
+        raise InvalidPolicyfileLockFilename, "Policyfile lock files must end in '.lock.json'. I received '#{policyfile_lock_file}'."
+      end
+
+      unless File.exist?(policyfile_lock_file)
+        raise InvalidPolicyfileLockFilename, "Unable to locate '#{policyfile_lock_file}' You may need to run `chef install` to generate it."
+      end
+    end
+
+    def exporter
+      @exporter ||= Umami::Policyfile::Exporter.new(policyfile_lock_file, cookbook_dir, policyfile)
+    end
+
+    def uploader
+      @uploader ||= Umami::Policyfile::Uploader.new(policyfile_lock_file)
+    end
+
+    def chef_zero_server
+      @chef_zero_server ||= Umami::Server.new
+    end
+
+    def chef_client
+      @chef_client ||= Umami::Client.new
+    end
+
+    def run
+      validate_lock_file!
+      puts "\nExporting the policy, related cookbooks, and a valid client configuration..."
+      exporter.export
+      Chef::Config.from_file("#{exporter.chef_config_file}")
+      chef_zero_server.start
+      puts "\nUploading the policy and related cookbooks..."
+      uploader.upload
+      puts "\nExecuting chef-client compile phase..."
+      # Define Chef::Config['config_file'] lest Ohai complain.
+      Chef::Config['config_file'] = exporter.chef_config_file
+      chef_client.compile
+      # Build a hash of all the recipes' resources, keyed by the canonical
+      # name of the recipe (i.e. ohai::default).
+      recipe_resources = {}
+      chef_client.resource_collection.each do |resource|
+        canonical_recipe = "#{resource.cookbook_name}::#{resource.recipe_name}"
+        if recipe_resources.key?(canonical_recipe)
+          recipe_resources[canonical_recipe] << resource
+        else
+          recipe_resources[canonical_recipe] = [resource]
+        end
+      end
+
+      # Remove the temporary directory using a naive guard to ensure we're
+      # deleting what we expect.
+      re_export_path = Regexp.new('/tmp/umami')
+      FileUtils.rm_rf(exporter.export_root) if exporter.export_root.match(re_export_path)
+
+      puts "\nGenerating a set of unit tests..."
+      unit_tester = Umami::Test::Unit.new
+      unit_tester.generate(recipe_resources)
+
+      puts "\nGenerating a set of integration tests..."
+      integration_tester = Umami::Test::Integration.new
+      integration_tester.generate(recipe_resources)
+
+    end
+
+  end
+end

data/lib/chef-umami/server.rb

@@ -0,0 +1,36 @@
+#   Copyright 2017 Bloomberg Finance, L.P.
+#
+#   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_zero/server'
+
+module Umami
+  class Server
+    def initialize
+      @server = server
+    end
+
+    def server
+      @server ||= ChefZero::Server.new(port: 8889)
+    end
+
+    def start
+      server.start_background
+    end
+
+    def stop
+      server.stop
+    end
+
+  end
+end

data/lib/chef-umami/test.rb

@@ -0,0 +1,63 @@
+#   Copyright 2017 Bloomberg Finance, L.P.
+#
+#   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 Umami
+  class Test
+
+    attr_reader :root_dir
+    def initialize
+      @root_dir = 'spec'
+    end
+
+    # All subclasses should implement the following methods.
+
+    # #framework should return a string describing the framework it's
+    # expected to write tests for.
+    # Examples:
+    #  "chefspec"
+    #  "serverspec"
+    #  "inspec"
+    def framework
+      raise NoMethodError, "#{self.class} needs to implement the ##{__method__} method! Refer to Umami::Test."
+    end
+
+    # #preamble should return a string (with newlines) that will appear at
+    # the top of a test file.
+    # Expects a string representing the recipe name, at least.
+    # Example:
+    # "# #{test_root}/#{recipe}_spec.rb\n" \
+    # "\n" \
+    # "require '#{framework}'\n" \
+    # "\n" \
+    # "describe '#{recipe}' do\n" \
+    # "  let(:chef_run) { ChefSpec::ServerRunner.converge(described_recipe) }"
+    def preamble(recipe = '')
+      raise NoMethodError, "#{self.class} needs to implement the ##{__method__} method! Refer to Umami::Test."
+    end
+
+    # #write_test should write a single, discreet test for a given resource.
+    # Return as a string with newlines.
+    # Expects a Chef::Resource object.
+    def write_test(resource = nil)
+      raise NoMethodError, "#{self.class} needs to implement the ##{__method__} method! Refer to Umami::Test."
+    end
+
+    # Performs the necessary steps to generate one or more tests within a
+    # test file.
+    def generate
+      raise NoMethodError, "#{self.class} needs to implement the ##{__method__} method! Refer to Umami::Test."
+    end
+
+  end
+end

data/lib/chef-umami/test/integration.rb

@@ -0,0 +1,95 @@
+#   Copyright 2017 Bloomberg Finance, L.P.
+#
+#   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-umami/test'
+require 'chef-umami/helpers/inspec'
+require 'chef-umami/helpers/filetools'
+
+module Umami
+  class Test
+    class Integration < Umami::Test
+
+      include Umami::Helper::InSpec
+      include Umami::Helper::FileTools
+
+      attr_reader :test_root
+      def initialize
+        super
+        @test_root = File.join(self.root_dir, 'umami', 'integration')
+      end
+
+      # InSpec doesn't need a require statement to use its tests.
+      # We define #framework here for completeness.
+      def framework
+        "inspec"
+      end
+
+      def test_file(cookbook = '', recipe = '')
+        "#{test_root}/#{cookbook}_#{recipe}_spec.rb"
+      end
+
+      def preamble(cookbook = '', recipe = '')
+        "# #{test_file(cookbook, recipe)} - Originally written by Umami!"
+      end
+
+      # Call on the apprpriate method from the Umami::Helper::InSpec
+      # module to generate our test.
+      def write_test(resource = nil)
+        if resource.action.is_a? Array
+          return if resource.action.include?(:delete)
+        end
+        return if resource.action == :delete
+        "\n" + send("test_#{resource.declared_type}", resource)
+      end
+
+      # If the test framework's helper module doesn't provide support for a
+      # given test-related method, return a friendly message.
+      # Raise NoMethodError for any other failed calls.
+      def method_missing(m, *args, &block)
+        case m
+          when /^test_/
+            "# #{m} is not currently defined. Stay tuned for updates."
+          else
+            raise NoMethodError
+        end
+      end
+
+      def generate(recipe_resources = {})
+        test_files_written = []
+        recipe_resources.each do |canonical_recipe, resources|
+          (cookbook, recipe) = canonical_recipe.split('::')
+          content = [preamble(cookbook, recipe)]
+          resources.each do |resource|
+            content << write_test(resource)
+          end
+          test_file_name = test_file(cookbook, recipe)
+          test_file_content = content.join("\n") + "\n"
+          write_file(test_file_name, test_file_content)
+          test_files_written << test_file_name
+        end
+
+        enforce_styling(test_root)
+
+        unless test_files_written.empty?
+          puts "Wrote the following integration tests:"
+          test_files_written.each do |f|
+            puts "\t#{f}"
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/chef-umami/test/unit.rb

@@ -0,0 +1,108 @@
+#   Copyright 2017 Bloomberg Finance, L.P.
+#
+#   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-umami/test'
+require 'chef-umami/helpers/os'
+require 'chef-umami/helpers/filetools'
+
+module Umami
+  class Test
+    class Unit < Umami::Test
+
+      include Umami::Helper::OS
+      include Umami::Helper::FileTools
+
+      attr_reader :test_root
+      attr_reader :tested_cookbook # This cookbook.
+      def initialize
+        super
+        @test_root = File.join(self.root_dir, 'umami', 'unit', 'recipes')
+        @tested_cookbook = File.basename(Dir.pwd)
+      end
+
+      def framework
+        "chefspec"
+      end
+
+      def test_file(recipe = '')
+        "#{test_root}/#{recipe}_spec.rb"
+      end
+
+      def preamble(cookbook = '', recipe = '')
+        "# #{test_file(recipe)} - Originally written by Umami!\n" \
+        "\n" \
+        "require '#{framework}'\n" \
+        "require '#{framework}/policyfile'\n" \
+        "\n" \
+        "describe '#{cookbook}::#{recipe}' do\n" \
+        "let(:chef_run) { ChefSpec::ServerRunner.new(platform: '#{os[:platform]}', version: '#{os[:version]}').converge(described_recipe) }"
+      end
+
+      def write_test(resource = nil)
+        state_attrs = [] # Attribute hash to be used with #with()
+        resource.state.each do |attr, value|
+          next if value.nil? or (value.respond_to?(:empty) and value.empty?)
+          if value.is_a? String
+            value = value.gsub("'", "\\\\'") # Escape any single quotes in the value.
+          end
+          state_attrs << "#{attr}: '#{value}'"
+        end
+        action = ''
+        if resource.action.is_a? Array
+          action = resource.action.first
+        else
+          action = resource.action
+        end
+        resource_name = resource.name.gsub("'", "\\\\'") # Escape any single quotes in the resource name.
+        test_output = ["\nit '#{action}s #{resource.declared_type} \"#{resource_name}\"' do"]
+        if state_attrs.empty?
+          test_output << "expect(chef_run).to #{action}_#{resource.declared_type}('#{resource_name}')"
+        else
+          test_output << "expect(chef_run).to #{action}_#{resource.declared_type}('#{resource_name}').with(#{state_attrs.join(', ')})"
+        end
+        test_output << "end\n"
+        test_output.join("\n")
+      end
+
+      def generate(recipe_resources = {})
+        test_files_written = []
+        recipe_resources.each do |canonical_recipe, resources|
+          (cookbook, recipe) = canonical_recipe.split('::')
+          # Only write unit tests for the cookbook we're in.
+          next unless cookbook == tested_cookbook
+          content = [preamble(cookbook, recipe)]
+          resources.each do |resource|
+            content << write_test(resource)
+          end
+          content << "end"
+          test_file_name = test_file(recipe)
+          test_file_content = content.join("\n") + "\n"
+          write_file(test_file_name, test_file_content)
+          test_files_written << test_file_name
+        end
+
+        enforce_styling(test_root)
+
+        unless test_files_written.empty?
+          puts "Wrote the following unit test files:"
+          test_files_written.each do |f|
+            puts "\t#{f}"
+          end
+        end
+
+      end
+
+    end
+  end
+end