chef-dk 0.2.0

data/lib/chef-dk/policyfile_lock.rb

@@ -0,0 +1,243 @@
+#
+# 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.
+#
+
+require 'chef-dk/cookbook_profiler/identifiers'
+require 'chef-dk/cookbook_profiler/null_scm'
+require 'chef-dk/cookbook_profiler/git'
+
+module ChefDK
+  class PolicyfileLock
+
+    # CachedCookbook objects represent a cookbook that has been fetched from an
+    # upstream canonical source and stored (presumed unmodified).
+    class CachedCookbook
+
+      # The cookbook name (without any version or other info suffixed)
+      attr_reader :name
+
+      # The directory name in the cookbook cache where the cookbook is stored.
+      # By convention, this should be the name of the cookbook followed by a
+      # hyphen and then some sort of version identifier (depending on the
+      # cookbook source).
+      attr_accessor :cache_key
+
+      # A URI pointing to the canonical source of the cookbook.
+      attr_accessor :origin
+
+      # A string that uniquely identifies the cookbook version. If not
+      # explicitly set, an identifier is generated based on the cookbook's
+      # content.
+      attr_writer :identifier
+
+      # A string in "X.Y.Z" version number format that uniquely identifies the
+      # cookbook version. This is for compatibility with Chef Server 11.x,
+      # where cookbooks are stored by x.y.z version numbers.
+      attr_writer :dotted_decimal_identifier
+
+      # The root of the cookbook cache.
+      attr_reader :cache_path
+
+      def initialize(name, cache_path)
+        @name = name
+        @cache_path = cache_path
+        @origin = nil
+        @cache_key = nil
+        @identifier = nil
+        @dotted_decimal_identifier = nil
+      end
+
+      def cookbook_path
+        File.join(cache_path, cache_key)
+      end
+
+      def identifier
+        @identifier || identifiers.content_identifier
+      end
+
+      def dotted_decimal_identifier
+        @dotted_decimal_identifier || identifiers.dotted_decimal_identifier
+      end
+
+      def to_lock
+        validate!
+        {
+          "version" => identifiers.semver_version,
+          "identifier" => identifier,
+          "dotted_decimal_identifier" => dotted_decimal_identifier,
+          "cache_key" => cache_key,
+          "origin" => origin
+        }
+      end
+
+      def identifiers
+        @identifiers ||= CookbookProfiler::Identifiers.new(cookbook_path)
+      end
+
+      def validate!
+        unless File.exist?(cookbook_path)
+          raise CachedCookbookNotFound, "Cookbook `#{name}' not found at expected cache location `#{cookbook_path}'"
+        end
+      end
+
+    end
+
+    # LocalCookbook objects represent cookbooks that are sourced from the local
+    # filesystem and are assumed to be under active development.
+    class LocalCookbook
+
+      # A relative or absolute path to the cookbook. If a relative path is
+      # given, it is resolved relative to #relative_paths_root
+      attr_accessor :source
+
+      # A string that uniquely identifies the cookbook version. If not
+      # explicitly set, an identifier is generated based on the cookbook's
+      # content.
+      attr_writer :identifier
+
+      # A string in "X.Y.Z" version number format that uniquely identifies the
+      # cookbook version. This is for compatibility with Chef Server 11.x,
+      # where cookbooks are stored by x.y.z version numbers.
+      attr_writer :dotted_decimal_identifier
+
+      # The root path from which source is expanded.
+      attr_accessor :relative_paths_root
+
+      def initialize(name, relative_paths_root)
+        @name = name
+        @identifier = nil
+        @relative_paths_root = relative_paths_root
+      end
+
+      def cookbook_path
+        File.expand_path(source, relative_paths_root)
+      end
+
+      def scm_profiler
+        if File.exist?(File.join(cookbook_path, ".git"))
+          CookbookProfiler::Git.new(cookbook_path)
+        else
+          CookbookProfiler::NullSCM.new(cookbook_path)
+        end
+      end
+
+      def identifier
+        @identifier || identifiers.content_identifier
+      end
+
+      def dotted_decimal_identifier
+        @dotted_decimal_identifier || identifiers.dotted_decimal_identifier
+      end
+
+      def to_lock
+
+        {
+          "version" => identifiers.semver_version,
+          "identifier" => identifier,
+          "dotted_decimal_identifier" => dotted_decimal_identifier,
+          "source" => source,
+          "cache_key" => nil,
+          "scm_info" => scm_profiler.profile_data
+        }
+      end
+
+      def identifiers
+        @identifiers ||= CookbookProfiler::Identifiers.new(cookbook_path)
+      end
+
+    end
+
+    def self.build(options = {})
+      lock = new(options)
+      yield lock
+      lock
+    end
+
+    def self.build_from_compiler(compiler, options = {})
+      lock = new(options)
+      lock.build_from_compiler(compiler)
+      lock
+    end
+
+    attr_accessor :name
+    attr_accessor :run_list
+
+    attr_reader :cookbook_locks
+    attr_reader :cache_path
+    attr_reader :relative_paths_root
+
+    def initialize(options = {})
+      @name = nil
+      @run_list = []
+      @cookbook_locks = {}
+      @relative_paths_root = Dir.pwd
+      handle_options(options)
+    end
+
+    def cached_cookbook(name)
+      cached_cookbook = CachedCookbook.new(name, cache_path)
+      yield cached_cookbook
+      @cookbook_locks[name] = cached_cookbook
+    end
+
+    def local_cookbook(name)
+      local_cookbook = LocalCookbook.new(name, relative_paths_root)
+      yield local_cookbook
+      @cookbook_locks[name] = local_cookbook
+    end
+
+    def to_lock
+      {}.tap do |lock|
+        lock["name"] = name
+        lock["run_list"] = run_list
+        lock["cookbook_locks"] = cookbook_locks_for_lockfile
+      end
+    end
+
+    def cookbook_locks_for_lockfile
+      cookbook_locks.inject({}) do |locks_map, (name, cookbook_spec)|
+        locks_map[name] = cookbook_spec.to_lock
+        locks_map
+      end
+    end
+
+    def build_from_compiler(compiler)
+      @run_list = compiler.expanded_run_list
+
+      compiler.all_cookbook_specs.each do |cookbook_name, spec|
+        if spec.mirrors_canonical_upstream?
+          cached_cookbook(cookbook_name) do |cached_cb|
+            cached_cb.cache_key = spec.cache_key
+            cached_cb.origin = spec.uri
+          end
+        else
+          local_cookbook(cookbook_name) do |local_cb|
+            local_cb.source = spec.relative_path
+            local_cb.relative_paths_root = spec.relative_paths_root
+          end
+        end
+      end
+      self
+    end
+
+    private
+
+    def handle_options(options)
+      @cache_path = options[:cache_path]
+      @relative_paths_root = options[:relative_paths_root] if options.key?(:relative_paths_root)
+    end
+  end
+end

data/lib/chef-dk/shell_out.rb

@@ -0,0 +1,36 @@
+#
+# 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.
+#
+
+require 'mixlib/shellout'
+
+module ChefDK
+
+  # A subclass of Mixlib::ShellOut that conforms to the API expected by
+  # CookbookOmnifetch
+  class ShellOut < Mixlib::ShellOut
+    def self.shell_out(*command_args)
+      cmd = new(*command_args)
+      cmd.run_command
+      cmd
+    end
+
+    def success?
+      !error?
+    end
+  end
+
+end

data/lib/chef-dk/skeletons/code_generator/files/default/Berksfile

@@ -0,0 +1,3 @@
+source "https://api.berkshelf.com"
+
+metadata

data/lib/chef-dk/skeletons/code_generator/files/default/chefignore

@@ -0,0 +1,96 @@
+# Put files/directories that should be ignored in this file when uploading
+# or sharing to the community site.
+# Lines that start with '# ' are comments.
+
+# OS generated files #
+######################
+.DS_Store
+Icon?
+nohup.out
+ehthumbs.db
+Thumbs.db
+
+# SASS #
+########
+.sass-cache
+
+# EDITORS #
+###########
+\#*
+.#*
+*~
+*.sw[a-z]
+*.bak
+REVISION
+TAGS*
+tmtags
+*_flymake.*
+*_flymake
+*.tmproj
+.project
+.settings
+mkmf.log
+
+## COMPILED ##
+##############
+a.out
+*.o
+*.pyc
+*.so
+*.com
+*.class
+*.dll
+*.exe
+*/rdoc/
+
+# Testing #
+###########
+.watchr
+.rspec
+spec/*
+spec/fixtures/*
+test/*
+features/*
+Guardfile
+Procfile
+
+# SCM #
+#######
+.git
+*/.git
+.gitignore
+.gitmodules
+.gitconfig
+.gitattributes
+.svn
+*/.bzr/*
+*/.hg/*
+*/.svn/*
+
+# Berkshelf #
+#############
+Berksfile
+Berksfile.lock
+cookbooks/*
+tmp
+
+# Cookbooks #
+#############
+CONTRIBUTING
+CHANGELOG*
+
+# Strainer #
+############
+Colanderfile
+Strainerfile
+.colander
+.strainer
+
+# Vagrant #
+###########
+.vagrant
+Vagrantfile
+
+# Travis #
+##########
+.travis.yml

data/lib/chef-dk/skeletons/code_generator/files/default/converge_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe 'demo::default' do
+  let(:chef_run) { ChefSpec::Runner.new.converge("demo::default") }
+
+  it "converges successfully" do
+    chef_run # This should not raise an error
+  end
+end

data/lib/chef-dk/skeletons/code_generator/files/default/gitignore

@@ -0,0 +1,16 @@
+.vagrant
+Berksfile.lock
+*~
+*#
+.#*
+\#*#
+.*.sw[a-z]
+*.un~
+
+# Bundler
+Gemfile.lock
+bin/*
+.bundle/*
+
+.kitchen/
+.kitchen.local.yml

data/lib/chef-dk/skeletons/code_generator/files/default/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'chefspec'
+
+current_dir = File.dirname(__FILE__)
+
+RSpec.configure do |config|
+  # Point to the cookbooks directory
+  config.cookbook_path = File.join(current_dir, '../cookbooks')
+end

data/lib/chef-dk/skeletons/code_generator/metadata.rb

@@ -0,0 +1,8 @@
+name             'code_generator'
+maintainer       'Chef Software, Inc.'
+maintainer_email 'dev@getchef.com'
+license          'Apache 2 License'
+description      'Generates Chef code for Chef DK'
+long_description 'Generates Chef code for Chef DK'
+version          '0.1.0'
+

data/lib/chef-dk/skeletons/code_generator/recipes/app.rb

@@ -0,0 +1,65 @@
+
+
+context = ChefDK::Generator.context
+app_dir = File.join(context.app_root, context.app_name)
+cookbooks_dir = context.cookbook_root
+cookbook_dir = File.join(cookbooks_dir, context.cookbook_name)
+
+cookbook_dir = File.join(cookbooks_dir, context.app_name)
+
+# app root dir
+directory app_dir
+
+# Top level files
+
+# TK
+template "#{app_dir}/.kitchen.yml" do
+  source 'kitchen.yml.erb'
+  helpers(ChefDK::Generator::TemplateHelper)
+end
+
+# README
+template "#{app_dir}/README.md" do
+  helpers(ChefDK::Generator::TemplateHelper)
+end
+
+# Generated Cookbook:
+
+# cookbook collection dir
+directory cookbooks_dir
+
+# cookbook collection dir
+directory cookbook_dir
+
+# metadata.rb
+template "#{cookbook_dir}/metadata.rb" do
+  helpers(ChefDK::Generator::TemplateHelper)
+end
+
+# chefignore
+cookbook_file "#{cookbook_dir}/chefignore"
+
+# Berks
+cookbook_file "#{cookbook_dir}/Berksfile"
+
+# Recipes
+
+directory "#{cookbook_dir}/recipes"
+
+template "#{cookbook_dir}/recipes/default.rb" do
+  source "default_recipe.rb.erb"
+  helpers(ChefDK::Generator::TemplateHelper)
+end
+
+# git
+if context.have_git
+
+  execute("initialize-git") do
+    command("git init .")
+    cwd app_dir
+  end
+
+  cookbook_file "#{app_dir}/.gitignore" do
+    source "gitignore"
+  end
+end