Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added ability to include recipes smartly #1765

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 89 additions & 21 deletions chef/cookbooks/barclamp/libraries/barclamp_library.rb
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
#

require_relative "conduit_resolver.rb"
require "chef/role"

module BarclampLibrary
class Barclamp
Expand Down Expand Up @@ -417,21 +418,104 @@ def self.size_to_bytes(s)
end
end

# this class holds the recipe_depedencies object
# the object is added as the class level
class DependsOn
class << self
# api to add recipe dependency
def add(dependency)
@recipe_depedencies ||= Mash.new
@recipe_depedencies.merge!(dependency)
end

def get(recipe)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Layout/EmptyLineBetweenDefs: Use empty lines between method definitions. (https://github.com/bbatsov/ruby-style-guide#empty-lines-between-methods)

@recipe_depedencies.fetch(recipe, [])
end
end
end

class Config
class << self
attr_accessor :node

def load(group, barclamp, instance = nil)
# If no instance is specified, see if this node uses an instance of
# this barclamp and use it
def last_two_configs(group, barclamp, instance)
prev_cfg = load(group, barclamp, instance)
instance = infer_instance_from_cached_databag(group, barclamp, instance)
cur_cfg = Chef::Role.load "#{barclamp}-config-#{instance}"
return prev_cfg, cur_cfg.default_attributes[barclamp]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Style/RedundantReturn: Redundant return detected. To return multiple values, use an array. (https://github.com/bbatsov/ruby-style-guide#no-explicit-return)

end

# a attrlist is ['api','bind_port'] (array)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

# and collection is assumed to be a hash like object
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

# this method will return collection['api']['bind_port']
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Layout/Tab: Tab detected. (https://github.com/bbatsov/ruby-style-guide#spaces-indentation)
Layout/TrailingWhitespace: Trailing whitespace detected. (https://github.com/bbatsov/ruby-style-guide#no-trailing-whitespace)

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Layout/Tab: Tab detected. (https://github.com/bbatsov/ruby-style-guide#spaces-indentation)
Layout/TrailingWhitespace: Trailing whitespace detected. (https://github.com/bbatsov/ruby-style-guide#no-trailing-whitespace)

# - abort and return nil , if any key not found
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

# - log accordingly
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Layout/Tab: Tab detected. (https://github.com/bbatsov/ruby-style-guide#spaces-indentation)
Layout/CommentIndentation: Incorrect indentation detected (column 2 instead of 8).

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Layout/Tab: Tab detected. (https://github.com/bbatsov/ruby-style-guide#spaces-indentation)
Layout/CommentIndentation: Incorrect indentation detected (column 2 instead of 8).

def loadattr(collection, attrlist)
begin
attrlist.each do |item|
unless collection.key?(item)
Chef::Log.info("[smart] #{item} is missing from collection")
return nil
end
collection = collection[item]
end
rescue NoMethodError
msg = "[smart] collection variable did not " \
"respond to []/key? while looking for #{item}"
Chef::Log.info(msg)
return nil
end
collection
end

def guess_instance(barclamp, instance)
if instance.nil? && @node[barclamp] && @node[barclamp][:config]
instance = @node[barclamp][:config][:environment]
end

# Accept environments passed as instances
if instance =~ /^#{barclamp}-config-(.*)/
instance = $1
end
instance
end

def infer_instance_from_cached_databag(group, barclamp, instance)
if instance.nil?
# try the "default" instance, and fallback on any existing instance
instance = "default"
unless @cache["groups"][group].fetch(instance, {}).key?(barclamp)
# sort to guarantee a consistent order
@cache["groups"][group].keys.sort.each do |key|
# ignore the id attribute from the data bag item, which is not
# an instance
next if key == "id"
if @cache["groups"][group][key].key?(barclamp)
instance = key
break
end
end
end
end
instance
end

def changes_to_apply?(depedency, group = "openstack", instance = nil)
barclamp = depedency.shift
instance = guess_instance(barclamp, instance)
prev_cfg, curr_cfg = last_two_configs(group, barclamp, instance)
old = loadattr(prev_cfg, depedency)
new = loadattr(curr_cfg, depedency)
# Chef::Log.info("[smart] loadattr prev #{depedency}, #{prev_cfg}")
# Chef::Log.info("[smart] loadattr curr #{depedency}, #{curr_cfg.inspect}")
# Chef::Log.info("[smart] comparision #{old}, #{new}")
old != new
rhafer marked this conversation as resolved.
Show resolved Hide resolved
end

def load(group, barclamp, instance = nil)
# If no instance is specified, see if this node uses an instance of
# this barclamp and use it
instance = guess_instance(barclamp, instance)

# Cache the config we load from data bag items.
# This cache needs to be invalidated for each chef-client run from
Expand All @@ -453,23 +537,7 @@ def load(group, barclamp, instance = nil)
{}
end

if instance.nil?
# try the "default" instance, and fallback on any existing instance
instance = "default"
unless @cache["groups"][group].fetch(instance, {}).key?(barclamp)
# sort to guarantee a consistent order
@cache["groups"][group].keys.sort.each do |key|
# ignore the id attribute from the data bag item, which is not
# an instance
next if key == "id"
if @cache["groups"][group][key].key?(barclamp)
instance = key
break
end
end
end
end

instance = infer_instance_from_cached_databag(group, barclamp, instance)
@cache["groups"][group].fetch(instance, {}).fetch(barclamp, {})
end
end
Expand Down
35 changes: 35 additions & 0 deletions chef/cookbooks/barclamp/libraries/smartroles.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
require "chef/mixin/language_include_recipe"

class Chef
module Mixin
module LanguageIncludeRecipe
def include_recipe_smartly(*list_of_recipes)
# Iterate over the dependcies and find if either have changed
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Layout/Tab: Tab detected. (https://github.com/bbatsov/ruby-style-guide#spaces-indentation)
Layout/CommentIndentation: Incorrect indentation detected (column 2 instead of 8).

# if it has changed include the recipe
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Layout/CommentIndentation: Incorrect indentation detected (column 8 instead of 2).

# "horizon::server" => [
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

# ['glance','api','bind_port'],
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

# ['horizon']
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

# ]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Layout/Tab: Tab detected. (https://github.com/bbatsov/ruby-style-guide#spaces-indentation)
Layout/CommentIndentation: Incorrect indentation detected (column 2 instead of 8).

# - break immediately on first changed dependency
# - if dependency list is empty, include recipe
# - log accordingly
list_of_recipes.each do |recipe|
included = false
dependancylist = BarclampLibrary::Barclamp::DependsOn.get(recipe)
dependancylist.each do |dependency|
next unless BarclampLibrary::Barclamp::Config.changes_to_apply?(dependency)
Chef::Log.info("[smart] including recipe : #{recipe}")
Chef::Log.debug("[smart] due to change in: #{dependency}")
include_recipe recipe
included = true
break
end.empty? and begin
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Style/AndOr: Use && instead of and. (https://github.com/bbatsov/ruby-style-guide#no-and-or-or)

include_recipe recipe
Chef::Log.info("[smart] including recipe without depencies: #{recipe}")
end # each
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Style/CommentedKeyword: Do not place comments on the same line as the end keyword.

Chef::Log.info("[smart] recipe excluded: #{recipe}") unless included
end # each
sjamgade marked this conversation as resolved.
Show resolved Hide resolved
sjamgade marked this conversation as resolved.
Show resolved Hide resolved
end # def include_recipe_smartly
sjamgade marked this conversation as resolved.
Show resolved Hide resolved
end
end
end