CHEF-4591: Knife commands to manipulate env_run_list on nodes

11 files changed, 664 insertions, 0 deletions

diff --git a/lib/chef/knife/role_env_run_list_add.rb b/lib/chef/knife/role_env_run_list_add.rb
new file mode 100644
index 0000000000..faf84ccfdb
--- /dev/null
+++ b/lib/chef/knife/role_env_run_list_add.rb
@@ -0,0 +1,86 @@
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Author:: William Albenzi (<walbenzi@gmail.com>)
+# Copyright:: Copyright (c) 2009 Opscode, 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/knife'
+
+class Chef
+  class Knife
+    class RoleEnvRunListAdd < Knife
+
+      deps do
+        require 'chef/role'
+        require 'chef/json_compat'
+      end
+
+      banner "knife role env_run_list add [ROLE] [ENVIRONMENT] [ENTRY[,ENTRY]] (options)"
+
+      option :after,
+        :short => "-a ITEM",
+        :long  => "--after ITEM",
+        :description => "Place the ENTRY in the run list after ITEM"
+
+      def add_to_env_run_list(role, environment, entries, after=nil)
+        if after
+          nlist = []
+          unless role.env_run_lists.key?(environment)
+            role.env_run_lists_add(environment => nlist)
+          end
+          role.run_list_for(environment).each do |entry| 
+            nlist << entry
+            if entry == after
+              entries.each { |e| nlist << e }
+            end
+          end
+          role.env_run_lists_add(environment => nlist)
+        else
+          nlist = []
+          unless role.env_run_lists.key?(environment)
+            role.env_run_lists_add(environment => nlist)
+          end
+          role.run_list_for(environment).each do |entry|
+            nlist << entry
+          end
+          entries.each { |e| nlist << e }
+          role.env_run_lists_add(environment => nlist)
+        end
+      end
+
+      def run
+        role = Chef::Role.load(@name_args[0])
+        role.name(@name_args[0])
+        environment = @name_args[1]
+
+        if @name_args.size > 2
+          # Check for nested lists and create a single plain one
+          entries = @name_args[2..-1].map do |entry|
+            entry.split(',').map { |e| e.strip }
+          end.flatten
+        else
+          # Convert to array and remove the extra spaces
+          entries = @name_args[2].split(',').map { |e| e.strip }
+        end
+
+        add_to_env_run_list(role, environment, entries, config[:after])
+        role.save
+        config[:env_run_list] = true
+        output(format_for_display(role))
+      end
+
+    end
+  end
+end
diff --git a/lib/chef/knife/role_env_run_list_clear.rb b/lib/chef/knife/role_env_run_list_clear.rb
new file mode 100644
index 0000000000..4304f29a38
--- /dev/null
+++ b/lib/chef/knife/role_env_run_list_clear.rb
@@ -0,0 +1,55 @@
+#
+# Author:: Mike Fiedler (<miketheman@gmail.com>)
+# Author:: William Albenzi (<walbenzi@gmail.com>)
+# Copyright:: Copyright (c) 2013 Mike Fiedler
+# 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/knife'
+
+class Chef
+  class Knife
+    class RoleEnvRunListClear < Knife
+
+      deps do
+        require 'chef/role'
+        require 'chef/json_compat'
+      end
+
+      banner "knife role env_run_list clear [ROLE] [ENVIRONMENT]"
+      def clear_env_run_list(role, environment)
+        nlist = []
+        role.env_run_lists_add(environment => nlist)
+      end
+
+      def run
+        if @name_args.size > 2
+          ui.fatal "You must not supply an environment run list."
+          show_usage
+          exit 1
+        end
+        role = Chef::Role.load(@name_args[0])
+        role.name(@name_args[0])
+        environment = @name_args[1]
+
+        clear_env_run_list(role, environment)
+        role.save
+        config[:env_run_list] = true
+        output(format_for_display(role))
+      end
+
+    end
+  end
+end
diff --git a/lib/chef/knife/role_env_run_list_remove.rb b/lib/chef/knife/role_env_run_list_remove.rb
new file mode 100644
index 0000000000..9ffc3f520e
--- /dev/null
+++ b/lib/chef/knife/role_env_run_list_remove.rb
@@ -0,0 +1,57 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Copyright:: Copyright (c) 2009 Opscode, 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/knife'
+
+class Chef
+  class Knife
+    class RoleEnvRunListRemove < Knife
+
+      deps do
+        require 'chef/role'
+        require 'chef/json_compat'
+      end
+
+      banner "knife role env_run_list remove [ROLE] [ENVIRONMENT] [ENTRIES]"
+
+      def remove_from_env_run_list(role, environment, item_to_remove)
+          nlist = []
+          role.run_list_for(environment).each do |entry|
+            nlist << entry unless entry == item_to_remove
+            #unless entry == @name_args[2]
+            #  nlist << entry
+            #end
+          end
+          role.env_run_lists_add(environment => nlist)
+      end
+
+      def run
+        role = Chef::Role.load(@name_args[0])
+        role.name(@name_args[0])
+        environment = @name_args[1]
+        item_to_remove = @name_args[2]
+
+        remove_from_env_run_list(role, environment, item_to_remove)
+        role.save
+        config[:env_run_list] = true
+        output(format_for_display(role))
+      end
+
+    end
+  end
+end
diff --git a/lib/chef/knife/role_env_run_list_replace.rb b/lib/chef/knife/role_env_run_list_replace.rb
new file mode 100644
index 0000000000..146d0c4905
--- /dev/null
+++ b/lib/chef/knife/role_env_run_list_replace.rb
@@ -0,0 +1,59 @@
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Author:: William Albenzi (<walbenzi@gmail.com>)
+# Copyright:: Copyright (c) 2009 Opscode, 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/knife'
+
+class Chef
+  class Knife
+    class RoleEnvRunListReplace < Knife
+
+      deps do
+        require 'chef/role'
+        require 'chef/json_compat'
+      end
+
+      banner "knife role env_run_list replace [ROLE] [ENVIRONMENT] [OLD_ENTRY] [NEW_ENTRY] "
+
+      def replace_in_env_run_list(role, environment, old_entry, new_entry)
+        nlist = []
+        role.run_list_for(environment).each do |entry| 
+          if entry == old_entry
+            nlist << new_entry
+          else
+            nlist << entry
+          end
+        end
+        role.env_run_lists_add(environment => nlist)
+      end
+
+      def run
+        role = Chef::Role.load(@name_args[0])
+        role.name(@name_args[0])
+        environment = @name_args[1]
+        old_entry = @name_args[2]
+        new_entry = @name_args[3]
+
+        replace_in_env_run_list(role, environment, old_entry, new_entry)
+        role.save
+        config[:env_run_list] = true
+        output(format_for_display(role))
+      end
+
+    end
+  end
+end
diff --git a/lib/chef/knife/role_env_run_list_set.rb b/lib/chef/knife/role_env_run_list_set.rb
new file mode 100644
index 0000000000..a1618516c0
--- /dev/null
+++ b/lib/chef/knife/role_env_run_list_set.rb
@@ -0,0 +1,70 @@
+#
+# Author:: Mike Fiedler (<miketheman@gmail.com>)
+# Author:: William Albenzi (<walbenzi@gmail.com>)
+# Copyright:: Copyright (c) 2013 Mike Fiedler
+# 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/knife'
+
+class Chef
+  class Knife
+    class RoleEnvRunListSet < Knife
+
+      deps do
+        require 'chef/role'
+        require 'chef/json_compat'
+      end
+
+      banner "knife role env_run_list set [ROLE] [ENVIRONMENT] [ENTRIES]"
+
+      # Clears out any existing env_run_list_items and sets them to the
+      # specified entries
+      def set_env_run_list(role, environment, entries)
+        nlist = []
+        unless role.env_run_lists.key?(environment)
+          role.env_run_lists_add(environment => nlist)
+        end
+        entries.each { |e| nlist << e }
+        role.env_run_lists_add(environment => nlist)
+      end
+
+      def run
+        role = Chef::Role.load(@name_args[0])
+        role.name(@name_args[0])
+        environment = @name_args[1]
+        if @name_args.size < 2
+          ui.fatal "You must supply both a role name and an environment run list."
+          show_usage
+          exit 1
+        elsif @name_args.size > 2
+          # Check for nested lists and create a single plain one
+          entries = @name_args[2..-1].map do |entry|
+            entry.split(',').map { |e| e.strip }
+          end.flatten
+        else
+          # Convert to array and remove the extra spaces
+          entries = @name_args[2].split(',').map { |e| e.strip }
+        end
+
+        set_env_run_list(role, environment, entries )
+        role.save
+        config[:env_run_list] = true
+        output(format_for_display(role))
+      end
+
+    end
+  end
+end
diff --git a/lib/chef/knife/role_run_list_add.rb b/lib/chef/knife/role_run_list_add.rb
new file mode 100644
index 0000000000..c9d7785bb7
--- /dev/null
+++ b/lib/chef/knife/role_run_list_add.rb
@@ -0,0 +1,86 @@
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Author:: William Albenzi (<walbenzi@gmail.com>)
+# Copyright:: Copyright (c) 2009 Opscode, 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/knife'
+
+class Chef
+  class Knife
+    class RoleRunListAdd < Knife
+
+      deps do
+        require 'chef/role'
+        require 'chef/json_compat'
+      end
+
+      banner "knife role run_list add [ROLE] [ENTRY[,ENTRY]] (options)"
+
+      option :after,
+        :short => "-a ITEM",
+        :long  => "--after ITEM",
+        :description => "Place the ENTRY in the run list after ITEM"
+
+      def add_to_env_run_list(role, environment, entries, after=nil)
+        if after
+          nlist = []
+          unless role.env_run_lists.key?(environment)
+            role.env_run_lists_add(environment => nlist)
+          end
+          role.run_list_for(environment).each do |entry| 
+            nlist << entry
+            if entry == after
+              entries.each { |e| nlist << e }
+            end
+          end
+          role.env_run_lists_add(environment => nlist)
+        else
+          nlist = []
+          unless role.env_run_lists.key?(environment)
+            role.env_run_lists_add(environment => nlist)
+          end
+          role.run_list_for(environment).each do |entry|
+            nlist << entry
+          end
+          entries.each { |e| nlist << e }
+          role.env_run_lists_add(environment => nlist)
+        end
+      end
+
+      def run
+        role = Chef::Role.load(@name_args[0])
+        role.name(@name_args[0])
+        environment = "_default"
+
+        if @name_args.size > 1
+          # Check for nested lists and create a single plain one
+          entries = @name_args[1..-1].map do |entry|
+            entry.split(',').map { |e| e.strip }
+          end.flatten
+        else
+          # Convert to array and remove the extra spaces
+          entries = @name_args[1].split(',').map { |e| e.strip }
+        end
+
+        add_to_env_run_list(role, environment, entries, config[:after])
+        role.save
+        config[:env_run_list] = true
+        output(format_for_display(role))
+      end
+
+    end
+  end
+end
diff --git a/lib/chef/knife/role_run_list_clear.rb b/lib/chef/knife/role_run_list_clear.rb
new file mode 100644
index 0000000000..ed6225d83d
--- /dev/null
+++ b/lib/chef/knife/role_run_list_clear.rb
@@ -0,0 +1,55 @@
+#
+# Author:: Mike Fiedler (<miketheman@gmail.com>)
+# Author:: William Albenzi (<walbenzi@gmail.com>)
+# Copyright:: Copyright (c) 2013 Mike Fiedler
+# 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/knife'
+
+class Chef
+  class Knife
+    class RoleRunListClear < Knife
+
+      deps do
+        require 'chef/role'
+        require 'chef/json_compat'
+      end
+
+      banner "knife role run_list clear [ROLE]"
+      def clear_env_run_list(role, environment)
+        nlist = []
+        role.env_run_lists_add(environment => nlist)
+      end
+
+      def run
+        if @name_args.size > 2
+          ui.fatal "You must not supply an environment run list."
+          show_usage
+          exit 1
+        end
+        role = Chef::Role.load(@name_args[0])
+        role.name(@name_args[0])
+        environment = "_default"
+
+        clear_env_run_list(role, environment)
+        role.save
+        config[:env_run_list] = true
+        output(format_for_display(role))
+      end
+
+    end
+  end
+end
diff --git a/lib/chef/knife/role_run_list_remove.rb b/lib/chef/knife/role_run_list_remove.rb
new file mode 100644
index 0000000000..d783b34ab4
--- /dev/null
+++ b/lib/chef/knife/role_run_list_remove.rb
@@ -0,0 +1,57 @@
+#
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Copyright:: Copyright (c) 2009 Opscode, 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/knife'
+
+class Chef
+  class Knife
+    class RoleRunListRemove < Knife
+
+      deps do
+        require 'chef/role'
+        require 'chef/json_compat'
+      end
+
+      banner "knife role run_list remove [ROLE] [ENTRY]"
+
+      def remove_from_env_run_list(role, environment, item_to_remove)
+          nlist = []
+          role.run_list_for(environment).each do |entry|
+            nlist << entry unless entry == item_to_remove
+            #unless entry == @name_args[2]
+            #  nlist << entry
+            #end
+          end
+          role.env_run_lists_add(environment => nlist)
+      end
+
+      def run
+        role = Chef::Role.load(@name_args[0])
+        role.name(@name_args[0])
+        environment = "_default"
+        item_to_remove = @name_args[1]
+
+        remove_from_env_run_list(role, environment, item_to_remove)
+        role.save
+        config[:env_run_list] = true
+        output(format_for_display(role))
+      end
+
+    end
+  end
+end
diff --git a/lib/chef/knife/role_run_list_replace.rb b/lib/chef/knife/role_run_list_replace.rb
new file mode 100644
index 0000000000..1ab94df111
--- /dev/null
+++ b/lib/chef/knife/role_run_list_replace.rb
@@ -0,0 +1,59 @@
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Author:: William Albenzi (<walbenzi@gmail.com>)
+# Copyright:: Copyright (c) 2009 Opscode, 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/knife'
+
+class Chef
+  class Knife
+    class RoleRunListReplace < Knife
+
+      deps do
+        require 'chef/role'
+        require 'chef/json_compat'
+      end
+
+      banner "knife role run_list replace [ROLE] [OLD_ENTRY] [NEW_ENTRY] "
+
+      def replace_in_env_run_list(role, environment, old_entry, new_entry)
+        nlist = []
+        role.run_list_for(environment).each do |entry| 
+          if entry == old_entry
+            nlist << new_entry
+          else
+            nlist << entry
+          end
+        end
+        role.env_run_lists_add(environment => nlist)
+      end
+
+      def run
+        role = Chef::Role.load(@name_args[0])
+        role.name(@name_args[0])
+        environment = "_default"
+        old_entry = @name_args[1]
+        new_entry = @name_args[2]
+
+        replace_in_env_run_list(role, environment, old_entry, new_entry)
+        role.save
+        config[:env_run_list] = true
+        output(format_for_display(role))
+      end
+
+    end
+  end
+end
diff --git a/lib/chef/knife/role_run_list_set.rb b/lib/chef/knife/role_run_list_set.rb
new file mode 100644
index 0000000000..b9675c70dd
--- /dev/null
+++ b/lib/chef/knife/role_run_list_set.rb
@@ -0,0 +1,70 @@
+#
+# Author:: Mike Fiedler (<miketheman@gmail.com>)
+# Author:: William Albenzi (<walbenzi@gmail.com>)
+# Copyright:: Copyright (c) 2013 Mike Fiedler
+# 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/knife'
+
+class Chef
+  class Knife
+    class RoleRunListSet < Knife
+
+      deps do
+        require 'chef/role'
+        require 'chef/json_compat'
+      end
+
+      banner "knife role run_list set [ROLE] [ENTRIES]"
+
+      # Clears out any existing env_run_list_items and sets them to the
+      # specified entries
+      def set_env_run_list(role, environment, entries)
+        nlist = []
+        unless role.env_run_lists.key?(environment)
+          role.env_run_lists_add(environment => nlist)
+        end
+        entries.each { |e| nlist << e }
+        role.env_run_lists_add(environment => nlist)
+      end
+
+      def run
+        role = Chef::Role.load(@name_args[0])
+        role.name(@name_args[0])
+        environment = "_default"
+        if @name_args.size < 1
+          ui.fatal "You must supply both a role name and an environment run list."
+          show_usage
+          exit 1
+        elsif @name_args.size > 1
+          # Check for nested lists and create a single plain one
+          entries = @name_args[1..-1].map do |entry|
+            entry.split(',').map { |e| e.strip }
+          end.flatten
+        else
+          # Convert to array and remove the extra spaces
+          entries = @name_args[1].split(',').map { |e| e.strip }
+        end
+
+        set_env_run_list(role, environment, entries )
+        role.save
+        config[:env_run_list] = true
+        output(format_for_display(role))
+      end
+
+    end
+  end
+end
diff --git a/lib/chef/role.rb b/lib/chef/role.rb
index 4b4669f4b5..2f174116cf 100644
--- a/lib/chef/role.rb
+++ b/lib/chef/role.rb
@@ -103,6 +103,16 @@ class Chef
 
     alias :env_run_list :env_run_lists
 
+    def env_run_lists_add(env_run_lists=nil)
+      if (!env_run_lists.nil?)
+        env_run_lists.each { |k,v| @env_run_lists[k] = Chef::RunList.new(*Array(v))}
+      end
+      @env_run_lists
+    end
+
+    alias :env_run_list_add :env_run_lists_add
+
+
     def default_attributes(arg=nil)
       set_or_return(
         :default_attributes,