WIP: Feature/simon hoenscheid 603 restructure repository management

.travis.yml

@@ -86,6 +86,7 @@ jobs:
 branches:
   only:
   - master
+  - module_rewrite
   - /^v\d/
 notifications:
   email: false

data/Archlinux/rolling.yaml

@@ -0,0 +1 @@
+---

data/CentOS/6.yaml

@@ -0,0 +1 @@
+---

data/CentOS/7.yaml

@@ -0,0 +1 @@
+---

data/CentOS/8.yaml

@@ -0,0 +1 @@
+---

data/Debian/10.yaml

@@ -0,0 +1,25 @@
+---
+php::external_repo: false
+php::php_version: '7.3'
+php::os_supported_php_versions:
+  - '7.3'
+
+php::external_repo_supported_php_versions:
+  - '5.6'
+  - '7.0'
+  - '7.1'
+  - '7.2'
+  - '7.3'
+  - '7.4'
+
+php::external_repo_details:
+  'source_php_sury':
+    comment: 'the debian sury repo sury.org'
+    location: 'https://packages.sury.org/php/'
+    repos: 'main'
+    include:
+      src: true
+      deb: true
+    key:
+      id: '15058500A0235D97F5D10063B188E2B695BD4743'
+      source: 'https://packages.sury.org/php/apt.gpg'

data/Debian/9.yaml

@@ -0,0 +1 @@
+---

data/Fedora/31.yaml

@@ -0,0 +1 @@
+---

data/Fedora/32.yaml

@@ -0,0 +1 @@
+---

data/Fedora/33.yaml

@@ -0,0 +1 @@
+---

data/FreeBSD/11.3.yaml

@@ -0,0 +1 @@
+---

data/FreeBSD/11.4.yaml

@@ -0,0 +1 @@
+---

data/FreeBSD/12.1.yaml

@@ -0,0 +1 @@
+---

data/OpenSuSE/15.1.yaml

@@ -0,0 +1 @@
+---

data/OpenSuSE/15.2.yaml

@@ -0,0 +1 @@
+---

data/OpenSuSE/15.3.yaml

@@ -0,0 +1 @@
+---

data/RedHat/6.yaml

@@ -0,0 +1 @@
+---

data/RedHat/7.yaml

@@ -0,0 +1 @@
+---

data/RedHat/8.yaml

@@ -0,0 +1 @@
+---

data/SLES/11.yaml

@@ -0,0 +1 @@
+---

data/SLES/12.yaml

@@ -0,0 +1 @@
+---

data/SLES/15.yaml

@@ -0,0 +1 @@
+---

data/Ubuntu/16.04.yaml

@@ -0,0 +1 @@
+---

data/Ubuntu/18.04.yaml

@@ -0,0 +1 @@
+---

data/Ubuntu/20.04.yaml

@@ -0,0 +1 @@
+---

data/default.yaml → data/common.yaml

@@ -1,6 +1,4 @@
 ---
-
 lookup_options:
   php::fpm::pools:
     merge: first
-

hiera.yaml

@@ -1,6 +1,13 @@
 ---
 version: 5
+defaults:
+  datadir: 'data'
+  data_hash: 'yaml_data'
+
 hierarchy:
-  - name: default.yaml
+  - name: 'My Hierarchies'
     paths:
-      - 'default.yaml'
+     - '%{facts.os.name}/%{facts.os.distro.release.major}.yaml'
+     - '%{facts.os.name}/%{facts.os.release.full}.yaml'
+     - '%{facts.os.name}/%{facts.os.release.major}.yaml'
+     - 'common.yaml'

manifests/init.pp

@@ -133,6 +133,43 @@
 #   If set to false, a restart will be executed instead of a reload.
 #   This default will be changed in a future release.
 #
+#########
+######### REWRITE
+#
+# @param [Boolean] manage_external_repo
+#   manage an external package repository or not
+# @option external_repo [Boolean] :false
+#   default
+# @option external_repo [Boolean] :true  
+#
+# @param [Hash] external_repo_details
+#   The PHP versions the additional repositories support
+# @option external_repo_details [Hash] :{}
+#   default: empty Hash, default for OS from Hiera Data in module
+#
+# @param [Array] external_repo_supported_php_versions
+#   The PHP versions the additional repositories support
+# @option external_repo_supported_php_versions [Array] :[]
+#   default: empty array, default for OS from Hiera Data in module
+#
+# @param [Boolean] manage_internal_repo
+#   manage an internal package repository, parameter is to control
+#   app streams in CENTOS/RHEL/Fedora, Repos on FreeBSD or Archlinux
+# @option external_repo [Boolean] :false
+#   true
+# @option external_repo [Boolean] :true   
+#
+# @param [Array] os_supported_php_versions
+#   The PHP versions the OS supports by default, without any additional repositories,
+#   on RHEL/CentOS and Fedora this includes app streams, on FreeBSD or Archlinux it manages Repos
+# @option os_supported_php_versions [Array] :[]
+#   default: empty array, default for OS from Hiera Data in module
+# 
+# @param [String] php_version
+#   Set the PHP version to install
+# @option php_version [String] :'7.4'
+#   defaults: latest stable PHP Version available on php.net, default for OS from Hiera Data in module
+#
 class php (
   String $ensure                                  = $php::params::ensure,
   Boolean $manage_repos                           = $php::params::manage_repos,
@@ -169,6 +206,15 @@
   String $log_group                               = $php::params::fpm_group,
   Boolean $pool_purge                             = $php::params::pool_purge,
   Boolean $reload_fpm_on_config_changes           = true,
+  # added for refactoring
+  Boolean $manage_external_repo                         = false,
+  Array $external_repo_supported_php_versions           = [],
+  Hash $external_repo_details                           = {},
+  Boolean $manage_internal_repo                         = true,
+  Array $os_supported_php_versions                      = [],
+  String[1] $php_version                                = '7.4', # TODO: validate a version string here?
+
+
 ) inherits php::params {
   $real_fpm_package = pick($fpm_package, "${package_prefix}${php::params::fpm_package_suffix}")
 

manifests/repo.pp

@@ -1,32 +1,53 @@
-# Configure package repository
+# @api private
+# @summary Configure package repository
 #
-class php::repo {
-  $msg_no_repo = "No repo available for ${facts['os']['family']}/${facts['os']['name']}"
+# @param [Boolean] manage_external_repo
+#   manage an external package repository or not
+# @option external_repo [Boolean] :false
+#   default
+# @option external_repo [Boolean] :true  
+#
+# @param [Array] external_repo_supported_php_versions
+#   The PHP versions the additional repositories support
+# @option external_repo_supported_php_versions [Array] :[]
+#   default: empty array, default for OS from Hiera Data in module
+#
+# @param [Boolean] manage_internal_repo
+#   manage an internal package repository, parameter is to control
+#   app streams in CENTOS/RHEL/Fedora, Repos on FreeBSD or Archlinux
+# @option external_repo [Boolean] :false
+#   true
+# @option external_repo [Boolean] :true   
+#
+# @param [Array] os_supported_php_versions
+#   The PHP versions the OS supports by default, without any additional repositories,
+#   on RHEL/CentOS and Fedora this includes app streams, on FreeBSD or Archlinux it manages Repos
+# @option os_supported_php_versions [Array] :[]
+#   default: empty array, default for OS from Hiera Data in module
+# 
+# @param [String] php_version
+#   Set the PHP version to install
+# @option php_version [String] :'7.4'
+#   defaults: latest stable PHP Version available on php.net, default for OS from Hiera Data in module
+#
+class php::repo (
+  Boolean $manage_internal_repo                         = $php::manage_internal_repo,
+  Boolean $manage_external_repo                         = $php::manage_external_repo,
+  Optional[Array] $external_repo_supported_php_versions = $php::external_repo_supported_php_versions,
+  Array $os_supported_php_versions                      = $php::os_supported_php_versions,
+  Optional[String[1]] $php_version                      = $php::php_version,
 
-  case $facts['os']['family'] {
-    'Debian': {
-      # no contain here because apt does that already
-      case $facts['os']['name'] {
-        'Debian': {
-          include php::repo::debian
-        }
-        'Ubuntu': {
-          include php::repo::ubuntu
-        }
-        default: {
-          fail($msg_no_repo)
-        }
-      }
-    }
-    'FreeBSD': {}
-    'Suse': {
-      contain php::repo::suse
-    }
-    'RedHat': {
-      contain 'php::repo::redhat'
-    }
-    default: {
-      fail($msg_no_repo)
+) {
+  assert_private()
+
+  if (($manage_internal_repo or $manage_external_repo) and (($php_version in $external_repo_supported_php_versions) or ($php_version in $os_supported_php_versions))) {
+    case $facts['os']['name'] {
+      'Archlinux':                  { contain 'php::repo::archlinux' }
+      'FreeBSD':                    { contain 'php::repo::freebsd' }
+      'RedHat', 'CentOS', 'Fedora': { contain 'php::repo::redhat' }
+      'Debian', 'Ubuntu':           { contain 'php::repo::debian' }
+      'OpenSuSE', 'SLES':           { contain 'php::repo::suse' }
+      default:                      { contain 'php::repo::fallback' }
     }
   }
 }

manifests/repo/archlinux.pp

@@ -0,0 +1,13 @@
+# @api private
+# @summary Configure archlinux repo
+#
+# @param [Hash] external_repo_details
+#   The PHP versions the additional repositories support
+# @option external_repo_details [Hash] :{}
+#   default: empty Hash, default for OS from Hiera Data in module
+#
+class php::repo::archlinux (
+  Hash[String[1], Hash] $external_repo_details = $php::external_repo_details,
+) {
+  assert_private()
+}

manifests/repo/debian.pp

@@ -1,67 +1,21 @@
-# Configure debian apt repo
+# @api private
+# @summary Configure debian apt repo
 #
-# === Parameters
-#
-# [*location*]
-#   Location of the apt repository
-#
-# [*release*]
-#   Release of the apt repository
-#
-# [*repos*]
-#   Apt repository names
-#
-# [*include_src*]
-#   Add source source repository
-#
-# [*key*]
-#   Public key in apt::key format
-#
-# [*dotdeb*]
-#   Enable special dotdeb handling
-#
-# [*sury*]
-#   Enable special sury handling
+# @param [Hash] external_repo_details
+#   The PHP versions the additional repositories support
+# @option external_repo_details [Hash] :{}
+#   default: empty Hash, default for OS from Hiera Data in module
 #
 class php::repo::debian (
-  $location     = 'https://packages.dotdeb.org',
-  $release      = 'wheezy-php56',
-  $repos        = 'all',
-  $include_src  = false,
-  $key          = {
-    'id'     => '6572BBEF1B5FF28B28B706837E3F070089DF5277',
-    'source' => 'http://www.dotdeb.org/dotdeb.gpg',
-  },
-  $dotdeb       = true,
-  $sury         = true,
+  Hash[String[1], Hash] $external_repo_details = $php::external_repo_details,
 ) {
   assert_private()
 
   include 'apt'
 
-  apt::source { "source_php_${release}":
-    location => $location,
-    release  => $release,
-    repos    => $repos,
-    include  => {
-      'src' => $include_src,
-      'deb' => true,
-    },
-    key      => $key,
-  }
-
-  if ($sury and $php::globals::php_version in ['7.1','7.2']) {
-    apt::source { 'source_php_sury':
-      location => 'https://packages.sury.org/php/',
-      repos    => 'main',
-      include  => {
-        'src' => $include_src,
-        'deb' => true,
-      },
-      key      => {
-        id     => '15058500A0235D97F5D10063B188E2B695BD4743',
-        source => 'https://packages.sury.org/php/apt.gpg',
-      },
+  $external_repo_details.each |String $repository, Hash $repository_details| {
+    apt::source { $repository:
+      * => $repository_details,
     }
   }
 }

manifests/repo/fallback.pp

@@ -0,0 +1,8 @@
+# @api private
+# @summary the fallback class, throws an error, if called
+class php::repo::fallback () {
+  assert_private()
+    $msg_no_repo = "No repo available for ${facts['os']['family']}/${facts['os']['name']}"
+
+  fail($msg_no_repo)
+}

manifests/repo/freebsd.pp

@@ -0,0 +1,12 @@
+# @api private
+# @summary Configure Freebsd repos
+#
+# @param [Hash] external_repo_details
+#   The PHP versions the additional repositories support
+# @option external_repo_details [Hash] :{}
+#   default: empty Hash, default for OS from Hiera Data in module
+class php::repo::freebsd (
+  Hash[String[1], Hash] $external_repo_details = $php::external_repo_details,
+) {
+  assert_private()
+}