chef-dk 1.6.11 → 2.0.26

data/lib/chef-dk/policyfile/artifactory_cookbook_source.rb

@@ -0,0 +1,102 @@
+#
+# Copyright:: Copyright (c) 2017 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 "json"
+require "chef-dk/cookbook_omnifetch"
+require "chef-dk/policyfile/source_uri"
+require "chef-dk/exceptions"
+require "chef/http/simple"
+
+module ChefDK
+  module Policyfile
+    class ArtifactoryCookbookSource
+
+      attr_reader :uri
+      attr_reader :preferred_cookbooks
+      attr_reader :chef_config
+
+      def initialize(uri, chef_config: nil)
+        @uri = uri
+        @http_connections = {}
+        @chef_config = chef_config
+        @preferred_cookbooks = []
+        yield self if block_given?
+      end
+
+      def default_source_args
+        [:artifactory, uri]
+      end
+
+      def ==(other)
+        other.kind_of?(self.class) && other.uri == uri && other.preferred_cookbooks == preferred_cookbooks
+      end
+
+      def preferred_for(*cookbook_names)
+        preferred_cookbooks.concat(cookbook_names)
+      end
+
+      def preferred_source_for?(cookbook_name)
+        preferred_cookbooks.include?(cookbook_name)
+      end
+
+      def universe_graph
+        @universe_graph ||= begin
+          full_community_graph.inject({}) do |normalized_graph, (cookbook_name, metadata_by_version)|
+            normalized_graph[cookbook_name] = metadata_by_version.inject({}) do |deps_by_version, (version, metadata)|
+              deps_by_version[version] = metadata["dependencies"]
+              deps_by_version
+            end
+            normalized_graph
+          end
+        end
+      end
+
+      def source_options_for(cookbook_name, cookbook_version)
+        base_uri = full_community_graph[cookbook_name][cookbook_version]["download_url"]
+        {
+          artifactory: base_uri,
+          version: cookbook_version,
+          http_client: http_connection_for(base_uri.to_s),
+        }
+      end
+
+      def null?
+        false
+      end
+
+      def desc
+        "artifactory(#{uri})"
+      end
+
+      private
+
+      def http_connection_for(base_url)
+        headers = { 'X-Jfrog-Art-API' => chef_config.artifactory_api_key || ENV["ARTIFACTORY_API_KEY"] }
+        @http_connections[base_url] ||= Chef::HTTP::Simple.new(base_url, headers: headers)
+      end
+
+      def full_community_graph
+        @full_community_graph ||=
+          begin
+            graph_json = http_connection_for(uri).get("/universe")
+            JSON.parse(graph_json)
+          end
+      end
+
+    end
+  end
+end

data/lib/chef-dk/policyfile/cookbook_location_specification.rb

@@ -29,7 +29,7 @@ module ChefDK
       # API contract
       include StorageConfigDelegation
 
-      SOURCE_TYPES = [:git, :github, :path, :artifactserver, :chef_server]
+      SOURCE_TYPES = [:git, :github, :path, :artifactserver, :chef_server, :artifactory]
 
       #--
       # Required by CookbookOmnifetch API contract
@@ -69,7 +69,7 @@ module ChefDK
       end
 
       def mirrors_canonical_upstream?
-        [:git, :github, :artifactserver, :chef_server].include?(source_type)
+        [:git, :github, :artifactserver, :chef_server, :artifactory].include?(source_type)
       end
 
       def installed?

data/lib/chef-dk/policyfile/cookbook_sources.rb

@@ -20,3 +20,4 @@ require "chef-dk/policyfile/community_cookbook_source"
 require "chef-dk/policyfile/chef_server_cookbook_source"
 require "chef-dk/policyfile/chef_repo_cookbook_source"
 require "chef-dk/policyfile/delivery_supermarket_source"
+require "chef-dk/policyfile/artifactory_cookbook_source"

data/lib/chef-dk/policyfile/dsl.rb

@@ -92,6 +92,8 @@ module ChefDK
           set_default_chef_server_source(source_argument, &block)
         when :chef_repo
           set_default_chef_repo_source(source_argument, &block)
+        when :artifactory
+          set_default_artifactory_source(source_argument, &block)
         else
           @errors << "Invalid default_source type '#{source_type.inspect}'"
         end
@@ -173,6 +175,14 @@ module ChefDK
         end
       end
 
+      def set_default_artifactory_source(source_uri, &block)
+        if source_uri.nil?
+          @errors << "You must specify the server's URI when using a default_source :artifactory"
+        else
+          set_default_source(ArtifactoryCookbookSource.new(source_uri, chef_config: chef_config, &block))
+        end
+      end
+
       def set_default_chef_repo_source(path, &block)
         if path.nil?
           @errors << "You must specify the path to the chef-repo when using a default_source :chef_repo"

data/lib/chef-dk/policyfile/solution_dependencies.rb

@@ -109,7 +109,7 @@ module ChefDK
       def policyfile_dependencies_for_lock
         policyfile_dependencies.map do |name, constraint|
           [ name, constraint.to_s ]
-        end
+        end.sort
       end
 
       def cookbook_deps_for_lock
@@ -118,7 +118,21 @@ module ChefDK
             [ name, constraint.to_s ]
           end
           map
+        end.sort.to_h
+      end
+
+      def transitive_deps(names)
+        require 'set'
+        deps = Set.new
+        to_explore = names.dup
+        until to_explore.empty?
+          ck_name = to_explore.shift
+          next unless deps.add?(ck_name) # explore each ck only once
+          my_deps = find_cookbook_dep_by_name(ck_name)
+          dep_names = my_deps[1].map(&:first)
+          to_explore += dep_names
         end
+        deps.to_a.sort
       end
 
       private

data/lib/chef-dk/policyfile_lock.rb

@@ -193,7 +193,7 @@ module ChefDK
         location_spec.gather_profile_data
         locks_map[name] = location_spec.to_lock
         locks_map
-      end
+      end.sort.to_h
     end
 
     def validate_cookbooks!

data/lib/chef-dk/policyfile_services/install.rb

@@ -49,7 +49,7 @@ module ChefDK
         @policyfile_compiler = nil
       end
 
-      def run
+      def run(cookbooks_to_update = [])
         unless File.exist?(policyfile_expanded_path)
           # TODO: suggest next step. Add a generator/init command? Specify path to Policyfile.rb?
           # See card CC-232
@@ -58,8 +58,10 @@ module ChefDK
 
         if installing_from_lock?
           install_from_lock
-        else
+        elsif cookbooks_to_update.empty? # means update everything
           generate_lock_and_install
+        else
+          update_lock_and_install(cookbooks_to_update)
         end
       end
 
@@ -111,6 +113,32 @@ module ChefDK
         raise PolicyfileInstallError.new("Failed to generate Policyfile.lock", error)
       end
 
+      def update_lock_and_install(cookbooks_to_update)
+        ui.msg "Updating #{cookbooks_to_update.join(',')} cookbooks"
+
+        to_update = policyfile_lock.solution_dependencies.transitive_deps(cookbooks_to_update)
+        prepare_constraints_for_update(to_update)
+        generate_lock_and_install
+      end
+
+      def prepare_constraints_for_update(to_update)
+        ui.msg "Will relax constraints on:"
+        to_update.each do |ck|
+          ui.msg " - #{ck}"
+        end
+
+        policyfile_lock.cookbook_locks.each do |ck_name, location_spec|
+          next if to_update.include?(ck_name)
+          # we need to feed policyfile_compiler.cookbook_location_spec_for with a CookbookLocationSpecification
+          policyfile_compiler.dsl.cookbook_location_specs[ck_name] = Policyfile::CookbookLocationSpecification.new(
+            ck_name,
+            Semverse::Constraint.new("=#{location_spec.version}"),
+            location_spec.source_options,
+            location_spec.storage_config
+          )
+        end
+      end
+
       def install_from_lock
         ui.msg "Installing cookbooks from lock"
 

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 source 'https://supermarket.chef.io'
 
 metadata

data/lib/chef-dk/skeletons/code_generator/files/default/build_cookbook/test-fixture-recipe.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 %w(unit lint syntax).each do |phase|
   # TODO: This works on Linux/Unix. Not Windows.
   execute "HOME=/home/vagrant delivery job verify #{phase} --server localhost --ent test --org kitchen" do

data/lib/chef-dk/skeletons/code_generator/files/default/cookbook_readmes/README.md

@@ -19,9 +19,9 @@ Configure knife to use your preferred copyright holder, email contact and licens
 
 Supported values for `cookbook_license` are "apachev2", "mit","gplv2","gplv3",  or "none". These settings are used to prefill comments in the default recipe, and the corresponding values in the metadata.rb. You are free to change the the comments in those files.
 
-Create new cookbooks in this directory with Knife.
+Create new cookbooks in this directory with Chef.
 
-    knife cookbook create COOKBOOK
+    chef generate cookbook COOKBOOK
 
 This will create all the cookbook directory components. You don't need to use them all, and can delete the ones you don't need. It also creates a README file, metadata.rb and default recipe.
 

data/lib/chef-dk/skeletons/code_generator/files/default/delivery-config.json

@@ -4,6 +4,9 @@
     "name": "build_cookbook",
     "path": ".delivery/build_cookbook"
   },
+  "delivery-truck": {
+    "enable_cookstyle": true
+  },
   "skip_phases": [],
   "job_dispatch": {
     "version": "v2"

data/lib/chef-dk/skeletons/code_generator/files/default/delivery-project.toml

@@ -18,7 +18,7 @@ lint = "chef exec cookstyle"
 # uploaded to Supermarket. We turn off any rules tagged "supermarket"
 # by default. If you plan to share this cookbook you should remove
 # '-t ~supermarket' below to enable supermarket rules.
-syntax = "chef exec foodcritic . --exclude spec -f any -t ~supermarket"
+syntax = "chef exec foodcritic . -t ~supermarket"
 provision = "chef exec kitchen create"
 deploy = "chef exec kitchen converge"
 smoke = "chef exec kitchen verify"

data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/attributes/default.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This is a Chef attributes file. It can be used to specify default and override
 # attributes to be applied to nodes that run this cookbook.
 

data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/metadata.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 name 'example'
 description 'An example cookbook'
 maintainer 'Example maintainer'
 maintainer_email 'maintainer@example.com'
-license 'Apache v2'
+license 'Apache-2.0'
 version '1.0.0'

data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/recipes/default.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This is a Chef recipe file. It can be used to specify resources which will
 # apply configuration to a server.
 

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

@@ -1,2 +1,3 @@
+# frozen_string_literal: true
 require 'chefspec'
 require 'chefspec/berkshelf'

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

@@ -1,2 +1,3 @@
+# frozen_string_literal: true
 require 'chefspec'
 require 'chefspec/policyfile'

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

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 name             'code_generator'
 maintainer       'Chef Software, Inc.'
 maintainer_email 'dev@chef.io'
-license          'Apache 2 License'
+license          'Apache-2.0'
 description      'Generates Chef code for Chef DK'
-long_description 'Generates Chef code for Chef DK'
 version          '0.1.0'
+chef_version     '>= 12.0'

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

@@ -1,4 +1,4 @@
-
+# frozen_string_literal: true
 
 context = ChefDK::Generator.context
 app_dir = File.join(context.app_root, context.app_name)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 context = ChefDK::Generator.context
 cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 context = ChefDK::Generator.context
 delivery_project_dir = context.delivery_project_dir
@@ -120,15 +121,13 @@ if context.have_git && context.delivery_project_git_initialized && !context.skip
   execute('git-create-feature-branch') do
     command('git checkout -t -b add-delivery-configuration')
     cwd delivery_project_dir
-
-    not_if 'git branch |grep "add-delivery-configuration"'
+    not_if { shell_out('git branch', cwd: delivery_project_dir).stdout.match(/add-delivery-configuration/) }
   end
 
   execute('git-add-delivery-config-json') do
     command('git add .delivery/config.json')
     cwd delivery_project_dir
-
-    only_if 'git status -u --porcelain |grep ".delivery/config.json"'
+    only_if { shell_out('git status -u --porcelain', cwd: delivery_project_dir).stdout.match(%r{.delivery/config.json}) }
   end
 
   # Adding the new prototype file to the feature branch
@@ -136,15 +135,13 @@ if context.have_git && context.delivery_project_git_initialized && !context.skip
   execute('git-add-delivery-project-toml') do
     command('git add .delivery/project.toml')
     cwd delivery_project_dir
-
-    only_if 'git status -u --porcelain |grep ".delivery/project.toml"'
+    only_if { shell_out('git status -u --porcelain', cwd: delivery_project_dir).stdout.match(%r{.delivery/project.toml}) }
   end
 
   execute('git-commit-delivery-config') do
     command('git commit -m "Add generated delivery configuration"')
     cwd delivery_project_dir
-
-    only_if 'git status -u --porcelain | egrep "config.json|project.toml"'
+    only_if { shell_out('git status -u --porcelain', cwd: delivery_project_dir).stdout.match(/config\.json|project\.toml/) }
   end
 
   generator_desc('Adding build cookbook to feature branch')
@@ -152,15 +149,13 @@ if context.have_git && context.delivery_project_git_initialized && !context.skip
   execute('git-add-delivery-build-cookbook-files') do
     command('git add .delivery')
     cwd delivery_project_dir
-
-    only_if 'git status -u --porcelain |grep ".delivery"'
+    only_if { shell_out('git status -u --porcelain', cwd: delivery_project_dir).stdout.match(/\.delivery/) }
   end
 
   execute('git-commit-delivery-build-cookbook') do
     command('git commit -m "Add generated delivery build cookbook"')
     cwd delivery_project_dir
-
-    only_if 'git status -u --porcelain |grep ".delivery"'
+    only_if { shell_out('git status -u --porcelain', cwd: delivery_project_dir).stdout.match(/\.delivery/) }
   end
 
   execute("git-return-to-#{pipeline}-branch") do

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 context = ChefDK::Generator.context
 cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 context = ChefDK::Generator.context
 cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+context = ChefDK::Generator.context
+cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)
+libraries_dir = File.join(cookbook_dir, 'libraries')
+helpers_path = File.join(cookbook_dir, 'libraries', "#{context.new_file_basename}.rb")
+
+directory libraries_dir
+
+def camelize(name)
+  name.to_s.split(/[^a-zA-Z]/).map(&:capitalize).join
+end
+
+cookbook_class_name = camelize(context.cookbook_name)
+helper_class_name = "#{camelize(context.new_file_basename)}Helpers"
+
+template helpers_path do
+  source 'helpers.rb.erb'
+  helpers(ChefDK::Generator::TemplateHelper)
+  variables(cookbook_class_name: cookbook_class_name, helper_class_name: helper_class_name)
+end

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 context = ChefDK::Generator.context
 policyfile_path = File.join(context.policyfile_dir, "#{context.new_file_basename}.rb")

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 context = ChefDK::Generator.context
 cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)