Use an array as listen attribute instead of a hash

This PR amends the logic introduced in
sous-chefs#378 to use an array
as attribute instead of a hash, as this will simplify using this
cookbook in other recipes.

E.g., if a recipe wants httpd to listen on `addr:port`, it is much easier to
just set

    node.set['apache2']['listen'] += ['addr:port']

instead of first having to check whether the listen hash does have the
key `addr` already and then either add it or update the port list.

Author: Jens Rosenboom

README.md

@@ -173,7 +173,7 @@ These are general settings used in recipes and templates. Default
 values are noted.
 
 * `node['apache']['version']` - Specifing 2.4 triggers apache 2.4 support. If the platform is known during our test to install 2.4 by default, it will be set to 2.4 for you. Otherwise it falls back to 2.2. This value should be specified as a string.
-* `node['apache']['listen']` - Hash of address and arrays of ports that httpd should listen on. Default is any address and port 80 (`{"*" => ["80"]}`).
+* `node['apache']['listen']` - Array of address:port combinations that httpd should listen on. Default is any address and port 80 (`["*:80"]`).
 * `node['apache']['contact']` - Value for ServerAdmin directive. Default "[email protected]".
 * `node['apache']['timeout']` - Value for the Timeout directive. Default is 300.
 * `node['apache']['keepalive']` - Value for the KeepAlive directive. Default is On.
@@ -681,9 +681,7 @@ create a basic role for web servers that provide both HTTP and HTTPS:
     )
     default_attributes(
       "apache" => {
-        "listen" => {
-          "*" => ["80", "443"]
-        }
+        "listen" => ["*:80", "*:443"]
       }
     )
 ``````

attributes/default.rb

@@ -272,7 +272,7 @@
 if node['apache']['service_name'].nil?
   default['apache']['service_name'] = node['apache']['package']
 end
-default['apache']['listen']['*']       = ['80']
+default['apache']['listen']            = ['*:80']
 default['apache']['contact']           = '[email protected]'
 default['apache']['timeout']           = 300
 default['apache']['keepalive']         = 'On'

definitions/web_app.rb

@@ -17,7 +17,7 @@
 # limitations under the License.
 #
 
-define :web_app, :template => 'web_app.conf.erb', :local => false, :enable => true do
+define :web_app, :template => 'web_app.conf.erb', :local => false, :enable => true, :server_port => 80 do
   application_name = params[:name]
 
   include_recipe 'apache2::default'

libraries/listen.rb

@@ -17,27 +17,27 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-require 'chef/mixin/deep_merge'
-
 module Apache2
   # Provides method to convert node['apache']['listen_ports'] and node['apache']['listen_addresses'] into new node['apache']['listen']
   module Listen
     # @param node [Chef::Node] the chef node
     # @return [Hash] a hash indexed by address where the values are arrays of ports to listen to
-    def listen_ports_by_address(node)
-      Chef::Mixin::DeepMerge.deep_merge(Apache2::Listen.converted_listen_ports_and_addresses(node), node['apache']['listen'].to_hash)
+    def merge_listen_attributes(node)
+      (Apache2::Listen.converted_listen_ports_and_addresses(node) + node['apache']['listen']).uniq
     end
 
-    module_function :listen_ports_by_address
+    module_function :merge_listen_attributes
 
-    private
+    private_class_method
 
     def self.converted_listen_ports_and_addresses(node)
-      return {} unless node['apache']['listen_ports'] && node['apache']['listen_addresses']
+      return [] unless node['apache']['listen_ports'] && node['apache']['listen_addresses']
       Chef::Log.warn "node['apache']['listen_ports'] and node['apache']['listen_addresses'] are deprecated in favor of node['apache']['listen']. Please adjust your cookbooks"
 
-      node['apache']['listen_addresses'].uniq.each_with_object({}) do |address, listen|
-        listen[address] = node['apache']['listen_ports'].map(&:to_i)
+      node['apache']['listen_addresses'].uniq.each_with_object([]) do |address, listen|
+        node['apache']['listen_ports'].uniq.each do |port|
+          listen << "#{address}:#{port}"
+        end
       end
     end
   end

recipes/mod_ssl.rb

@@ -16,10 +16,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-unless node['apache']['listen'].values.any? { |ports| ports.include?(node['apache']['mod_ssl']['port']) }
-  node['apache']['listen'].each_key do |address|
-    node.default['apache']['listen'][address] = node['apache']['listen'][address] + [node['apache']['mod_ssl']['port']]
-  end
+if node['apache']['listen'] == ['*:80']
+  node.default['apache']['listen'] = ['*:80', "*:#{node['apache']['mod_ssl']['port']}"]
 end
 
 include_recipe 'apache2::default'

templates/default/default-site.conf.erb

@@ -1,3 +1,6 @@
+<% if node['apache']['version'] != '2.4' -%>
+NameVirtualHost *:<%= node['apache']['default_site_port'] %>
+<% end -%>
 <VirtualHost *:<%= node['apache']['default_site_port'] %>>
   ServerAdmin <%= node['apache']['contact'] %>
 

templates/default/ports.conf.erb

@@ -1,15 +1,6 @@
 # This file was generated by Chef for <%= node['fqdn'] %>.
 # Do NOT modify this file by hand!
 
-<% Apache2::Listen.listen_ports_by_address(node).each do |address, ports| -%>
-<% ports.map(&:to_i).uniq.each do |port| -%>
-<% if address.empty? -%>
-Listen <%= port %>
-<% else -%>
-Listen <%= address %>:<%= port %>
-<% end -%>
-<% if node['apache']['version'] != "2.4" -%>
-NameVirtualHost *:<%= port %>
-<% end -%>
-<% end -%>
+<% Apache2::Listen.merge_listen_attributes(node).each do |addr| -%>
+Listen <%= addr %>
 <% end -%>

templates/default/web_app.conf.erb

@@ -1,4 +1,7 @@
-<VirtualHost *:<%= @params[:server_port] || Apache2::Listen.listen_ports_by_address(node).values.map(&:to_a).flatten.first %>>
+<% if node['apache']['version'] != '2.4' -%>
+NameVirtualHost *:<%= @params[:server_port] %>
+<% end -%>
+<VirtualHost *:<%= @params[:server_port] %>>
   ServerName <%= @params[:server_name] %>
   <% if @params[:server_aliases] -%>
   ServerAlias <%= @params[:server_aliases].join " " %>