Refs #37325 - add postgresql module as a requirement

Author: ianballou

.fixtures.yml

@@ -17,6 +17,7 @@ fixtures:
     systemd:  'https://github.com/camptocamp/puppet-systemd'
     tftp:     'https://github.com/theforeman/puppet-tftp'
     translate: 'https://github.com/puppetlabs/puppetlabs-translate'
+    postgresql: 'https://github.com/puppetlabs/puppetlabs-postgresql'
     xinetd:   'https://github.com/puppetlabs/puppetlabs-xinetd'
     yumrepo_core: "https://github.com/puppetlabs/puppetlabs-yumrepo_core"
     sshkeys_core: "https://github.com/puppetlabs/puppetlabs-sshkeys_core"

README.md

@@ -100,11 +100,6 @@ class { 'foreman_proxy::plugin::ansible':
 }
 ```
 
-### Katello Container Gateway Support
-
-If installing a Foreman Proxy with the Container Gateway, ensure that the
-postgresql module is available for use on the system.
-
 ## Contributing
 
 * Fork the project

manifests/plugin/container_gateway.pp

@@ -36,14 +36,14 @@
   Boolean $enabled = true,
   Foreman_proxy::ListenOn $listen_on = 'https',
   Stdlib::HTTPUrl $pulp_endpoint = "https://${facts['networking']['fqdn']}",
-  String $database_backend = 'postgres',
+  Enum['postgres', 'sqlite'] $database_backend = 'postgres',
   Stdlib::Absolutepath $sqlite_db_path = '/var/lib/foreman-proxy/smart_proxy_container_gateway.db',
   Optional[Integer] $sqlite_timeout = undef,
   Boolean $manage_postgresql = true,
-  Stdlib::Host $postgresql_host = 'localhost',
-  Stdlib::Port $postgresql_port = 5432,
+  Optional[Stdlib::Host] $postgresql_host = undef,
+  Optional[Stdlib::Port] $postgresql_port = undef,
   String $postgresql_database = 'container_gateway',
-  String $postgresql_user = 'foreman-proxy',
+  String $postgresql_user = pick($foreman_proxy::globals::user, 'foreman-proxy'),
   String $postgresql_password = extlib::cache_data('container_gateway_cache_data', 'db_password', extlib::random_password(32))
 ) {
   foreman_proxy::plugin::module { 'container_gateway':
@@ -53,7 +53,8 @@
     listen_on => $listen_on,
   }
 
-  if $foreman_proxy::plugin::container_gateway::manage_postgresql {
+  if $foreman_proxy::plugin::container_gateway::manage_postgresql and
+  $foreman_proxy::plugin::container_gateway::database_backend != 'sqlite' {
     include postgresql::server
     postgresql::server::db { $foreman_proxy::plugin::container_gateway::postgresql_database:
       user     => $foreman_proxy::plugin::container_gateway::postgresql_user,
@@ -62,8 +63,7 @@
         $foreman_proxy::plugin::container_gateway::postgresql_password
       ),
       encoding => 'utf8',
-      locale   => 'en_US.utf8',
-      require  => Package['glibc-langpack-en'],
+      locale   => 'C.utf8',
     }
   }
 }

spec/classes/foreman_proxy__plugin__container_gateway_spec.rb

@@ -7,26 +7,23 @@
       let(:pre_condition) { 'include foreman_proxy' }
 
       describe 'with default settings' do
-        let :postgresql_password do 'changeme' end
         it { should contain_foreman_proxy__plugin__module('container_gateway') }
         it 'container_gateway.yml should contain the correct configuration' do
-          verify_exact_contents(catalogue, '/etc/foreman-proxy/settings.d/container_gateway.yml', [
-            '---',
-            ':enabled: https',
-            ":pulp_endpoint: https://#{facts[:fqdn]}",
-            ':database_backend: postgresql',
-            ':sqlite_db_path: /var/lib/foreman-proxy/smart_proxy_container_gateway.db',
-            ':postgresql_connection_string: postgres://foreman-proxy:changeme@localhost:5432/container_gateway'
-          ])
+          expect(get_content(catalogue, '/etc/foreman-proxy/settings.d/container_gateway.yml')).to include("---")
+          expect(get_content(catalogue, '/etc/foreman-proxy/settings.d/container_gateway.yml')).to include(":enabled: https")
+          expect(get_content(catalogue, '/etc/foreman-proxy/settings.d/container_gateway.yml')).to include(":pulp_endpoint: https://#{facts[:fqdn]}")
+          expect(get_content(catalogue, '/etc/foreman-proxy/settings.d/container_gateway.yml')).to include(":sqlite_db_path: /var/lib/foreman-proxy/smart_proxy_container_gateway.db")
+          connection_string = get_content(catalogue, '/etc/foreman-proxy/settings.d/container_gateway.yml').find { |str| str.include?("db_connection_string") }
+          expect(connection_string.split(/[:@\/]/)[6]).to be_a(String).and have_attributes(length: 32)
         end
       end
 
       describe 'with overwritten parameters' do
         let :params do {
           :pulp_endpoint => 'https://test.example.com',
-          :database_backend => 'postgresql',
           :sqlite_db_path => '/dev/null.db',
           :sqlite_timeout => 12345,
+          :database_backend => 'sqlite',
           :postgresql_host => 'test.example.com',
           :postgresql_port => 5432,
           :postgresql_database => 'container_gateway',
@@ -39,10 +36,9 @@
             '---',
             ':enabled: https',
             ':pulp_endpoint: https://test.example.com',
-            ':database_backend: postgresql',
             ':sqlite_db_path: /dev/null.db',
             ':sqlite_timeout: 12345',
-            ':postgresql_connection_string: postgres://foreman-proxy:[email protected]:5432/container_gateway'
+            ':db_connection_string: sqlite:///dev/null.db'
           ])
         end
       end

templates/plugin/container_gateway.yml.erb

@@ -2,15 +2,23 @@
 # Container Gateway for Katello
 :enabled: <%= @module_enabled %>
 :pulp_endpoint: <%= scope.lookupvar("foreman_proxy::plugin::container_gateway::pulp_endpoint") %>
-:database_backend: <%= scope.lookupvar("foreman_proxy::plugin::container_gateway::database_backend") %>
 :sqlite_db_path: <%= scope.lookupvar("foreman_proxy::plugin::container_gateway::sqlite_db_path") %>
 <% if scope.lookupvar("foreman_proxy::plugin::container_gateway::sqlite_timeout") -%>
 :sqlite_timeout: <%= scope.lookupvar("foreman_proxy::plugin::container_gateway::sqlite_timeout") %>
 <% end -%>
-:postgresql_connection_string: postgres://<%=
+<% if scope.lookupvar("foreman_proxy::plugin::container_gateway::database_backend") == 'postgres' -%>
+:db_connection_string: <%=
+  "#{scope.lookupvar("foreman_proxy::plugin::container_gateway::database_backend")}://" \
   "#{scope.lookupvar("foreman_proxy::plugin::container_gateway::postgresql_user")}:" \
   "#{scope.lookupvar("foreman_proxy::plugin::container_gateway::postgresql_password")}@" \
   "#{scope.lookupvar("foreman_proxy::plugin::container_gateway::postgresql_host")}:" \
   "#{scope.lookupvar("foreman_proxy::plugin::container_gateway::postgresql_port")}/" \
   "#{scope.lookupvar("foreman_proxy::plugin::container_gateway::postgresql_database")}"
-  %>
+  %>
+<% end -%>
+<% if scope.lookupvar("foreman_proxy::plugin::container_gateway::database_backend") == 'sqlite' -%>
+:db_connection_string: <%=
+  "#{scope.lookupvar("foreman_proxy::plugin::container_gateway::database_backend")}://" \
+  "#{scope.lookupvar("foreman_proxy::plugin::container_gateway::sqlite_db_path")}"
+  %>
+<% end -%>