OS package install support (#743)

* OS package install support

* Increase testing for OS package install

Author: bmhughes

.github/workflows/ci.yml

@@ -32,7 +32,6 @@ jobs:
           - "rockylinux-8"
           - "ubuntu-2004"
           - "ubuntu-2204"
-
         suite:
           - "access-11"
           - "access-12"
@@ -58,6 +57,10 @@ jobs:
           - "server-install-13"
           - "server-install-14"
           - "server-install-15"
+          - "server-install-os"
+        exclude:
+          - os: "centos-7"
+            suite: "server-install-os"
       fail-fast: false
 
     steps:

CHANGELOG.md

@@ -4,6 +4,8 @@ This file is used to list changes made in the last 3 major versions of the postg
 
 ## Unreleased
 
+- Allow package installation from OS distribution repository
+
 ## 11.2.12 - *2023-05-16*
 
 ## 11.2.11 - *2023-05-04*

documentation/postgresql_install.md

@@ -21,7 +21,7 @@
 | ---------------------------------- | ----- | --------------- | ------- | ------------------------------------------------ | -------------- |
 | `sensitive`                        |       | true, false     |         |                                                  |                |
 | `version`                          |       | String, Integer |         | Version to install                               |                |
-| `source`                           |       | String, Symbol  |         | Installation source                              | repo           |
+| `source`                           |       | String, Symbol  |         | Installation source                              | repo, os       |
 | `client_packages`                  |       | String, Array   |         | Client packages to install                       |                |
 | `server_packages`                  |       | String, Array   |         | Server packages to install                       |                |
 | `repo_pgdg`                        |       | true, false     |         | Create pgdg repo                                 |                |

kitchen.yml

@@ -33,6 +33,13 @@ platforms:
   - name: ubuntu-22.04
 
 suites:
+  - name: server_install_os
+    verifier:
+      inspec_tests:
+        - path: test/integration/server_install_os/
+    run_list:
+      - recipe[test::server_install_os]
+
   - name: access_15
     attributes:
       test:

libraries/helpers.rb

@@ -28,33 +28,58 @@ def installed_postgresql_major_version
 
         raise 'Unable to determine installed PostgreSQL version' if nil_or_empty?(pgsql_package)
 
-        pgsql_package_version = pgsql_package.first[1].fetch('version').to_i
-        Chef::Log.info("Deteched PostgreSQL version: #{pgsql_package_version}")
+        pgsql_package = pgsql_package.values.first
+        pgsql_package_version = pgsql_package.fetch('version').to_i
+        pgsql_package_source = if pgsql_package.key?('release')
+                                 pgsql_package.fetch('release').match?('PGDG') ? :repo : :os
+                               else
+                                 pgsql_package.fetch('version').match?('pgdg') ? :repo : :os
+                               end
+
+        Chef::Log.info("Detected installed PostgreSQL version: #{pgsql_package_version} installed from #{pgsql_package_source}")
 
         pgsql_package_version
       end
 
-      def data_dir(version = installed_postgresql_major_version)
+      def installed_postgresql_package_source
+        pgsql_package = node['packages'].filter { |p| p.match?(/postgresql-?(\d+)?$/) }
+
+        raise 'Unable to determine installed PostgreSQL version' if nil_or_empty?(pgsql_package)
+
+        pgsql_package = pgsql_package.values.first
+        pgsql_package_version = pgsql_package.fetch('version').to_i
+        pgsql_package_source = if pgsql_package.key?('release')
+                                 pgsql_package.fetch('release').match?('PGDG') ? :repo : :os
+                               else
+                                 pgsql_package.fetch('version').match?('pgdg') ? :repo : :os
+                               end
+
+        Chef::Log.info("Detected installed PostgreSQL version: #{pgsql_package_version} installed from #{pgsql_package_source}")
+
+        pgsql_package_source
+      end
+
+      def data_dir(version: installed_postgresql_major_version, source: installed_postgresql_package_source)
         case node['platform_family']
         when 'rhel', 'fedora', 'amazon'
-          "/var/lib/pgsql/#{version}/data"
+          source.eql?(:repo) ? "/var/lib/pgsql/#{version}/data" : '/var/lib/pgsql/data'
         when 'debian'
           "/var/lib/postgresql/#{version}/main"
         end
       end
 
-      def conf_dir(version = installed_postgresql_major_version)
+      def conf_dir(version: installed_postgresql_major_version, source: installed_postgresql_package_source)
         case node['platform_family']
         when 'rhel', 'fedora', 'amazon'
-          "/var/lib/pgsql/#{version}/data"
+          source.eql?(:repo) ? "/var/lib/pgsql/#{version}/data" : '/var/lib/pgsql/data'
         when 'debian'
           "/etc/postgresql/#{version}/main"
         end
       end
 
       # determine the platform specific service name
-      def default_platform_service_name(version = installed_postgresql_major_version)
-        if platform_family?('rhel', 'fedora', 'amazon')
+      def default_platform_service_name(version: installed_postgresql_major_version, source: installed_postgresql_package_source)
+        if platform_family?('rhel', 'fedora', 'amazon') && source.eql?(:repo)
           "postgresql-#{version}"
         else
           'postgresql'
@@ -73,24 +98,37 @@ def initialized?
       def secure_random
         r = SecureRandom.hex
         Chef::Log.debug "Generated password: #{r}"
+
         r
       end
 
-      def default_server_packages
+      def default_server_packages(version: nil, source: :os)
         case node['platform_family']
         when 'rhel', 'fedora', 'amazon'
-          %W(postgresql#{version.delete('.')}-contrib postgresql#{version.delete('.')}-libs postgresql#{version.delete('.')}-server)
+          {
+            os: %w(postgresql-contrib postgresql-server),
+            repo: %W(postgresql#{version.delete('.')}-contrib postgresql#{version.delete('.')}-server),
+          }.fetch(source, nil)
         when 'debian'
-          %W(postgresql-#{version} postgresql-common)
+          {
+            os: %w(postgresql postgresql-common),
+            repo: %W(postgresql-#{version} postgresql-common),
+          }.fetch(source, nil)
         end
       end
 
-      def default_client_packages
+      def default_client_packages(version: nil, source: :os)
         case node['platform_family']
         when 'rhel', 'fedora', 'amazon'
-          %W(postgresql#{version.delete('.')} postgresql#{version.delete('.')}-libs)
+          {
+            os: %w(postgresql),
+            repo: %W(postgresql#{version.delete('.')}),
+          }.fetch(source, nil)
         when 'debian'
-          %W(postgresql-client-#{version})
+          {
+            os: %w(postgresql-client),
+            repo: %W(postgresql-client-#{version}),
+          }.fetch(source, nil)
         end
       end
 
@@ -102,11 +140,11 @@ def dnf_module_platform?
       # initdb defaults to the execution environment.
       # https://www.postgresql.org/docs/9.5/static/locale.html
       def rhel_init_db_command(new_resource)
-        cmd = "/usr/pgsql-#{new_resource.version}/bin/initdb"
+        cmd = new_resource.source.eql?(:repo) ? "/usr/pgsql-#{new_resource.version}/bin/initdb" : '/usr/bin/initdb'
         cmd << " --locale '#{new_resource.initdb_locale}'" if new_resource.initdb_locale
         cmd << " -E '#{new_resource.initdb_encoding}'" if new_resource.initdb_encoding
         cmd << " #{new_resource.initdb_additional_options}" if new_resource.initdb_additional_options
-        cmd << " -D '#{data_dir(new_resource.version)}'"
+        cmd << " -D '#{data_dir}'"
       end
 
       # Given the base URL build the complete URL string for a yum repo

libraries/sql/_connection.rb

@@ -27,8 +27,13 @@ module Connection
         include PostgreSQL::Cookbook::Utils
         include PostgreSQL::Cookbook::Helpers
 
-        def postgresql_devel_pkg_name(version = installed_postgresql_major_version)
-          platform_family?('debian') ? 'libpq-dev' : "postgresql#{version}-devel"
+        def postgresql_devel_pkg_name(version: installed_postgresql_major_version, source: installed_postgresql_package_source)
+          case node['platform_family']
+          when 'rhel', 'fedora', 'amazon'
+            source.eql?(:repo) ? "postgresql#{version}-devel" : 'postgresql-devel'
+          when 'debian'
+            'libpq-dev'
+          end
         end
 
         def postgresql_devel_path(suffix = nil, version: installed_postgresql_major_version)
@@ -65,11 +70,13 @@ def install_pg_gem
             declare_resource(:package, 'epel-release') { compile_time(true) }
             declare_resource(:package, 'centos-release-scl') { compile_time(true) }
           when 8
+            declare_resource(:package, 'libpq') { compile_time(true) }
             declare_resource(:package, 'perl-IPC-Run') do
               compile_time(true)
               options('--enablerepo=powertools')
             end
           when 9
+            declare_resource(:package, 'libpq') { compile_time(true) }
             declare_resource(:package, 'perl-IPC-Run') do
               compile_time(true)
               options('--enablerepo=crb')

resources/config.rb

@@ -94,15 +94,24 @@
       action :create
     end
 
+    service_dir = case installed_postgresql_package_source
+                  when :os
+                    '/etc/systemd/system/postgresql.service.d'
+                  when :repo
+                    "/etc/systemd/system/postgresql-#{new_resource.version}.service.d"
+                  else
+                    raise ArgumentError, "Unknown installation source: #{installed_postgresql_package_source}"
+                  end
+
     if new_resource.external_pid_file
-      directory "/etc/systemd/system/postgresql-#{new_resource.version}.service.d" do
+      directory service_dir do
         owner 'root'
         group 'root'
         mode '0755'
         action :create
       end
 
-      template "/etc/systemd/system/postgresql-#{new_resource.version}.service.d/10-pid.conf" do
+      template "#{service_dir}/10-pid.conf" do
         cookbook new_resource.cookbook
         source 'systemd/10-pid.conf.erb'
 
@@ -117,8 +126,8 @@
         action :create
       end
     else
-      directory("/etc/systemd/system/postgresql-#{new_resource.version}.service.d") { action(:delete) }
-      file("/etc/systemd/system/postgresql-#{new_resource.version}.service.d") { action(:delete) }
+      directory(service_dir) { action(:delete) }
+      file("#{service_dir}/10-pid.conf") { action(:delete) }
     end
   end
 end

resources/install.rb

@@ -30,16 +30,16 @@
 property :source, [String, Symbol],
           default: :repo,
           coerce: proc { |p| p.to_sym },
-          equal_to: %i(repo),
+          equal_to: %i(repo os),
           description: 'Installation source'
 
 property :client_packages, [String, Array],
-          default: lazy { default_client_packages },
+          default: lazy { default_client_packages(version: version, source: source) },
           coerce: proc { |p| Array(p) },
           description: 'Client packages to install'
 
 property :server_packages, [String, Array],
-          default: lazy { default_server_packages },
+          default: lazy { default_server_packages(version: version, source: source) },
           coerce: proc { |p| Array(p) },
           description: 'Server packages to install'
 
@@ -187,6 +187,8 @@ def do_client_package_action(package_action)
     end
 
     ohai 'postgresql_client_packages' do
+      plugin 'packages'
+
       action :nothing
     end
   end
@@ -205,6 +207,8 @@ def do_server_package_action(package_action)
     end
 
     ohai 'postgresql_server_packages' do
+      plugin 'packages'
+
       action :nothing
     end
   end
@@ -267,7 +271,7 @@ def do_server_package_action(package_action)
 action :init_server do
   return if initialized? || !platform_family?('rhel', 'fedora', 'amazon')
 
-  converge_by('Init Postgresql DB') do
+  converge_by('Init PostgreSQL') do
     execute 'init_db' do
       command rhel_init_db_command(new_resource)
       user new_resource.initdb_user