Fixes #30951 - Provide a rackup_path plugin DSL

Currently there's http_rackup_path and https_rackup_path. In practice all built in modules and most (all?) plugins that I know define the same rackup config for both HTTP and HTTPS. Having a DSL method to do this simplifies code.
theforeman · Oct 2, 2020 · 88fbc8e · 88fbc8e
1 parent 774fb1d
commit 88fbc8e
Show file tree

Hide file tree

Showing 14 changed files with 27 additions and 24 deletions.
diff --git a/lib/proxy/plugin.rb b/lib/proxy/plugin.rb
@@ -37,6 +37,11 @@ class ::Proxy::Plugin
   class << self
     attr_reader :get_http_rackup_path, :get_https_rackup_path, :get_uses_provider
 
+    def rackup_path(path)
+      http_rackup_path(path)
+      https_rackup_path(path)
+    end
+
     def http_rackup_path(path)
       @get_http_rackup_path = path
     end

diff --git a/modules/bmc/bmc_plugin.rb b/modules/bmc/bmc_plugin.rb
@@ -1,7 +1,6 @@
 module Proxy::BMC
   class Plugin < Proxy::Plugin
-    http_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
-    https_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
+    rackup_path File.expand_path("http_config.ru", __dir__)
 
     plugin :bmc, ::Proxy::VERSION
   end

diff --git a/modules/dhcp/dhcp_plugin.rb b/modules/dhcp/dhcp_plugin.rb
@@ -1,6 +1,5 @@
 class Proxy::DhcpPlugin < ::Proxy::Plugin
-  http_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
-  https_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
+  rackup_path File.expand_path("http_config.ru", __dir__)
 
   uses_provider
   default_settings :use_provider => 'dhcp_isc', :server => '127.0.0.1', :subnets => [], :ping_free_ip => true

diff --git a/modules/dns/dns_plugin.rb b/modules/dns/dns_plugin.rb
@@ -1,7 +1,6 @@
 module Proxy::Dns
   class Plugin < ::Proxy::Plugin
-    http_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
-    https_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
+    rackup_path File.expand_path("http_config.ru", __dir__)
 
     uses_provider
     default_settings :use_provider => 'dns_nsupdate', :dns_ttl => 86_400

diff --git a/modules/facts/facts_plugin.rb b/modules/facts/facts_plugin.rb
@@ -1,6 +1,5 @@
 class Proxy::FactsPlugin < ::Proxy::Plugin
-  http_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
-  https_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
+  rackup_path File.expand_path("http_config.ru", __dir__)
 
   default_settings :enabled => false
   plugin :facts, ::Proxy::VERSION

diff --git a/modules/httpboot/httpboot_plugin.rb b/modules/httpboot/httpboot_plugin.rb
@@ -1,7 +1,6 @@
 module Proxy::Httpboot
   class Plugin < ::Proxy::Plugin
-    http_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
-    https_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
+    rackup_path File.expand_path("http_config.ru", __dir__)
 
     plugin :httpboot, ::Proxy::VERSION
 

diff --git a/modules/logs/logs_plugin.rb b/modules/logs/logs_plugin.rb
@@ -1,6 +1,5 @@
 class ::Proxy::LogsPlugin < ::Proxy::Plugin
-  http_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
-  https_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
+  rackup_path File.expand_path("http_config.ru", __dir__)
 
   plugin :logs, ::Proxy::VERSION
   default_settings :enabled => true

diff --git a/modules/puppet_proxy/puppet_plugin.rb b/modules/puppet_proxy/puppet_plugin.rb
@@ -1,7 +1,6 @@
 module Proxy::Puppet
   class Plugin < Proxy::Plugin
-    http_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
-    https_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
+    rackup_path File.expand_path("http_config.ru", __dir__)
 
     plugin :puppet, ::Proxy::VERSION
 

diff --git a/modules/puppetca/puppetca_plugin.rb b/modules/puppetca/puppetca_plugin.rb
@@ -1,7 +1,6 @@
 module Proxy::PuppetCa
   class Plugin < ::Proxy::Plugin
-    http_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
-    https_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
+    rackup_path File.expand_path("http_config.ru", __dir__)
 
     uses_provider
     default_settings :use_provider => 'puppetca_hostname_whitelisting'

diff --git a/modules/realm/realm_plugin.rb b/modules/realm/realm_plugin.rb
@@ -1,7 +1,6 @@
 module Proxy::Realm
   class Plugin < ::Proxy::Plugin
-    http_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
-    https_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
+    rackup_path File.expand_path("http_config.ru", __dir__)
 
     default_settings :use_provider => 'realm_freeipa'
 

diff --git a/modules/root/root_plugin.rb b/modules/root/root_plugin.rb
@@ -2,8 +2,7 @@ class ::Proxy::RootPlugin < ::Proxy::Plugin
   plugin :foreman_proxy, ::Proxy::VERSION
   default_settings :enabled => true
 
-  http_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
-  https_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
+  rackup_path File.expand_path("http_config.ru", __dir__)
 
   override_module_loader_class ::Proxy::RootPluginLoader
 end
diff --git a/modules/templates/templates_plugin.rb b/modules/templates/templates_plugin.rb
@@ -1,7 +1,6 @@
 module Proxy::Templates
   class Plugin < ::Proxy::Plugin
-    http_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
-    https_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
+    rackup_path File.expand_path("http_config.ru", __dir__)
 
     plugin :templates, ::Proxy::VERSION
 

diff --git a/modules/tftp/tftp_plugin.rb b/modules/tftp/tftp_plugin.rb
@@ -2,8 +2,7 @@ module Proxy::TFTP
   class Plugin < ::Proxy::Plugin
     plugin :tftp, ::Proxy::VERSION
 
-    http_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
-    https_rackup_path File.expand_path("http_config.ru", File.expand_path(__dir__))
+    rackup_path File.expand_path("http_config.ru", __dir__)
 
     default_settings :tftproot => '/var/lib/tftpboot',
                      :tftp_read_timeout => 60,

diff --git a/test/plugins/plugin_test.rb b/test/plugins/plugin_test.rb
@@ -7,6 +7,16 @@ def test_http_rackup_returns_empty_string_with_missing_rackup_path
     assert_equal "", TestPlugin2.https_rackup
   end
 
+  class TestPluginSingleRackupPath < Proxy::Plugin
+    plugin :test2, '1.0'
+    rackup_path '/dev/null'
+  end
+
+  def test_combined_rackup_path_returns_http_and_https
+    assert_equal '/dev/null', TestPluginSingleRackupPath.get_http_rackup_path
+    assert_equal '/dev/null', TestPluginSingleRackupPath.get_https_rackup_path
+  end
+
   class TestBundlerGroupPlugin < ::Proxy::Plugin
     plugin :test_bundler_group, '1.0'
     bundler_group :test_group